DwarfDebug.h revision 9174fd77e5e299fa3b1357a85ad82173217270b7
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
17#include "DIE.h"
18#include "llvm/ADT/DenseMap.h"
19#include "llvm/ADT/FoldingSet.h"
20#include "llvm/ADT/SetVector.h"
21#include "llvm/ADT/SmallPtrSet.h"
22#include "llvm/ADT/StringMap.h"
23#include "llvm/CodeGen/AsmPrinter.h"
24#include "llvm/CodeGen/LexicalScopes.h"
25#include "llvm/DebugInfo.h"
26#include "llvm/MC/MachineLocation.h"
27#include "llvm/Support/Allocator.h"
28#include "llvm/Support/DebugLoc.h"
29
30namespace llvm {
31
32class CompileUnit;
33class ConstantInt;
34class ConstantFP;
35class DbgVariable;
36class MachineFrameInfo;
37class MachineModuleInfo;
38class MachineOperand;
39class MCAsmInfo;
40class DIEAbbrev;
41class DIE;
42class DIEBlock;
43class DIEEntry;
44class DwarfDebug;
45
46//===----------------------------------------------------------------------===//
47/// \brief This class is used to record source line correspondence.
48class SrcLineInfo {
49  unsigned Line;                     // Source line number.
50  unsigned Column;                   // Source column.
51  unsigned SourceID;                 // Source ID number.
52  MCSymbol *Label;                   // Label in code ID number.
53public:
54  SrcLineInfo(unsigned L, unsigned C, unsigned S, MCSymbol *label)
55    : Line(L), Column(C), SourceID(S), Label(label) {}
56
57  // Accessors
58  unsigned getLine() const { return Line; }
59  unsigned getColumn() const { return Column; }
60  unsigned getSourceID() const { return SourceID; }
61  MCSymbol *getLabel() const { return Label; }
62};
63
64/// \brief This struct describes location entries emitted in the .debug_loc
65/// section.
66typedef struct DotDebugLocEntry {
67  const MCSymbol *Begin;
68  const MCSymbol *End;
69  MachineLocation Loc;
70  const MDNode *Variable;
71  bool Merged;
72  bool Constant;
73  enum EntryType {
74    E_Location,
75    E_Integer,
76    E_ConstantFP,
77    E_ConstantInt
78  };
79  enum EntryType EntryKind;
80
81  union {
82    int64_t Int;
83    const ConstantFP *CFP;
84    const ConstantInt *CIP;
85  } Constants;
86  DotDebugLocEntry()
87    : Begin(0), End(0), Variable(0), Merged(false),
88      Constant(false) { Constants.Int = 0;}
89  DotDebugLocEntry(const MCSymbol *B, const MCSymbol *E, MachineLocation &L,
90                   const MDNode *V)
91    : Begin(B), End(E), Loc(L), Variable(V), Merged(false),
92      Constant(false) { Constants.Int = 0; EntryKind = E_Location; }
93  DotDebugLocEntry(const MCSymbol *B, const MCSymbol *E, int64_t i)
94    : Begin(B), End(E), Variable(0), Merged(false),
95      Constant(true) { Constants.Int = i; EntryKind = E_Integer; }
96  DotDebugLocEntry(const MCSymbol *B, const MCSymbol *E, const ConstantFP *FPtr)
97    : Begin(B), End(E), Variable(0), Merged(false),
98      Constant(true) { Constants.CFP = FPtr; EntryKind = E_ConstantFP; }
99  DotDebugLocEntry(const MCSymbol *B, const MCSymbol *E,
100                   const ConstantInt *IPtr)
101    : Begin(B), End(E), Variable(0), Merged(false),
102      Constant(true) { Constants.CIP = IPtr; EntryKind = E_ConstantInt; }
103
104  /// \brief Empty entries are also used as a trigger to emit temp label. Such
105  /// labels are referenced is used to find debug_loc offset for a given DIE.
106  bool isEmpty() { return Begin == 0 && End == 0; }
107  bool isMerged() { return Merged; }
108  void Merge(DotDebugLocEntry *Next) {
109    if (!(Begin && Loc == Next->Loc && End == Next->Begin))
110      return;
111    Next->Begin = Begin;
112    Merged = true;
113  }
114  bool isLocation() const    { return EntryKind == E_Location; }
115  bool isInt() const         { return EntryKind == E_Integer; }
116  bool isConstantFP() const  { return EntryKind == E_ConstantFP; }
117  bool isConstantInt() const { return EntryKind == E_ConstantInt; }
118  int64_t getInt()                    { return Constants.Int; }
119  const ConstantFP *getConstantFP()   { return Constants.CFP; }
120  const ConstantInt *getConstantInt() { return Constants.CIP; }
121} DotDebugLocEntry;
122
123//===----------------------------------------------------------------------===//
124/// \brief This class is used to track local variable information.
125class DbgVariable {
126  DIVariable Var;                    // Variable Descriptor.
127  DIE *TheDIE;                       // Variable DIE.
128  unsigned DotDebugLocOffset;        // Offset in DotDebugLocEntries.
129  DbgVariable *AbsVar;               // Corresponding Abstract variable, if any.
130  const MachineInstr *MInsn;         // DBG_VALUE instruction of the variable.
131  int FrameIndex;
132public:
133  // AbsVar may be NULL.
134  DbgVariable(DIVariable V, DbgVariable *AV)
135    : Var(V), TheDIE(0), DotDebugLocOffset(~0U), AbsVar(AV), MInsn(0),
136      FrameIndex(~0) {}
137
138  // Accessors.
139  DIVariable getVariable()           const { return Var; }
140  void setDIE(DIE *D)                      { TheDIE = D; }
141  DIE *getDIE()                      const { return TheDIE; }
142  void setDotDebugLocOffset(unsigned O)    { DotDebugLocOffset = O; }
143  unsigned getDotDebugLocOffset()    const { return DotDebugLocOffset; }
144  StringRef getName()                const { return Var.getName(); }
145  DbgVariable *getAbstractVariable() const { return AbsVar; }
146  const MachineInstr *getMInsn()     const { return MInsn; }
147  void setMInsn(const MachineInstr *M)     { MInsn = M; }
148  int getFrameIndex()                const { return FrameIndex; }
149  void setFrameIndex(int FI)               { FrameIndex = FI; }
150  // Translate tag to proper Dwarf tag.
151  unsigned getTag()                  const {
152    if (Var.getTag() == dwarf::DW_TAG_arg_variable)
153      return dwarf::DW_TAG_formal_parameter;
154
155    return dwarf::DW_TAG_variable;
156  }
157  /// \brief Return true if DbgVariable is artificial.
158  bool isArtificial()                const {
159    if (Var.isArtificial())
160      return true;
161    if (getType().isArtificial())
162      return true;
163    return false;
164  }
165
166  bool isObjectPointer()             const {
167    if (Var.isObjectPointer())
168      return true;
169    if (getType().isObjectPointer())
170      return true;
171    return false;
172  }
173
174  bool variableHasComplexAddress()   const {
175    assert(Var.Verify() && "Invalid complex DbgVariable!");
176    return Var.hasComplexAddress();
177  }
178  bool isBlockByrefVariable()        const {
179    assert(Var.Verify() && "Invalid complex DbgVariable!");
180    return Var.isBlockByrefVariable();
181  }
182  unsigned getNumAddrElements()      const {
183    assert(Var.Verify() && "Invalid complex DbgVariable!");
184    return Var.getNumAddrElements();
185  }
186  uint64_t getAddrElement(unsigned i) const {
187    return Var.getAddrElement(i);
188  }
189  DIType getType() const;
190};
191
192
193// A String->Symbol mapping of strings used by indirect
194// references.
195typedef StringMap<std::pair<MCSymbol*, unsigned>,
196                  BumpPtrAllocator&> StrPool;
197
198// A Symbol->pair<Symbol, unsigned> mapping of addresses used by indirect
199// references.
200typedef DenseMap<MCSymbol *, std::pair<MCSymbol *, unsigned> > AddrPool;
201
202/// \brief Collects and handles information specific to a particular
203/// collection of units.
204class DwarfUnits {
205  // Target of Dwarf emission, used for sizing of abbreviations.
206  AsmPrinter *Asm;
207
208  // Used to uniquely define abbreviations.
209  FoldingSet<DIEAbbrev> *AbbreviationsSet;
210
211  // A list of all the unique abbreviations in use.
212  std::vector<DIEAbbrev *> *Abbreviations;
213
214  // A pointer to all units in the section.
215  SmallVector<CompileUnit *, 1> CUs;
216
217  // Collection of strings for this unit and assorted symbols.
218  StrPool StringPool;
219  unsigned NextStringPoolNumber;
220  std::string StringPref;
221
222  // Collection of addresses for this unit and assorted labels.
223  AddrPool AddressPool;
224  unsigned NextAddrPoolNumber;
225
226public:
227  DwarfUnits(AsmPrinter *AP, FoldingSet<DIEAbbrev> *AS,
228             std::vector<DIEAbbrev *> *A, const char *Pref,
229             BumpPtrAllocator &DA) :
230    Asm(AP), AbbreviationsSet(AS), Abbreviations(A),
231    StringPool(DA), NextStringPoolNumber(0), StringPref(Pref),
232    AddressPool(), NextAddrPoolNumber(0) {}
233
234  /// \brief Compute the size and offset of a DIE given an incoming Offset.
235  unsigned computeSizeAndOffset(DIE *Die, unsigned Offset);
236
237  /// \brief Compute the size and offset of all the DIEs.
238  void computeSizeAndOffsets();
239
240  /// \brief Define a unique number for the abbreviation.
241  void assignAbbrevNumber(DIEAbbrev &Abbrev);
242
243  /// \brief Add a unit to the list of CUs.
244  void addUnit(CompileUnit *CU) { CUs.push_back(CU); }
245
246  /// \brief Emit all of the units to the section listed with the given
247  /// abbreviation section.
248  void emitUnits(DwarfDebug *, const MCSection *, const MCSection *,
249                 const MCSymbol *);
250
251  /// \brief Emit all of the strings to the section given.
252  void emitStrings(const MCSection *, const MCSection *, const MCSymbol *);
253
254  /// \brief Emit all of the addresses to the section given.
255  void emitAddresses(const MCSection *);
256
257  /// \brief Returns the entry into the start of the pool.
258  MCSymbol *getStringPoolSym();
259
260  /// \brief Returns an entry into the string pool with the given
261  /// string text.
262  MCSymbol *getStringPoolEntry(StringRef Str);
263
264  /// \brief Returns the index into the string pool with the given
265  /// string text.
266  unsigned getStringPoolIndex(StringRef Str);
267
268  /// \brief Returns the string pool.
269  StrPool *getStringPool() { return &StringPool; }
270
271  /// \brief Returns the index into the address pool with the given
272  /// label/symbol.
273  unsigned getAddrPoolIndex(MCSymbol *);
274
275  /// \brief Returns the address pool.
276  AddrPool *getAddrPool() { return &AddressPool; }
277
278  /// \brief for a given compile unit DIE, returns offset from beginning of
279  /// debug info.
280  unsigned getCUOffset(DIE *Die);
281};
282
283/// \brief Collects and handles dwarf debug information.
284class DwarfDebug {
285  // Target of Dwarf emission.
286  AsmPrinter *Asm;
287
288  // Collected machine module information.
289  MachineModuleInfo *MMI;
290
291  // All DIEValues are allocated through this allocator.
292  BumpPtrAllocator DIEValueAllocator;
293
294  //===--------------------------------------------------------------------===//
295  // Attribute used to construct specific Dwarf sections.
296  //
297
298  CompileUnit *FirstCU;
299
300  // Maps MDNode with its corresponding CompileUnit.
301  DenseMap <const MDNode *, CompileUnit *> CUMap;
302
303  // Maps subprogram MDNode with its corresponding CompileUnit.
304  DenseMap <const MDNode *, CompileUnit *> SPMap;
305
306  // Used to uniquely define abbreviations.
307  FoldingSet<DIEAbbrev> AbbreviationsSet;
308
309  // A list of all the unique abbreviations in use.
310  std::vector<DIEAbbrev *> Abbreviations;
311
312  // Stores the current file ID for a given compile unit.
313  DenseMap <unsigned, unsigned> FileIDCUMap;
314  // Source id map, i.e. CUID, source filename and directory,
315  // separated by a zero byte, mapped to a unique id.
316  StringMap<unsigned, BumpPtrAllocator&> SourceIdMap;
317
318  // Provides a unique id per text section.
319  SetVector<const MCSection*> SectionMap;
320
321  // List of Arguments (DbgValues) for current function.
322  SmallVector<DbgVariable *, 8> CurrentFnArguments;
323
324  LexicalScopes LScopes;
325
326  // Collection of abstract subprogram DIEs.
327  DenseMap<const MDNode *, DIE *> AbstractSPDies;
328
329  // Collection of dbg variables of a scope.
330  DenseMap<LexicalScope *, SmallVector<DbgVariable *, 8> > ScopeVariables;
331
332  // Collection of abstract variables.
333  DenseMap<const MDNode *, DbgVariable *> AbstractVariables;
334
335  // Collection of DotDebugLocEntry.
336  SmallVector<DotDebugLocEntry, 4> DotDebugLocEntries;
337
338  // Collection of subprogram DIEs that are marked (at the end of the module)
339  // as DW_AT_inline.
340  SmallPtrSet<DIE *, 4> InlinedSubprogramDIEs;
341
342  // Keep track of inlined functions and their location.  This
343  // information is used to populate the debug_inlined section.
344  typedef std::pair<const MCSymbol *, DIE *> InlineInfoLabels;
345  DenseMap<const MDNode *, SmallVector<InlineInfoLabels, 4> > InlineInfo;
346  SmallVector<const MDNode *, 4> InlinedSPNodes;
347
348  // This is a collection of subprogram MDNodes that are processed to
349  // create DIEs.
350  SmallPtrSet<const MDNode *, 16> ProcessedSPNodes;
351
352  // Maps instruction with label emitted before instruction.
353  DenseMap<const MachineInstr *, MCSymbol *> LabelsBeforeInsn;
354
355  // Maps instruction with label emitted after instruction.
356  DenseMap<const MachineInstr *, MCSymbol *> LabelsAfterInsn;
357
358  // Every user variable mentioned by a DBG_VALUE instruction in order of
359  // appearance.
360  SmallVector<const MDNode*, 8> UserVariables;
361
362  // For each user variable, keep a list of DBG_VALUE instructions in order.
363  // The list can also contain normal instructions that clobber the previous
364  // DBG_VALUE.
365  typedef DenseMap<const MDNode*, SmallVector<const MachineInstr*, 4> >
366    DbgValueHistoryMap;
367  DbgValueHistoryMap DbgValues;
368
369  SmallVector<const MCSymbol *, 8> DebugRangeSymbols;
370
371  // Previous instruction's location information. This is used to determine
372  // label location to indicate scope boundries in dwarf debug info.
373  DebugLoc PrevInstLoc;
374  MCSymbol *PrevLabel;
375
376  // This location indicates end of function prologue and beginning of function
377  // body.
378  DebugLoc PrologEndLoc;
379
380  // Section Symbols: these are assembler temporary labels that are emitted at
381  // the beginning of each supported dwarf section.  These are used to form
382  // section offsets and are created by EmitSectionLabels.
383  MCSymbol *DwarfInfoSectionSym, *DwarfAbbrevSectionSym;
384  MCSymbol *DwarfStrSectionSym, *TextSectionSym, *DwarfDebugRangeSectionSym;
385  MCSymbol *DwarfDebugLocSectionSym, *DwarfLineSectionSym, *DwarfAddrSectionSym;
386  MCSymbol *FunctionBeginSym, *FunctionEndSym;
387  MCSymbol *DwarfAbbrevDWOSectionSym, *DwarfStrDWOSectionSym;
388
389  // As an optimization, there is no need to emit an entry in the directory
390  // table for the same directory as DW_at_comp_dir.
391  StringRef CompilationDir;
392
393  // Counter for assigning globally unique IDs for CUs.
394  unsigned GlobalCUIndexCount;
395
396  // Holder for the file specific debug information.
397  DwarfUnits InfoHolder;
398
399  // Holders for the various debug information flags that we might need to
400  // have exposed. See accessor functions below for description.
401
402  // Whether or not we're emitting info for older versions of gdb on darwin.
403  bool IsDarwinGDBCompat;
404
405  // Whether or not we use ref_addr in the generated DWARF.
406  unsigned UseRefAddr;
407
408  // DWARF5 Experimental Options
409  bool HasDwarfAccelTables;
410  bool HasSplitDwarf;
411
412  // Separated Dwarf Variables
413  // In general these will all be for bits that are left in the
414  // original object file, rather than things that are meant
415  // to be in the .dwo sections.
416
417  // The CUs left in the original object file for separated debug info.
418  SmallVector<CompileUnit *, 1> SkeletonCUs;
419
420  // Used to uniquely define abbreviations for the skeleton emission.
421  FoldingSet<DIEAbbrev> SkeletonAbbrevSet;
422
423  // A list of all the unique abbreviations in use.
424  std::vector<DIEAbbrev *> SkeletonAbbrevs;
425
426  // Holder for the skeleton information.
427  DwarfUnits SkeletonHolder;
428
429  typedef SmallVector<std::pair<const MDNode *, const MDNode *>, 32>
430    ImportedEntityMap;
431  ImportedEntityMap ScopesWithImportedEntities;
432
433private:
434
435  void addScopeVariable(LexicalScope *LS, DbgVariable *Var);
436
437  /// \brief Find abstract variable associated with Var.
438  DbgVariable *findAbstractVariable(DIVariable &Var, DebugLoc Loc);
439
440  /// \brief Find DIE for the given subprogram and attach appropriate
441  /// DW_AT_low_pc and DW_AT_high_pc attributes. If there are global
442  /// variables in this scope then create and insert DIEs for these
443  /// variables.
444  DIE *updateSubprogramScopeDIE(CompileUnit *SPCU, const MDNode *SPNode);
445
446  /// \brief Construct new DW_TAG_lexical_block for this scope and
447  /// attach DW_AT_low_pc/DW_AT_high_pc labels.
448  DIE *constructLexicalScopeDIE(CompileUnit *TheCU, LexicalScope *Scope);
449
450  /// \brief This scope represents inlined body of a function. Construct
451  /// DIE to represent this concrete inlined copy of the function.
452  DIE *constructInlinedScopeDIE(CompileUnit *TheCU, LexicalScope *Scope);
453
454  /// \brief Construct a DIE for this scope.
455  DIE *constructScopeDIE(CompileUnit *TheCU, LexicalScope *Scope);
456
457  /// \brief Emit initial Dwarf sections with a label at the start of each one.
458  void emitSectionLabels();
459
460  /// \brief Compute the size and offset of a DIE given an incoming Offset.
461  unsigned computeSizeAndOffset(DIE *Die, unsigned Offset);
462
463  /// \brief Compute the size and offset of all the DIEs.
464  void computeSizeAndOffsets();
465
466  /// \brief Attach DW_AT_inline attribute with inlined subprogram DIEs.
467  void computeInlinedDIEs();
468
469  /// \brief Collect info for variables that were optimized out.
470  void collectDeadVariables();
471
472  /// \brief Finish off debug information after all functions have been
473  /// processed.
474  void finalizeModuleInfo();
475
476  /// \brief Emit labels to close any remaining sections that have been left
477  /// open.
478  void endSections();
479
480  /// \brief Emit a set of abbreviations to the specific section.
481  void emitAbbrevs(const MCSection *, std::vector<DIEAbbrev*> *);
482
483  /// \brief Emit the debug info section.
484  void emitDebugInfo();
485
486  /// \brief Emit the abbreviation section.
487  void emitAbbreviations();
488
489  /// \brief Emit the last address of the section and the end of
490  /// the line matrix.
491  void emitEndOfLineMatrix(unsigned SectionEnd);
492
493  /// \brief Emit visible names into a hashed accelerator table section.
494  void emitAccelNames();
495
496  /// \brief Emit objective C classes and categories into a hashed
497  /// accelerator table section.
498  void emitAccelObjC();
499
500  /// \brief Emit namespace dies into a hashed accelerator table.
501  void emitAccelNamespaces();
502
503  /// \brief Emit type dies into a hashed accelerator table.
504  void emitAccelTypes();
505
506  /// \brief Emit visible names into a debug pubnames section.
507  void emitDebugPubnames();
508
509  /// \brief Emit visible types into a debug pubtypes section.
510  void emitDebugPubTypes();
511
512  /// \brief Emit visible names into a debug str section.
513  void emitDebugStr();
514
515  /// \brief Emit visible names into a debug loc section.
516  void emitDebugLoc();
517
518  /// \brief Emit visible names into a debug aranges section.
519  void emitDebugARanges();
520
521  /// \brief Emit visible names into a debug ranges section.
522  void emitDebugRanges();
523
524  /// \brief Emit visible names into a debug macinfo section.
525  void emitDebugMacInfo();
526
527  /// \brief Emit inline info using custom format.
528  void emitDebugInlineInfo();
529
530  /// DWARF 5 Experimental Split Dwarf Emitters
531
532  /// \brief Construct the split debug info compile unit for the debug info
533  /// section.
534  CompileUnit *constructSkeletonCU(const MDNode *);
535
536  /// \brief Emit the local split abbreviations.
537  void emitSkeletonAbbrevs(const MCSection *);
538
539  /// \brief Emit the debug info dwo section.
540  void emitDebugInfoDWO();
541
542  /// \brief Emit the debug abbrev dwo section.
543  void emitDebugAbbrevDWO();
544
545  /// \brief Emit the debug str dwo section.
546  void emitDebugStrDWO();
547
548  /// \brief Create new CompileUnit for the given metadata node with tag
549  /// DW_TAG_compile_unit.
550  CompileUnit *constructCompileUnit(const MDNode *N);
551
552  /// \brief Construct subprogram DIE.
553  void constructSubprogramDIE(CompileUnit *TheCU, const MDNode *N);
554
555  /// \brief Construct imported_module or imported_declaration DIE.
556  void constructImportedEntityDIE(CompileUnit *TheCU, const MDNode *N);
557
558  /// \brief Construct import_module DIE.
559  void constructImportedEntityDIE(CompileUnit *TheCU, const MDNode *N,
560                                  DIE *Context);
561
562  /// \brief Construct import_module DIE.
563  void constructImportedEntityDIE(CompileUnit *TheCU,
564                                  const DIImportedEntity &Module,
565                                  DIE *Context);
566
567  /// \brief Register a source line with debug info. Returns the unique
568  /// label that was emitted and which provides correspondence to the
569  /// source line list.
570  void recordSourceLine(unsigned Line, unsigned Col, const MDNode *Scope,
571                        unsigned Flags);
572
573  /// \brief Indentify instructions that are marking the beginning of or
574  /// ending of a scope.
575  void identifyScopeMarkers();
576
577  /// \brief If Var is an current function argument that add it in
578  /// CurrentFnArguments list.
579  bool addCurrentFnArgument(const MachineFunction *MF,
580                            DbgVariable *Var, LexicalScope *Scope);
581
582  /// \brief Populate LexicalScope entries with variables' info.
583  void collectVariableInfo(const MachineFunction *,
584                           SmallPtrSet<const MDNode *, 16> &ProcessedVars);
585
586  /// \brief Collect variable information from the side table maintained
587  /// by MMI.
588  void collectVariableInfoFromMMITable(const MachineFunction * MF,
589                                       SmallPtrSet<const MDNode *, 16> &P);
590
591  /// \brief Ensure that a label will be emitted before MI.
592  void requestLabelBeforeInsn(const MachineInstr *MI) {
593    LabelsBeforeInsn.insert(std::make_pair(MI, (MCSymbol*)0));
594  }
595
596  /// \brief Return Label preceding the instruction.
597  MCSymbol *getLabelBeforeInsn(const MachineInstr *MI);
598
599  /// \brief Ensure that a label will be emitted after MI.
600  void requestLabelAfterInsn(const MachineInstr *MI) {
601    LabelsAfterInsn.insert(std::make_pair(MI, (MCSymbol*)0));
602  }
603
604  /// \brief Return Label immediately following the instruction.
605  MCSymbol *getLabelAfterInsn(const MachineInstr *MI);
606
607  /// \brief Search all compile units to find the SP DIE for the given MDNode.
608  DIE *findSPDieInAllCUs(const MDNode *N);
609
610public:
611  //===--------------------------------------------------------------------===//
612  // Main entry points.
613  //
614  DwarfDebug(AsmPrinter *A, Module *M);
615  ~DwarfDebug();
616
617  /// \brief Emit all Dwarf sections that should come prior to the
618  /// content.
619  void beginModule();
620
621  /// \brief Emit all Dwarf sections that should come after the content.
622  void endModule();
623
624  /// \brief Gather pre-function debug information.
625  void beginFunction(const MachineFunction *MF);
626
627  /// \brief Gather and emit post-function debug information.
628  void endFunction(const MachineFunction *MF);
629
630  /// \brief Process beginning of an instruction.
631  void beginInstruction(const MachineInstr *MI);
632
633  /// \brief Process end of an instruction.
634  void endInstruction(const MachineInstr *MI);
635
636  /// \brief Look up the source id with the given directory and source file
637  /// names. If none currently exists, create a new id and insert it in the
638  /// SourceIds map.
639  unsigned getOrCreateSourceID(StringRef DirName, StringRef FullName,
640                               unsigned CUID);
641
642  /// \brief Recursively Emits a debug information entry.
643  void emitDIE(DIE *Die, std::vector<DIEAbbrev *> *Abbrevs);
644
645  /// \brief Returns whether or not to limit some of our debug
646  /// output to the limitations of darwin gdb.
647  bool useDarwinGDBCompat() { return IsDarwinGDBCompat; }
648
649  bool getUseRefAddr() { return UseRefAddr; }
650  void setUseRefAddr(bool RefAddr) { UseRefAddr = RefAddr; }
651
652  // Experimental DWARF5 features.
653
654  /// \brief Returns whether or not to emit tables that dwarf consumers can
655  /// use to accelerate lookup.
656  bool useDwarfAccelTables() { return HasDwarfAccelTables; }
657
658  /// \brief Returns whether or not to change the current debug info for the
659  /// split dwarf proposal support.
660  bool useSplitDwarf() { return HasSplitDwarf; }
661};
662} // End of namespace llvm
663
664#endif
665