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/OwningPtr.h"
21 #include "llvm/ADT/StringMap.h"
22 #include "llvm/DebugInfo.h"
23 #include "llvm/MC/MCExpr.h"
27 class MachineLocation;
33 //===----------------------------------------------------------------------===//
34 /// CompileUnit - This dwarf writer support class manages information associated
35 /// with a source file.
37 /// UniqueID - a numeric ID unique among all CUs in the module
41 /// Node - MDNode for the compile unit.
44 /// Die - Compile unit debug information entry.
46 const OwningPtr<DIE> CUDie;
48 /// Asm - Target of Dwarf emission.
51 // Holders for some common dwarf information.
55 /// IndexTyDie - An anonymous type for index type. Owned by CUDie.
58 /// MDNodeToDieMap - Tracks the mapping of unit level debug information
59 /// variables to debug information entries.
60 DenseMap<const MDNode *, DIE *> MDNodeToDieMap;
62 /// MDNodeToDIEEntryMap - Tracks the mapping of unit level debug information
63 /// descriptors to debug information entries using a DIEEntry proxy.
64 DenseMap<const MDNode *, DIEEntry *> MDNodeToDIEEntryMap;
66 /// GlobalNames - A map of globally visible named entities for this unit.
68 StringMap<DIE *> GlobalNames;
70 /// GlobalTypes - A map of globally visible types for this unit.
72 StringMap<DIE *> GlobalTypes;
74 /// AccelNames - A map of names for the name accelerator table.
76 StringMap<std::vector<DIE *> > AccelNames;
77 StringMap<std::vector<DIE *> > AccelObjC;
78 StringMap<std::vector<DIE *> > AccelNamespace;
79 StringMap<std::vector<std::pair<DIE *, unsigned> > > AccelTypes;
81 /// DIEBlocks - A list of all the DIEBlocks in use.
82 std::vector<DIEBlock *> DIEBlocks;
84 /// ContainingTypeMap - This map is used to keep track of subprogram DIEs that
85 /// need DW_AT_containing_type attribute. This attribute points to a DIE that
86 /// corresponds to the MDNode mapped with the subprogram DIE.
87 DenseMap<DIE *, const MDNode *> ContainingTypeMap;
89 // DIEValueAllocator - All DIEValues are allocated through this allocator.
90 BumpPtrAllocator DIEValueAllocator;
92 // DIEIntegerOne - A preallocated DIEValue because 1 is used frequently.
93 DIEInteger *DIEIntegerOne;
96 CompileUnit(unsigned UID, DIE *D, const MDNode *N, AsmPrinter *A,
97 DwarfDebug *DW, DwarfUnits *DWU);
101 unsigned getUniqueID() const { return UniqueID; }
102 uint16_t getLanguage() const { return DICompileUnit(Node).getLanguage(); }
103 const MDNode *getNode() const { return Node; }
104 DIE *getCUDie() const { return CUDie.get(); }
105 const StringMap<DIE *> &getGlobalNames() const { return GlobalNames; }
106 const StringMap<DIE *> &getGlobalTypes() const { return GlobalTypes; }
108 const StringMap<std::vector<DIE *> > &getAccelNames() const {
111 const StringMap<std::vector<DIE *> > &getAccelObjC() const {
114 const StringMap<std::vector<DIE *> > &getAccelNamespace() const {
115 return AccelNamespace;
117 const StringMap<std::vector<std::pair<DIE *, unsigned> > > &
118 getAccelTypes() const {
122 /// hasContent - Return true if this compile unit has something to write out.
124 bool hasContent() const { return !CUDie->getChildren().empty(); }
126 /// addGlobalName - Add a new global entity to the compile unit.
128 void addGlobalName(StringRef Name, DIE *Die);
130 /// addGlobalType - Add a new global type to the compile unit.
132 void addGlobalType(DIType Ty);
134 /// addPubTypes - Add a set of types from the subprogram to the global types.
135 void addPubTypes(DISubprogram SP);
137 /// addAccelName - Add a new name to the name accelerator table.
138 void addAccelName(StringRef Name, DIE *Die);
140 /// addAccelObjC - Add a new name to the ObjC accelerator table.
141 void addAccelObjC(StringRef Name, DIE *Die);
143 /// addAccelNamespace - Add a new name to the namespace accelerator table.
144 void addAccelNamespace(StringRef Name, DIE *Die);
146 /// addAccelType - Add a new type to the type accelerator table.
147 void addAccelType(StringRef Name, std::pair<DIE *, unsigned> Die);
149 /// getDIE - Returns the debug information entry map slot for the
150 /// specified debug variable.
151 DIE *getDIE(const MDNode *N) const { return MDNodeToDieMap.lookup(N); }
153 DIEBlock *getDIEBlock() { return new (DIEValueAllocator) DIEBlock(); }
155 /// insertDIE - Insert DIE into the map.
156 void insertDIE(const MDNode *N, DIE *D) {
157 MDNodeToDieMap.insert(std::make_pair(N, D));
160 /// addDie - Adds or interns the DIE to the compile unit.
162 void addDie(DIE *Buffer) { CUDie->addChild(Buffer); }
164 /// addFlag - Add a flag that is true to the DIE.
165 void addFlag(DIE *Die, uint16_t Attribute);
167 /// addUInt - Add an unsigned integer attribute data and value.
169 void addUInt(DIE *Die, uint16_t Attribute, uint16_t Form, uint64_t Integer);
171 /// addSInt - Add an signed integer attribute data and value.
173 void addSInt(DIE *Die, uint16_t Attribute, uint16_t Form, int64_t Integer);
175 /// addString - Add a string attribute data and value.
177 void addString(DIE *Die, uint16_t Attribute, const StringRef Str);
179 /// addLocalString - Add a string attribute data and value.
181 void addLocalString(DIE *Die, uint16_t Attribute, const StringRef Str);
183 /// addExpr - Add a Dwarf expression attribute data and value.
185 void addExpr(DIE *Die, uint16_t Attribute, uint16_t Form, const MCExpr *Expr);
187 /// addLabel - Add a Dwarf label attribute data and value.
189 void addLabel(DIE *Die, uint16_t Attribute, uint16_t Form,
190 const MCSymbol *Label);
192 /// addLabelAddress - Add a dwarf label attribute data and value using
193 /// either DW_FORM_addr or DW_FORM_GNU_addr_index.
195 void addLabelAddress(DIE *Die, uint16_t Attribute, MCSymbol *Label);
197 /// addOpAddress - Add a dwarf op address data and value using the
198 /// form given and an op of either DW_FORM_addr or DW_FORM_GNU_addr_index.
200 void addOpAddress(DIE *Die, const MCSymbol *Label);
201 void addOpAddress(DIE *Die, const MCSymbolRefExpr *Label);
203 /// addDelta - Add a label delta attribute data and value.
205 void addDelta(DIE *Die, uint16_t Attribute, uint16_t Form, const MCSymbol *Hi,
208 /// addDIEEntry - Add a DIE attribute data and value.
210 void addDIEEntry(DIE *Die, uint16_t Attribute, uint16_t Form, DIE *Entry);
212 /// addBlock - Add block data.
214 void addBlock(DIE *Die, uint16_t Attribute, uint16_t Form, DIEBlock *Block);
216 /// addSourceLine - Add location information to specified debug information
218 void addSourceLine(DIE *Die, DIVariable V);
219 void addSourceLine(DIE *Die, DIGlobalVariable G);
220 void addSourceLine(DIE *Die, DISubprogram SP);
221 void addSourceLine(DIE *Die, DIType Ty);
222 void addSourceLine(DIE *Die, DINameSpace NS);
223 void addSourceLine(DIE *Die, DIObjCProperty Ty);
225 /// addAddress - Add an address attribute to a die based on the location
227 void addAddress(DIE *Die, uint16_t Attribute, const MachineLocation &Location,
228 bool Indirect = false);
230 /// addConstantValue - Add constant value entry in variable DIE.
231 void addConstantValue(DIE *Die, const MachineOperand &MO, DIType Ty);
232 void addConstantValue(DIE *Die, const ConstantInt *CI, bool Unsigned);
233 void addConstantValue(DIE *Die, const APInt &Val, bool Unsigned);
235 /// addConstantFPValue - Add constant value entry in variable DIE.
236 void addConstantFPValue(DIE *Die, const MachineOperand &MO);
237 void addConstantFPValue(DIE *Die, const ConstantFP *CFP);
239 /// addTemplateParams - Add template parameters in buffer.
240 void addTemplateParams(DIE &Buffer, DIArray TParams);
242 /// addRegisterOp - Add register operand.
243 void addRegisterOp(DIE *TheDie, unsigned Reg);
245 /// addRegisterOffset - Add register offset.
246 void addRegisterOffset(DIE *TheDie, unsigned Reg, int64_t Offset);
248 /// addComplexAddress - Start with the address based on the location provided,
249 /// and generate the DWARF information necessary to find the actual variable
250 /// (navigating the extra location information encoded in the type) based on
251 /// the starting location. Add the DWARF information to the die.
253 void addComplexAddress(const DbgVariable &DV, DIE *Die, uint16_t Attribute,
254 const MachineLocation &Location);
256 // FIXME: Should be reformulated in terms of addComplexAddress.
257 /// addBlockByrefAddress - Start with the address based on the location
258 /// provided, and generate the DWARF information necessary to find the
259 /// actual Block variable (navigating the Block struct) based on the
260 /// starting location. Add the DWARF information to the die. Obsolete,
261 /// please use addComplexAddress instead.
263 void addBlockByrefAddress(const DbgVariable &DV, DIE *Die, uint16_t Attribute,
264 const MachineLocation &Location);
266 /// addVariableAddress - Add DW_AT_location attribute for a
267 /// DbgVariable based on provided MachineLocation.
268 void addVariableAddress(const DbgVariable &DV, DIE *Die,
269 MachineLocation Location);
271 /// addToContextOwner - Add Die into the list of its context owner's children.
272 void addToContextOwner(DIE *Die, DIScope Context);
274 /// addType - Add a new type attribute to the specified entity. This takes
275 /// and attribute parameter because DW_AT_friend attributes are also
277 void addType(DIE *Entity, DIType Ty, uint16_t Attribute = dwarf::DW_AT_type);
279 /// getOrCreateNameSpace - Create a DIE for DINameSpace.
280 DIE *getOrCreateNameSpace(DINameSpace NS);
282 /// getOrCreateSubprogramDIE - Create new DIE using SP.
283 DIE *getOrCreateSubprogramDIE(DISubprogram SP);
285 /// getOrCreateTypeDIE - Find existing DIE or create new DIE for the
287 DIE *getOrCreateTypeDIE(const MDNode *N);
289 /// getOrCreateTemplateTypeParameterDIE - Find existing DIE or create new DIE
290 /// for the given DITemplateTypeParameter.
291 DIE *getOrCreateTemplateTypeParameterDIE(DITemplateTypeParameter TP);
293 /// getOrCreateTemplateValueParameterDIE - Find existing DIE or create
294 /// new DIE for the given DITemplateValueParameter.
295 DIE *getOrCreateTemplateValueParameterDIE(DITemplateValueParameter TVP);
297 /// getOrCreateContextDIE - Get context owner's DIE.
298 DIE *getOrCreateContextDIE(DIScope Context);
300 /// createGlobalVariableDIE - create global variable DIE.
301 void createGlobalVariableDIE(const MDNode *N);
303 /// constructContainingTypeDIEs - Construct DIEs for types that contain
305 void constructContainingTypeDIEs();
307 /// constructVariableDIE - Construct a DIE for the given DbgVariable.
308 DIE *constructVariableDIE(DbgVariable *DV, bool isScopeAbstract);
311 /// constructTypeDIE - Construct basic type die from DIBasicType.
312 void constructTypeDIE(DIE &Buffer, DIBasicType BTy);
314 /// constructTypeDIE - Construct derived type die from DIDerivedType.
315 void constructTypeDIE(DIE &Buffer, DIDerivedType DTy);
317 /// constructTypeDIE - Construct type DIE from DICompositeType.
318 void constructTypeDIE(DIE &Buffer, DICompositeType CTy);
320 /// constructSubrangeDIE - Construct subrange DIE from DISubrange.
321 void constructSubrangeDIE(DIE &Buffer, DISubrange SR, DIE *IndexTy);
323 /// constructArrayTypeDIE - Construct array type DIE from DICompositeType.
324 void constructArrayTypeDIE(DIE &Buffer, DICompositeType *CTy);
326 /// constructEnumTypeDIE - Construct enum type DIE from DIEnumerator.
327 DIE *constructEnumTypeDIE(DIEnumerator ETy);
329 /// createMemberDIE - Create new member DIE.
330 DIE *createMemberDIE(DIDerivedType DT);
332 /// createStaticMemberDIE - Create new static data member DIE.
333 DIE *createStaticMemberDIE(DIDerivedType DT);
335 /// getLowerBoundDefault - Return the default lower bound for an array. If the
336 /// DWARF version doesn't handle the language, return -1.
337 int64_t getDefaultLowerBound() const;
339 /// getDIEEntry - Returns the debug information entry for the specified
341 DIEEntry *getDIEEntry(const MDNode *N) const {
342 return MDNodeToDIEEntryMap.lookup(N);
345 /// insertDIEEntry - Insert debug information entry into the map.
346 void insertDIEEntry(const MDNode *N, DIEEntry *E) {
347 MDNodeToDIEEntryMap.insert(std::make_pair(N, E));
350 // getIndexTyDie - Get an anonymous type for index type.
351 DIE *getIndexTyDie() { return IndexTyDie; }
353 // setIndexTyDie - Set D as anonymous type for index which can be reused
355 void setIndexTyDie(DIE *D) { IndexTyDie = D; }
357 /// createDIEEntry - Creates a new DIEEntry to be a proxy for a debug
358 /// information entry.
359 DIEEntry *createDIEEntry(DIE *Entry);
361 /// resolve - Look in the DwarfDebug map for the MDNode that
362 /// corresponds to the reference.
363 template <typename T> T resolve(DIRef<T> Ref) const {
364 return DD->resolve(Ref);
368 } // end llvm namespace