1 //===-- llvm/CodeGen/DwarfWriter.h - Dwarf Framework ------------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file was developed by James M. Laskey and is distributed under the
6 // University of Illinois Open Source License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file contains support for writing Dwarf debug info into asm files. For
11 // Details on the Dwarf 3 specfication see DWARF Debugging Information Format
12 // V.3 reference manual http://dwarf.freestandards.org ,
14 // The role of the Dwarf Writer class is to extract debug information from the
15 // MachineDebugInfo object, organize it in Dwarf form and then emit it into asm
16 // the current asm file using data and high level Dwarf directives.
18 //===----------------------------------------------------------------------===//
20 #ifndef LLVM_CODEGEN_DWARFWRITER_H
21 #define LLVM_CODEGEN_DWARFWRITER_H
23 #include "llvm/ADT/UniqueVector.h"
24 #include "llvm/Support/DataTypes.h"
32 // Forward declarations.
36 class CompileUnitDesc;
42 class GlobalVariableDesc;
43 class MachineDebugInfo;
44 class MachineFunction;
50 //===----------------------------------------------------------------------===//
51 // DWLabel - Labels are used to track locations in the assembler file.
52 // Labels appear in the form <prefix>debug_<Tag><Number>, where the tag is a
53 // category of label (Ex. location) and number is a value unique in that
57 const char *Tag; // Label category tag. Should always be
58 // a staticly declared C string.
59 unsigned Number; // Unique number.
61 DWLabel(const char *T, unsigned N) : Tag(T), Number(N) {}
64 //===----------------------------------------------------------------------===//
65 // DwarfWriter - Emits Dwarf debug and exception handling directives.
70 //===--------------------------------------------------------------------===//
71 // Core attributes used by the Dwarf writer.
75 /// O - Stream to .s file.
79 /// Asm - Target of Dwarf emission.
83 /// M - Current module.
87 /// MF - Current machine function.
91 /// DebugInfo - Collected debug information.
93 MachineDebugInfo *DebugInfo;
95 /// didInitial - Flag to indicate if initial emission has been done.
99 /// SubprogramCount - The running count of functions being compiled.
101 unsigned SubprogramCount;
103 //===--------------------------------------------------------------------===//
104 // Attributes used to construct specific Dwarf sections.
107 /// CompileUnits - All the compile units involved in this build. The index
108 /// of each entry in this vector corresponds to the sources in DebugInfo.
109 std::vector<CompileUnit *> CompileUnits;
111 /// Abbreviations - A UniqueVector of TAG structure abbreviations.
113 UniqueVector<DIEAbbrev> Abbreviations;
115 /// StringPool - A UniqueVector of strings used by indirect references.
116 /// UnitMap - Map debug information descriptor to compile unit.
118 UniqueVector<std::string> StringPool;
120 /// UnitMap - Map debug information descriptor to compile unit.
122 std::map<DebugInfoDesc *, CompileUnit *> DescToUnitMap;
124 /// DescToDieMap - Tracks the mapping of top level debug informaton
125 /// descriptors to debug information entries.
126 std::map<DebugInfoDesc *, DIE *> DescToDieMap;
128 /// TypeToDieMap - Type to DIEType map.
130 // FIXME - Should not be needed.
131 std::map<Type *, DIE *> TypeToDieMap;
133 //===--------------------------------------------------------------------===//
134 // Properties to be set by the derived class ctor, used to configure the
138 /// AddressSize - Size of addresses used in file.
140 unsigned AddressSize;
142 /// hasLEB128 - True if target asm supports leb128 directives.
144 bool hasLEB128; /// Defaults to false.
146 /// hasDotLoc - True if target asm supports .loc directives.
148 bool hasDotLoc; /// Defaults to false.
150 /// hasDotFile - True if target asm supports .file directives.
152 bool hasDotFile; /// Defaults to false.
154 /// needsSet - True if target asm can't compute addresses on data
156 bool needsSet; /// Defaults to false.
158 /// DwarfAbbrevSection - Section directive for Dwarf abbrev.
160 const char *DwarfAbbrevSection; /// Defaults to ".debug_abbrev".
162 /// DwarfInfoSection - Section directive for Dwarf info.
164 const char *DwarfInfoSection; /// Defaults to ".debug_info".
166 /// DwarfLineSection - Section directive for Dwarf info.
168 const char *DwarfLineSection; /// Defaults to ".debug_line".
170 /// DwarfFrameSection - Section directive for Dwarf info.
172 const char *DwarfFrameSection; /// Defaults to ".debug_frame".
174 /// DwarfPubNamesSection - Section directive for Dwarf info.
176 const char *DwarfPubNamesSection; /// Defaults to ".debug_pubnames".
178 /// DwarfPubTypesSection - Section directive for Dwarf info.
180 const char *DwarfPubTypesSection; /// Defaults to ".debug_pubtypes".
182 /// DwarfStrSection - Section directive for Dwarf info.
184 const char *DwarfStrSection; /// Defaults to ".debug_str".
186 /// DwarfLocSection - Section directive for Dwarf info.
188 const char *DwarfLocSection; /// Defaults to ".debug_loc".
190 /// DwarfARangesSection - Section directive for Dwarf info.
192 const char *DwarfARangesSection; /// Defaults to ".debug_aranges".
194 /// DwarfRangesSection - Section directive for Dwarf info.
196 const char *DwarfRangesSection; /// Defaults to ".debug_ranges".
198 /// DwarfMacInfoSection - Section directive for Dwarf info.
200 const char *DwarfMacInfoSection; /// Defaults to ".debug_macinfo".
202 /// TextSection - Section directive for standard text.
204 const char *TextSection; /// Defaults to ".text".
206 /// DataSection - Section directive for standard data.
208 const char *DataSection; /// Defaults to ".data".
210 //===--------------------------------------------------------------------===//
211 // Emission and print routines
215 /// getAddressSize - Return the size of a target address in bytes.
217 unsigned getAddressSize() const { return AddressSize; }
219 /// PrintHex - Print a value as a hexidecimal value.
221 void PrintHex(int Value) const;
223 /// EOL - Print a newline character to asm stream. If a comment is present
224 /// then it will be printed first. Comments should not contain '\n'.
225 void EOL(const std::string &Comment) const;
227 /// EmitAlign - Print a align directive.
229 void EmitAlign(unsigned Alignment) const;
231 /// EmitULEB128Bytes - Emit an assembler byte data directive to compose an
232 /// unsigned leb128 value.
233 void EmitULEB128Bytes(unsigned Value) const;
235 /// EmitSLEB128Bytes - print an assembler byte data directive to compose a
236 /// signed leb128 value.
237 void EmitSLEB128Bytes(int Value) const;
239 /// PrintULEB128 - Print a series of hexidecimal values (separated by
240 /// commas) representing an unsigned leb128 value.
241 void PrintULEB128(unsigned Value) const;
243 /// SizeULEB128 - Compute the number of bytes required for an unsigned
245 static unsigned SizeULEB128(unsigned Value);
247 /// PrintSLEB128 - Print a series of hexidecimal values (separated by
248 /// commas) representing a signed leb128 value.
249 void PrintSLEB128(int Value) const;
251 /// SizeSLEB128 - Compute the number of bytes required for a signed leb128
253 static unsigned SizeSLEB128(int Value);
255 /// EmitInt8 - Emit a byte directive and value.
257 void EmitInt8(int Value) const;
259 /// EmitInt16 - Emit a short directive and value.
261 void EmitInt16(int Value) const;
263 /// EmitInt32 - Emit a long directive and value.
265 void EmitInt32(int Value) const;
267 /// EmitInt64 - Emit a long long directive and value.
269 void EmitInt64(uint64_t Value) const;
271 /// EmitString - Emit a string with quotes and a null terminator.
272 /// Special characters are emitted properly. (Eg. '\t')
273 void EmitString(const std::string &String) const;
275 /// PrintLabelName - Print label name in form used by Dwarf writer.
277 void PrintLabelName(DWLabel Label) const {
278 PrintLabelName(Label.Tag, Label.Number);
280 void PrintLabelName(const char *Tag, unsigned Number) const;
282 /// EmitLabel - Emit location label for internal use by Dwarf.
284 void EmitLabel(DWLabel Label) const {
285 EmitLabel(Label.Tag, Label.Number);
287 void EmitLabel(const char *Tag, unsigned Number) const;
289 /// EmitReference - Emit a reference to a label.
291 void EmitReference(DWLabel Label) const {
292 EmitReference(Label.Tag, Label.Number);
294 void EmitReference(const char *Tag, unsigned Number) const;
295 void EmitReference(const std::string &Name) const;
297 /// EmitDifference - Emit the difference between two labels. Some
298 /// assemblers do not behave with absolute expressions with data directives,
299 /// so there is an option (needsSet) to use an intermediary set expression.
300 void EmitDifference(DWLabel LabelHi, DWLabel LabelLo) const {
301 EmitDifference(LabelHi.Tag, LabelHi.Number, LabelLo.Tag, LabelLo.Number);
303 void EmitDifference(const char *TagHi, unsigned NumberHi,
304 const char *TagLo, unsigned NumberLo) const;
306 /// NewAbbreviation - Add the abbreviation to the Abbreviation vector.
308 unsigned NewAbbreviation(DIEAbbrev *Abbrev);
310 /// NewString - Add a string to the constant pool and returns a label.
312 DWLabel NewString(const std::string &String);
314 /// getDieMapSlotFor - Returns the debug information entry map slot for the
315 /// specified debug descriptor.
316 DIE *&getDieMapSlotFor(DebugInfoDesc *DD);
320 /// AddSourceLine - Add location information to specified debug information
322 void AddSourceLine(DIE *Die, CompileUnitDesc *File, unsigned Line);
324 /// NewType - Create a new type DIE.
326 DIE *NewType(DIE *Context, TypeDesc *TyDesc, CompileUnit *Unit);
328 /// NewCompileUnit - Create new compile unit and it's die.
330 CompileUnit *NewCompileUnit(CompileUnitDesc *UnitDesc, unsigned ID);
332 /// FindCompileUnit - Get the compile unit for the given descriptor.
334 CompileUnit *FindCompileUnit(CompileUnitDesc *UnitDesc);
336 /// NewGlobalVariable - Make a new global variable DIE.
338 DIE *NewGlobalVariable(GlobalVariableDesc *GVD);
340 /// NewSubprogram - Add a new subprogram DIE.
342 DIE *NewSubprogram(SubprogramDesc *SPD);
344 /// NewScopeVariable - Create a new scope variable.
346 DIE *NewScopeVariable(DebugVariable *DV, CompileUnit *Unit);
348 /// ConstructScope - Construct the components of a scope.
350 void ConstructScope(DebugScope *ParentScope, DIE *ParentDie,
353 /// ConstructRootScope - Construct the scope for the subprogram.
355 void ConstructRootScope(DebugScope *RootScope);
357 /// EmitInitial - Emit initial Dwarf declarations.
359 void EmitInitial() const;
361 /// EmitDIE - Recusively Emits a debug information entry.
363 void EmitDIE(DIE *Die) const;
365 /// SizeAndOffsetDie - Compute the size and offset of a DIE.
367 unsigned SizeAndOffsetDie(DIE *Die, unsigned Offset, bool Last);
369 /// SizeAndOffsets - Compute the size and offset of all the DIEs.
371 void SizeAndOffsets();
373 /// EmitDebugInfo - Emit the debug info section.
375 void EmitDebugInfo() const;
377 /// EmitAbbreviations - Emit the abbreviation section.
379 void EmitAbbreviations() const;
381 /// EmitDebugLines - Emit source line information.
383 void EmitDebugLines() const;
385 /// EmitDebugFrame - Emit info into a debug frame section.
387 void EmitDebugFrame();
389 /// EmitDebugPubNames - Emit info into a debug pubnames section.
391 void EmitDebugPubNames();
393 /// EmitDebugStr - Emit info into a debug str section.
397 /// EmitDebugLoc - Emit info into a debug loc section.
401 /// EmitDebugARanges - Emit info into a debug aranges section.
403 void EmitDebugARanges();
405 /// EmitDebugRanges - Emit info into a debug ranges section.
407 void EmitDebugRanges();
409 /// EmitDebugMacInfo - Emit info into a debug macinfo section.
411 void EmitDebugMacInfo();
413 /// ConstructCompileUnitDIEs - Create a compile unit DIE for each source and
415 void ConstructCompileUnitDIEs();
417 /// ConstructGlobalDIEs - Create DIEs for each of the externally visible
418 /// global variables.
419 void ConstructGlobalDIEs();
421 /// ConstructSubprogramDIEs - Create DIEs for each of the externally visible
423 void ConstructSubprogramDIEs();
425 /// ShouldEmitDwarf - Returns true if Dwarf declarations should be made.
426 /// When called it also checks to see if debug info is newly available. if
427 /// so the initial Dwarf headers are emitted.
428 bool ShouldEmitDwarf();
432 DwarfWriter(std::ostream &OS, AsmPrinter *A);
433 virtual ~DwarfWriter();
435 /// SetDebugInfo - Set DebugInfo when it's known that pass manager has
436 /// created it. Set by the target AsmPrinter.
437 void SetDebugInfo(MachineDebugInfo *DI) { DebugInfo = DI; }
439 //===--------------------------------------------------------------------===//
440 // Main entry points.
443 /// BeginModule - Emit all Dwarf sections that should come prior to the
445 void BeginModule(Module *M);
447 /// EndModule - Emit all Dwarf sections that should come after the content.
451 /// BeginFunction - Gather pre-function debug information.
453 void BeginFunction(MachineFunction *MF);
455 /// EndFunction - Gather and emit post-function debug information.
460 } // end llvm namespace