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/Analysis/DebugInfo.h"
19 #include "llvm/ADT/DenseMap.h"
20 #include "llvm/ADT/StringMap.h"
21 #include "llvm/ADT/OwningPtr.h"
26 class MachineLocation;
31 //===----------------------------------------------------------------------===//
32 /// CompileUnit - This dwarf writer support class manages information associated
33 /// with a source file.
35 /// ID - File identifier for source.
39 /// Language - The DW_AT_language of the compile unit
43 /// Die - Compile unit debug information entry.
45 const OwningPtr<DIE> CUDie;
47 /// Asm - Target of Dwarf emission.
52 /// IndexTyDie - An anonymous type for index type. Owned by CUDie.
55 /// MDNodeToDieMap - Tracks the mapping of unit level debug informaton
56 /// variables to debug information entries.
57 DenseMap<const MDNode *, DIE *> MDNodeToDieMap;
59 /// MDNodeToDIEEntryMap - Tracks the mapping of unit level debug informaton
60 /// descriptors to debug information entries using a DIEEntry proxy.
61 DenseMap<const MDNode *, DIEEntry *> MDNodeToDIEEntryMap;
63 /// GlobalTypes - A map of globally visible types for this unit.
65 StringMap<DIE*> GlobalTypes;
67 /// AccelNames - A map of names for the name accelerator table.
69 StringMap<std::vector<DIE*> > AccelNames;
70 StringMap<std::vector<DIE*> > AccelObjC;
71 StringMap<std::vector<DIE*> > AccelNamespace;
72 StringMap<std::vector<std::pair<DIE*, unsigned> > > AccelTypes;
74 /// DIEBlocks - A list of all the DIEBlocks in use.
75 std::vector<DIEBlock *> DIEBlocks;
77 /// ContainingTypeMap - This map is used to keep track of subprogram DIEs that
78 /// need DW_AT_containing_type attribute. This attribute points to a DIE that
79 /// corresponds to the MDNode mapped with the subprogram DIE.
80 DenseMap<DIE *, const MDNode *> ContainingTypeMap;
83 CompileUnit(unsigned I, unsigned L, DIE *D, AsmPrinter *A, DwarfDebug *DW);
87 unsigned getID() const { return ID; }
88 unsigned getLanguage() const { return Language; }
89 DIE* getCUDie() const { return CUDie.get(); }
90 const StringMap<DIE*> &getGlobalTypes() const { return GlobalTypes; }
92 const StringMap<std::vector<DIE*> > &getAccelNames() const {
95 const StringMap<std::vector<DIE*> > &getAccelObjC() const {
98 const StringMap<std::vector<DIE*> > &getAccelNamespace() const {
99 return AccelNamespace;
101 const StringMap<std::vector<std::pair<DIE*, unsigned > > >
102 &getAccelTypes() const {
106 /// hasContent - Return true if this compile unit has something to write out.
108 bool hasContent() const { return !CUDie->getChildren().empty(); }
110 /// addGlobalType - Add a new global type to the compile unit.
112 void addGlobalType(DIType Ty);
115 /// addAccelName - Add a new name to the name accelerator table.
116 void addAccelName(StringRef Name, DIE *Die) {
117 std::vector<DIE*> &DIEs = AccelNames[Name];
120 void addAccelObjC(StringRef Name, DIE *Die) {
121 std::vector<DIE*> &DIEs = AccelObjC[Name];
124 void addAccelNamespace(StringRef Name, DIE *Die) {
125 std::vector<DIE*> &DIEs = AccelNamespace[Name];
128 void addAccelType(StringRef Name, std::pair<DIE *, unsigned> Die) {
129 std::vector<std::pair<DIE*, unsigned > > &DIEs = AccelTypes[Name];
133 /// getDIE - Returns the debug information entry map slot for the
134 /// specified debug variable.
135 DIE *getDIE(const MDNode *N) { return MDNodeToDieMap.lookup(N); }
137 DIEBlock *getDIEBlock() {
138 return new (DIEValueAllocator) DIEBlock();
141 /// insertDIE - Insert DIE into the map.
142 void insertDIE(const MDNode *N, DIE *D) {
143 MDNodeToDieMap.insert(std::make_pair(N, D));
146 /// getDIEEntry - Returns the debug information entry for the specified
148 DIEEntry *getDIEEntry(const MDNode *N) {
149 DenseMap<const MDNode *, DIEEntry *>::iterator I =
150 MDNodeToDIEEntryMap.find(N);
151 if (I == MDNodeToDIEEntryMap.end())
156 /// insertDIEEntry - Insert debug information entry into the map.
157 void insertDIEEntry(const MDNode *N, DIEEntry *E) {
158 MDNodeToDIEEntryMap.insert(std::make_pair(N, E));
161 /// addDie - Adds or interns the DIE to the compile unit.
163 void addDie(DIE *Buffer) {
164 this->CUDie->addChild(Buffer);
167 // getIndexTyDie - Get an anonymous type for index type.
168 DIE *getIndexTyDie() {
172 // setIndexTyDie - Set D as anonymous type for index which can be reused
174 void setIndexTyDie(DIE *D) {
179 /// addUInt - Add an unsigned integer attribute data and value.
181 void addUInt(DIE *Die, unsigned Attribute, unsigned Form, uint64_t Integer);
183 /// addSInt - Add an signed integer attribute data and value.
185 void addSInt(DIE *Die, unsigned Attribute, unsigned Form, int64_t Integer);
187 /// addString - Add a string attribute data and value.
189 void addString(DIE *Die, unsigned Attribute, const StringRef Str);
191 /// addLabel - Add a Dwarf label attribute data and value.
193 void addLabel(DIE *Die, unsigned Attribute, unsigned Form,
194 const MCSymbol *Label);
196 /// addDelta - Add a label delta attribute data and value.
198 void addDelta(DIE *Die, unsigned Attribute, unsigned Form,
199 const MCSymbol *Hi, const MCSymbol *Lo);
201 /// addDIEEntry - Add a DIE attribute data and value.
203 void addDIEEntry(DIE *Die, unsigned Attribute, unsigned Form, DIE *Entry);
205 /// addBlock - Add block data.
207 void addBlock(DIE *Die, unsigned Attribute, unsigned Form, DIEBlock *Block);
209 /// addSourceLine - Add location information to specified debug information
211 void addSourceLine(DIE *Die, DIVariable V);
212 void addSourceLine(DIE *Die, DIGlobalVariable G);
213 void addSourceLine(DIE *Die, DISubprogram SP);
214 void addSourceLine(DIE *Die, DIType Ty);
215 void addSourceLine(DIE *Die, DINameSpace NS);
216 void addSourceLine(DIE *Die, DIObjCProperty Ty);
218 /// addAddress - Add an address attribute to a die based on the location
220 void addAddress(DIE *Die, unsigned Attribute,
221 const MachineLocation &Location);
223 /// addConstantValue - Add constant value entry in variable DIE.
224 bool addConstantValue(DIE *Die, const MachineOperand &MO, DIType Ty);
225 bool addConstantValue(DIE *Die, const ConstantInt *CI, bool Unsigned);
227 /// addConstantFPValue - Add constant value entry in variable DIE.
228 bool addConstantFPValue(DIE *Die, const MachineOperand &MO);
230 /// addTemplateParams - Add template parameters in buffer.
231 void addTemplateParams(DIE &Buffer, DIArray TParams);
233 /// addRegisterOp - Add register operand.
234 void addRegisterOp(DIE *TheDie, unsigned Reg);
236 /// addRegisterOffset - Add register offset.
237 void addRegisterOffset(DIE *TheDie, unsigned Reg, int64_t Offset);
239 /// addComplexAddress - Start with the address based on the location provided,
240 /// and generate the DWARF information necessary to find the actual variable
241 /// (navigating the extra location information encoded in the type) based on
242 /// the starting location. Add the DWARF information to the die.
244 void addComplexAddress(DbgVariable *&DV, DIE *Die, unsigned Attribute,
245 const MachineLocation &Location);
247 // FIXME: Should be reformulated in terms of addComplexAddress.
248 /// addBlockByrefAddress - Start with the address based on the location
249 /// provided, and generate the DWARF information necessary to find the
250 /// actual Block variable (navigating the Block struct) based on the
251 /// starting location. Add the DWARF information to the die. Obsolete,
252 /// please use addComplexAddress instead.
254 void addBlockByrefAddress(DbgVariable *&DV, DIE *Die, unsigned Attribute,
255 const MachineLocation &Location);
257 /// addVariableAddress - Add DW_AT_location attribute for a
258 /// DbgVariable based on provided MachineLocation.
259 void addVariableAddress(DbgVariable *&DV, DIE *Die, MachineLocation Location);
261 /// addToContextOwner - Add Die into the list of its context owner's children.
262 void addToContextOwner(DIE *Die, DIDescriptor Context);
264 /// addType - Add a new type attribute to the specified entity. This takes
265 /// and attribute parameter because DW_AT_friend attributes are also
267 void addType(DIE *Entity, DIType Ty, unsigned Attribute = dwarf::DW_AT_type);
269 /// getOrCreateNameSpace - Create a DIE for DINameSpace.
270 DIE *getOrCreateNameSpace(DINameSpace NS);
272 /// getOrCreateSubprogramDIE - Create new DIE using SP.
273 DIE *getOrCreateSubprogramDIE(DISubprogram SP);
275 /// getOrCreateTypeDIE - Find existing DIE or create new DIE for the
277 DIE *getOrCreateTypeDIE(const MDNode *N);
279 /// getOrCreateTemplateTypeParameterDIE - Find existing DIE or create new DIE
280 /// for the given DITemplateTypeParameter.
281 DIE *getOrCreateTemplateTypeParameterDIE(DITemplateTypeParameter TP);
283 /// getOrCreateTemplateValueParameterDIE - Find existing DIE or create new DIE
284 /// for the given DITemplateValueParameter.
285 DIE *getOrCreateTemplateValueParameterDIE(DITemplateValueParameter TVP);
287 /// createDIEEntry - Creates a new DIEEntry to be a proxy for a debug
288 /// information entry.
289 DIEEntry *createDIEEntry(DIE *Entry);
291 /// createGlobalVariableDIE - create global variable DIE.
292 void createGlobalVariableDIE(const MDNode *N);
294 void addPubTypes(DISubprogram SP);
296 /// constructTypeDIE - Construct basic type die from DIBasicType.
297 void constructTypeDIE(DIE &Buffer,
300 /// constructTypeDIE - Construct derived type die from DIDerivedType.
301 void constructTypeDIE(DIE &Buffer,
304 /// constructTypeDIE - Construct type DIE from DICompositeType.
305 void constructTypeDIE(DIE &Buffer,
306 DICompositeType CTy);
308 /// constructSubrangeDIE - Construct subrange DIE from DISubrange.
309 void constructSubrangeDIE(DIE &Buffer, DISubrange SR, DIE *IndexTy);
311 /// constructArrayTypeDIE - Construct array type DIE from DICompositeType.
312 void constructArrayTypeDIE(DIE &Buffer,
313 DICompositeType *CTy);
315 /// constructEnumTypeDIE - Construct enum type DIE from DIEnumerator.
316 DIE *constructEnumTypeDIE(DIEnumerator ETy);
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 /// createMemberDIE - Create new member DIE.
326 DIE *createMemberDIE(DIDerivedType DT);
330 // DIEValueAllocator - All DIEValues are allocated through this allocator.
331 BumpPtrAllocator DIEValueAllocator;
332 DIEInteger *DIEIntegerOne;
335 } // end llvm namespace