blob: f0ff3bc71699ad2dca30acc93494b34335619c06 [file] [log] [blame]
Bill Wendling0310d762009-05-15 09:23:25 +00001//===-- 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 Wendling0310d762009-05-15 09:23:25 +000017#include "llvm/CodeGen/AsmPrinter.h"
Devang Patelc3f5f782010-05-25 23:40:22 +000018#include "llvm/CodeGen/MachineLocation.h"
Chris Lattnerd2c4f192010-04-05 06:12:01 +000019#include "DIE.h"
Devang Patel622b0262010-01-19 06:19:05 +000020#include "llvm/ADT/DenseMap.h"
Bill Wendling0310d762009-05-15 09:23:25 +000021#include "llvm/ADT/FoldingSet.h"
Chris Lattner74e41f92010-04-05 05:24:55 +000022#include "llvm/ADT/SmallPtrSet.h"
Bill Wendling0310d762009-05-15 09:23:25 +000023#include "llvm/ADT/StringMap.h"
24#include "llvm/ADT/UniqueVector.h"
Chris Lattner74e41f92010-04-05 05:24:55 +000025#include "llvm/Support/Allocator.h"
Bill Wendling0310d762009-05-15 09:23:25 +000026
27namespace llvm {
28
29class CompileUnit;
Bill Wendling0310d762009-05-15 09:23:25 +000030class DbgConcreteScope;
Nick Lewycky381afae2009-11-17 09:17:08 +000031class DbgScope;
32class DbgVariable;
Bill Wendling0310d762009-05-15 09:23:25 +000033class MachineFrameInfo;
34class MachineModuleInfo;
Devang Patela43098d2010-04-28 01:03:09 +000035class MachineOperand;
Chris Lattneraf76e592009-08-22 20:48:53 +000036class MCAsmInfo;
Chris Lattner74e41f92010-04-05 05:24:55 +000037class DIEAbbrev;
38class DIE;
39class DIEBlock;
40class DIEEntry;
41
42class DIEnumerator;
43class DIDescriptor;
44class DIVariable;
45class DIGlobal;
46class DIGlobalVariable;
47class DISubprogram;
48class DIBasicType;
49class DIDerivedType;
50class DIType;
51class DINameSpace;
52class DISubrange;
53class DICompositeType;
Bill Wendling0310d762009-05-15 09:23:25 +000054
55//===----------------------------------------------------------------------===//
56/// SrcLineInfo - This class is used to record source line correspondence.
57///
Nick Lewycky381afae2009-11-17 09:17:08 +000058class SrcLineInfo {
Bill Wendling0310d762009-05-15 09:23:25 +000059 unsigned Line; // Source line number.
60 unsigned Column; // Source column.
61 unsigned SourceID; // Source ID number.
Chris Lattner25b68c62010-03-14 08:15:55 +000062 MCSymbol *Label; // Label in code ID number.
Bill Wendling0310d762009-05-15 09:23:25 +000063public:
Chris Lattner25b68c62010-03-14 08:15:55 +000064 SrcLineInfo(unsigned L, unsigned C, unsigned S, MCSymbol *label)
65 : Line(L), Column(C), SourceID(S), Label(label) {}
Bill Wendling0310d762009-05-15 09:23:25 +000066
67 // Accessors
68 unsigned getLine() const { return Line; }
69 unsigned getColumn() const { return Column; }
70 unsigned getSourceID() const { return SourceID; }
Chris Lattner25b68c62010-03-14 08:15:55 +000071 MCSymbol *getLabel() const { return Label; }
Bill Wendling0310d762009-05-15 09:23:25 +000072};
73
Chris Lattnerd38fee82010-04-05 00:13:49 +000074class DwarfDebug {
75 /// Asm - Target of Dwarf emission.
76 AsmPrinter *Asm;
Chris Lattner105d6972010-04-05 05:31:04 +000077
Chris Lattnerd38fee82010-04-05 00:13:49 +000078 /// MMI - Collected machine module information.
79 MachineModuleInfo *MMI;
80
Bill Wendling0310d762009-05-15 09:23:25 +000081 //===--------------------------------------------------------------------===//
82 // Attributes used to construct specific Dwarf sections.
83 //
84
Devang Patel163a9f72010-05-10 22:49:55 +000085 CompileUnit *FirstCU;
86 DenseMap <const MDNode *, CompileUnit *> CUMap;
Bill Wendling0310d762009-05-15 09:23:25 +000087
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 Gohmanf451cb82010-02-10 16:03:48 +0000118 /// Lines - List of source line correspondence.
Bill Wendling0310d762009-05-15 09:23:25 +0000119 std::vector<SrcLineInfo> Lines;
120
Benjamin Kramer345ef342010-03-31 19:34:01 +0000121 /// 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 Wendling0310d762009-05-15 09:23:25 +0000126
Chris Lattnerbc733f52010-03-13 02:17:42 +0000127 /// 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 Wendling0310d762009-05-15 09:23:25 +0000133
134 /// SectionMap - Provides a unique id per text section.
135 ///
Chris Lattnera87dea42009-07-31 18:48:30 +0000136 UniqueVector<const MCSection*> SectionMap;
Bill Wendling0310d762009-05-15 09:23:25 +0000137
138 /// SectionSourceLines - Tracks line numbers per text section.
139 ///
140 std::vector<std::vector<SrcLineInfo> > SectionSourceLines;
141
Devang Patel53bb5c92009-11-10 23:06:00 +0000142 // CurrentFnDbgScope - Top level scope for the current function.
Bill Wendling0310d762009-05-15 09:23:25 +0000143 //
Devang Patel53bb5c92009-11-10 23:06:00 +0000144 DbgScope *CurrentFnDbgScope;
Bill Wendling0310d762009-05-15 09:23:25 +0000145
Jeffrey Yasskin5c213dc2010-03-12 17:45:06 +0000146 /// DbgScopeMap - Tracks the scopes in the current function. Owns the
147 /// contained DbgScope*s.
Devang Patel53bb5c92009-11-10 23:06:00 +0000148 ///
Devang Patele9f8f5e2010-05-07 20:54:48 +0000149 DenseMap<const MDNode *, DbgScope *> DbgScopeMap;
Bill Wendling0310d762009-05-15 09:23:25 +0000150
Devang Patel53bb5c92009-11-10 23:06:00 +0000151 /// ConcreteScopes - Tracks the concrete scopees in the current function.
152 /// These scopes are also included in DbgScopeMap.
Devang Patele9f8f5e2010-05-07 20:54:48 +0000153 DenseMap<const MDNode *, DbgScope *> ConcreteScopes;
Devang Patel53bb5c92009-11-10 23:06:00 +0000154
155 /// AbstractScopes - Tracks the abstract scopes a module. These scopes are
Jeffrey Yasskin5c213dc2010-03-12 17:45:06 +0000156 /// not included DbgScopeMap. AbstractScopes owns its DbgScope*s.
Devang Patele9f8f5e2010-05-07 20:54:48 +0000157 DenseMap<const MDNode *, DbgScope *> AbstractScopes;
Devang Patel2ddefec2010-03-25 15:09:44 +0000158
Devang Patel8aa61472010-07-07 22:20:57 +0000159 /// AbstractSPDies - Collection of abstract subprogram DIEs.
160 DenseMap<const MDNode *, DIE *> AbstractSPDies;
161
Devang Patel2ddefec2010-03-25 15:09:44 +0000162 /// AbstractScopesList - Tracks abstract scopes constructed while processing
163 /// a function. This list is cleared during endFunction().
Devang Patel53bb5c92009-11-10 23:06:00 +0000164 SmallVector<DbgScope *, 4>AbstractScopesList;
165
Jeffrey Yasskin5c213dc2010-03-12 17:45:06 +0000166 /// AbstractVariables - Collection on abstract variables. Owned by the
167 /// DbgScopes in AbstractScopes.
Devang Patele9f8f5e2010-05-07 20:54:48 +0000168 DenseMap<const MDNode *, DbgVariable *> AbstractVariables;
Devang Patel53bb5c92009-11-10 23:06:00 +0000169
Devang Patel26c1e562010-05-20 16:36:41 +0000170 /// DbgVariableToFrameIndexMap - Tracks frame index used to find
171 /// variable's value.
172 DenseMap<const DbgVariable *, int> DbgVariableToFrameIndexMap;
173
174 /// DbgVariableToDbgInstMap - Maps DbgVariable to corresponding DBG_VALUE
175 /// machine instruction.
176 DenseMap<const DbgVariable *, const MachineInstr *> DbgVariableToDbgInstMap;
177
178 /// DbgVariableLabelsMap - Maps DbgVariable to corresponding MCSymbol.
179 DenseMap<const DbgVariable *, const MCSymbol *> DbgVariableLabelsMap;
180
Devang Patelc3f5f782010-05-25 23:40:22 +0000181 /// DotDebugLocEntry - This struct describes location entries emitted in
182 /// .debug_loc section.
183 typedef struct DotDebugLocEntry {
184 const MCSymbol *Begin;
185 const MCSymbol *End;
186 MachineLocation Loc;
187 DotDebugLocEntry() : Begin(0), End(0) {}
188 DotDebugLocEntry(const MCSymbol *B, const MCSymbol *E,
189 MachineLocation &L) : Begin(B), End(E), Loc(L) {}
190 /// Empty entries are also used as a trigger to emit temp label. Such
191 /// labels are referenced is used to find debug_loc offset for a given DIE.
192 bool isEmpty() { return Begin == 0 && End == 0; }
193 } DotDebugLocEntry;
194
195 /// DotDebugLocEntries - Collection of DotDebugLocEntry.
196 SmallVector<DotDebugLocEntry, 4> DotDebugLocEntries;
197
198 /// UseDotDebugLocEntry - DW_AT_location attributes for the DIEs in this set
199 /// idetifies corresponding .debug_loc entry offset.
200 SmallPtrSet<const DIE *, 4> UseDotDebugLocEntry;
201
Devang Patel26c1e562010-05-20 16:36:41 +0000202 /// VarToAbstractVarMap - Maps DbgVariable with corresponding Abstract
203 /// DbgVariable, if any.
204 DenseMap<const DbgVariable *, const DbgVariable *> VarToAbstractVarMap;
205
Devang Patel53bb5c92009-11-10 23:06:00 +0000206 /// InliendSubprogramDIEs - Collection of subprgram DIEs that are marked
207 /// (at the end of the module) as DW_AT_inline.
208 SmallPtrSet<DIE *, 4> InlinedSubprogramDIEs;
209
Devang Patelf8a2e012010-04-15 00:02:49 +0000210 /// ContainingTypeMap - This map is used to keep track of subprogram DIEs that
211 /// need DW_AT_containing_type attribute. This attribute points to a DIE that
212 /// corresponds to the MDNode mapped with the subprogram DIE.
Devang Patele9f8f5e2010-05-07 20:54:48 +0000213 DenseMap<DIE *, const MDNode *> ContainingTypeMap;
Devang Patel5d11eb02009-12-03 19:11:07 +0000214
Devang Patel461a6462010-05-19 21:58:28 +0000215 typedef SmallVector<DbgScope *, 2> ScopeVector;
Devang Patelf347b822010-06-28 05:59:13 +0000216
Devang Patel1c246352010-04-08 16:50:29 +0000217 SmallPtrSet<const MachineInstr *, 8> InsnsEndScopeSet;
Devang Patelaf9e8472009-10-01 20:31:14 +0000218
Bill Wendling0310d762009-05-15 09:23:25 +0000219 /// InlineInfo - Keep track of inlined functions and their location. This
220 /// information is used to populate debug_inlined section.
Devang Patelc3f5f782010-05-25 23:40:22 +0000221 typedef std::pair<const MCSymbol *, DIE *> InlineInfoLabels;
Devang Patele9f8f5e2010-05-07 20:54:48 +0000222 DenseMap<const MDNode *, SmallVector<InlineInfoLabels, 4> > InlineInfo;
223 SmallVector<const MDNode *, 4> InlinedSPNodes;
Bill Wendling0310d762009-05-15 09:23:25 +0000224
Devang Patel4a1cad62010-06-28 18:25:03 +0000225 // ProcessedSPNodes - This is a collection of subprogram MDNodes that
226 // are processed to create DIEs.
227 SmallPtrSet<const MDNode *, 16> ProcessedSPNodes;
228
Devang Pateleac9c072010-04-27 19:46:33 +0000229 /// LabelsBeforeInsn - Maps instruction with label emitted before
Devang Patel1c246352010-04-08 16:50:29 +0000230 /// instruction.
Devang Pateleac9c072010-04-27 19:46:33 +0000231 DenseMap<const MachineInstr *, MCSymbol *> LabelsBeforeInsn;
Devang Patel1c246352010-04-08 16:50:29 +0000232
Devang Pateleac9c072010-04-27 19:46:33 +0000233 /// LabelsAfterInsn - Maps instruction with label emitted after
Devang Patel1c246352010-04-08 16:50:29 +0000234 /// instruction.
Devang Pateleac9c072010-04-27 19:46:33 +0000235 DenseMap<const MachineInstr *, MCSymbol *> LabelsAfterInsn;
Devang Patel1c246352010-04-08 16:50:29 +0000236
Devang Patelb2b31a62010-05-26 19:37:24 +0000237 /// insnNeedsLabel - Collection of instructions that need a label to mark
238 /// a debuggging information entity.
239 SmallPtrSet<const MachineInstr *, 8> InsnNeedsLabel;
240
Devang Patelf2548ca2010-04-16 23:33:45 +0000241 SmallVector<const MCSymbol *, 8> DebugRangeSymbols;
Devang Patelc04d5452010-04-22 20:56:35 +0000242
Devang Patel553881b2010-03-29 17:20:31 +0000243 /// Previous instruction's location information. This is used to determine
244 /// label location to indicate scope boundries in dwarf debug info.
Chris Lattnerde4845c2010-04-02 19:42:39 +0000245 DebugLoc PrevInstLoc;
Devang Patelf2548ca2010-04-16 23:33:45 +0000246 MCSymbol *PrevLabel;
Devang Patel553881b2010-03-29 17:20:31 +0000247
Bill Wendling0310d762009-05-15 09:23:25 +0000248 struct FunctionDebugFrameInfo {
249 unsigned Number;
250 std::vector<MachineMove> Moves;
251
252 FunctionDebugFrameInfo(unsigned Num, const std::vector<MachineMove> &M)
253 : Number(Num), Moves(M) {}
254 };
255
256 std::vector<FunctionDebugFrameInfo> DebugFrames;
257
Chris Lattner9c69e285532010-04-04 22:59:04 +0000258 // Section Symbols: these are assembler temporary labels that are emitted at
259 // the beginning of each supported dwarf section. These are used to form
260 // section offsets and are created by EmitSectionLabels.
261 MCSymbol *DwarfFrameSectionSym, *DwarfInfoSectionSym, *DwarfAbbrevSectionSym;
Devang Patelf2548ca2010-04-16 23:33:45 +0000262 MCSymbol *DwarfStrSectionSym, *TextSectionSym, *DwarfDebugRangeSectionSym;
Devang Patelc3f5f782010-05-25 23:40:22 +0000263 MCSymbol *DwarfDebugLocSectionSym;
264 MCSymbol *FunctionBeginSym, *FunctionEndSym;
Devang Patelca76f6f2010-07-08 20:10:35 +0000265
266 DIEInteger *DIEIntegerOne;
Chris Lattner9c69e285532010-04-04 22:59:04 +0000267private:
268
Bill Wendling0310d762009-05-15 09:23:25 +0000269 /// getSourceDirectoryAndFileIds - Return the directory and file ids that
270 /// maps to the source id. Source id starts at 1.
271 std::pair<unsigned, unsigned>
272 getSourceDirectoryAndFileIds(unsigned SId) const {
273 return SourceIds[SId-1];
274 }
275
276 /// getNumSourceDirectories - Return the number of source directories in the
277 /// debug info.
278 unsigned getNumSourceDirectories() const {
279 return DirectoryNames.size();
280 }
281
282 /// getSourceDirectoryName - Return the name of the directory corresponding
283 /// to the id.
284 const std::string &getSourceDirectoryName(unsigned Id) const {
285 return DirectoryNames[Id - 1];
286 }
287
288 /// getSourceFileName - Return the name of the source file corresponding
289 /// to the id.
290 const std::string &getSourceFileName(unsigned Id) const {
291 return SourceFileNames[Id - 1];
292 }
293
294 /// getNumSourceIds - Return the number of unique source ids.
295 unsigned getNumSourceIds() const {
296 return SourceIds.size();
297 }
298
Devang Patel2c4ceb12009-11-21 02:48:08 +0000299 /// assignAbbrevNumber - Define a unique number for the abbreviation.
Bill Wendling0310d762009-05-15 09:23:25 +0000300 ///
Devang Patel2c4ceb12009-11-21 02:48:08 +0000301 void assignAbbrevNumber(DIEAbbrev &Abbrev);
Bill Wendling0310d762009-05-15 09:23:25 +0000302
Devang Patel2c4ceb12009-11-21 02:48:08 +0000303 /// createDIEEntry - Creates a new DIEEntry to be a proxy for a debug
Bill Wendling995f80a2009-05-20 23:24:48 +0000304 /// information entry.
Jeffrey Yasskin5c213dc2010-03-12 17:45:06 +0000305 DIEEntry *createDIEEntry(DIE *Entry);
Bill Wendling0310d762009-05-15 09:23:25 +0000306
Devang Patel2c4ceb12009-11-21 02:48:08 +0000307 /// addUInt - Add an unsigned integer attribute data and value.
Bill Wendling0310d762009-05-15 09:23:25 +0000308 ///
Devang Patel2c4ceb12009-11-21 02:48:08 +0000309 void addUInt(DIE *Die, unsigned Attribute, unsigned Form, uint64_t Integer);
Bill Wendling0310d762009-05-15 09:23:25 +0000310
Devang Patel2c4ceb12009-11-21 02:48:08 +0000311 /// addSInt - Add an signed integer attribute data and value.
Bill Wendling0310d762009-05-15 09:23:25 +0000312 ///
Devang Patel2c4ceb12009-11-21 02:48:08 +0000313 void addSInt(DIE *Die, unsigned Attribute, unsigned Form, int64_t Integer);
Bill Wendling0310d762009-05-15 09:23:25 +0000314
Devang Patel2c4ceb12009-11-21 02:48:08 +0000315 /// addString - Add a string attribute data and value.
Bill Wendling0310d762009-05-15 09:23:25 +0000316 ///
Devang Patel2c4ceb12009-11-21 02:48:08 +0000317 void addString(DIE *Die, unsigned Attribute, unsigned Form,
Devang Patele9a05972009-11-24 19:42:17 +0000318 const StringRef Str);
Bill Wendling0310d762009-05-15 09:23:25 +0000319
Devang Patel2c4ceb12009-11-21 02:48:08 +0000320 /// addLabel - Add a Dwarf label attribute data and value.
Bill Wendling0310d762009-05-15 09:23:25 +0000321 ///
Devang Patel2c4ceb12009-11-21 02:48:08 +0000322 void addLabel(DIE *Die, unsigned Attribute, unsigned Form,
Chris Lattnerb98b1bf2010-03-08 22:23:36 +0000323 const MCSymbol *Label);
Bill Wendling0310d762009-05-15 09:23:25 +0000324
Devang Patel2c4ceb12009-11-21 02:48:08 +0000325 /// addDelta - Add a label delta attribute data and value.
Bill Wendling0310d762009-05-15 09:23:25 +0000326 ///
Devang Patel2c4ceb12009-11-21 02:48:08 +0000327 void addDelta(DIE *Die, unsigned Attribute, unsigned Form,
Chris Lattnerb98b1bf2010-03-08 22:23:36 +0000328 const MCSymbol *Hi, const MCSymbol *Lo);
Bill Wendling0310d762009-05-15 09:23:25 +0000329
Devang Patel2c4ceb12009-11-21 02:48:08 +0000330 /// addDIEEntry - Add a DIE attribute data and value.
Bill Wendling0310d762009-05-15 09:23:25 +0000331 ///
Chris Lattner74e41f92010-04-05 05:24:55 +0000332 void addDIEEntry(DIE *Die, unsigned Attribute, unsigned Form, DIE *Entry);
333
Devang Patel2c4ceb12009-11-21 02:48:08 +0000334 /// addBlock - Add block data.
Bill Wendling0310d762009-05-15 09:23:25 +0000335 ///
Devang Patel2c4ceb12009-11-21 02:48:08 +0000336 void addBlock(DIE *Die, unsigned Attribute, unsigned Form, DIEBlock *Block);
Bill Wendling0310d762009-05-15 09:23:25 +0000337
Devang Patel2c4ceb12009-11-21 02:48:08 +0000338 /// addSourceLine - Add location information to specified debug information
Bill Wendling0310d762009-05-15 09:23:25 +0000339 /// entry.
Devang Patel85e95802010-08-10 04:09:06 +0000340 void addSourceLine(DIE *Die, DIVariable V);
341 void addSourceLine(DIE *Die, DIGlobalVariable G);
342 void addSourceLine(DIE *Die, DISubprogram SP);
343 void addSourceLine(DIE *Die, DIType Ty);
344 void addSourceLine(DIE *Die, DINameSpace NS);
Bill Wendling0310d762009-05-15 09:23:25 +0000345
Devang Patel2c4ceb12009-11-21 02:48:08 +0000346 /// addAddress - Add an address attribute to a die based on the location
Bill Wendling0310d762009-05-15 09:23:25 +0000347 /// provided.
Devang Patel2c4ceb12009-11-21 02:48:08 +0000348 void addAddress(DIE *Die, unsigned Attribute,
Bill Wendling0310d762009-05-15 09:23:25 +0000349 const MachineLocation &Location);
350
Devang Patela43098d2010-04-28 01:03:09 +0000351 /// addRegisterAddress - Add register location entry in variable DIE.
Devang Patel26c1e562010-05-20 16:36:41 +0000352 bool addRegisterAddress(DIE *Die, const MCSymbol *VS, const MachineOperand &MO);
Devang Patela43098d2010-04-28 01:03:09 +0000353
354 /// addConstantValue - Add constant value entry in variable DIE.
Devang Patel26c1e562010-05-20 16:36:41 +0000355 bool addConstantValue(DIE *Die, const MCSymbol *VS, const MachineOperand &MO);
Devang Patela43098d2010-04-28 01:03:09 +0000356
357 /// addConstantFPValue - Add constant value entry in variable DIE.
Devang Patel26c1e562010-05-20 16:36:41 +0000358 bool addConstantFPValue(DIE *Die, const MCSymbol *VS, const MachineOperand &MO);
Devang Patela43098d2010-04-28 01:03:09 +0000359
Devang Patel2c4ceb12009-11-21 02:48:08 +0000360 /// addComplexAddress - Start with the address based on the location provided,
Mike Stump3e4c9bd2009-09-30 00:08:22 +0000361 /// and generate the DWARF information necessary to find the actual variable
362 /// (navigating the extra location information encoded in the type) based on
363 /// the starting location. Add the DWARF information to the die.
364 ///
Devang Patel2c4ceb12009-11-21 02:48:08 +0000365 void addComplexAddress(DbgVariable *&DV, DIE *Die, unsigned Attribute,
Mike Stump3e4c9bd2009-09-30 00:08:22 +0000366 const MachineLocation &Location);
367
Devang Patel2c4ceb12009-11-21 02:48:08 +0000368 // FIXME: Should be reformulated in terms of addComplexAddress.
369 /// addBlockByrefAddress - Start with the address based on the location
Caroline Ticedc8f6042009-08-31 21:19:37 +0000370 /// provided, and generate the DWARF information necessary to find the
371 /// actual Block variable (navigating the Block struct) based on the
Mike Stump3e4c9bd2009-09-30 00:08:22 +0000372 /// starting location. Add the DWARF information to the die. Obsolete,
Devang Patel2c4ceb12009-11-21 02:48:08 +0000373 /// please use addComplexAddress instead.
Caroline Ticedc8f6042009-08-31 21:19:37 +0000374 ///
Devang Patel2c4ceb12009-11-21 02:48:08 +0000375 void addBlockByrefAddress(DbgVariable *&DV, DIE *Die, unsigned Attribute,
Caroline Ticedc8f6042009-08-31 21:19:37 +0000376 const MachineLocation &Location);
377
Devang Patel9e3bd2c2010-08-31 06:11:28 +0000378 /// addVariableAddress - Add DW_AT_location attribute for a DbgVariable based
379 /// on provided frame index.
380 void addVariableAddress(DbgVariable *&DV, DIE *Die, int64_t FI);
Devang Patel8bd11de2010-08-09 21:01:39 +0000381
Devang Patelc366f832009-12-10 19:14:49 +0000382 /// addToContextOwner - Add Die into the list of its context owner's children.
383 void addToContextOwner(DIE *Die, DIDescriptor Context);
384
Devang Patel2c4ceb12009-11-21 02:48:08 +0000385 /// addType - Add a new type attribute to the specified entity.
Devang Patel8a241142009-12-09 18:24:21 +0000386 void addType(DIE *Entity, DIType Ty);
Bill Wendling0310d762009-05-15 09:23:25 +0000387
Devang Patel6404e4e2009-12-15 19:16:48 +0000388
389 /// getOrCreateNameSpace - Create a DIE for DINameSpace.
390 DIE *getOrCreateNameSpace(DINameSpace NS);
391
Devang Patel16ced732009-12-10 18:05:33 +0000392 /// getOrCreateTypeDIE - Find existing DIE or create new DIE for the
393 /// given DIType.
394 DIE *getOrCreateTypeDIE(DIType Ty);
395
Devang Patel193f7202009-11-24 01:14:22 +0000396 void addPubTypes(DISubprogram SP);
397
Devang Patel2c4ceb12009-11-21 02:48:08 +0000398 /// constructTypeDIE - Construct basic type die from DIBasicType.
Devang Patel8a241142009-12-09 18:24:21 +0000399 void constructTypeDIE(DIE &Buffer,
Bill Wendling0310d762009-05-15 09:23:25 +0000400 DIBasicType BTy);
401
Devang Patel2c4ceb12009-11-21 02:48:08 +0000402 /// constructTypeDIE - Construct derived type die from DIDerivedType.
Devang Patel8a241142009-12-09 18:24:21 +0000403 void constructTypeDIE(DIE &Buffer,
Bill Wendling0310d762009-05-15 09:23:25 +0000404 DIDerivedType DTy);
405
Devang Patel2c4ceb12009-11-21 02:48:08 +0000406 /// constructTypeDIE - Construct type DIE from DICompositeType.
Devang Patel8a241142009-12-09 18:24:21 +0000407 void constructTypeDIE(DIE &Buffer,
Bill Wendling0310d762009-05-15 09:23:25 +0000408 DICompositeType CTy);
409
Devang Patel2c4ceb12009-11-21 02:48:08 +0000410 /// constructSubrangeDIE - Construct subrange DIE from DISubrange.
411 void constructSubrangeDIE(DIE &Buffer, DISubrange SR, DIE *IndexTy);
Bill Wendling0310d762009-05-15 09:23:25 +0000412
Devang Patel2c4ceb12009-11-21 02:48:08 +0000413 /// constructArrayTypeDIE - Construct array type DIE from DICompositeType.
Devang Patel8a241142009-12-09 18:24:21 +0000414 void constructArrayTypeDIE(DIE &Buffer,
Bill Wendling0310d762009-05-15 09:23:25 +0000415 DICompositeType *CTy);
416
Devang Patel2c4ceb12009-11-21 02:48:08 +0000417 /// constructEnumTypeDIE - Construct enum type DIE from DIEnumerator.
Devang Patel3c91b052010-03-08 20:52:55 +0000418 DIE *constructEnumTypeDIE(DIEnumerator ETy);
Devang Patel4063f6b2009-12-07 21:41:32 +0000419
Devang Patel2c4ceb12009-11-21 02:48:08 +0000420 /// createMemberDIE - Create new member DIE.
Devang Patelecbd8e82010-08-10 04:12:17 +0000421 DIE *createMemberDIE(DIDerivedType DT);
Bill Wendling0310d762009-05-15 09:23:25 +0000422
Devang Patel2c4ceb12009-11-21 02:48:08 +0000423 /// createSubprogramDIE - Create new DIE using SP.
Devang Patelecbd8e82010-08-10 04:12:17 +0000424 DIE *createSubprogramDIE(DISubprogram SP, bool MakeDecl = false);
Bill Wendling0310d762009-05-15 09:23:25 +0000425
Devang Pateleac9c072010-04-27 19:46:33 +0000426 /// getOrCreateDbgScope - Create DbgScope for the scope.
Devang Patele9f8f5e2010-05-07 20:54:48 +0000427 DbgScope *getOrCreateDbgScope(const MDNode *Scope, const MDNode *InlinedAt);
Devang Patel70d75ca2009-11-12 19:02:56 +0000428
Devang Patele9f8f5e2010-05-07 20:54:48 +0000429 DbgScope *getOrCreateAbstractScope(const MDNode *N);
Devang Patel53bb5c92009-11-10 23:06:00 +0000430
431 /// findAbstractVariable - Find abstract variable associated with Var.
Devang Patel26c1e562010-05-20 16:36:41 +0000432 DbgVariable *findAbstractVariable(DIVariable &Var, DebugLoc Loc);
Devang Patel53bb5c92009-11-10 23:06:00 +0000433
Devang Patel2c4ceb12009-11-21 02:48:08 +0000434 /// updateSubprogramScopeDIE - Find DIE for the given subprogram and
435 /// attach appropriate DW_AT_low_pc and DW_AT_high_pc attributes.
436 /// If there are global variables in this scope then create and insert
437 /// DIEs for these variables.
Devang Patele9f8f5e2010-05-07 20:54:48 +0000438 DIE *updateSubprogramScopeDIE(const MDNode *SPNode);
Bill Wendling0310d762009-05-15 09:23:25 +0000439
Devang Patel2c4ceb12009-11-21 02:48:08 +0000440 /// constructLexicalScope - Construct new DW_TAG_lexical_block
441 /// for this scope and attach DW_AT_low_pc/DW_AT_high_pc labels.
442 DIE *constructLexicalScopeDIE(DbgScope *Scope);
Bill Wendling0310d762009-05-15 09:23:25 +0000443
Devang Patel2c4ceb12009-11-21 02:48:08 +0000444 /// constructInlinedScopeDIE - This scope represents inlined body of
445 /// a function. Construct DIE to represent this concrete inlined copy
446 /// of the function.
447 DIE *constructInlinedScopeDIE(DbgScope *Scope);
448
449 /// constructVariableDIE - Construct a DIE for the given DbgVariable.
Devang Patel8a241142009-12-09 18:24:21 +0000450 DIE *constructVariableDIE(DbgVariable *DV, DbgScope *S);
Devang Patel2c4ceb12009-11-21 02:48:08 +0000451
452 /// constructScopeDIE - Construct a DIE for this scope.
453 DIE *constructScopeDIE(DbgScope *Scope);
454
Chris Lattnerfa070b02010-04-04 22:33:59 +0000455 /// EmitSectionLabels - Emit initial Dwarf sections with a label at
456 /// the start of each one.
457 void EmitSectionLabels();
Bill Wendling0310d762009-05-15 09:23:25 +0000458
Devang Patel2c4ceb12009-11-21 02:48:08 +0000459 /// emitDIE - Recusively Emits a debug information entry.
Bill Wendling0310d762009-05-15 09:23:25 +0000460 ///
Devang Patel2c4ceb12009-11-21 02:48:08 +0000461 void emitDIE(DIE *Die);
Bill Wendling0310d762009-05-15 09:23:25 +0000462
Devang Patel2c4ceb12009-11-21 02:48:08 +0000463 /// computeSizeAndOffset - Compute the size and offset of a DIE.
Bill Wendling0310d762009-05-15 09:23:25 +0000464 ///
Devang Patel2c4ceb12009-11-21 02:48:08 +0000465 unsigned computeSizeAndOffset(DIE *Die, unsigned Offset, bool Last);
Bill Wendling0310d762009-05-15 09:23:25 +0000466
Devang Patel2c4ceb12009-11-21 02:48:08 +0000467 /// computeSizeAndOffsets - Compute the size and offset of all the DIEs.
Bill Wendling0310d762009-05-15 09:23:25 +0000468 ///
Devang Patel2c4ceb12009-11-21 02:48:08 +0000469 void computeSizeAndOffsets();
Bill Wendling0310d762009-05-15 09:23:25 +0000470
Devang Patel8a241142009-12-09 18:24:21 +0000471 /// EmitDebugInfo - Emit the debug info section.
Bill Wendling0310d762009-05-15 09:23:25 +0000472 ///
Devang Patel2c4ceb12009-11-21 02:48:08 +0000473 void emitDebugInfo();
Bill Wendling0310d762009-05-15 09:23:25 +0000474
Devang Patel2c4ceb12009-11-21 02:48:08 +0000475 /// emitAbbreviations - Emit the abbreviation section.
Bill Wendling0310d762009-05-15 09:23:25 +0000476 ///
Devang Patel2c4ceb12009-11-21 02:48:08 +0000477 void emitAbbreviations() const;
Bill Wendling0310d762009-05-15 09:23:25 +0000478
Devang Patel2c4ceb12009-11-21 02:48:08 +0000479 /// emitEndOfLineMatrix - Emit the last address of the section and the end of
Bill Wendling0310d762009-05-15 09:23:25 +0000480 /// the line matrix.
481 ///
Devang Patel2c4ceb12009-11-21 02:48:08 +0000482 void emitEndOfLineMatrix(unsigned SectionEnd);
Bill Wendling0310d762009-05-15 09:23:25 +0000483
Devang Patel2c4ceb12009-11-21 02:48:08 +0000484 /// emitDebugLines - Emit source line information.
Bill Wendling0310d762009-05-15 09:23:25 +0000485 ///
Devang Patel2c4ceb12009-11-21 02:48:08 +0000486 void emitDebugLines();
Bill Wendling0310d762009-05-15 09:23:25 +0000487
Devang Patel2c4ceb12009-11-21 02:48:08 +0000488 /// emitCommonDebugFrame - Emit common frame info into a debug frame section.
Bill Wendling0310d762009-05-15 09:23:25 +0000489 ///
Devang Patel2c4ceb12009-11-21 02:48:08 +0000490 void emitCommonDebugFrame();
Bill Wendling0310d762009-05-15 09:23:25 +0000491
Devang Patel2c4ceb12009-11-21 02:48:08 +0000492 /// emitFunctionDebugFrame - Emit per function frame info into a debug frame
Bill Wendling0310d762009-05-15 09:23:25 +0000493 /// section.
Devang Patel2c4ceb12009-11-21 02:48:08 +0000494 void emitFunctionDebugFrame(const FunctionDebugFrameInfo &DebugFrameInfo);
Bill Wendling0310d762009-05-15 09:23:25 +0000495
Devang Patel2c4ceb12009-11-21 02:48:08 +0000496 /// emitDebugPubNames - Emit visible names into a debug pubnames section.
Bill Wendling0310d762009-05-15 09:23:25 +0000497 ///
Devang Patel2c4ceb12009-11-21 02:48:08 +0000498 void emitDebugPubNames();
Bill Wendling0310d762009-05-15 09:23:25 +0000499
Devang Patel193f7202009-11-24 01:14:22 +0000500 /// emitDebugPubTypes - Emit visible types into a debug pubtypes section.
501 ///
502 void emitDebugPubTypes();
503
Devang Patel2c4ceb12009-11-21 02:48:08 +0000504 /// emitDebugStr - Emit visible names into a debug str section.
Bill Wendling0310d762009-05-15 09:23:25 +0000505 ///
Devang Patel2c4ceb12009-11-21 02:48:08 +0000506 void emitDebugStr();
Bill Wendling0310d762009-05-15 09:23:25 +0000507
Devang Patel2c4ceb12009-11-21 02:48:08 +0000508 /// emitDebugLoc - Emit visible names into a debug loc section.
Bill Wendling0310d762009-05-15 09:23:25 +0000509 ///
Devang Patel2c4ceb12009-11-21 02:48:08 +0000510 void emitDebugLoc();
Bill Wendling0310d762009-05-15 09:23:25 +0000511
512 /// EmitDebugARanges - Emit visible names into a debug aranges section.
513 ///
514 void EmitDebugARanges();
515
Devang Patel2c4ceb12009-11-21 02:48:08 +0000516 /// emitDebugRanges - Emit visible names into a debug ranges section.
Bill Wendling0310d762009-05-15 09:23:25 +0000517 ///
Devang Patel2c4ceb12009-11-21 02:48:08 +0000518 void emitDebugRanges();
Bill Wendling0310d762009-05-15 09:23:25 +0000519
Devang Patel2c4ceb12009-11-21 02:48:08 +0000520 /// emitDebugMacInfo - Emit visible names into a debug macinfo section.
Bill Wendling0310d762009-05-15 09:23:25 +0000521 ///
Devang Patel2c4ceb12009-11-21 02:48:08 +0000522 void emitDebugMacInfo();
Bill Wendling0310d762009-05-15 09:23:25 +0000523
Devang Patel2c4ceb12009-11-21 02:48:08 +0000524 /// emitDebugInlineInfo - Emit inline info using following format.
Bill Wendling0310d762009-05-15 09:23:25 +0000525 /// Section Header:
526 /// 1. length of section
527 /// 2. Dwarf version number
528 /// 3. address size.
529 ///
530 /// Entries (one "entry" for each function that was inlined):
531 ///
532 /// 1. offset into __debug_str section for MIPS linkage name, if exists;
533 /// otherwise offset into __debug_str for regular function name.
534 /// 2. offset into __debug_str section for regular function name.
535 /// 3. an unsigned LEB128 number indicating the number of distinct inlining
536 /// instances for the function.
537 ///
538 /// The rest of the entry consists of a {die_offset, low_pc} pair for each
539 /// inlined instance; the die_offset points to the inlined_subroutine die in
540 /// the __debug_info section, and the low_pc is the starting address for the
541 /// inlining instance.
Devang Patel2c4ceb12009-11-21 02:48:08 +0000542 void emitDebugInlineInfo();
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000543
544 /// GetOrCreateSourceID - Look up the source id with the given directory and
545 /// source file names. If none currently exists, create a new id and insert it
Chris Lattner75f50722010-04-04 07:48:20 +0000546 /// in the SourceIds map. This can update DirectoryNames and SourceFileNames
547 /// maps as well.
Devang Patel65dbc902009-11-25 17:36:49 +0000548 unsigned GetOrCreateSourceID(StringRef DirName, StringRef FileName);
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000549
Devang Patel163a9f72010-05-10 22:49:55 +0000550 /// constructCompileUnit - Create new CompileUnit for the given
551 /// metadata node with tag DW_TAG_compile_unit.
Devang Patele9f8f5e2010-05-07 20:54:48 +0000552 void constructCompileUnit(const MDNode *N);
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000553
Devang Patel163a9f72010-05-10 22:49:55 +0000554 /// getCompielUnit - Get CompileUnit DIE.
555 CompileUnit *getCompileUnit(const MDNode *N) const;
556
557 /// constructGlobalVariableDIE - Construct global variable DIE.
Devang Patele9f8f5e2010-05-07 20:54:48 +0000558 void constructGlobalVariableDIE(const MDNode *N);
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000559
Devang Patel163a9f72010-05-10 22:49:55 +0000560 /// construct SubprogramDIE - Construct subprogram DIE.
Devang Patele9f8f5e2010-05-07 20:54:48 +0000561 void constructSubprogramDIE(const MDNode *N);
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000562
Chris Lattner2b1b3312010-04-05 05:32:45 +0000563 /// recordSourceLine - Register a source line with debug info. Returns the
564 /// unique label that was emitted and which provides correspondence to
565 /// the source line list.
Devang Patele9f8f5e2010-05-07 20:54:48 +0000566 MCSymbol *recordSourceLine(unsigned Line, unsigned Col, const MDNode *Scope);
Chris Lattner2b1b3312010-04-05 05:32:45 +0000567
568 /// getSourceLineCount - Return the number of source lines in the debug
569 /// info.
570 unsigned getSourceLineCount() const {
571 return Lines.size();
572 }
573
Devang Patel26c1e562010-05-20 16:36:41 +0000574 /// recordVariableFrameIndex - Record a variable's index.
575 void recordVariableFrameIndex(const DbgVariable *V, int Index);
576
577 /// findVariableFrameIndex - Return true if frame index for the variable
578 /// is found. Update FI to hold value of the index.
579 bool findVariableFrameIndex(const DbgVariable *V, int *FI);
580
581 /// findVariableLabel - Find MCSymbol for the variable.
582 const MCSymbol *findVariableLabel(const DbgVariable *V);
583
Devang Patelee432862010-05-20 19:57:06 +0000584 /// findDbgScope - Find DbgScope for the debug loc attached with an
585 /// instruction.
586 DbgScope *findDbgScope(const MachineInstr *MI);
587
Devang Patele37b0c62010-04-08 18:43:56 +0000588 /// identifyScopeMarkers() - Indentify instructions that are marking
589 /// beginning of or end of a scope.
590 void identifyScopeMarkers();
Devang Patel6122a4d2010-04-08 15:37:09 +0000591
Chris Lattner2b1b3312010-04-05 05:32:45 +0000592 /// extractScopeInformation - Scan machine instructions in this function
593 /// and collect DbgScopes. Return true, if atleast one scope was found.
594 bool extractScopeInformation();
595
596 /// collectVariableInfo - Populate DbgScope entries with variables' info.
Devang Patel78e127d2010-06-25 22:07:34 +0000597 void collectVariableInfo(const MachineFunction *,
598 SmallPtrSet<const MDNode *, 16> &ProcessedVars);
Chris Lattner2b1b3312010-04-05 05:32:45 +0000599
Devang Patelee432862010-05-20 19:57:06 +0000600 /// collectVariableInfoFromMMITable - Collect variable information from
601 /// side table maintained by MMI.
602 void collectVariableInfoFromMMITable(const MachineFunction * MF,
603 SmallPtrSet<const MDNode *, 16> &P);
Bill Wendling0310d762009-05-15 09:23:25 +0000604public:
605 //===--------------------------------------------------------------------===//
606 // Main entry points.
607 //
Chris Lattner49cd6642010-04-05 05:11:15 +0000608 DwarfDebug(AsmPrinter *A, Module *M);
Chris Lattner2b1b3312010-04-05 05:32:45 +0000609 ~DwarfDebug();
Bill Wendling0310d762009-05-15 09:23:25 +0000610
Devang Patel2c4ceb12009-11-21 02:48:08 +0000611 /// beginModule - Emit all Dwarf sections that should come prior to the
Bill Wendling0310d762009-05-15 09:23:25 +0000612 /// content.
Chris Lattner75f50722010-04-04 07:48:20 +0000613 void beginModule(Module *M);
Bill Wendling0310d762009-05-15 09:23:25 +0000614
Devang Patel2c4ceb12009-11-21 02:48:08 +0000615 /// endModule - Emit all Dwarf sections that should come after the content.
Bill Wendling0310d762009-05-15 09:23:25 +0000616 ///
Devang Patel2c4ceb12009-11-21 02:48:08 +0000617 void endModule();
Bill Wendling0310d762009-05-15 09:23:25 +0000618
Devang Patel2c4ceb12009-11-21 02:48:08 +0000619 /// beginFunction - Gather pre-function debug information. Assumes being
Bill Wendling0310d762009-05-15 09:23:25 +0000620 /// emitted immediately after the function entry point.
Chris Lattnereec791a2010-01-26 23:18:02 +0000621 void beginFunction(const MachineFunction *MF);
Bill Wendling0310d762009-05-15 09:23:25 +0000622
Devang Patel2c4ceb12009-11-21 02:48:08 +0000623 /// endFunction - Gather and emit post-function debug information.
Bill Wendling0310d762009-05-15 09:23:25 +0000624 ///
Chris Lattnereec791a2010-01-26 23:18:02 +0000625 void endFunction(const MachineFunction *MF);
Bill Wendling0310d762009-05-15 09:23:25 +0000626
Devang Patelc3f5f782010-05-25 23:40:22 +0000627 /// getLabelBeforeInsn - Return Label preceding the instruction.
628 const MCSymbol *getLabelBeforeInsn(const MachineInstr *MI);
629
630 /// getLabelAfterInsn - Return Label immediately following the instruction.
631 const MCSymbol *getLabelAfterInsn(const MachineInstr *MI);
632
Devang Patel553881b2010-03-29 17:20:31 +0000633 /// beginScope - Process beginning of a scope.
634 void beginScope(const MachineInstr *MI);
Bill Wendling0310d762009-05-15 09:23:25 +0000635
Devang Patel2c4ceb12009-11-21 02:48:08 +0000636 /// endScope - Prcess end of a scope.
637 void endScope(const MachineInstr *MI);
Devang Patel53bb5c92009-11-10 23:06:00 +0000638};
Bill Wendling0310d762009-05-15 09:23:25 +0000639} // End of namespace llvm
640
641#endif