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;
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 /// Language - The DW_AT_language of the compile unit
45 /// Die - 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 informaton
60 /// variables to debug information entries.
61 DenseMap<const MDNode *, DIE *> MDNodeToDieMap;
63 /// MDNodeToDIEEntryMap - Tracks the mapping of unit level debug informaton
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<DIE*> > AccelNames;
78 StringMap<std::vector<DIE*> > AccelObjC;
79 StringMap<std::vector<DIE*> > AccelNamespace;
80 StringMap<std::vector<std::pair<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 /// Offset of the CUDie from beginning of debug info section.
91 unsigned DebugInfoOffset;
93 /// getLowerBoundDefault - Return the default lower bound for an array. If the
94 /// DWARF version doesn't handle the language, return -1.
95 int64_t getDefaultLowerBound() const;
98 CompileUnit(unsigned UID, unsigned L, DIE *D, AsmPrinter *A, DwarfDebug *DW,
103 unsigned getUniqueID() const { return UniqueID; }
104 unsigned getLanguage() const { return Language; }
105 DIE* getCUDie() const { return CUDie.get(); }
106 unsigned getDebugInfoOffset() const { return DebugInfoOffset; }
107 const StringMap<DIE*> &getGlobalNames() const { return GlobalNames; }
108 const StringMap<DIE*> &getGlobalTypes() const { return GlobalTypes; }
110 const StringMap<std::vector<DIE*> > &getAccelNames() const {
113 const StringMap<std::vector<DIE*> > &getAccelObjC() const {
116 const StringMap<std::vector<DIE*> > &getAccelNamespace() const {
117 return AccelNamespace;
119 const StringMap<std::vector<std::pair<DIE*, unsigned > > >
120 &getAccelTypes() const {
124 void setDebugInfoOffset(unsigned DbgInfoOff) { DebugInfoOffset = DbgInfoOff; }
125 /// hasContent - Return true if this compile unit has something to write out.
127 bool hasContent() const { return !CUDie->getChildren().empty(); }
129 /// addGlobalName - Add a new global entity to the compile unit.
131 void addGlobalName(StringRef Name, DIE *Die) { GlobalNames[Name] = Die; }
133 /// addGlobalType - Add a new global type to the compile unit.
135 void addGlobalType(DIType Ty);
138 /// addAccelName - Add a new name to the name accelerator table.
139 void addAccelName(StringRef Name, DIE *Die) {
140 std::vector<DIE*> &DIEs = AccelNames[Name];
143 void addAccelObjC(StringRef Name, DIE *Die) {
144 std::vector<DIE*> &DIEs = AccelObjC[Name];
147 void addAccelNamespace(StringRef Name, DIE *Die) {
148 std::vector<DIE*> &DIEs = AccelNamespace[Name];
151 void addAccelType(StringRef Name, std::pair<DIE *, unsigned> Die) {
152 std::vector<std::pair<DIE*, unsigned > > &DIEs = AccelTypes[Name];
156 /// getDIE - Returns the debug information entry map slot for the
157 /// specified debug variable.
158 DIE *getDIE(const MDNode *N) { return MDNodeToDieMap.lookup(N); }
160 DIEBlock *getDIEBlock() {
161 return new (DIEValueAllocator) DIEBlock();
164 /// insertDIE - Insert DIE into the map.
165 void insertDIE(const MDNode *N, DIE *D) {
166 MDNodeToDieMap.insert(std::make_pair(N, D));
169 /// getDIEEntry - Returns the debug information entry for the specified
171 DIEEntry *getDIEEntry(const MDNode *N) {
172 DenseMap<const MDNode *, DIEEntry *>::iterator I =
173 MDNodeToDIEEntryMap.find(N);
174 if (I == MDNodeToDIEEntryMap.end())
179 /// insertDIEEntry - Insert debug information entry into the map.
180 void insertDIEEntry(const MDNode *N, DIEEntry *E) {
181 MDNodeToDIEEntryMap.insert(std::make_pair(N, E));
184 /// addDie - Adds or interns the DIE to the compile unit.
186 void addDie(DIE *Buffer) {
187 this->CUDie->addChild(Buffer);
190 // getIndexTyDie - Get an anonymous type for index type.
191 DIE *getIndexTyDie() {
195 // setIndexTyDie - Set D as anonymous type for index which can be reused
197 void setIndexTyDie(DIE *D) {
201 /// addFlag - Add a flag that is true to the DIE.
202 void addFlag(DIE *Die, unsigned Attribute);
204 /// addUInt - Add an unsigned integer attribute data and value.
206 void addUInt(DIE *Die, unsigned Attribute, unsigned Form, uint64_t Integer);
208 /// addSInt - Add an signed integer attribute data and value.
210 void addSInt(DIE *Die, unsigned Attribute, unsigned Form, int64_t Integer);
212 /// addString - Add a string attribute data and value.
214 void addString(DIE *Die, unsigned Attribute, const StringRef Str);
216 /// addLocalString - Add a string attribute data and value.
218 void addLocalString(DIE *Die, unsigned Attribute, const StringRef Str);
220 /// addLabel - Add a Dwarf label attribute data and value.
222 void addLabel(DIE *Die, unsigned Attribute, unsigned Form,
223 const MCSymbol *Label);
225 /// addLabelAddress - Add a dwarf label attribute data and value using
226 /// either DW_FORM_addr or DW_FORM_GNU_addr_index.
228 void addLabelAddress(DIE *Die, unsigned Attribute, MCSymbol *Label);
230 /// addOpAddress - Add a dwarf op address data and value using the
231 /// form given and an op of either DW_FORM_addr or DW_FORM_GNU_addr_index.
233 void addOpAddress(DIE *Die, MCSymbol *Label);
235 /// addDelta - Add a label delta attribute data and value.
237 void addDelta(DIE *Die, unsigned Attribute, unsigned Form,
238 const MCSymbol *Hi, const MCSymbol *Lo);
240 /// addDIEEntry - Add a DIE attribute data and value.
242 void addDIEEntry(DIE *Die, unsigned Attribute, unsigned Form, DIE *Entry);
244 /// addBlock - Add block data.
246 void addBlock(DIE *Die, unsigned Attribute, unsigned Form, DIEBlock *Block);
248 /// addSourceLine - Add location information to specified debug information
250 void addSourceLine(DIE *Die, DIVariable V);
251 void addSourceLine(DIE *Die, DIGlobalVariable G);
252 void addSourceLine(DIE *Die, DISubprogram SP);
253 void addSourceLine(DIE *Die, DIType Ty);
254 void addSourceLine(DIE *Die, DINameSpace NS);
255 void addSourceLine(DIE *Die, DIObjCProperty Ty);
257 /// addAddress - Add an address attribute to a die based on the location
259 void addAddress(DIE *Die, unsigned Attribute,
260 const MachineLocation &Location);
262 /// addConstantValue - Add constant value entry in variable DIE.
263 bool addConstantValue(DIE *Die, const MachineOperand &MO, DIType Ty);
264 bool addConstantValue(DIE *Die, const ConstantInt *CI, bool Unsigned);
265 bool addConstantValue(DIE *Die, const APInt &Val, bool Unsigned);
267 /// addConstantFPValue - Add constant value entry in variable DIE.
268 bool addConstantFPValue(DIE *Die, const MachineOperand &MO);
269 bool addConstantFPValue(DIE *Die, const ConstantFP *CFP);
271 /// addTemplateParams - Add template parameters in buffer.
272 void addTemplateParams(DIE &Buffer, DIArray TParams);
274 /// addRegisterOp - Add register operand.
275 void addRegisterOp(DIE *TheDie, unsigned Reg);
277 /// addRegisterOffset - Add register offset.
278 void addRegisterOffset(DIE *TheDie, unsigned Reg, int64_t Offset);
280 /// addComplexAddress - Start with the address based on the location provided,
281 /// and generate the DWARF information necessary to find the actual variable
282 /// (navigating the extra location information encoded in the type) based on
283 /// the starting location. Add the DWARF information to the die.
285 void addComplexAddress(DbgVariable *&DV, DIE *Die, unsigned Attribute,
286 const MachineLocation &Location);
288 // FIXME: Should be reformulated in terms of addComplexAddress.
289 /// addBlockByrefAddress - Start with the address based on the location
290 /// provided, and generate the DWARF information necessary to find the
291 /// actual Block variable (navigating the Block struct) based on the
292 /// starting location. Add the DWARF information to the die. Obsolete,
293 /// please use addComplexAddress instead.
295 void addBlockByrefAddress(DbgVariable *&DV, DIE *Die, unsigned Attribute,
296 const MachineLocation &Location);
298 /// addVariableAddress - Add DW_AT_location attribute for a
299 /// DbgVariable based on provided MachineLocation.
300 void addVariableAddress(DbgVariable *&DV, DIE *Die, MachineLocation Location);
302 /// addToContextOwner - Add Die into the list of its context owner's children.
303 void addToContextOwner(DIE *Die, DIDescriptor Context);
305 /// addType - Add a new type attribute to the specified entity. This takes
306 /// and attribute parameter because DW_AT_friend attributes are also
308 void addType(DIE *Entity, DIType Ty, unsigned Attribute = dwarf::DW_AT_type);
310 /// getOrCreateNameSpace - Create a DIE for DINameSpace.
311 DIE *getOrCreateNameSpace(DINameSpace NS);
313 /// getOrCreateSubprogramDIE - Create new DIE using SP.
314 DIE *getOrCreateSubprogramDIE(DISubprogram SP);
316 /// getOrCreateTypeDIE - Find existing DIE or create new DIE for the
318 DIE *getOrCreateTypeDIE(const MDNode *N);
320 /// getOrCreateTemplateTypeParameterDIE - Find existing DIE or create new DIE
321 /// for the given DITemplateTypeParameter.
322 DIE *getOrCreateTemplateTypeParameterDIE(DITemplateTypeParameter TP);
324 /// getOrCreateTemplateValueParameterDIE - Find existing DIE or create
325 /// new DIE for the given DITemplateValueParameter.
326 DIE *getOrCreateTemplateValueParameterDIE(DITemplateValueParameter TVP);
328 /// createDIEEntry - Creates a new DIEEntry to be a proxy for a debug
329 /// information entry.
330 DIEEntry *createDIEEntry(DIE *Entry);
332 /// createGlobalVariableDIE - create global variable DIE.
333 void createGlobalVariableDIE(const MDNode *N);
335 void addPubTypes(DISubprogram SP);
337 /// constructTypeDIE - Construct basic type die from DIBasicType.
338 void constructTypeDIE(DIE &Buffer,
341 /// constructTypeDIE - Construct derived type die from DIDerivedType.
342 void constructTypeDIE(DIE &Buffer,
345 /// constructTypeDIE - Construct type DIE from DICompositeType.
346 void constructTypeDIE(DIE &Buffer,
347 DICompositeType CTy);
349 /// constructSubrangeDIE - Construct subrange DIE from DISubrange.
350 void constructSubrangeDIE(DIE &Buffer, DISubrange SR, DIE *IndexTy);
352 /// constructArrayTypeDIE - Construct array type DIE from DICompositeType.
353 void constructArrayTypeDIE(DIE &Buffer,
354 DICompositeType *CTy);
356 /// constructEnumTypeDIE - Construct enum type DIE from DIEnumerator.
357 DIE *constructEnumTypeDIE(DIEnumerator ETy);
359 /// constructContainingTypeDIEs - Construct DIEs for types that contain
361 void constructContainingTypeDIEs();
363 /// constructVariableDIE - Construct a DIE for the given DbgVariable.
364 DIE *constructVariableDIE(DbgVariable *DV, bool isScopeAbstract);
366 /// createMemberDIE - Create new member DIE.
367 DIE *createMemberDIE(DIDerivedType DT);
369 /// createStaticMemberDIE - Create new static data member DIE.
370 DIE *createStaticMemberDIE(DIDerivedType DT);
372 /// getOrCreateContextDIE - Get context owner's DIE.
373 DIE *getOrCreateContextDIE(DIDescriptor Context);
377 // DIEValueAllocator - All DIEValues are allocated through this allocator.
378 BumpPtrAllocator DIEValueAllocator;
379 DIEInteger *DIEIntegerOne;
382 } // end llvm namespace