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"
22 #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 /// Language - The DW_AT_language of the compile unit
46 /// Die - Compile unit debug information entry.
48 const OwningPtr<DIE> CUDie;
50 /// Asm - Target of Dwarf emission.
53 // Holders for some common dwarf information.
57 /// IndexTyDie - An anonymous type for index type. Owned by CUDie.
60 /// MDNodeToDieMap - Tracks the mapping of unit level debug information
61 /// variables to debug information entries.
62 DenseMap<const MDNode *, DIE *> MDNodeToDieMap;
64 /// MDNodeToDIEEntryMap - Tracks the mapping of unit level debug information
65 /// descriptors to debug information entries using a DIEEntry proxy.
66 DenseMap<const MDNode *, DIEEntry *> MDNodeToDIEEntryMap;
68 /// GlobalNames - A map of globally visible named entities for this unit.
70 StringMap<DIE*> GlobalNames;
72 /// GlobalTypes - A map of globally visible types for this unit.
74 StringMap<DIE*> GlobalTypes;
76 /// AccelNames - A map of names for the name accelerator table.
78 StringMap<std::vector<DIE*> > AccelNames;
79 StringMap<std::vector<DIE*> > AccelObjC;
80 StringMap<std::vector<DIE*> > AccelNamespace;
81 StringMap<std::vector<std::pair<DIE*, unsigned> > > AccelTypes;
83 /// DIEBlocks - A list of all the DIEBlocks in use.
84 std::vector<DIEBlock *> DIEBlocks;
86 /// ContainingTypeMap - This map is used to keep track of subprogram DIEs that
87 /// need DW_AT_containing_type attribute. This attribute points to a DIE that
88 /// corresponds to the MDNode mapped with the subprogram DIE.
89 DenseMap<DIE *, const MDNode *> ContainingTypeMap;
91 /// Offset of the CUDie from beginning of debug info section.
92 unsigned DebugInfoOffset;
94 /// getLowerBoundDefault - Return the default lower bound for an array. If the
95 /// DWARF version doesn't handle the language, return -1.
96 int64_t getDefaultLowerBound() const;
99 CompileUnit(unsigned UID, unsigned L, DIE *D, const MDNode *N, AsmPrinter *A,
100 DwarfDebug *DW, DwarfUnits *DWU);
104 unsigned getUniqueID() const { return UniqueID; }
105 unsigned getLanguage() const { return Language; }
106 DIE* getCUDie() const { return CUDie.get(); }
107 unsigned getDebugInfoOffset() const { return DebugInfoOffset; }
108 const StringMap<DIE*> &getGlobalNames() const { return GlobalNames; }
109 const StringMap<DIE*> &getGlobalTypes() const { return GlobalTypes; }
111 const StringMap<std::vector<DIE*> > &getAccelNames() const {
114 const StringMap<std::vector<DIE*> > &getAccelObjC() const {
117 const StringMap<std::vector<DIE*> > &getAccelNamespace() const {
118 return AccelNamespace;
120 const StringMap<std::vector<std::pair<DIE*, unsigned > > >
121 &getAccelTypes() const {
125 void setDebugInfoOffset(unsigned DbgInfoOff) { DebugInfoOffset = DbgInfoOff; }
126 /// hasContent - Return true if this compile unit has something to write out.
128 bool hasContent() const { return !CUDie->getChildren().empty(); }
130 /// addGlobalName - Add a new global entity to the compile unit.
132 void addGlobalName(StringRef Name, DIE *Die) { GlobalNames[Name] = Die; }
134 /// addGlobalType - Add a new global type to the compile unit.
136 void addGlobalType(DIType Ty);
139 /// addAccelName - Add a new name to the name accelerator table.
140 void addAccelName(StringRef Name, DIE *Die) {
141 std::vector<DIE*> &DIEs = AccelNames[Name];
144 void addAccelObjC(StringRef Name, DIE *Die) {
145 std::vector<DIE*> &DIEs = AccelObjC[Name];
148 void addAccelNamespace(StringRef Name, DIE *Die) {
149 std::vector<DIE*> &DIEs = AccelNamespace[Name];
152 void addAccelType(StringRef Name, std::pair<DIE *, unsigned> Die) {
153 std::vector<std::pair<DIE*, unsigned > > &DIEs = AccelTypes[Name];
157 /// getDIE - Returns the debug information entry map slot for the
158 /// specified debug variable.
159 DIE *getDIE(const MDNode *N) { return MDNodeToDieMap.lookup(N); }
161 DIEBlock *getDIEBlock() {
162 return new (DIEValueAllocator) DIEBlock();
165 /// insertDIE - Insert DIE into the map.
166 void insertDIE(const MDNode *N, DIE *D) {
167 MDNodeToDieMap.insert(std::make_pair(N, D));
170 /// getDIEEntry - Returns the debug information entry for the specified
172 DIEEntry *getDIEEntry(const MDNode *N) {
173 DenseMap<const MDNode *, DIEEntry *>::iterator I =
174 MDNodeToDIEEntryMap.find(N);
175 if (I == MDNodeToDIEEntryMap.end())
180 /// insertDIEEntry - Insert debug information entry into the map.
181 void insertDIEEntry(const MDNode *N, DIEEntry *E) {
182 MDNodeToDIEEntryMap.insert(std::make_pair(N, E));
185 /// addDie - Adds or interns the DIE to the compile unit.
187 void addDie(DIE *Buffer) {
188 this->CUDie->addChild(Buffer);
191 // getIndexTyDie - Get an anonymous type for index type.
192 DIE *getIndexTyDie() {
196 // setIndexTyDie - Set D as anonymous type for index which can be reused
198 void setIndexTyDie(DIE *D) {
202 /// addFlag - Add a flag that is true to the DIE.
203 void addFlag(DIE *Die, unsigned Attribute);
205 /// addUInt - Add an unsigned integer attribute data and value.
207 void addUInt(DIE *Die, unsigned Attribute, unsigned Form, uint64_t Integer);
209 /// addSInt - Add an signed integer attribute data and value.
211 void addSInt(DIE *Die, unsigned Attribute, unsigned Form, int64_t Integer);
213 /// addString - Add a string attribute data and value.
215 void addString(DIE *Die, unsigned Attribute, const StringRef Str);
217 /// addLocalString - Add a string attribute data and value.
219 void addLocalString(DIE *Die, unsigned Attribute, const StringRef Str);
221 /// addLabel - Add a Dwarf label attribute data and value.
223 void addLabel(DIE *Die, unsigned Attribute, unsigned Form,
224 const MCSymbolRefExpr *Label);
225 void addLabel(DIE *Die, unsigned Attribute, unsigned Form,
226 const MCSymbol *Label);
228 /// addLabelAddress - Add a dwarf label attribute data and value using
229 /// either DW_FORM_addr or DW_FORM_GNU_addr_index.
231 void addLabelAddress(DIE *Die, unsigned Attribute, MCSymbol *Label);
233 /// addOpAddress - Add a dwarf op address data and value using the
234 /// form given and an op of either DW_FORM_addr or DW_FORM_GNU_addr_index.
236 void addOpAddress(DIE *Die, const MCSymbol *Label);
237 void addOpAddress(DIE *Die, const MCSymbolRefExpr *Label);
239 /// addDelta - Add a label delta attribute data and value.
241 void addDelta(DIE *Die, unsigned Attribute, unsigned Form,
242 const MCSymbol *Hi, const MCSymbol *Lo);
244 /// addDIEEntry - Add a DIE attribute data and value.
246 void addDIEEntry(DIE *Die, unsigned Attribute, unsigned Form, DIE *Entry);
248 /// addBlock - Add block data.
250 void addBlock(DIE *Die, unsigned Attribute, unsigned Form, DIEBlock *Block);
252 /// addSourceLine - Add location information to specified debug information
254 void addSourceLine(DIE *Die, DIVariable V);
255 void addSourceLine(DIE *Die, DIGlobalVariable G);
256 void addSourceLine(DIE *Die, DISubprogram SP);
257 void addSourceLine(DIE *Die, DIType Ty);
258 void addSourceLine(DIE *Die, DINameSpace NS);
259 void addSourceLine(DIE *Die, DIObjCProperty Ty);
261 /// addAddress - Add an address attribute to a die based on the location
263 void addAddress(DIE *Die, unsigned Attribute,
264 const MachineLocation &Location, bool Indirect = false);
266 /// addConstantValue - Add constant value entry in variable DIE.
267 bool addConstantValue(DIE *Die, const MachineOperand &MO, DIType Ty);
268 bool addConstantValue(DIE *Die, const ConstantInt *CI, bool Unsigned);
269 bool addConstantValue(DIE *Die, const APInt &Val, bool Unsigned);
271 /// addConstantFPValue - Add constant value entry in variable DIE.
272 bool addConstantFPValue(DIE *Die, const MachineOperand &MO);
273 bool addConstantFPValue(DIE *Die, const ConstantFP *CFP);
275 /// addTemplateParams - Add template parameters in buffer.
276 void addTemplateParams(DIE &Buffer, DIArray TParams);
278 /// addRegisterOp - Add register operand.
279 void addRegisterOp(DIE *TheDie, unsigned Reg);
281 /// addRegisterOffset - Add register offset.
282 void addRegisterOffset(DIE *TheDie, unsigned Reg, int64_t Offset);
284 /// addComplexAddress - Start with the address based on the location provided,
285 /// and generate the DWARF information necessary to find the actual variable
286 /// (navigating the extra location information encoded in the type) based on
287 /// the starting location. Add the DWARF information to the die.
289 void addComplexAddress(const DbgVariable &DV, DIE *Die, unsigned Attribute,
290 const MachineLocation &Location);
292 // FIXME: Should be reformulated in terms of addComplexAddress.
293 /// addBlockByrefAddress - Start with the address based on the location
294 /// provided, and generate the DWARF information necessary to find the
295 /// actual Block variable (navigating the Block struct) based on the
296 /// starting location. Add the DWARF information to the die. Obsolete,
297 /// please use addComplexAddress instead.
299 void addBlockByrefAddress(const DbgVariable &DV, DIE *Die, unsigned Attribute,
300 const MachineLocation &Location);
302 /// addVariableAddress - Add DW_AT_location attribute for a
303 /// DbgVariable based on provided MachineLocation.
304 void addVariableAddress(const DbgVariable &DV, DIE *Die,
305 MachineLocation Location);
307 /// addToContextOwner - Add Die into the list of its context owner's children.
308 void addToContextOwner(DIE *Die, DIDescriptor Context);
310 /// addType - Add a new type attribute to the specified entity. This takes
311 /// and attribute parameter because DW_AT_friend attributes are also
313 void addType(DIE *Entity, DIType Ty, unsigned Attribute = dwarf::DW_AT_type);
315 /// getOrCreateNameSpace - Create a DIE for DINameSpace.
316 DIE *getOrCreateNameSpace(DINameSpace NS);
318 /// getOrCreateSubprogramDIE - Create new DIE using SP.
319 DIE *getOrCreateSubprogramDIE(DISubprogram SP);
321 /// getOrCreateTypeDIE - Find existing DIE or create new DIE for the
323 DIE *getOrCreateTypeDIE(const MDNode *N);
325 /// getOrCreateTemplateTypeParameterDIE - Find existing DIE or create new DIE
326 /// for the given DITemplateTypeParameter.
327 DIE *getOrCreateTemplateTypeParameterDIE(DITemplateTypeParameter TP);
329 /// getOrCreateTemplateValueParameterDIE - Find existing DIE or create
330 /// new DIE for the given DITemplateValueParameter.
331 DIE *getOrCreateTemplateValueParameterDIE(DITemplateValueParameter TVP);
333 /// createDIEEntry - Creates a new DIEEntry to be a proxy for a debug
334 /// information entry.
335 DIEEntry *createDIEEntry(DIE *Entry);
337 /// createGlobalVariableDIE - create global variable DIE.
338 void createGlobalVariableDIE(const MDNode *N);
340 void addPubTypes(DISubprogram SP);
342 /// constructTypeDIE - Construct basic type die from DIBasicType.
343 void constructTypeDIE(DIE &Buffer,
346 /// constructTypeDIE - Construct derived type die from DIDerivedType.
347 void constructTypeDIE(DIE &Buffer,
350 /// constructTypeDIE - Construct type DIE from DICompositeType.
351 void constructTypeDIE(DIE &Buffer,
352 DICompositeType CTy);
354 /// constructSubrangeDIE - Construct subrange DIE from DISubrange.
355 void constructSubrangeDIE(DIE &Buffer, DISubrange SR, DIE *IndexTy);
357 /// constructArrayTypeDIE - Construct array type DIE from DICompositeType.
358 void constructArrayTypeDIE(DIE &Buffer,
359 DICompositeType *CTy);
361 /// constructEnumTypeDIE - Construct enum type DIE from DIEnumerator.
362 DIE *constructEnumTypeDIE(DIEnumerator ETy);
364 /// constructContainingTypeDIEs - Construct DIEs for types that contain
366 void constructContainingTypeDIEs();
368 /// constructVariableDIE - Construct a DIE for the given DbgVariable.
369 DIE *constructVariableDIE(DbgVariable *DV, bool isScopeAbstract);
371 /// createMemberDIE - Create new member DIE.
372 DIE *createMemberDIE(DIDerivedType DT);
374 /// createStaticMemberDIE - Create new static data member DIE.
375 DIE *createStaticMemberDIE(DIDerivedType DT);
377 /// getOrCreateContextDIE - Get context owner's DIE.
378 DIE *getOrCreateContextDIE(DIDescriptor Context);
382 // DIEValueAllocator - All DIEValues are allocated through this allocator.
383 BumpPtrAllocator DIEValueAllocator;
384 DIEInteger *DIEIntegerOne;
387 } // end llvm namespace