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 "llvm/ADT/DenseMap.h"
19 #include "llvm/ADT/OwningPtr.h"
20 #include "llvm/ADT/StringMap.h"
21 #include "llvm/DebugInfo.h"
27 class MachineLocation;
32 //===----------------------------------------------------------------------===//
33 /// CompileUnit - This dwarf writer support class manages information associated
34 /// with a source file.
36 /// UniqueID - a numeric ID unique among all CUs in the module
40 /// Language - The DW_AT_language of 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 informaton
59 /// variables to debug information entries.
60 DenseMap<const MDNode *, DIE *> MDNodeToDieMap;
62 /// MDNodeToDIEEntryMap - Tracks the mapping of unit level debug informaton
63 /// descriptors to debug information entries using a DIEEntry proxy.
64 DenseMap<const MDNode *, DIEEntry *> MDNodeToDIEEntryMap;
66 /// GlobalTypes - A map of globally visible types for this unit.
68 StringMap<DIE*> GlobalTypes;
70 /// AccelNames - A map of names for the name accelerator table.
72 StringMap<std::vector<DIE*> > AccelNames;
73 StringMap<std::vector<DIE*> > AccelObjC;
74 StringMap<std::vector<DIE*> > AccelNamespace;
75 StringMap<std::vector<std::pair<DIE*, unsigned> > > AccelTypes;
77 /// DIEBlocks - A list of all the DIEBlocks in use.
78 std::vector<DIEBlock *> DIEBlocks;
80 /// ContainingTypeMap - This map is used to keep track of subprogram DIEs that
81 /// need DW_AT_containing_type attribute. This attribute points to a DIE that
82 /// corresponds to the MDNode mapped with the subprogram DIE.
83 DenseMap<DIE *, const MDNode *> ContainingTypeMap;
85 /// getLowerBoundDefault - Return the default lower bound for an array. If the
86 /// DWARF version doesn't handle the language, return -1.
87 int64_t getDefaultLowerBound() const;
90 CompileUnit(unsigned UID, unsigned L, DIE *D, AsmPrinter *A, DwarfDebug *DW,
95 unsigned getUniqueID() const { return UniqueID; }
96 unsigned getLanguage() const { return Language; }
97 DIE* getCUDie() const { return CUDie.get(); }
98 const StringMap<DIE*> &getGlobalTypes() const { return GlobalTypes; }
100 const StringMap<std::vector<DIE*> > &getAccelNames() const {
103 const StringMap<std::vector<DIE*> > &getAccelObjC() const {
106 const StringMap<std::vector<DIE*> > &getAccelNamespace() const {
107 return AccelNamespace;
109 const StringMap<std::vector<std::pair<DIE*, unsigned > > >
110 &getAccelTypes() const {
114 /// hasContent - Return true if this compile unit has something to write out.
116 bool hasContent() const { return !CUDie->getChildren().empty(); }
118 /// addGlobalType - Add a new global type to the compile unit.
120 void addGlobalType(DIType Ty);
123 /// addAccelName - Add a new name to the name accelerator table.
124 void addAccelName(StringRef Name, DIE *Die) {
125 std::vector<DIE*> &DIEs = AccelNames[Name];
128 void addAccelObjC(StringRef Name, DIE *Die) {
129 std::vector<DIE*> &DIEs = AccelObjC[Name];
132 void addAccelNamespace(StringRef Name, DIE *Die) {
133 std::vector<DIE*> &DIEs = AccelNamespace[Name];
136 void addAccelType(StringRef Name, std::pair<DIE *, unsigned> Die) {
137 std::vector<std::pair<DIE*, unsigned > > &DIEs = AccelTypes[Name];
141 /// getDIE - Returns the debug information entry map slot for the
142 /// specified debug variable.
143 DIE *getDIE(const MDNode *N) { return MDNodeToDieMap.lookup(N); }
145 DIEBlock *getDIEBlock() {
146 return new (DIEValueAllocator) DIEBlock();
149 /// insertDIE - Insert DIE into the map.
150 void insertDIE(const MDNode *N, DIE *D) {
151 MDNodeToDieMap.insert(std::make_pair(N, D));
154 /// getDIEEntry - Returns the debug information entry for the specified
156 DIEEntry *getDIEEntry(const MDNode *N) {
157 DenseMap<const MDNode *, DIEEntry *>::iterator I =
158 MDNodeToDIEEntryMap.find(N);
159 if (I == MDNodeToDIEEntryMap.end())
164 /// insertDIEEntry - Insert debug information entry into the map.
165 void insertDIEEntry(const MDNode *N, DIEEntry *E) {
166 MDNodeToDIEEntryMap.insert(std::make_pair(N, E));
169 /// addDie - Adds or interns the DIE to the compile unit.
171 void addDie(DIE *Buffer) {
172 this->CUDie->addChild(Buffer);
175 // getIndexTyDie - Get an anonymous type for index type.
176 DIE *getIndexTyDie() {
180 // setIndexTyDie - Set D as anonymous type for index which can be reused
182 void setIndexTyDie(DIE *D) {
186 /// addFlag - Add a flag that is true to the DIE.
187 void addFlag(DIE *Die, unsigned Attribute);
189 /// addUInt - Add an unsigned integer attribute data and value.
191 void addUInt(DIE *Die, unsigned Attribute, unsigned Form, uint64_t Integer);
193 /// addSInt - Add an signed integer attribute data and value.
195 void addSInt(DIE *Die, unsigned Attribute, unsigned Form, int64_t Integer);
197 /// addString - Add a string attribute data and value.
199 void addString(DIE *Die, unsigned Attribute, const StringRef Str);
201 /// addLocalString - Add a string attribute data and value.
203 void addLocalString(DIE *Die, unsigned Attribute, const StringRef Str);
205 /// addLabel - Add a Dwarf label attribute data and value.
207 void addLabel(DIE *Die, unsigned Attribute, unsigned Form,
208 const MCSymbol *Label);
210 /// addDelta - Add a label delta attribute data and value.
212 void addDelta(DIE *Die, unsigned Attribute, unsigned Form,
213 const MCSymbol *Hi, const MCSymbol *Lo);
215 /// addDIEEntry - Add a DIE attribute data and value.
217 void addDIEEntry(DIE *Die, unsigned Attribute, unsigned Form, DIE *Entry);
219 /// addBlock - Add block data.
221 void addBlock(DIE *Die, unsigned Attribute, unsigned Form, DIEBlock *Block);
223 /// addSourceLine - Add location information to specified debug information
225 void addSourceLine(DIE *Die, DIVariable V);
226 void addSourceLine(DIE *Die, DIGlobalVariable G);
227 void addSourceLine(DIE *Die, DISubprogram SP);
228 void addSourceLine(DIE *Die, DIType Ty);
229 void addSourceLine(DIE *Die, DINameSpace NS);
230 void addSourceLine(DIE *Die, DIObjCProperty Ty);
232 /// addAddress - Add an address attribute to a die based on the location
234 void addAddress(DIE *Die, unsigned Attribute,
235 const MachineLocation &Location);
237 /// addConstantValue - Add constant value entry in variable DIE.
238 bool addConstantValue(DIE *Die, const MachineOperand &MO, DIType Ty);
239 bool addConstantValue(DIE *Die, const ConstantInt *CI, bool Unsigned);
241 /// addConstantFPValue - Add constant value entry in variable DIE.
242 bool addConstantFPValue(DIE *Die, const MachineOperand &MO);
244 /// addTemplateParams - Add template parameters in buffer.
245 void addTemplateParams(DIE &Buffer, DIArray TParams);
247 /// addRegisterOp - Add register operand.
248 void addRegisterOp(DIE *TheDie, unsigned Reg);
250 /// addRegisterOffset - Add register offset.
251 void addRegisterOffset(DIE *TheDie, unsigned Reg, int64_t Offset);
253 /// addComplexAddress - Start with the address based on the location provided,
254 /// and generate the DWARF information necessary to find the actual variable
255 /// (navigating the extra location information encoded in the type) based on
256 /// the starting location. Add the DWARF information to the die.
258 void addComplexAddress(DbgVariable *&DV, DIE *Die, unsigned Attribute,
259 const MachineLocation &Location);
261 // FIXME: Should be reformulated in terms of addComplexAddress.
262 /// addBlockByrefAddress - Start with the address based on the location
263 /// provided, and generate the DWARF information necessary to find the
264 /// actual Block variable (navigating the Block struct) based on the
265 /// starting location. Add the DWARF information to the die. Obsolete,
266 /// please use addComplexAddress instead.
268 void addBlockByrefAddress(DbgVariable *&DV, DIE *Die, unsigned Attribute,
269 const MachineLocation &Location);
271 /// addVariableAddress - Add DW_AT_location attribute for a
272 /// DbgVariable based on provided MachineLocation.
273 void addVariableAddress(DbgVariable *&DV, DIE *Die, MachineLocation Location);
275 /// addToContextOwner - Add Die into the list of its context owner's children.
276 void addToContextOwner(DIE *Die, DIDescriptor Context);
278 /// addType - Add a new type attribute to the specified entity. This takes
279 /// and attribute parameter because DW_AT_friend attributes are also
281 void addType(DIE *Entity, DIType Ty, unsigned Attribute = dwarf::DW_AT_type);
283 /// getOrCreateNameSpace - Create a DIE for DINameSpace.
284 DIE *getOrCreateNameSpace(DINameSpace NS);
286 /// getOrCreateSubprogramDIE - Create new DIE using SP.
287 DIE *getOrCreateSubprogramDIE(DISubprogram SP);
289 /// getOrCreateTypeDIE - Find existing DIE or create new DIE for the
291 DIE *getOrCreateTypeDIE(const MDNode *N);
293 /// getOrCreateTemplateTypeParameterDIE - Find existing DIE or create new DIE
294 /// for the given DITemplateTypeParameter.
295 DIE *getOrCreateTemplateTypeParameterDIE(DITemplateTypeParameter TP);
297 /// getOrCreateTemplateValueParameterDIE - Find existing DIE or create
298 /// new DIE for the given DITemplateValueParameter.
299 DIE *getOrCreateTemplateValueParameterDIE(DITemplateValueParameter TVP);
301 /// createDIEEntry - Creates a new DIEEntry to be a proxy for a debug
302 /// information entry.
303 DIEEntry *createDIEEntry(DIE *Entry);
305 /// createGlobalVariableDIE - create global variable DIE.
306 void createGlobalVariableDIE(const MDNode *N);
308 void addPubTypes(DISubprogram SP);
310 /// constructTypeDIE - Construct basic type die from DIBasicType.
311 void constructTypeDIE(DIE &Buffer,
314 /// constructTypeDIE - Construct derived type die from DIDerivedType.
315 void constructTypeDIE(DIE &Buffer,
318 /// constructTypeDIE - Construct type DIE from DICompositeType.
319 void constructTypeDIE(DIE &Buffer,
320 DICompositeType CTy);
322 /// constructSubrangeDIE - Construct subrange DIE from DISubrange.
323 void constructSubrangeDIE(DIE &Buffer, DISubrange SR, DIE *IndexTy);
325 /// constructArrayTypeDIE - Construct array type DIE from DICompositeType.
326 void constructArrayTypeDIE(DIE &Buffer,
327 DICompositeType *CTy);
329 /// constructEnumTypeDIE - Construct enum type DIE from DIEnumerator.
330 DIE *constructEnumTypeDIE(DIEnumerator ETy);
332 /// constructContainingTypeDIEs - Construct DIEs for types that contain
334 void constructContainingTypeDIEs();
336 /// constructVariableDIE - Construct a DIE for the given DbgVariable.
337 DIE *constructVariableDIE(DbgVariable *DV, bool isScopeAbstract);
339 /// createMemberDIE - Create new member DIE.
340 DIE *createMemberDIE(DIDerivedType DT);
344 // DIEValueAllocator - All DIEValues are allocated through this allocator.
345 BumpPtrAllocator DIEValueAllocator;
346 DIEInteger *DIEIntegerOne;
349 } // end llvm namespace