1 //===-- llvm/CodeGen/DwarfCompileUnit.h - Dwarf Compile Unit ---*- C++ -*--===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file contains support for writing dwarf compile unit.
12 //===----------------------------------------------------------------------===//
14 #ifndef CODEGEN_ASMPRINTER_DWARFCOMPILEUNIT_H
15 #define CODEGEN_ASMPRINTER_DWARFCOMPILEUNIT_H
18 #include "DwarfDebug.h"
19 #include "llvm/ADT/DenseMap.h"
20 #include "llvm/ADT/Optional.h"
21 #include "llvm/ADT/OwningPtr.h"
22 #include "llvm/ADT/StringMap.h"
23 #include "llvm/DebugInfo.h"
24 #include "llvm/MC/MCExpr.h"
28 class MachineLocation;
34 //===----------------------------------------------------------------------===//
35 /// CompileUnit - This dwarf writer support class manages information associated
36 /// with a source file.
38 /// UniqueID - a numeric ID unique among all CUs in the module
41 /// Node - MDNode for the compile unit.
44 /// Language - Language for the translation unit associated with this CU.
47 /// CUDie - Compile unit debug information entry.
48 const OwningPtr<DIE> CUDie;
50 /// Offset of the CUDie from beginning of debug info section.
51 unsigned DebugInfoOffset;
53 /// Asm - Target of Dwarf emission.
56 // Holders for some common dwarf information.
60 /// IndexTyDie - An anonymous type for index type. Owned by CUDie.
63 /// MDNodeToDieMap - Tracks the mapping of unit level debug information
64 /// variables to debug information entries.
65 DenseMap<const MDNode *, DIE *> MDNodeToDieMap;
67 /// MDNodeToDIEEntryMap - Tracks the mapping of unit level debug information
68 /// descriptors to debug information entries using a DIEEntry proxy.
69 DenseMap<const MDNode *, DIEEntry *> MDNodeToDIEEntryMap;
71 /// GlobalNames - A map of globally visible named entities for this unit.
72 StringMap<const DIE *> GlobalNames;
74 /// GlobalTypes - A map of globally visible types for this unit.
75 StringMap<const DIE *> GlobalTypes;
77 /// AccelNames - A map of names for the name accelerator table.
78 StringMap<std::vector<const DIE *> > AccelNames;
80 /// AccelObjC - A map of objc spec for the objc accelerator table.
81 StringMap<std::vector<const DIE *> > AccelObjC;
83 /// AccelNamespace - A map of names for the namespace accelerator table.
84 StringMap<std::vector<const DIE *> > AccelNamespace;
86 /// AccelTypes - A map of names for the type accelerator table.
87 StringMap<std::vector<std::pair<const DIE *, unsigned> > > AccelTypes;
89 /// DIEBlocks - A list of all the DIEBlocks in use.
90 std::vector<DIEBlock *> DIEBlocks;
92 /// ContainingTypeMap - This map is used to keep track of subprogram DIEs that
93 /// need DW_AT_containing_type attribute. This attribute points to a DIE that
94 /// corresponds to the MDNode mapped with the subprogram DIE.
95 DenseMap<DIE *, const MDNode *> ContainingTypeMap;
97 // DIEValueAllocator - All DIEValues are allocated through this allocator.
98 BumpPtrAllocator DIEValueAllocator;
100 // DIEIntegerOne - A preallocated DIEValue because 1 is used frequently.
101 DIEInteger *DIEIntegerOne;
104 CompileUnit(unsigned UID, DIE *D, DICompileUnit CU, AsmPrinter *A,
105 DwarfDebug *DW, DwarfUnits *DWU);
106 CompileUnit(unsigned UID, DIE *D, uint16_t Language, AsmPrinter *A,
107 DwarfDebug *DW, DwarfUnits *DWU);
111 unsigned getUniqueID() const { return UniqueID; }
112 uint16_t getLanguage() const { return Language; }
113 DICompileUnit getNode() const { return Node; }
114 DIE *getCUDie() const { return CUDie.get(); }
115 const StringMap<const DIE *> &getGlobalNames() const { return GlobalNames; }
116 const StringMap<const DIE *> &getGlobalTypes() const { return GlobalTypes; }
118 const StringMap<std::vector<const DIE *> > &getAccelNames() const {
121 const StringMap<std::vector<const DIE *> > &getAccelObjC() const {
124 const StringMap<std::vector<const DIE *> > &getAccelNamespace() const {
125 return AccelNamespace;
127 const StringMap<std::vector<std::pair<const DIE *, unsigned> > > &
128 getAccelTypes() const {
132 unsigned getDebugInfoOffset() const { return DebugInfoOffset; }
133 void setDebugInfoOffset(unsigned DbgInfoOff) { DebugInfoOffset = DbgInfoOff; }
135 /// hasContent - Return true if this compile unit has something to write out.
136 bool hasContent() const { return !CUDie->getChildren().empty(); }
138 /// getParentContextString - Get a string containing the language specific
139 /// context for a global name.
140 std::string getParentContextString(DIScope Context) const;
142 /// addGlobalName - Add a new global entity to the compile unit.
144 void addGlobalName(StringRef Name, DIE *Die, DIScope Context);
146 /// addGlobalType - Add a new global type to the compile unit.
147 void addGlobalType(DIType Ty);
149 /// addPubTypes - Add a set of types from the subprogram to the global types.
150 void addPubTypes(DISubprogram SP);
152 /// addAccelName - Add a new name to the name accelerator table.
153 void addAccelName(StringRef Name, const DIE *Die);
155 /// addAccelObjC - Add a new name to the ObjC accelerator table.
156 void addAccelObjC(StringRef Name, const DIE *Die);
158 /// addAccelNamespace - Add a new name to the namespace accelerator table.
159 void addAccelNamespace(StringRef Name, const DIE *Die);
161 /// addAccelType - Add a new type to the type accelerator table.
162 void addAccelType(StringRef Name, std::pair<const DIE *, unsigned> Die);
164 /// getDIE - Returns the debug information entry map slot for the
165 /// specified debug variable. We delegate the request to DwarfDebug
166 /// when the MDNode can be part of the type system, since DIEs for
167 /// the type system can be shared across CUs and the mappings are
168 /// kept in DwarfDebug.
169 DIE *getDIE(DIDescriptor D) const;
171 /// getDIEBlock - Returns a fresh newly allocated DIEBlock.
172 DIEBlock *getDIEBlock() { return new (DIEValueAllocator) DIEBlock(); }
174 /// insertDIE - Insert DIE into the map. We delegate the request to DwarfDebug
175 /// when the MDNode can be part of the type system, since DIEs for
176 /// the type system can be shared across CUs and the mappings are
177 /// kept in DwarfDebug.
178 void insertDIE(DIDescriptor Desc, DIE *D);
180 /// addDie - Adds or interns the DIE to the compile unit.
182 void addDie(DIE *Buffer) { CUDie->addChild(Buffer); }
184 /// addFlag - Add a flag that is true to the DIE.
185 void addFlag(DIE *Die, dwarf::Attribute Attribute);
187 /// addUInt - Add an unsigned integer attribute data and value.
188 void addUInt(DIE *Die, dwarf::Attribute Attribute, Optional<dwarf::Form> Form,
191 void addUInt(DIEBlock *Block, dwarf::Form Form, uint64_t Integer);
193 /// addSInt - Add an signed integer attribute data and value.
194 void addSInt(DIE *Die, dwarf::Attribute Attribute, Optional<dwarf::Form> Form,
197 void addSInt(DIEBlock *Die, Optional<dwarf::Form> Form, int64_t Integer);
199 /// addString - Add a string attribute data and value.
200 void addString(DIE *Die, dwarf::Attribute Attribute, const StringRef Str);
202 /// addLocalString - Add a string attribute data and value.
203 void addLocalString(DIE *Die, dwarf::Attribute Attribute,
204 const StringRef Str);
206 /// addExpr - Add a Dwarf expression attribute data and value.
207 void addExpr(DIEBlock *Die, dwarf::Form Form, const MCExpr *Expr);
209 /// addLabel - Add a Dwarf label attribute data and value.
210 void addLabel(DIE *Die, dwarf::Attribute Attribute, dwarf::Form Form,
211 const MCSymbol *Label);
213 void addLabel(DIEBlock *Die, dwarf::Form Form, const MCSymbol *Label);
215 /// addSectionLabel - Add a Dwarf section label attribute data and value.
217 void addSectionLabel(DIE *Die, dwarf::Attribute Attribute, const MCSymbol *Label);
219 /// addSectionOffset - Add an offset into a section attribute data and value.
221 void addSectionOffset(DIE *Die, dwarf::Attribute Attribute, uint64_t Integer);
223 /// addLabelAddress - Add a dwarf label attribute data and value using
224 /// either DW_FORM_addr or DW_FORM_GNU_addr_index.
225 void addLabelAddress(DIE *Die, dwarf::Attribute Attribute, MCSymbol *Label);
227 /// addOpAddress - Add a dwarf op address data and value using the
228 /// form given and an op of either DW_FORM_addr or DW_FORM_GNU_addr_index.
229 void addOpAddress(DIEBlock *Die, const MCSymbol *Label);
231 /// addSectionDelta - Add a label delta attribute data and value.
232 void addSectionDelta(DIE *Die, dwarf::Attribute Attribute, const MCSymbol *Hi,
235 /// addDIEEntry - Add a DIE attribute data and value.
236 void addDIEEntry(DIE *Die, dwarf::Attribute Attribute, DIE *Entry);
238 /// addDIEEntry - Add a DIE attribute data and value.
239 void addDIEEntry(DIE *Die, dwarf::Attribute Attribute, DIEEntry *Entry);
241 /// addBlock - Add block data.
242 void addBlock(DIE *Die, dwarf::Attribute Attribute, DIEBlock *Block);
244 /// addSourceLine - Add location information to specified debug information
246 void addSourceLine(DIE *Die, DIVariable V);
247 void addSourceLine(DIE *Die, DIGlobalVariable G);
248 void addSourceLine(DIE *Die, DISubprogram SP);
249 void addSourceLine(DIE *Die, DIType Ty);
250 void addSourceLine(DIE *Die, DINameSpace NS);
251 void addSourceLine(DIE *Die, DIObjCProperty Ty);
253 /// addAddress - Add an address attribute to a die based on the location
255 void addAddress(DIE *Die, dwarf::Attribute Attribute,
256 const MachineLocation &Location, bool Indirect = false);
258 /// addConstantValue - Add constant value entry in variable DIE.
259 void addConstantValue(DIE *Die, const MachineOperand &MO, DIType Ty);
260 void addConstantValue(DIE *Die, const ConstantInt *CI, bool Unsigned);
261 void addConstantValue(DIE *Die, const APInt &Val, bool Unsigned);
263 /// addConstantFPValue - Add constant value entry in variable DIE.
264 void addConstantFPValue(DIE *Die, const MachineOperand &MO);
265 void addConstantFPValue(DIE *Die, const ConstantFP *CFP);
267 /// addTemplateParams - Add template parameters in buffer.
268 void addTemplateParams(DIE &Buffer, DIArray TParams);
270 /// addRegisterOp - Add register operand.
271 void addRegisterOp(DIEBlock *TheDie, unsigned Reg);
273 /// addRegisterOffset - Add register offset.
274 void addRegisterOffset(DIEBlock *TheDie, unsigned Reg, int64_t Offset);
276 /// addComplexAddress - Start with the address based on the location provided,
277 /// and generate the DWARF information necessary to find the actual variable
278 /// (navigating the extra location information encoded in the type) based on
279 /// the starting location. Add the DWARF information to the die.
280 void addComplexAddress(const DbgVariable &DV, DIE *Die,
281 dwarf::Attribute Attribute,
282 const MachineLocation &Location);
284 // FIXME: Should be reformulated in terms of addComplexAddress.
285 /// addBlockByrefAddress - Start with the address based on the location
286 /// provided, and generate the DWARF information necessary to find the
287 /// actual Block variable (navigating the Block struct) based on the
288 /// starting location. Add the DWARF information to the die. Obsolete,
289 /// please use addComplexAddress instead.
290 void addBlockByrefAddress(const DbgVariable &DV, DIE *Die,
291 dwarf::Attribute Attribute,
292 const MachineLocation &Location);
294 /// addVariableAddress - Add DW_AT_location attribute for a
295 /// DbgVariable based on provided MachineLocation.
296 void addVariableAddress(const DbgVariable &DV, DIE *Die,
297 MachineLocation Location);
299 /// addType - Add a new type attribute to the specified entity. This takes
300 /// and attribute parameter because DW_AT_friend attributes are also
302 void addType(DIE *Entity, DIType Ty,
303 dwarf::Attribute Attribute = dwarf::DW_AT_type);
305 /// getOrCreateNameSpace - Create a DIE for DINameSpace.
306 DIE *getOrCreateNameSpace(DINameSpace NS);
308 /// getOrCreateSubprogramDIE - Create new DIE using SP.
309 DIE *getOrCreateSubprogramDIE(DISubprogram SP);
311 /// getOrCreateTypeDIE - Find existing DIE or create new DIE for the
313 DIE *getOrCreateTypeDIE(const MDNode *N);
315 /// getOrCreateContextDIE - Get context owner's DIE.
316 DIE *createTypeDIE(DICompositeType Ty);
318 /// getOrCreateContextDIE - Get context owner's DIE.
319 DIE *getOrCreateContextDIE(DIScope Context);
321 /// createGlobalVariableDIE - create global variable DIE.
322 void createGlobalVariableDIE(DIGlobalVariable GV);
324 /// constructContainingTypeDIEs - Construct DIEs for types that contain
326 void constructContainingTypeDIEs();
328 /// constructVariableDIE - Construct a DIE for the given DbgVariable.
329 DIE *constructVariableDIE(DbgVariable &DV, bool isScopeAbstract);
331 /// Create a DIE with the given Tag, add the DIE to its parent, and
332 /// call insertDIE if MD is not null.
333 DIE *createAndAddDIE(unsigned Tag, DIE &Parent,
334 DIDescriptor N = DIDescriptor());
336 /// constructTypeDIEImpl - Construct type DIE that is not a type unit
337 /// reference from a DICompositeType.
338 void constructTypeDIEImpl(DIE &Buffer, DICompositeType CTy);
340 /// Compute the size of a header for this unit, not including the initial
342 unsigned getHeaderSize() const {
343 return sizeof(int16_t) + // DWARF version number
344 sizeof(int32_t) + // Offset Into Abbrev. Section
345 sizeof(int8_t); // Pointer Size (in bytes)
348 /// Emit the header for this unit, not including the initial length field.
349 void emitHeader(const MCSection *ASection, const MCSymbol *ASectionSym);
352 /// constructTypeDIE - Construct basic type die from DIBasicType.
353 void constructTypeDIE(DIE &Buffer, DIBasicType BTy);
355 /// constructTypeDIE - Construct derived type die from DIDerivedType.
356 void constructTypeDIE(DIE &Buffer, DIDerivedType DTy);
358 /// constructTypeDIE - Construct type DIE from DICompositeType.
359 void constructTypeDIE(DIE &Buffer, DICompositeType CTy);
361 /// constructSubrangeDIE - Construct subrange DIE from DISubrange.
362 void constructSubrangeDIE(DIE &Buffer, DISubrange SR, DIE *IndexTy);
364 /// constructArrayTypeDIE - Construct array type DIE from DICompositeType.
365 void constructArrayTypeDIE(DIE &Buffer, DICompositeType CTy);
367 /// constructEnumTypeDIE - Construct enum type DIE from DIEnumerator.
368 void constructEnumTypeDIE(DIE &Buffer, DICompositeType CTy);
370 /// constructMemberDIE - Construct member DIE from DIDerivedType.
371 void constructMemberDIE(DIE &Buffer, DIDerivedType DT);
373 /// constructTemplateTypeParameterDIE - Construct new DIE for the given
374 /// DITemplateTypeParameter.
375 void constructTemplateTypeParameterDIE(DIE &Buffer,
376 DITemplateTypeParameter TP);
378 /// constructTemplateValueParameterDIE - Construct new DIE for the given
379 /// DITemplateValueParameter.
380 void constructTemplateValueParameterDIE(DIE &Buffer,
381 DITemplateValueParameter TVP);
383 /// getOrCreateStaticMemberDIE - Create new static data member DIE.
384 DIE *getOrCreateStaticMemberDIE(DIDerivedType DT);
386 /// getLowerBoundDefault - Return the default lower bound for an array. If the
387 /// DWARF version doesn't handle the language, return -1.
388 int64_t getDefaultLowerBound() const;
390 /// getDIEEntry - Returns the debug information entry for the specified
392 DIEEntry *getDIEEntry(const MDNode *N) const {
393 return MDNodeToDIEEntryMap.lookup(N);
396 /// insertDIEEntry - Insert debug information entry into the map.
397 void insertDIEEntry(const MDNode *N, DIEEntry *E) {
398 MDNodeToDIEEntryMap.insert(std::make_pair(N, E));
401 // getIndexTyDie - Get an anonymous type for index type.
402 DIE *getIndexTyDie() { return IndexTyDie; }
404 // setIndexTyDie - Set D as anonymous type for index which can be reused
406 void setIndexTyDie(DIE *D) { IndexTyDie = D; }
408 /// createDIEEntry - Creates a new DIEEntry to be a proxy for a debug
409 /// information entry.
410 DIEEntry *createDIEEntry(DIE *Entry);
412 /// resolve - Look in the DwarfDebug map for the MDNode that
413 /// corresponds to the reference.
414 template <typename T> T resolve(DIRef<T> Ref) const {
415 return DD->resolve(Ref);
418 /// If this is a named finished type then include it in the list of types for
419 /// the accelerator tables.
420 void updateAcceleratorTables(DIType Ty, const DIE *TyDIE);
423 } // end llvm namespace