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 /// addAccelName - Add a new name to the name accelerator table.
147 void addAccelName(StringRef Name, const DIE *Die);
149 /// addAccelObjC - Add a new name to the ObjC accelerator table.
150 void addAccelObjC(StringRef Name, const DIE *Die);
152 /// addAccelNamespace - Add a new name to the namespace accelerator table.
153 void addAccelNamespace(StringRef Name, const DIE *Die);
155 /// addAccelType - Add a new type to the type accelerator table.
156 void addAccelType(StringRef Name, std::pair<const DIE *, unsigned> Die);
158 /// getDIE - Returns the debug information entry map slot for the
159 /// specified debug variable. We delegate the request to DwarfDebug
160 /// when the MDNode can be part of the type system, since DIEs for
161 /// the type system can be shared across CUs and the mappings are
162 /// kept in DwarfDebug.
163 DIE *getDIE(DIDescriptor D) const;
165 /// getDIEBlock - Returns a fresh newly allocated DIEBlock.
166 DIEBlock *getDIEBlock() { return new (DIEValueAllocator) DIEBlock(); }
168 /// insertDIE - Insert DIE into the map. We delegate the request to DwarfDebug
169 /// when the MDNode can be part of the type system, since DIEs for
170 /// the type system can be shared across CUs and the mappings are
171 /// kept in DwarfDebug.
172 void insertDIE(DIDescriptor Desc, DIE *D);
174 /// addDie - Adds or interns the DIE to the compile unit.
176 void addDie(DIE *Buffer) { CUDie->addChild(Buffer); }
178 /// addFlag - Add a flag that is true to the DIE.
179 void addFlag(DIE *Die, dwarf::Attribute Attribute);
181 /// addUInt - Add an unsigned integer attribute data and value.
182 void addUInt(DIE *Die, dwarf::Attribute Attribute, Optional<dwarf::Form> Form,
185 void addUInt(DIEBlock *Block, dwarf::Form Form, uint64_t Integer);
187 /// addSInt - Add an signed integer attribute data and value.
188 void addSInt(DIE *Die, dwarf::Attribute Attribute, Optional<dwarf::Form> Form,
191 void addSInt(DIEBlock *Die, Optional<dwarf::Form> Form, int64_t Integer);
193 /// addString - Add a string attribute data and value.
194 void addString(DIE *Die, dwarf::Attribute Attribute, const StringRef Str);
196 /// addLocalString - Add a string attribute data and value.
197 void addLocalString(DIE *Die, dwarf::Attribute Attribute,
198 const StringRef Str);
200 /// addExpr - Add a Dwarf expression attribute data and value.
201 void addExpr(DIEBlock *Die, dwarf::Form Form, const MCExpr *Expr);
203 /// addLabel - Add a Dwarf label attribute data and value.
204 void addLabel(DIE *Die, dwarf::Attribute Attribute, dwarf::Form Form,
205 const MCSymbol *Label);
207 void addLabel(DIEBlock *Die, dwarf::Form Form, const MCSymbol *Label);
209 /// addSectionLabel - Add a Dwarf section label attribute data and value.
211 void addSectionLabel(DIE *Die, dwarf::Attribute Attribute, const MCSymbol *Label);
213 /// addSectionOffset - Add an offset into a section attribute data and value.
215 void addSectionOffset(DIE *Die, dwarf::Attribute Attribute, uint64_t Integer);
217 /// addLabelAddress - Add a dwarf label attribute data and value using
218 /// either DW_FORM_addr or DW_FORM_GNU_addr_index.
219 void addLabelAddress(DIE *Die, dwarf::Attribute Attribute, MCSymbol *Label);
221 /// addOpAddress - Add a dwarf op address data and value using the
222 /// form given and an op of either DW_FORM_addr or DW_FORM_GNU_addr_index.
223 void addOpAddress(DIEBlock *Die, const MCSymbol *Label);
225 /// addSectionDelta - Add a label delta attribute data and value.
226 void addSectionDelta(DIE *Die, dwarf::Attribute Attribute, const MCSymbol *Hi,
229 /// addDIEEntry - Add a DIE attribute data and value.
230 void addDIEEntry(DIE *Die, dwarf::Attribute Attribute, DIE *Entry);
232 /// addDIEEntry - Add a DIE attribute data and value.
233 void addDIEEntry(DIE *Die, dwarf::Attribute Attribute, DIEEntry *Entry);
235 /// addBlock - Add block data.
236 void addBlock(DIE *Die, dwarf::Attribute Attribute, DIEBlock *Block);
238 /// addSourceLine - Add location information to specified debug information
240 void addSourceLine(DIE *Die, DIVariable V);
241 void addSourceLine(DIE *Die, DIGlobalVariable G);
242 void addSourceLine(DIE *Die, DISubprogram SP);
243 void addSourceLine(DIE *Die, DIType Ty);
244 void addSourceLine(DIE *Die, DINameSpace NS);
245 void addSourceLine(DIE *Die, DIObjCProperty Ty);
247 /// addAddress - Add an address attribute to a die based on the location
249 void addAddress(DIE *Die, dwarf::Attribute Attribute,
250 const MachineLocation &Location, bool Indirect = false);
252 /// addConstantValue - Add constant value entry in variable DIE.
253 void addConstantValue(DIE *Die, const MachineOperand &MO, DIType Ty);
254 void addConstantValue(DIE *Die, const ConstantInt *CI, bool Unsigned);
255 void addConstantValue(DIE *Die, const APInt &Val, bool Unsigned);
257 /// addConstantFPValue - Add constant value entry in variable DIE.
258 void addConstantFPValue(DIE *Die, const MachineOperand &MO);
259 void addConstantFPValue(DIE *Die, const ConstantFP *CFP);
261 /// addTemplateParams - Add template parameters in buffer.
262 void addTemplateParams(DIE &Buffer, DIArray TParams);
264 /// addRegisterOp - Add register operand.
265 void addRegisterOp(DIEBlock *TheDie, unsigned Reg);
267 /// addRegisterOffset - Add register offset.
268 void addRegisterOffset(DIEBlock *TheDie, unsigned Reg, int64_t Offset);
270 /// addComplexAddress - Start with the address based on the location provided,
271 /// and generate the DWARF information necessary to find the actual variable
272 /// (navigating the extra location information encoded in the type) based on
273 /// the starting location. Add the DWARF information to the die.
274 void addComplexAddress(const DbgVariable &DV, DIE *Die,
275 dwarf::Attribute Attribute,
276 const MachineLocation &Location);
278 // FIXME: Should be reformulated in terms of addComplexAddress.
279 /// addBlockByrefAddress - Start with the address based on the location
280 /// provided, and generate the DWARF information necessary to find the
281 /// actual Block variable (navigating the Block struct) based on the
282 /// starting location. Add the DWARF information to the die. Obsolete,
283 /// please use addComplexAddress instead.
284 void addBlockByrefAddress(const DbgVariable &DV, DIE *Die,
285 dwarf::Attribute Attribute,
286 const MachineLocation &Location);
288 /// addVariableAddress - Add DW_AT_location attribute for a
289 /// DbgVariable based on provided MachineLocation.
290 void addVariableAddress(const DbgVariable &DV, DIE *Die,
291 MachineLocation Location);
293 /// addType - Add a new type attribute to the specified entity. This takes
294 /// and attribute parameter because DW_AT_friend attributes are also
296 void addType(DIE *Entity, DIType Ty,
297 dwarf::Attribute Attribute = dwarf::DW_AT_type);
299 /// getOrCreateNameSpace - Create a DIE for DINameSpace.
300 DIE *getOrCreateNameSpace(DINameSpace NS);
302 /// getOrCreateSubprogramDIE - Create new DIE using SP.
303 DIE *getOrCreateSubprogramDIE(DISubprogram SP);
305 /// getOrCreateTypeDIE - Find existing DIE or create new DIE for the
307 DIE *getOrCreateTypeDIE(const MDNode *N);
309 /// getOrCreateContextDIE - Get context owner's DIE.
310 DIE *createTypeDIE(DICompositeType Ty);
312 /// getOrCreateContextDIE - Get context owner's DIE.
313 DIE *getOrCreateContextDIE(DIScope Context);
315 /// createGlobalVariableDIE - create global variable DIE.
316 void createGlobalVariableDIE(DIGlobalVariable GV);
318 /// constructContainingTypeDIEs - Construct DIEs for types that contain
320 void constructContainingTypeDIEs();
322 /// constructVariableDIE - Construct a DIE for the given DbgVariable.
323 DIE *constructVariableDIE(DbgVariable &DV, bool isScopeAbstract);
325 /// Create a DIE with the given Tag, add the DIE to its parent, and
326 /// call insertDIE if MD is not null.
327 DIE *createAndAddDIE(unsigned Tag, DIE &Parent,
328 DIDescriptor N = DIDescriptor());
330 /// constructTypeDIEImpl - Construct type DIE that is not a type unit
331 /// reference from a DICompositeType.
332 void constructTypeDIEImpl(DIE &Buffer, DICompositeType CTy);
334 /// Compute the size of a header for this unit, not including the initial
336 unsigned getHeaderSize() const {
337 return sizeof(int16_t) + // DWARF version number
338 sizeof(int32_t) + // Offset Into Abbrev. Section
339 sizeof(int8_t); // Pointer Size (in bytes)
342 /// Emit the header for this unit, not including the initial length field.
343 void emitHeader(const MCSection *ASection, const MCSymbol *ASectionSym);
346 /// constructTypeDIE - Construct basic type die from DIBasicType.
347 void constructTypeDIE(DIE &Buffer, DIBasicType BTy);
349 /// constructTypeDIE - Construct derived type die from DIDerivedType.
350 void constructTypeDIE(DIE &Buffer, DIDerivedType DTy);
352 /// constructTypeDIE - Construct type DIE from DICompositeType.
353 void constructTypeDIE(DIE &Buffer, DICompositeType CTy);
355 /// constructSubrangeDIE - Construct subrange DIE from DISubrange.
356 void constructSubrangeDIE(DIE &Buffer, DISubrange SR, DIE *IndexTy);
358 /// constructArrayTypeDIE - Construct array type DIE from DICompositeType.
359 void constructArrayTypeDIE(DIE &Buffer, DICompositeType CTy);
361 /// constructEnumTypeDIE - Construct enum type DIE from DIEnumerator.
362 void constructEnumTypeDIE(DIE &Buffer, DICompositeType CTy);
364 /// constructMemberDIE - Construct member DIE from DIDerivedType.
365 void constructMemberDIE(DIE &Buffer, DIDerivedType DT);
367 /// constructTemplateTypeParameterDIE - Construct new DIE for the given
368 /// DITemplateTypeParameter.
369 void constructTemplateTypeParameterDIE(DIE &Buffer,
370 DITemplateTypeParameter TP);
372 /// constructTemplateValueParameterDIE - Construct new DIE for the given
373 /// DITemplateValueParameter.
374 void constructTemplateValueParameterDIE(DIE &Buffer,
375 DITemplateValueParameter TVP);
377 /// getOrCreateStaticMemberDIE - Create new static data member DIE.
378 DIE *getOrCreateStaticMemberDIE(DIDerivedType DT);
380 /// getLowerBoundDefault - Return the default lower bound for an array. If the
381 /// DWARF version doesn't handle the language, return -1.
382 int64_t getDefaultLowerBound() const;
384 /// getDIEEntry - Returns the debug information entry for the specified
386 DIEEntry *getDIEEntry(const MDNode *N) const {
387 return MDNodeToDIEEntryMap.lookup(N);
390 /// insertDIEEntry - Insert debug information entry into the map.
391 void insertDIEEntry(const MDNode *N, DIEEntry *E) {
392 MDNodeToDIEEntryMap.insert(std::make_pair(N, E));
395 // getIndexTyDie - Get an anonymous type for index type.
396 DIE *getIndexTyDie() { return IndexTyDie; }
398 // setIndexTyDie - Set D as anonymous type for index which can be reused
400 void setIndexTyDie(DIE *D) { IndexTyDie = D; }
402 /// createDIEEntry - Creates a new DIEEntry to be a proxy for a debug
403 /// information entry.
404 DIEEntry *createDIEEntry(DIE *Entry);
406 /// resolve - Look in the DwarfDebug map for the MDNode that
407 /// corresponds to the reference.
408 template <typename T> T resolve(DIRef<T> Ref) const {
409 return DD->resolve(Ref);
412 /// If this is a named finished type then include it in the list of types for
413 /// the accelerator tables.
414 void updateAcceleratorTables(DIScope Context, DIType Ty, const DIE *TyDIE);
417 } // end llvm namespace