blob: b2e16074f51dec491645a3e1e315db5e5c80f59a [file] [log] [blame]
Bill Wendling2f921f82009-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
David Blaikie85f80d72014-04-23 18:54:00 +000017#include "DwarfFile.h"
Timur Iskhodzhanov1cd14442013-12-03 15:10:23 +000018#include "AsmPrinterHandler.h"
Bill Wendlinge38859d2012-06-28 00:05:13 +000019#include "DIE.h"
Alexey Samsonov414b6fb2014-04-30 21:34:11 +000020#include "DbgValueHistoryCalculator.h"
David Blaikie1275e4f2014-04-01 21:49:04 +000021#include "DebugLocEntry.h"
David Blaikie0a456de2014-04-02 01:43:18 +000022#include "DebugLocList.h"
David Blaikie2406a0622014-04-23 23:37:35 +000023#include "DwarfAccelTable.h"
Devang Patel018b29b2010-01-19 06:19:05 +000024#include "llvm/ADT/DenseMap.h"
Eric Christopheracbe42b2014-03-18 20:58:35 +000025#include "llvm/ADT/MapVector.h"
26#include "llvm/ADT/SmallPtrSet.h"
27#include "llvm/ADT/StringMap.h"
Bill Wendling2f921f82009-05-15 09:23:25 +000028#include "llvm/ADT/FoldingSet.h"
Chandler Carruth802d7552012-12-04 07:12:27 +000029#include "llvm/CodeGen/LexicalScopes.h"
Chandler Carruth9a4c9e52014-03-06 00:46:21 +000030#include "llvm/IR/DebugInfo.h"
Eric Christopheracbe42b2014-03-18 20:58:35 +000031#include "llvm/IR/DebugLoc.h"
Chandler Carruth802d7552012-12-04 07:12:27 +000032#include "llvm/MC/MachineLocation.h"
David Blaikie4a2f95f2014-03-18 01:17:26 +000033#include "llvm/MC/MCDwarf.h"
Chris Lattner3f3fb972010-04-05 05:24:55 +000034#include "llvm/Support/Allocator.h"
Bill Wendling2f921f82009-05-15 09:23:25 +000035
David Blaikief9b6a552014-04-22 22:39:41 +000036#include <memory>
37
Bill Wendling2f921f82009-05-15 09:23:25 +000038namespace llvm {
39
Adrian Prantl702bf5a2014-03-18 02:34:52 +000040class AsmPrinter;
Eric Christopher29e874d2014-03-07 22:40:37 +000041class ByteStreamer;
Chris Lattner88fce102012-01-26 20:44:57 +000042class ConstantInt;
43class ConstantFP;
Eric Christopherce4a9442014-03-18 20:37:10 +000044class DwarfCompileUnit;
45class DwarfDebug;
46class DwarfTypeUnit;
47class DwarfUnit;
Bill Wendling2f921f82009-05-15 09:23:25 +000048class MachineModuleInfo;
Bill Wendling2f921f82009-05-15 09:23:25 +000049
50//===----------------------------------------------------------------------===//
Eric Christopheracdcbdb2012-11-27 22:43:45 +000051/// \brief This class is used to record source line correspondence.
Benjamin Kramer079b96e2013-09-11 18:05:11 +000052class SrcLineInfo {
Eric Christophera5a79422013-12-09 23:32:48 +000053 unsigned Line; // Source line number.
54 unsigned Column; // Source column.
55 unsigned SourceID; // Source ID number.
56 MCSymbol *Label; // Label in code ID number.
Bill Wendling2f921f82009-05-15 09:23:25 +000057public:
Chris Lattnerb4666f42010-03-14 08:15:55 +000058 SrcLineInfo(unsigned L, unsigned C, unsigned S, MCSymbol *label)
Eric Christophera5a79422013-12-09 23:32:48 +000059 : Line(L), Column(C), SourceID(S), Label(label) {}
Bill Wendling2f921f82009-05-15 09:23:25 +000060
61 // Accessors
62 unsigned getLine() const { return Line; }
63 unsigned getColumn() const { return Column; }
64 unsigned getSourceID() const { return SourceID; }
Chris Lattnerb4666f42010-03-14 08:15:55 +000065 MCSymbol *getLabel() const { return Label; }
Bill Wendling2f921f82009-05-15 09:23:25 +000066};
67
Devang Patelf20c4f72011-04-12 22:53:02 +000068//===----------------------------------------------------------------------===//
Eric Christopheracdcbdb2012-11-27 22:43:45 +000069/// \brief This class is used to track local variable information.
Benjamin Kramer079b96e2013-09-11 18:05:11 +000070class DbgVariable {
Eric Christophera5a79422013-12-09 23:32:48 +000071 DIVariable Var; // Variable Descriptor.
72 DIE *TheDIE; // Variable DIE.
73 unsigned DotDebugLocOffset; // Offset in DotDebugLocEntries.
74 DbgVariable *AbsVar; // Corresponding Abstract variable, if any.
75 const MachineInstr *MInsn; // DBG_VALUE instruction of the variable.
Devang Patel3e4a9652011-08-15 21:24:36 +000076 int FrameIndex;
Manman Renb3388602013-10-05 01:43:03 +000077 DwarfDebug *DD;
Eric Christophera5a79422013-12-09 23:32:48 +000078
Devang Patelf20c4f72011-04-12 22:53:02 +000079public:
80 // AbsVar may be NULL.
Manman Renb3388602013-10-05 01:43:03 +000081 DbgVariable(DIVariable V, DbgVariable *AV, DwarfDebug *DD)
Craig Toppere73658d2014-04-28 04:05:08 +000082 : Var(V), TheDIE(nullptr), DotDebugLocOffset(~0U), AbsVar(AV),
83 MInsn(nullptr), FrameIndex(~0), DD(DD) {}
Devang Patelf20c4f72011-04-12 22:53:02 +000084
85 // Accessors.
Eric Christophera5a79422013-12-09 23:32:48 +000086 DIVariable getVariable() const { return Var; }
David Blaikiee071fc82014-04-25 17:32:19 +000087 void setDIE(DIE &D) { TheDIE = &D; }
Eric Christophera5a79422013-12-09 23:32:48 +000088 DIE *getDIE() const { return TheDIE; }
89 void setDotDebugLocOffset(unsigned O) { DotDebugLocOffset = O; }
90 unsigned getDotDebugLocOffset() const { return DotDebugLocOffset; }
91 StringRef getName() const { return Var.getName(); }
Devang Patel99819b52011-08-15 19:01:20 +000092 DbgVariable *getAbstractVariable() const { return AbsVar; }
Eric Christophera5a79422013-12-09 23:32:48 +000093 const MachineInstr *getMInsn() const { return MInsn; }
94 void setMInsn(const MachineInstr *M) { MInsn = M; }
95 int getFrameIndex() const { return FrameIndex; }
96 void setFrameIndex(int FI) { FrameIndex = FI; }
Eric Christopher27527b22012-11-21 00:03:28 +000097 // Translate tag to proper Dwarf tag.
David Blaikieefc403b2014-04-12 02:24:04 +000098 dwarf::Tag getTag() const {
Devang Patel6e4d2c92011-08-15 18:35:42 +000099 if (Var.getTag() == dwarf::DW_TAG_arg_variable)
100 return dwarf::DW_TAG_formal_parameter;
Eric Christopher27527b22012-11-21 00:03:28 +0000101
Devang Patel6e4d2c92011-08-15 18:35:42 +0000102 return dwarf::DW_TAG_variable;
103 }
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000104 /// \brief Return true if DbgVariable is artificial.
Eric Christophera5a79422013-12-09 23:32:48 +0000105 bool isArtificial() const {
Devang Pateld7d80aa2011-08-15 18:40:16 +0000106 if (Var.isArtificial())
107 return true;
Eric Christopherc1c8a1b2012-09-21 22:18:52 +0000108 if (getType().isArtificial())
Devang Pateld7d80aa2011-08-15 18:40:16 +0000109 return true;
110 return false;
111 }
Eric Christophere3417762012-09-12 23:36:19 +0000112
Eric Christophera5a79422013-12-09 23:32:48 +0000113 bool isObjectPointer() const {
Eric Christophere3417762012-09-12 23:36:19 +0000114 if (Var.isObjectPointer())
115 return true;
Eric Christopherc1c8a1b2012-09-21 22:18:52 +0000116 if (getType().isObjectPointer())
Eric Christophere3417762012-09-12 23:36:19 +0000117 return true;
118 return false;
119 }
Eric Christopher27527b22012-11-21 00:03:28 +0000120
Eric Christophera5a79422013-12-09 23:32:48 +0000121 bool variableHasComplexAddress() const {
Manman Ren7504ed42013-07-08 18:33:29 +0000122 assert(Var.isVariable() && "Invalid complex DbgVariable!");
Devang Patelf20c4f72011-04-12 22:53:02 +0000123 return Var.hasComplexAddress();
124 }
Adrian Prantl1a1647c2014-03-18 02:34:58 +0000125 bool isBlockByrefVariable() const;
Eric Christophera5a79422013-12-09 23:32:48 +0000126 unsigned getNumAddrElements() const {
Manman Ren7504ed42013-07-08 18:33:29 +0000127 assert(Var.isVariable() && "Invalid complex DbgVariable!");
Devang Patelf20c4f72011-04-12 22:53:02 +0000128 return Var.getNumAddrElements();
129 }
Eric Christophera5a79422013-12-09 23:32:48 +0000130 uint64_t getAddrElement(unsigned i) const { return Var.getAddrElement(i); }
Devang Patelf20c4f72011-04-12 22:53:02 +0000131 DIType getType() const;
Manman Renbe5576f2013-10-08 19:07:44 +0000132
133private:
134 /// resolve - Look in the DwarfDebug map for the MDNode that
135 /// corresponds to the reference.
136 template <typename T> T resolve(DIRef<T> Ref) const;
Devang Patelf20c4f72011-04-12 22:53:02 +0000137};
138
Eric Christopherc8a310e2012-12-10 23:34:43 +0000139
Eric Christopher670ee0e2013-10-24 21:20:23 +0000140/// \brief Helper used to pair up a symbol and its DWARF compile unit.
Richard Mitton21101b32013-09-19 23:21:01 +0000141struct SymbolCU {
Eric Christopher4287a492013-12-09 23:57:44 +0000142 SymbolCU(DwarfCompileUnit *CU, const MCSymbol *Sym) : Sym(Sym), CU(CU) {}
Richard Mitton21101b32013-09-19 23:21:01 +0000143 const MCSymbol *Sym;
Eric Christopher4287a492013-12-09 23:57:44 +0000144 DwarfCompileUnit *CU;
Richard Mitton21101b32013-09-19 23:21:01 +0000145};
146
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000147/// \brief Collects and handles dwarf debug information.
Timur Iskhodzhanov1cd14442013-12-03 15:10:23 +0000148class DwarfDebug : public AsmPrinterHandler {
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000149 // Target of Dwarf emission.
Chris Lattner3a383cb2010-04-05 00:13:49 +0000150 AsmPrinter *Asm;
Chris Lattneracda87b2010-04-05 05:31:04 +0000151
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000152 // Collected machine module information.
Chris Lattner3a383cb2010-04-05 00:13:49 +0000153 MachineModuleInfo *MMI;
154
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000155 // All DIEValues are allocated through this allocator.
Benjamin Kramer07480082012-06-09 10:34:15 +0000156 BumpPtrAllocator DIEValueAllocator;
157
Eric Christopherbfe7d292013-12-03 22:05:55 +0000158 // Handle to the compile unit used for the inline extension handling,
159 // this is just so that the DIEValue allocator has a place to store
160 // the particular elements.
161 // FIXME: Store these off of DwarfDebug instead?
Eric Christopher4287a492013-12-09 23:57:44 +0000162 DwarfCompileUnit *FirstCU;
Devang Pateleb1bb4e2011-08-16 22:09:43 +0000163
Eric Christopher4287a492013-12-09 23:57:44 +0000164 // Maps MDNode with its corresponding DwarfCompileUnit.
Eric Christopher179fba12014-01-29 22:06:23 +0000165 MapVector<const MDNode *, DwarfCompileUnit *> CUMap;
Bill Wendling2f921f82009-05-15 09:23:25 +0000166
Eric Christopher4287a492013-12-09 23:57:44 +0000167 // Maps subprogram MDNode with its corresponding DwarfCompileUnit.
168 DenseMap<const MDNode *, DwarfCompileUnit *> SPMap;
Devang Pateleb1bb4e2011-08-16 22:09:43 +0000169
Eric Christopher4287a492013-12-09 23:57:44 +0000170 // Maps a CU DIE with its corresponding DwarfCompileUnit.
171 DenseMap<const DIE *, DwarfCompileUnit *> CUDieMap;
Manman Rence20d462013-10-29 22:57:10 +0000172
Eric Christopher47f2be82014-03-20 19:16:20 +0000173 /// Maps MDNodes for type system with the corresponding DIEs. These DIEs can
Manman Ren4dbdc902013-10-31 17:54:35 +0000174 /// be shared across CUs, that is why we keep the map here instead
Eric Christopher4287a492013-12-09 23:57:44 +0000175 /// of in DwarfCompileUnit.
Manman Ren4dbdc902013-10-31 17:54:35 +0000176 DenseMap<const MDNode *, DIE *> MDTypeNodeToDieMap;
177
Alexey Samsonov4436bf02013-10-03 08:54:43 +0000178 // List of all labels used in aranges generation.
179 std::vector<SymbolCU> ArangeLabels;
Richard Mitton21101b32013-09-19 23:21:01 +0000180
Richard Mitton089ed892013-09-23 17:56:20 +0000181 // Size of each symbol emitted (for those symbols that have a specific size).
Eric Christophera5a79422013-12-09 23:32:48 +0000182 DenseMap<const MCSymbol *, uint64_t> SymSize;
Richard Mitton089ed892013-09-23 17:56:20 +0000183
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000184 // Provides a unique id per text section.
Richard Mitton21101b32013-09-19 23:21:01 +0000185 typedef DenseMap<const MCSection *, SmallVector<SymbolCU, 8> > SectionMapType;
186 SectionMapType SectionMap;
Bill Wendling2f921f82009-05-15 09:23:25 +0000187
Eric Christopheraba20dd2013-07-08 21:16:18 +0000188 // List of arguments for current function.
David Blaikieafd2c6b2014-04-22 05:41:06 +0000189 SmallVector<DbgVariable *, 8> CurrentFnArguments;
Devang Patel6c622ef2011-03-01 22:58:55 +0000190
Devang Patel7e623022011-08-10 20:55:27 +0000191 LexicalScopes LScopes;
Devang Patel95cd4b92010-03-25 15:09:44 +0000192
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000193 // Collection of abstract subprogram DIEs.
Devang Patela37a95e2010-07-07 22:20:57 +0000194 DenseMap<const MDNode *, DIE *> AbstractSPDies;
195
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000196 // Collection of dbg variables of a scope.
David Blaikieafd2c6b2014-04-22 05:41:06 +0000197 typedef DenseMap<LexicalScope *, SmallVector<DbgVariable *, 8> >
Eric Christophera5a79422013-12-09 23:32:48 +0000198 ScopeVariablesMap;
Craig Topper2b4a2012013-07-03 04:40:27 +0000199 ScopeVariablesMap ScopeVariables;
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000200
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000201 // Collection of abstract variables.
Devang Patel32cc43c2010-05-07 20:54:48 +0000202 DenseMap<const MDNode *, DbgVariable *> AbstractVariables;
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000203
David Blaikie0a456de2014-04-02 01:43:18 +0000204 // Collection of DebugLocEntry. Stored in a linked list so that DIELocLists
205 // can refer to them in spite of insertions into this list.
206 SmallVector<DebugLocList, 4> DotDebugLocEntries;
Devang Patel9fc11702010-05-25 23:40:22 +0000207
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000208 // Collection of subprogram DIEs that are marked (at the end of the module)
209 // as DW_AT_inline.
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000210 SmallPtrSet<DIE *, 4> InlinedSubprogramDIEs;
211
Eric Christopher48fef592012-12-20 21:58:40 +0000212 // This is a collection of subprogram MDNodes that are processed to
213 // create DIEs.
Devang Patelf3b2db62010-06-28 18:25:03 +0000214 SmallPtrSet<const MDNode *, 16> ProcessedSPNodes;
215
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000216 // Maps instruction with label emitted before instruction.
Devang Patel6c74a872010-04-27 19:46:33 +0000217 DenseMap<const MachineInstr *, MCSymbol *> LabelsBeforeInsn;
Devang Patel3ebd8932010-04-08 16:50:29 +0000218
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000219 // Maps instruction with label emitted after instruction.
Devang Patel6c74a872010-04-27 19:46:33 +0000220 DenseMap<const MachineInstr *, MCSymbol *> LabelsAfterInsn;
Devang Patel3ebd8932010-04-08 16:50:29 +0000221
Alexey Samsonov414b6fb2014-04-30 21:34:11 +0000222 // History of DBG_VALUE and clobber instructions for each user variable.
Alexey Samsonov0436caa2014-04-30 23:02:40 +0000223 // Variables are listed in order of appearance.
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +0000224 DbgValueHistoryMap DbgValues;
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +0000225
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000226 // Previous instruction's location information. This is used to determine
227 // label location to indicate scope boundries in dwarf debug info.
Chris Lattner915c5f92010-04-02 19:42:39 +0000228 DebugLoc PrevInstLoc;
Devang Patel12563b32010-04-16 23:33:45 +0000229 MCSymbol *PrevLabel;
Devang Patelbd477be2010-03-29 17:20:31 +0000230
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000231 // This location indicates end of function prologue and beginning of function
232 // body.
Devang Patel34a66202011-05-11 19:22:19 +0000233 DebugLoc PrologEndLoc;
234
Timur Iskhodzhanov1cd14442013-12-03 15:10:23 +0000235 // If nonnull, stores the current machine function we're processing.
236 const MachineFunction *CurFn;
237
238 // If nonnull, stores the current machine instruction we're processing.
239 const MachineInstr *CurMI;
240
Eric Christopher384f3fe2014-03-20 19:16:16 +0000241 // If nonnull, stores the section that the previous function was allocated to
242 // emitting.
243 const MCSection *PrevSection;
244
245 // If nonnull, stores the CU in which the previous subprogram was contained.
246 const DwarfCompileUnit *PrevCU;
247
Chris Lattner6629ca92010-04-04 22:59:04 +0000248 // Section Symbols: these are assembler temporary labels that are emitted at
249 // the beginning of each supported dwarf section. These are used to form
250 // section offsets and are created by EmitSectionLabels.
Rafael Espindolaa7160962011-05-06 14:56:22 +0000251 MCSymbol *DwarfInfoSectionSym, *DwarfAbbrevSectionSym;
Devang Patel12563b32010-04-16 23:33:45 +0000252 MCSymbol *DwarfStrSectionSym, *TextSectionSym, *DwarfDebugRangeSectionSym;
Eric Christopher55863be2013-04-07 03:43:09 +0000253 MCSymbol *DwarfDebugLocSectionSym, *DwarfLineSectionSym, *DwarfAddrSectionSym;
Devang Patel9fc11702010-05-25 23:40:22 +0000254 MCSymbol *FunctionBeginSym, *FunctionEndSym;
Eric Christopherd8667202013-12-30 17:22:27 +0000255 MCSymbol *DwarfInfoDWOSectionSym, *DwarfAbbrevDWOSectionSym;
David Blaikiebc094f32014-05-15 23:18:15 +0000256 MCSymbol *DwarfTypesDWOSectionSym;
David Blaikiee12ab122014-04-01 16:09:49 +0000257 MCSymbol *DwarfStrDWOSectionSym;
Eric Christopher39eebfa2013-09-30 23:14:16 +0000258 MCSymbol *DwarfGnuPubNamesSectionSym, *DwarfGnuPubTypesSectionSym;
Devang Patel9c160e12010-07-08 20:10:35 +0000259
Nick Lewyckyd1ee7f82011-11-02 20:55:33 +0000260 // As an optimization, there is no need to emit an entry in the directory
Eric Christopher808fd7b2013-07-03 01:57:23 +0000261 // table for the same directory as DW_AT_comp_dir.
Nick Lewyckyd1ee7f82011-11-02 20:55:33 +0000262 StringRef CompilationDir;
263
Eric Christopher0f63d062013-12-03 00:45:45 +0000264 // Counter for assigning globally unique IDs for ranges.
265 unsigned GlobalRangeCount;
266
Eric Christopherc8a310e2012-12-10 23:34:43 +0000267 // Holder for the file specific debug information.
Eric Christopherf8194852013-12-05 18:06:10 +0000268 DwarfFile InfoHolder;
Eric Christopherc8a310e2012-12-10 23:34:43 +0000269
Eric Christopher0aa4a672012-12-10 22:25:41 +0000270 // Holders for the various debug information flags that we might need to
271 // have exposed. See accessor functions below for description.
272
Eric Christopher070bf162013-07-03 01:57:26 +0000273 // Holder for imported entities.
274 typedef SmallVector<std::pair<const MDNode *, const MDNode *>, 32>
Eric Christophera5a79422013-12-09 23:32:48 +0000275 ImportedEntityMap;
Eric Christopher070bf162013-07-03 01:57:26 +0000276 ImportedEntityMap ScopesWithImportedEntities;
277
David Blaikie47f615e2013-12-17 23:32:35 +0000278 // Map from MDNodes for user-defined types to the type units that describe
279 // them.
280 DenseMap<const MDNode *, const DwarfTypeUnit *> DwarfTypeUnits;
Eric Christopher67646432013-07-26 17:02:41 +0000281
David Blaikiee12b49a2014-04-26 17:27:38 +0000282 SmallVector<std::pair<std::unique_ptr<DwarfTypeUnit>, DICompositeType>, 1> TypeUnitsUnderConstruction;
283
Eric Christopher4d36ca02013-08-26 23:24:35 +0000284 // Whether to emit the pubnames/pubtypes sections.
285 bool HasDwarfPubSections;
286
Eric Christopher1ad84572014-01-15 00:04:29 +0000287 // Whether or not to use AT_ranges for compilation units.
288 bool HasCURanges;
289
Eric Christopher2037caf2014-01-28 00:49:26 +0000290 // Whether we emitted a function into a section other than the default
291 // text.
292 bool UsedNonDefaultText;
293
Eric Christopher4d36ca02013-08-26 23:24:35 +0000294 // Version of dwarf we're emitting.
295 unsigned DwarfVersion;
296
Eric Christopher0a13eb32013-11-21 22:56:11 +0000297 // Maps from a type identifier to the actual MDNode.
298 DITypeIdentifierMap TypeIdentifierMap;
299
Eric Christopher42e39942012-11-29 22:56:13 +0000300 // DWARF5 Experimental Options
Eric Christopher7b30f2e42012-11-21 00:34:35 +0000301 bool HasDwarfAccelTables;
Eric Christophercdf218d2012-12-10 19:51:21 +0000302 bool HasSplitDwarf;
Manman Renac8062b2013-07-02 23:40:10 +0000303
Eric Christopherd692c1d2012-12-11 19:42:09 +0000304 // Separated Dwarf Variables
Eric Christopherd79f5482012-12-10 19:51:13 +0000305 // In general these will all be for bits that are left in the
306 // original object file, rather than things that are meant
307 // to be in the .dwo sections.
308
Eric Christopher3bf29fd2012-12-27 02:14:01 +0000309 // Holder for the skeleton information.
Eric Christopherf8194852013-12-05 18:06:10 +0000310 DwarfFile SkeletonHolder;
Eric Christopherd79f5482012-12-10 19:51:13 +0000311
David Blaikie47f4b822014-03-19 00:11:28 +0000312 /// Store file names for type units under fission in a line table header that
313 /// will be emitted into debug_line.dwo.
314 // FIXME: replace this with a map from comp_dir to table so that we can emit
315 // multiple tables during LTO each of which uses directory 0, referencing the
316 // comp_dir of all the type units that use it.
David Blaikie8287aff2014-03-18 02:13:23 +0000317 MCDwarfDwoLineTable SplitTypeUnitFileTable;
David Blaikie4a2f95f2014-03-18 01:17:26 +0000318
David Blaikie47f4b822014-03-19 00:11:28 +0000319 // True iff there are multiple CUs in this module.
320 bool SingleCU;
321
David Blaikied75fb282014-04-23 21:20:10 +0000322 AddressPool AddrPool;
323
David Blaikie2406a0622014-04-23 23:37:35 +0000324 DwarfAccelTable AccelNames;
David Blaikie0ee82b92014-04-24 00:53:32 +0000325 DwarfAccelTable AccelObjC;
David Blaikieecf04152014-04-24 01:02:42 +0000326 DwarfAccelTable AccelNamespace;
David Blaikie18d33752014-04-24 01:23:49 +0000327 DwarfAccelTable AccelTypes;
David Blaikie2406a0622014-04-23 23:37:35 +0000328
David Blaikie47f4b822014-03-19 00:11:28 +0000329 MCDwarfDwoLineTable *getDwoLineTable(const DwarfCompileUnit &);
330
David Blaikieafd2c6b2014-04-22 05:41:06 +0000331 void addScopeVariable(LexicalScope *LS, DbgVariable *Var);
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000332
David Blaikiec33b3cd2014-04-22 21:27:37 +0000333 const SmallVectorImpl<std::unique_ptr<DwarfUnit>> &getUnits() {
Eric Christophera5a79422013-12-09 23:32:48 +0000334 return InfoHolder.getUnits();
335 }
David Blaikiefd1eff52013-11-26 19:14:34 +0000336
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000337 /// \brief Find abstract variable associated with Var.
Devang Patele1c53f22010-05-20 16:36:41 +0000338 DbgVariable *findAbstractVariable(DIVariable &Var, DebugLoc Loc);
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000339
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000340 /// \brief Find DIE for the given subprogram and attach appropriate
341 /// DW_AT_low_pc and DW_AT_high_pc attributes. If there are global
342 /// variables in this scope then create and insert DIEs for these
343 /// variables.
David Blaikiee872a6e2014-04-29 15:58:35 +0000344 DIE &updateSubprogramScopeDIE(DwarfCompileUnit &SPCU, DISubprogram SP);
Bill Wendling2f921f82009-05-15 09:23:25 +0000345
Eric Christopher44e66c12013-12-03 00:45:56 +0000346 /// \brief A helper function to check whether the DIE for a given Scope is
347 /// going to be null.
Manman Ren2312ed32013-09-10 18:40:41 +0000348 bool isLexicalScopeDIENull(LexicalScope *Scope);
Bill Wendling2f921f82009-05-15 09:23:25 +0000349
Eric Christopherbe2513e2013-12-03 00:45:59 +0000350 /// \brief A helper function to construct a RangeSpanList for a given
351 /// lexical scope.
David Blaikie65a74662014-04-25 18:26:14 +0000352 void addScopeRangeList(DwarfCompileUnit &TheCU, DIE &ScopeDIE,
Eric Christopherbe2513e2013-12-03 00:45:59 +0000353 const SmallVectorImpl<InsnRange> &Range);
354
Eric Christopher77913e0392013-12-03 00:45:54 +0000355 /// \brief Construct new DW_TAG_lexical_block for this scope and
356 /// attach DW_AT_low_pc/DW_AT_high_pc labels.
David Blaikief2449222014-04-28 20:36:45 +0000357 std::unique_ptr<DIE> constructLexicalScopeDIE(DwarfCompileUnit &TheCU,
358 LexicalScope *Scope);
Eric Christopher77913e0392013-12-03 00:45:54 +0000359
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000360 /// \brief This scope represents inlined body of a function. Construct
361 /// DIE to represent this concrete inlined copy of the function.
David Blaikief2449222014-04-28 20:36:45 +0000362 std::unique_ptr<DIE> constructInlinedScopeDIE(DwarfCompileUnit &TheCU,
363 LexicalScope *Scope);
Devang Patel930143b2009-11-21 02:48:08 +0000364
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000365 /// \brief Construct a DIE for this scope.
David Blaikief2449222014-04-28 20:36:45 +0000366 std::unique_ptr<DIE> constructScopeDIE(DwarfCompileUnit &TheCU,
367 LexicalScope *Scope);
David Blaikiee872a6e2014-04-29 15:58:35 +0000368 void createAndAddScopeChildren(DwarfCompileUnit &TheCU, LexicalScope *Scope,
David Blaikie899ae612014-04-30 22:58:19 +0000369 DIE &ScopeDIE);
David Blaikiee872a6e2014-04-29 15:58:35 +0000370 /// \brief Construct a DIE for this abstract scope.
David Blaikie4c1089d2014-04-29 23:43:06 +0000371 void constructAbstractSubprogramScopeDIE(DwarfCompileUnit &TheCU,
372 LexicalScope *Scope);
David Blaikiee872a6e2014-04-29 15:58:35 +0000373 /// \brief Construct a DIE for this subprogram scope.
David Blaikie4c1089d2014-04-29 23:43:06 +0000374 DIE &constructSubprogramScopeDIE(DwarfCompileUnit &TheCU,
375 LexicalScope *Scope);
Manman Ren2312ed32013-09-10 18:40:41 +0000376 /// A helper function to create children of a Scope DIE.
David Blaikief9b6a552014-04-22 22:39:41 +0000377 DIE *createScopeChildrenDIE(DwarfCompileUnit &TheCU, LexicalScope *Scope,
David Blaikie914046e2014-04-25 20:00:34 +0000378 SmallVectorImpl<std::unique_ptr<DIE>> &Children);
Devang Patel930143b2009-11-21 02:48:08 +0000379
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000380 /// \brief Emit initial Dwarf sections with a label at the start of each one.
Eric Christopher7b30f2e42012-11-21 00:34:35 +0000381 void emitSectionLabels();
Bill Wendling2f921f82009-05-15 09:23:25 +0000382
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000383 /// \brief Compute the size and offset of a DIE given an incoming Offset.
Eric Christopher1f0cbb82012-11-20 22:14:13 +0000384 unsigned computeSizeAndOffset(DIE *Die, unsigned Offset);
Bill Wendling2f921f82009-05-15 09:23:25 +0000385
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000386 /// \brief Compute the size and offset of all the DIEs.
Devang Patel930143b2009-11-21 02:48:08 +0000387 void computeSizeAndOffsets();
Bill Wendling2f921f82009-05-15 09:23:25 +0000388
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000389 /// \brief Collect info for variables that were optimized out.
Eric Christopher960ac372012-11-22 00:59:49 +0000390 void collectDeadVariables();
391
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000392 /// \brief Finish off debug information after all functions have been
393 /// processed.
Eric Christopher960ac372012-11-22 00:59:49 +0000394 void finalizeModuleInfo();
395
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000396 /// \brief Emit labels to close any remaining sections that have been left
397 /// open.
Eric Christopher960ac372012-11-22 00:59:49 +0000398 void endSections();
399
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000400 /// \brief Emit the debug info section.
Devang Patel930143b2009-11-21 02:48:08 +0000401 void emitDebugInfo();
Bill Wendling2f921f82009-05-15 09:23:25 +0000402
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000403 /// \brief Emit the abbreviation section.
Eric Christopher38371952012-11-20 23:30:11 +0000404 void emitAbbreviations();
Bill Wendling2f921f82009-05-15 09:23:25 +0000405
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000406 /// \brief Emit the last address of the section and the end of
Bill Wendling2f921f82009-05-15 09:23:25 +0000407 /// the line matrix.
Devang Patel930143b2009-11-21 02:48:08 +0000408 void emitEndOfLineMatrix(unsigned SectionEnd);
Bill Wendling2f921f82009-05-15 09:23:25 +0000409
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000410 /// \brief Emit visible names into a hashed accelerator table section.
Eric Christopher4996c702011-11-07 09:24:32 +0000411 void emitAccelNames();
Eric Christopher27527b22012-11-21 00:03:28 +0000412
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000413 /// \brief Emit objective C classes and categories into a hashed
Eric Christopher4996c702011-11-07 09:24:32 +0000414 /// accelerator table section.
415 void emitAccelObjC();
416
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000417 /// \brief Emit namespace dies into a hashed accelerator table.
Eric Christopher4996c702011-11-07 09:24:32 +0000418 void emitAccelNamespaces();
419
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000420 /// \brief Emit type dies into a hashed accelerator table.
Eric Christopher4996c702011-11-07 09:24:32 +0000421 void emitAccelTypes();
Eric Christopher27527b22012-11-21 00:03:28 +0000422
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +0000423 /// \brief Emit visible names into a debug pubnames section.
Eric Christopherdd1a0122013-09-13 00:35:05 +0000424 /// \param GnuStyle determines whether or not we want to emit
425 /// additional information into the table ala newer gcc for gdb
426 /// index.
427 void emitDebugPubNames(bool GnuStyle = false);
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +0000428
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000429 /// \brief Emit visible types into a debug pubtypes section.
Eric Christopherdd1a0122013-09-13 00:35:05 +0000430 /// \param GnuStyle determines whether or not we want to emit
431 /// additional information into the table ala newer gcc for gdb
432 /// index.
433 void emitDebugPubTypes(bool GnuStyle = false);
Devang Patel04d2f2d2009-11-24 01:14:22 +0000434
David Blaikie0f55e832014-03-11 23:18:15 +0000435 void
436 emitDebugPubSection(bool GnuStyle, const MCSection *PSec, StringRef Name,
437 const StringMap<const DIE *> &(DwarfUnit::*Accessor)()
438 const);
439
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000440 /// \brief Emit visible names into a debug str section.
Devang Patel930143b2009-11-21 02:48:08 +0000441 void emitDebugStr();
Bill Wendling2f921f82009-05-15 09:23:25 +0000442
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000443 /// \brief Emit visible names into a debug loc section.
Devang Patel930143b2009-11-21 02:48:08 +0000444 void emitDebugLoc();
Bill Wendling2f921f82009-05-15 09:23:25 +0000445
David Blaikie94c1d7f2014-04-02 01:50:20 +0000446 /// \brief Emit visible names into a debug loc dwo section.
447 void emitDebugLocDWO();
448
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000449 /// \brief Emit visible names into a debug aranges section.
Eric Christopher7b30f2e42012-11-21 00:34:35 +0000450 void emitDebugARanges();
Bill Wendling2f921f82009-05-15 09:23:25 +0000451
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000452 /// \brief Emit visible names into a debug ranges section.
Devang Patel930143b2009-11-21 02:48:08 +0000453 void emitDebugRanges();
Bill Wendling2f921f82009-05-15 09:23:25 +0000454
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000455 /// \brief Emit inline info using custom format.
Devang Patel930143b2009-11-21 02:48:08 +0000456 void emitDebugInlineInfo();
Bill Wendling2b128d72009-05-20 23:19:06 +0000457
Eric Christophercdf218d2012-12-10 19:51:21 +0000458 /// DWARF 5 Experimental Split Dwarf Emitters
Eric Christopher9c2ecd92012-11-30 23:59:06 +0000459
David Blaikie38fe6342014-01-09 04:28:46 +0000460 /// \brief Initialize common features of skeleton units.
David Blaikie65a74662014-04-25 18:26:14 +0000461 void initSkeletonUnit(const DwarfUnit &U, DIE &Die,
David Blaikief9b6a552014-04-22 22:39:41 +0000462 std::unique_ptr<DwarfUnit> NewU);
David Blaikie38fe6342014-01-09 04:28:46 +0000463
Eric Christophercdf218d2012-12-10 19:51:21 +0000464 /// \brief Construct the split debug info compile unit for the debug info
465 /// section.
David Blaikief9b6a552014-04-22 22:39:41 +0000466 DwarfCompileUnit &constructSkeletonCU(const DwarfCompileUnit &CU);
Eric Christopher9c2ecd92012-11-30 23:59:06 +0000467
David Blaikie15ed5eb2014-01-10 01:38:41 +0000468 /// \brief Construct the split debug info compile unit for the debug info
469 /// section.
David Blaikief9b6a552014-04-22 22:39:41 +0000470 DwarfTypeUnit &constructSkeletonTU(DwarfTypeUnit &TU);
David Blaikie15ed5eb2014-01-10 01:38:41 +0000471
Eric Christopher9c2ecd92012-11-30 23:59:06 +0000472 /// \brief Emit the debug info dwo section.
473 void emitDebugInfoDWO();
474
Eric Christopher3c5a1912012-12-19 22:02:53 +0000475 /// \brief Emit the debug abbrev dwo section.
476 void emitDebugAbbrevDWO();
477
David Blaikie4a2f95f2014-03-18 01:17:26 +0000478 /// \brief Emit the debug line dwo section.
479 void emitDebugLineDWO();
480
Eric Christopher3bf29fd2012-12-27 02:14:01 +0000481 /// \brief Emit the debug str dwo section.
482 void emitDebugStrDWO();
483
David Blaikie3c842622013-12-04 21:31:26 +0000484 /// Flags to let the linker know we have emitted new style pubnames. Only
485 /// emit it here if we don't have a skeleton CU for split dwarf.
David Blaikie65a74662014-04-25 18:26:14 +0000486 void addGnuPubAttributes(DwarfUnit &U, DIE &D) const;
David Blaikie3c842622013-12-04 21:31:26 +0000487
Eric Christopher4287a492013-12-09 23:57:44 +0000488 /// \brief Create new DwarfCompileUnit for the given metadata node with tag
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000489 /// DW_TAG_compile_unit.
David Blaikief9b6a552014-04-22 22:39:41 +0000490 DwarfCompileUnit &constructDwarfCompileUnit(DICompileUnit DIUnit);
Devang Patel1a0df9a2010-05-10 22:49:55 +0000491
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000492 /// \brief Construct subprogram DIE.
David Blaikief9b6a552014-04-22 22:39:41 +0000493 void constructSubprogramDIE(DwarfCompileUnit &TheCU, const MDNode *N);
Bill Wendling2b128d72009-05-20 23:19:06 +0000494
David Blaikie1fd43652013-05-07 21:35:53 +0000495 /// \brief Construct imported_module or imported_declaration DIE.
David Blaikief9b6a552014-04-22 22:39:41 +0000496 void constructImportedEntityDIE(DwarfCompileUnit &TheCU, const MDNode *N);
David Blaikief55abea2013-04-22 06:12:31 +0000497
David Blaikie684fc532013-05-06 23:33:07 +0000498 /// \brief Construct import_module DIE.
David Blaikief9b6a552014-04-22 22:39:41 +0000499 void constructImportedEntityDIE(DwarfCompileUnit &TheCU, const MDNode *N,
David Blaikief2449222014-04-28 20:36:45 +0000500 DIE &Context);
David Blaikie684fc532013-05-06 23:33:07 +0000501
502 /// \brief Construct import_module DIE.
David Blaikief9b6a552014-04-22 22:39:41 +0000503 void constructImportedEntityDIE(DwarfCompileUnit &TheCU,
David Blaikief2449222014-04-28 20:36:45 +0000504 const DIImportedEntity &Module, DIE &Context);
David Blaikie684fc532013-05-06 23:33:07 +0000505
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000506 /// \brief Register a source line with debug info. Returns the unique
507 /// label that was emitted and which provides correspondence to the
508 /// source line list.
Devang Patel34a66202011-05-11 19:22:19 +0000509 void recordSourceLine(unsigned Line, unsigned Col, const MDNode *Scope,
510 unsigned Flags);
Eric Christopher27527b22012-11-21 00:03:28 +0000511
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000512 /// \brief Indentify instructions that are marking the beginning of or
513 /// ending of a scope.
Devang Patel359b0132010-04-08 18:43:56 +0000514 void identifyScopeMarkers();
Devang Patelf1d5a1e2010-04-08 15:37:09 +0000515
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000516 /// \brief If Var is an current function argument that add it in
517 /// CurrentFnArguments list.
David Blaikieafd2c6b2014-04-22 05:41:06 +0000518 bool addCurrentFnArgument(DbgVariable *Var, LexicalScope *Scope);
Devang Patel6c622ef2011-03-01 22:58:55 +0000519
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000520 /// \brief Populate LexicalScope entries with variables' info.
Timur Iskhodzhanov1cd14442013-12-03 15:10:23 +0000521 void collectVariableInfo(SmallPtrSet<const MDNode *, 16> &ProcessedVars);
Eric Christopher27527b22012-11-21 00:03:28 +0000522
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000523 /// \brief Collect variable information from the side table maintained
524 /// by MMI.
Timur Iskhodzhanov1cd14442013-12-03 15:10:23 +0000525 void collectVariableInfoFromMMITable(SmallPtrSet<const MDNode *, 16> &P);
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +0000526
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000527 /// \brief Ensure that a label will be emitted before MI.
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +0000528 void requestLabelBeforeInsn(const MachineInstr *MI) {
Craig Toppere73658d2014-04-28 04:05:08 +0000529 LabelsBeforeInsn.insert(std::make_pair(MI, nullptr));
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +0000530 }
531
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000532 /// \brief Return Label preceding the instruction.
Eric Christopher962c9082013-01-15 23:56:56 +0000533 MCSymbol *getLabelBeforeInsn(const MachineInstr *MI);
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +0000534
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000535 /// \brief Ensure that a label will be emitted after MI.
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +0000536 void requestLabelAfterInsn(const MachineInstr *MI) {
Craig Toppere73658d2014-04-28 04:05:08 +0000537 LabelsAfterInsn.insert(std::make_pair(MI, nullptr));
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +0000538 }
539
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000540 /// \brief Return Label immediately following the instruction.
Eric Christopher962c9082013-01-15 23:56:56 +0000541 MCSymbol *getLabelAfterInsn(const MachineInstr *MI);
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +0000542
David Blaikie4a3b84d2014-05-16 16:42:40 +0000543 void attachRangesOrLowHighPC(DwarfCompileUnit &Unit, DIE &D,
544 const SmallVectorImpl<InsnRange> &Ranges);
David Blaikie65a74662014-04-25 18:26:14 +0000545 void attachLowHighPC(DwarfCompileUnit &Unit, DIE &D, MCSymbol *Begin,
David Blaikie4bd13b72014-03-07 18:49:45 +0000546 MCSymbol *End);
547
Bill Wendling2f921f82009-05-15 09:23:25 +0000548public:
549 //===--------------------------------------------------------------------===//
550 // Main entry points.
551 //
Chris Lattnerf0d6bd32010-04-05 05:11:15 +0000552 DwarfDebug(AsmPrinter *A, Module *M);
Bill Wendling2f921f82009-05-15 09:23:25 +0000553
Reid Klecknerdd2647e2014-04-30 20:34:31 +0000554 ~DwarfDebug() override;
555
Manman Ren4dbdc902013-10-31 17:54:35 +0000556 void insertDIE(const MDNode *TypeMD, DIE *Die) {
557 MDTypeNodeToDieMap.insert(std::make_pair(TypeMD, Die));
558 }
559 DIE *getDIE(const MDNode *TypeMD) {
560 return MDTypeNodeToDieMap.lookup(TypeMD);
561 }
562
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000563 /// \brief Emit all Dwarf sections that should come prior to the
Bill Wendling2f921f82009-05-15 09:23:25 +0000564 /// content.
Eric Christopher58f41952012-11-19 22:42:15 +0000565 void beginModule();
Bill Wendling2f921f82009-05-15 09:23:25 +0000566
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000567 /// \brief Emit all Dwarf sections that should come after the content.
Craig Topper7b883b32014-03-08 06:31:39 +0000568 void endModule() override;
Bill Wendling2f921f82009-05-15 09:23:25 +0000569
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000570 /// \brief Gather pre-function debug information.
Craig Topper7b883b32014-03-08 06:31:39 +0000571 void beginFunction(const MachineFunction *MF) override;
Bill Wendling2f921f82009-05-15 09:23:25 +0000572
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000573 /// \brief Gather and emit post-function debug information.
Craig Topper7b883b32014-03-08 06:31:39 +0000574 void endFunction(const MachineFunction *MF) override;
Bill Wendling2f921f82009-05-15 09:23:25 +0000575
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000576 /// \brief Process beginning of an instruction.
Craig Topper7b883b32014-03-08 06:31:39 +0000577 void beginInstruction(const MachineInstr *MI) override;
Bill Wendling2f921f82009-05-15 09:23:25 +0000578
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000579 /// \brief Process end of an instruction.
Craig Topper7b883b32014-03-08 06:31:39 +0000580 void endInstruction() override;
Devang Patelf20c4f72011-04-12 22:53:02 +0000581
Eric Christopher67646432013-07-26 17:02:41 +0000582 /// \brief Add a DIE to the set of types that we're going to pull into
583 /// type units.
David Blaikie15632ae2014-02-12 00:31:30 +0000584 void addDwarfTypeUnitType(DwarfCompileUnit &CU, StringRef Identifier,
David Blaikie65a74662014-04-25 18:26:14 +0000585 DIE &Die, DICompositeType CTy);
Eric Christopher67646432013-07-26 17:02:41 +0000586
Richard Mitton21101b32013-09-19 23:21:01 +0000587 /// \brief Add a label so that arange data can be generated for it.
Alexey Samsonov4436bf02013-10-03 08:54:43 +0000588 void addArangeLabel(SymbolCU SCU) { ArangeLabels.push_back(SCU); }
Richard Mitton21101b32013-09-19 23:21:01 +0000589
Richard Mitton089ed892013-09-23 17:56:20 +0000590 /// \brief For symbols that have a size designated (e.g. common symbols),
591 /// this tracks that size.
Craig Topper7b883b32014-03-08 06:31:39 +0000592 void setSymbolSize(const MCSymbol *Sym, uint64_t Size) override {
Eric Christophera5a79422013-12-09 23:32:48 +0000593 SymSize[Sym] = Size;
594 }
Richard Mitton089ed892013-09-23 17:56:20 +0000595
Eric Christophera2de8262012-12-15 00:04:07 +0000596 /// \brief Recursively Emits a debug information entry.
David Blaikieb8184182014-04-14 22:45:02 +0000597 void emitDIE(DIE &Die);
Eric Christophera2de8262012-12-15 00:04:07 +0000598
Eric Christopher55c51812012-11-21 00:03:31 +0000599 // Experimental DWARF5 features.
600
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000601 /// \brief Returns whether or not to emit tables that dwarf consumers can
602 /// use to accelerate lookup.
Eric Christopher411bd592014-03-06 00:00:53 +0000603 bool useDwarfAccelTables() const { return HasDwarfAccelTables; }
Eric Christopher55c51812012-11-21 00:03:31 +0000604
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000605 /// \brief Returns whether or not to change the current debug info for the
Eric Christophercdf218d2012-12-10 19:51:21 +0000606 /// split dwarf proposal support.
Eric Christopher411bd592014-03-06 00:00:53 +0000607 bool useSplitDwarf() const { return HasSplitDwarf; }
Manman Renac8062b2013-07-02 23:40:10 +0000608
609 /// Returns the Dwarf Version.
610 unsigned getDwarfVersion() const { return DwarfVersion; }
Manman Ren60352032013-09-05 18:48:31 +0000611
Eric Christophera27220f2014-03-05 22:41:20 +0000612 /// Returns the section symbol for the .debug_loc section.
613 MCSymbol *getDebugLocSym() const { return DwarfDebugLocSectionSym; }
614
Eric Christopher384f3fe2014-03-20 19:16:16 +0000615 /// Returns the previous section that was emitted into.
616 const MCSection *getPrevSection() const { return PrevSection; }
617
618 /// Returns the previous CU that was being updated
619 const DwarfCompileUnit *getPrevCU() const { return PrevCU; }
620
Eric Christopher4f17ee02014-03-08 00:29:41 +0000621 /// Returns the entries for the .debug_loc section.
David Blaikie0a456de2014-04-02 01:43:18 +0000622 const SmallVectorImpl<DebugLocList> &
David Blaikie84d8e182014-03-24 22:38:38 +0000623 getDebugLocEntries() const {
Eric Christopher4f17ee02014-03-08 00:29:41 +0000624 return DotDebugLocEntries;
625 }
626
627 /// \brief Emit an entry for the debug loc section. This can be used to
628 /// handle an entry that's going to be emitted into the debug loc section.
Eric Christopher05135fb2014-03-18 02:18:24 +0000629 void emitDebugLocEntry(ByteStreamer &Streamer, const DebugLocEntry &Entry);
Eric Christopher4f17ee02014-03-08 00:29:41 +0000630
David Blaikie0e84adc2014-04-01 16:17:41 +0000631 /// Emit the location for a debug loc entry, including the size header.
632 void emitDebugLocEntryLocation(const DebugLocEntry &Entry);
633
Eric Christopher87b9c492013-10-05 00:32:34 +0000634 /// Find the MDNode for the given reference.
635 template <typename T> T resolve(DIRef<T> Ref) const {
Manman Ren34b3dcc2013-09-10 18:30:07 +0000636 return Ref.resolve(TypeIdentifierMap);
637 }
Manman Ren60352032013-09-05 18:48:31 +0000638
Adrian Prantl1a1647c2014-03-18 02:34:58 +0000639 /// \brief Return the TypeIdentifierMap.
Eric Christopherc0bd5f82014-03-18 20:39:54 +0000640 const DITypeIdentifierMap &getTypeIdentifierMap() const {
Adrian Prantl1a1647c2014-03-18 02:34:58 +0000641 return TypeIdentifierMap;
642 }
643
Eric Christopherdd508382014-03-06 00:00:56 +0000644 /// Find the DwarfCompileUnit for the given CU Die.
645 DwarfCompileUnit *lookupUnit(const DIE *CU) const {
646 return CUDieMap.lookup(CU);
647 }
Manman Ren3eb9dff2013-09-09 19:05:21 +0000648 /// isSubprogramContext - Return true if Context is either a subprogram
649 /// or another context nested inside a subprogram.
650 bool isSubprogramContext(const MDNode *Context);
David Blaikied75fb282014-04-23 21:20:10 +0000651
David Blaikieb0b3fcf2014-04-25 18:52:29 +0000652 void addSubprogramNames(DISubprogram SP, DIE &Die);
David Blaikie2406a0622014-04-23 23:37:35 +0000653
David Blaikied75fb282014-04-23 21:20:10 +0000654 AddressPool &getAddressPool() { return AddrPool; }
David Blaikie2406a0622014-04-23 23:37:35 +0000655
David Blaikieb0b3fcf2014-04-25 18:52:29 +0000656 void addAccelName(StringRef Name, const DIE &Die);
David Blaikie0ee82b92014-04-24 00:53:32 +0000657
David Blaikieb0b3fcf2014-04-25 18:52:29 +0000658 void addAccelObjC(StringRef Name, const DIE &Die);
David Blaikieecf04152014-04-24 01:02:42 +0000659
David Blaikieb0b3fcf2014-04-25 18:52:29 +0000660 void addAccelNamespace(StringRef Name, const DIE &Die);
David Blaikie18d33752014-04-24 01:23:49 +0000661
David Blaikieb0b3fcf2014-04-25 18:52:29 +0000662 void addAccelType(StringRef Name, const DIE &Die, char Flags);
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000663};
Bill Wendling2f921f82009-05-15 09:23:25 +0000664} // End of namespace llvm
665
666#endif