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
42 /// Node - MDNode for the compile unit.
45 /// CUDie - Compile unit debug information entry.
47 const OwningPtr<DIE> CUDie;
49 /// Asm - Target of Dwarf emission.
52 // Holders for some common dwarf information.
56 /// IndexTyDie - An anonymous type for index type. Owned by CUDie.
59 /// MDNodeToDieMap - Tracks the mapping of unit level debug information
60 /// variables to debug information entries.
61 DenseMap<const MDNode *, DIE *> MDNodeToDieMap;
63 /// MDNodeToDIEEntryMap - Tracks the mapping of unit level debug information
64 /// descriptors to debug information entries using a DIEEntry proxy.
65 DenseMap<const MDNode *, DIEEntry *> MDNodeToDIEEntryMap;
67 /// GlobalNames - A map of globally visible named entities for this unit.
69 StringMap<DIE *> GlobalNames;
71 /// GlobalTypes - A map of globally visible types for this unit.
73 StringMap<DIE *> GlobalTypes;
75 /// AccelNames - A map of names for the name accelerator table.
77 StringMap<std::vector<const DIE *> > AccelNames;
78 StringMap<std::vector<const DIE *> > AccelObjC;
79 StringMap<std::vector<const DIE *> > AccelNamespace;
80 StringMap<std::vector<std::pair<const DIE *, unsigned> > > AccelTypes;
82 /// DIEBlocks - A list of all the DIEBlocks in use.
83 std::vector<DIEBlock *> DIEBlocks;
85 /// ContainingTypeMap - This map is used to keep track of subprogram DIEs that
86 /// need DW_AT_containing_type attribute. This attribute points to a DIE that
87 /// corresponds to the MDNode mapped with the subprogram DIE.
88 DenseMap<DIE *, const MDNode *> ContainingTypeMap;
90 // DIEValueAllocator - All DIEValues are allocated through this allocator.
91 BumpPtrAllocator DIEValueAllocator;
93 // DIEIntegerOne - A preallocated DIEValue because 1 is used frequently.
94 DIEInteger *DIEIntegerOne;
99 CompileUnit(unsigned UID, DIE *D, DICompileUnit CU, AsmPrinter *A,
100 DwarfDebug *DW, DwarfUnits *DWU);
101 CompileUnit(unsigned UID, DIE *D, uint16_t Language, AsmPrinter *A,
102 DwarfDebug *DW, DwarfUnits *DWU);
106 unsigned getUniqueID() const { return UniqueID; }
107 uint16_t getLanguage() const { return Language; }
108 DICompileUnit getNode() const { return Node; }
109 DIE *getCUDie() const { return CUDie.get(); }
110 const StringMap<DIE *> &getGlobalNames() const { return GlobalNames; }
111 const StringMap<DIE *> &getGlobalTypes() const { return GlobalTypes; }
113 const StringMap<std::vector<const DIE *> > &getAccelNames() const {
116 const StringMap<std::vector<const DIE *> > &getAccelObjC() const {
119 const StringMap<std::vector<const DIE *> > &getAccelNamespace() const {
120 return AccelNamespace;
122 const StringMap<std::vector<std::pair<const DIE *, unsigned> > > &
123 getAccelTypes() const {
127 unsigned getDebugInfoOffset() const { return DebugInfoOffset; }
128 void setDebugInfoOffset(unsigned DbgInfoOff) { DebugInfoOffset = DbgInfoOff; }
130 /// hasContent - Return true if this compile unit has something to write out.
132 bool hasContent() const { return !CUDie->getChildren().empty(); }
134 /// getParentContextString - Get a string containing the language specific
135 /// context for a global name.
136 std::string getParentContextString(DIScope Context) const;
138 /// addGlobalName - Add a new global entity to the compile unit.
140 void addGlobalName(StringRef Name, DIE *Die, DIScope Context);
142 /// addGlobalType - Add a new global type to the compile unit.
144 void addGlobalType(DIType Ty);
146 /// addPubTypes - Add a set of types from the subprogram to the global types.
147 void addPubTypes(DISubprogram SP);
149 /// addAccelName - Add a new name to the name accelerator table.
150 void addAccelName(StringRef Name, const DIE *Die);
152 /// addAccelObjC - Add a new name to the ObjC accelerator table.
153 void addAccelObjC(StringRef Name, const DIE *Die);
155 /// addAccelNamespace - Add a new name to the namespace accelerator table.
156 void addAccelNamespace(StringRef Name, const DIE *Die);
158 /// addAccelType - Add a new type to the type accelerator table.
159 void addAccelType(StringRef Name, std::pair<const DIE *, unsigned> Die);
161 /// getDIE - Returns the debug information entry map slot for the
162 /// specified debug variable. We delegate the request to DwarfDebug
163 /// when the MDNode can be part of the type system, since DIEs for
164 /// the type system can be shared across CUs and the mappings are
165 /// kept in DwarfDebug.
166 DIE *getDIE(DIDescriptor D) const;
168 DIEBlock *getDIEBlock() { return new (DIEValueAllocator) DIEBlock(); }
170 /// insertDIE - Insert DIE into the map. We delegate the request to DwarfDebug
171 /// when the MDNode can be part of the type system, since DIEs for
172 /// the type system can be shared across CUs and the mappings are
173 /// kept in DwarfDebug.
174 void insertDIE(DIDescriptor Desc, DIE *D);
176 /// addDie - Adds or interns the DIE to the compile unit.
178 void addDie(DIE *Buffer) { CUDie->addChild(Buffer); }
180 /// addFlag - Add a flag that is true to the DIE.
181 void addFlag(DIE *Die, dwarf::Attribute Attribute);
183 /// addUInt - Add an unsigned integer attribute data and value.
185 void addUInt(DIE *Die, dwarf::Attribute Attribute, Optional<dwarf::Form> Form,
188 void addUInt(DIEBlock *Block, dwarf::Form Form, uint64_t Integer);
190 /// addSInt - Add an signed integer attribute data and value.
192 void addSInt(DIE *Die, dwarf::Attribute Attribute, Optional<dwarf::Form> Form,
195 void addSInt(DIEBlock *Die, Optional<dwarf::Form> Form, int64_t Integer);
197 /// addString - Add a string attribute data and value.
199 void addString(DIE *Die, dwarf::Attribute Attribute, const StringRef Str);
201 /// 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.
208 void addExpr(DIEBlock *Die, dwarf::Form Form, const MCExpr *Expr);
210 /// addLabel - Add a Dwarf label attribute data and value.
212 void addLabel(DIE *Die, dwarf::Attribute Attribute, dwarf::Form Form,
213 const MCSymbol *Label);
215 void addLabel(DIEBlock *Die, dwarf::Form Form, const MCSymbol *Label);
217 /// addLabelAddress - Add a dwarf label attribute data and value using
218 /// either DW_FORM_addr or DW_FORM_GNU_addr_index.
220 void addLabelAddress(DIE *Die, dwarf::Attribute Attribute, MCSymbol *Label);
222 /// addOpAddress - Add a dwarf op address data and value using the
223 /// form given and an op of either DW_FORM_addr or DW_FORM_GNU_addr_index.
225 void addOpAddress(DIEBlock *Die, const MCSymbol *Label);
227 /// addDelta - Add a label delta attribute data and value.
229 void addDelta(DIE *Die, dwarf::Attribute Attribute, dwarf::Form Form,
230 const MCSymbol *Hi, const MCSymbol *Lo);
232 /// addDIEEntry - Add a DIE attribute data and value.
234 void addDIEEntry(DIE *Die, dwarf::Attribute Attribute, DIE *Entry);
236 /// addDIEEntry - Add a DIE attribute data and value.
238 void addDIEEntry(DIE *Die, dwarf::Attribute Attribute, DIEEntry *Entry);
240 /// 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.
281 void addComplexAddress(const DbgVariable &DV, DIE *Die,
282 dwarf::Attribute Attribute,
283 const MachineLocation &Location);
285 // FIXME: Should be reformulated in terms of addComplexAddress.
286 /// addBlockByrefAddress - Start with the address based on the location
287 /// provided, and generate the DWARF information necessary to find the
288 /// actual Block variable (navigating the Block struct) based on the
289 /// starting location. Add the DWARF information to the die. Obsolete,
290 /// please use addComplexAddress instead.
292 void addBlockByrefAddress(const DbgVariable &DV, DIE *Die,
293 dwarf::Attribute Attribute,
294 const MachineLocation &Location);
296 /// addVariableAddress - Add DW_AT_location attribute for a
297 /// DbgVariable based on provided MachineLocation.
298 void addVariableAddress(const DbgVariable &DV, DIE *Die,
299 MachineLocation Location);
301 /// addType - Add a new type attribute to the specified entity. This takes
302 /// and attribute parameter because DW_AT_friend attributes are also
304 void addType(DIE *Entity, DIType Ty,
305 dwarf::Attribute Attribute = dwarf::DW_AT_type);
307 /// getOrCreateNameSpace - Create a DIE for DINameSpace.
308 DIE *getOrCreateNameSpace(DINameSpace NS);
310 /// getOrCreateSubprogramDIE - Create new DIE using SP.
311 DIE *getOrCreateSubprogramDIE(DISubprogram SP);
313 /// getOrCreateTypeDIE - Find existing DIE or create new DIE for the
315 DIE *getOrCreateTypeDIE(const MDNode *N);
317 /// getOrCreateContextDIE - Get context owner's DIE.
318 DIE *createTypeDIE(DICompositeType Ty);
320 /// getOrCreateContextDIE - Get context owner's DIE.
321 DIE *getOrCreateContextDIE(DIScope Context);
323 /// createGlobalVariableDIE - create global variable DIE.
324 void createGlobalVariableDIE(DIGlobalVariable GV);
326 /// constructContainingTypeDIEs - Construct DIEs for types that contain
328 void constructContainingTypeDIEs();
330 /// constructVariableDIE - Construct a DIE for the given DbgVariable.
331 DIE *constructVariableDIE(DbgVariable &DV, bool isScopeAbstract);
333 /// Create a DIE with the given Tag, add the DIE to its parent, and
334 /// call insertDIE if MD is not null.
335 DIE *createAndAddDIE(unsigned Tag, DIE &Parent,
336 DIDescriptor N = DIDescriptor());
338 /// constructTypeDIEImpl - Construct type DIE that is not a type unit
339 /// reference from a DICompositeType.
340 void constructTypeDIEImpl(DIE &Buffer, DICompositeType CTy);
342 /// Compute the size of a header for this unit, not including the initial
344 unsigned getHeaderSize() const {
345 return sizeof(int16_t) + // DWARF version number
346 sizeof(int32_t) + // Offset Into Abbrev. Section
347 sizeof(int8_t); // Pointer Size (in bytes)
350 /// Emit the header for this unit, not including the initial length field.
351 void emitHeader(const MCSection *ASection, const MCSymbol *ASectionSym);
354 /// constructTypeDIE - Construct basic type die from DIBasicType.
355 void constructTypeDIE(DIE &Buffer, DIBasicType BTy);
357 /// constructTypeDIE - Construct derived type die from DIDerivedType.
358 void constructTypeDIE(DIE &Buffer, DIDerivedType DTy);
360 /// constructTypeDIE - Construct type DIE from DICompositeType.
361 void constructTypeDIE(DIE &Buffer, DICompositeType CTy);
363 /// constructSubrangeDIE - Construct subrange DIE from DISubrange.
364 void constructSubrangeDIE(DIE &Buffer, DISubrange SR, DIE *IndexTy);
366 /// constructArrayTypeDIE - Construct array type DIE from DICompositeType.
367 void constructArrayTypeDIE(DIE &Buffer, DICompositeType CTy);
369 /// constructEnumTypeDIE - Construct enum type DIE from DIEnumerator.
370 void constructEnumTypeDIE(DIE &Buffer, DICompositeType CTy);
372 /// constructMemberDIE - Construct member DIE from DIDerivedType.
373 void constructMemberDIE(DIE &Buffer, DIDerivedType DT);
375 /// constructTemplateTypeParameterDIE - Construct new DIE for the given
376 /// DITemplateTypeParameter.
377 void constructTemplateTypeParameterDIE(DIE &Buffer,
378 DITemplateTypeParameter TP);
380 /// constructTemplateValueParameterDIE - Construct new DIE for the given
381 /// DITemplateValueParameter.
382 void constructTemplateValueParameterDIE(DIE &Buffer,
383 DITemplateValueParameter TVP);
385 /// getOrCreateStaticMemberDIE - Create new static data member DIE.
386 DIE *getOrCreateStaticMemberDIE(DIDerivedType DT);
388 /// Offset of the CUDie from beginning of debug info section.
389 unsigned DebugInfoOffset;
391 /// getLowerBoundDefault - Return the default lower bound for an array. If the
392 /// DWARF version doesn't handle the language, return -1.
393 int64_t getDefaultLowerBound() const;
395 /// getDIEEntry - Returns the debug information entry for the specified
397 DIEEntry *getDIEEntry(const MDNode *N) const {
398 return MDNodeToDIEEntryMap.lookup(N);
401 /// insertDIEEntry - Insert debug information entry into the map.
402 void insertDIEEntry(const MDNode *N, DIEEntry *E) {
403 MDNodeToDIEEntryMap.insert(std::make_pair(N, E));
406 // getIndexTyDie - Get an anonymous type for index type.
407 DIE *getIndexTyDie() { return IndexTyDie; }
409 // setIndexTyDie - Set D as anonymous type for index which can be reused
411 void setIndexTyDie(DIE *D) { IndexTyDie = D; }
413 /// createDIEEntry - Creates a new DIEEntry to be a proxy for a debug
414 /// information entry.
415 DIEEntry *createDIEEntry(DIE *Entry);
417 /// resolve - Look in the DwarfDebug map for the MDNode that
418 /// corresponds to the reference.
419 template <typename T> T resolve(DIRef<T> Ref) const {
420 return DD->resolve(Ref);
423 /// If this is a named finished type then include it in the list of types for
424 /// the accelerator tables.
425 void updateAcceleratorTables(DIType Ty, const DIE *TyDIE);
428 } // end llvm namespace