1 //===--- lib/CodeGen/DIE.h - DWARF Info Entries -----------------*- 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 // Data structures for DWARF info entries.
12 //===----------------------------------------------------------------------===//
14 #ifndef CODEGEN_ASMPRINTER_DIE_H__
15 #define CODEGEN_ASMPRINTER_DIE_H__
17 #include "DwarfLabel.h"
18 #include "llvm/ADT/FoldingSet.h"
19 #include "llvm/ADT/SmallVector.h"
20 #include "llvm/Support/Compiler.h"
21 #include "llvm/Support/Dwarf.h"
29 //===--------------------------------------------------------------------===//
30 /// DIEAbbrevData - Dwarf abbreviation data, describes the one attribute of a
31 /// Dwarf abbreviation.
33 /// Attribute - Dwarf attribute code.
37 /// Form - Dwarf form code.
41 DIEAbbrevData(unsigned A, unsigned F) : Attribute(A), Form(F) {}
44 unsigned getAttribute() const { return Attribute; }
45 unsigned getForm() const { return Form; }
47 /// Profile - Used to gather unique data for the abbreviation folding set.
49 void Profile(FoldingSetNodeID &ID) const;
52 //===--------------------------------------------------------------------===//
53 /// DIEAbbrev - Dwarf abbreviation, describes the organization of a debug
54 /// information object.
55 class DIEAbbrev : public FoldingSetNode {
56 /// Tag - Dwarf tag code.
60 /// Unique number for node.
64 /// ChildrenFlag - Dwarf children flag.
66 unsigned ChildrenFlag;
68 /// Data - Raw data bytes for abbreviation.
70 SmallVector<DIEAbbrevData, 8> Data;
72 DIEAbbrev(unsigned T, unsigned C) : Tag(T), ChildrenFlag(C), Data() {}
73 virtual ~DIEAbbrev() {}
76 unsigned getTag() const { return Tag; }
77 unsigned getNumber() const { return Number; }
78 unsigned getChildrenFlag() const { return ChildrenFlag; }
79 const SmallVector<DIEAbbrevData, 8> &getData() const { return Data; }
80 void setTag(unsigned T) { Tag = T; }
81 void setChildrenFlag(unsigned CF) { ChildrenFlag = CF; }
82 void setNumber(unsigned N) { Number = N; }
84 /// AddAttribute - Adds another set of attribute information to the
86 void AddAttribute(unsigned Attribute, unsigned Form) {
87 Data.push_back(DIEAbbrevData(Attribute, Form));
90 /// AddFirstAttribute - Adds a set of attribute information to the front
91 /// of the abbreviation.
92 void AddFirstAttribute(unsigned Attribute, unsigned Form) {
93 Data.insert(Data.begin(), DIEAbbrevData(Attribute, Form));
96 /// Profile - Used to gather unique data for the abbreviation folding set.
98 void Profile(FoldingSetNodeID &ID) const;
100 /// Emit - Print the abbreviation using the specified asm printer.
102 void Emit(const AsmPrinter *Asm) const;
105 void print(raw_ostream &O);
110 //===--------------------------------------------------------------------===//
111 /// DIE - A structured debug information entry. Has an abbreviation which
112 /// describes it's organization.
118 /// Abbrev - Buffer for constructing abbreviation.
122 /// Offset - Offset in debug info section.
126 /// Size - Size of instance + children.
132 std::vector<DIE *> Children;
134 /// Attributes values.
136 SmallVector<DIEValue*, 32> Values;
138 /// Abstract compile unit.
139 CompileUnit *AbstractCU;
141 // Private data for print()
142 mutable unsigned IndentCount;
144 explicit DIE(unsigned Tag)
145 : Abbrev(Tag, dwarf::DW_CHILDREN_no), Offset(0),
146 Size(0), IndentCount(0) {}
150 DIEAbbrev &getAbbrev() { return Abbrev; }
151 unsigned getAbbrevNumber() const { return Abbrev.getNumber(); }
152 unsigned getTag() const { return Abbrev.getTag(); }
153 unsigned getOffset() const { return Offset; }
154 unsigned getSize() const { return Size; }
155 const std::vector<DIE *> &getChildren() const { return Children; }
156 SmallVector<DIEValue*, 32> &getValues() { return Values; }
157 CompileUnit *getAbstractCompileUnit() const { return AbstractCU; }
159 void setTag(unsigned Tag) { Abbrev.setTag(Tag); }
160 void setOffset(unsigned O) { Offset = O; }
161 void setSize(unsigned S) { Size = S; }
162 void setAbstractCompileUnit(CompileUnit *CU) { AbstractCU = CU; }
164 /// addValue - Add a value and attributes to a DIE.
166 void addValue(unsigned Attribute, unsigned Form, DIEValue *Value) {
167 Abbrev.AddAttribute(Attribute, Form);
168 Values.push_back(Value);
171 /// SiblingOffset - Return the offset of the debug information entry's
173 unsigned getSiblingOffset() const { return Offset + Size; }
175 /// addSiblingOffset - Add a sibling offset field to the front of the DIE.
177 void addSiblingOffset();
179 /// addChild - Add a child to the DIE.
181 void addChild(DIE *Child) {
182 Abbrev.setChildrenFlag(dwarf::DW_CHILDREN_yes);
183 Children.push_back(Child);
187 void print(raw_ostream &O, unsigned IncIndent = 0);
192 //===--------------------------------------------------------------------===//
193 /// DIEValue - A debug information entry value.
208 /// Type - Type of data stored in the value.
212 explicit DIEValue(unsigned T) : Type(T) {}
213 virtual ~DIEValue() {}
216 unsigned getType() const { return Type; }
218 /// EmitValue - Emit value via the Dwarf writer.
220 virtual void EmitValue(Dwarf *D, unsigned Form) const = 0;
222 /// SizeOf - Return the size of a value in bytes.
224 virtual unsigned SizeOf(const TargetData *TD, unsigned Form) const = 0;
226 // Implement isa/cast/dyncast.
227 static bool classof(const DIEValue *) { return true; }
230 virtual void print(raw_ostream &O) = 0;
235 //===--------------------------------------------------------------------===//
236 /// DIEInteger - An integer value DIE.
238 class DIEInteger : public DIEValue {
241 explicit DIEInteger(uint64_t I) : DIEValue(isInteger), Integer(I) {}
243 /// BestForm - Choose the best form for integer.
245 static unsigned BestForm(bool IsSigned, uint64_t Int) {
247 if ((char)Int == (signed)Int) return dwarf::DW_FORM_data1;
248 if ((short)Int == (signed)Int) return dwarf::DW_FORM_data2;
249 if ((int)Int == (signed)Int) return dwarf::DW_FORM_data4;
251 if ((unsigned char)Int == Int) return dwarf::DW_FORM_data1;
252 if ((unsigned short)Int == Int) return dwarf::DW_FORM_data2;
253 if ((unsigned int)Int == Int) return dwarf::DW_FORM_data4;
255 return dwarf::DW_FORM_data8;
258 /// EmitValue - Emit integer of appropriate size.
260 virtual void EmitValue(Dwarf *D, unsigned Form) const;
262 /// SizeOf - Determine size of integer value in bytes.
264 virtual unsigned SizeOf(const TargetData *TD, unsigned Form) const;
267 // Implement isa/cast/dyncast.
268 static bool classof(const DIEInteger *) { return true; }
269 static bool classof(const DIEValue *I) { return I->getType() == isInteger; }
272 virtual void print(raw_ostream &O);
276 //===--------------------------------------------------------------------===//
277 /// DIEString - A string value DIE.
279 class DIEString : public DIEValue {
280 const std::string Str;
282 explicit DIEString(const std::string &S) : DIEValue(isString), Str(S) {}
284 /// EmitValue - Emit string value.
286 virtual void EmitValue(Dwarf *D, unsigned Form) const;
288 /// SizeOf - Determine size of string value in bytes.
290 virtual unsigned SizeOf(const TargetData *, unsigned /*Form*/) const {
291 return Str.size() + sizeof(char); // sizeof('\0');
294 // Implement isa/cast/dyncast.
295 static bool classof(const DIEString *) { return true; }
296 static bool classof(const DIEValue *S) { return S->getType() == isString; }
299 virtual void print(raw_ostream &O);
303 //===--------------------------------------------------------------------===//
304 /// DIEDwarfLabel - A Dwarf internal label expression DIE.
306 class DIEDwarfLabel : public DIEValue {
309 explicit DIEDwarfLabel(const DWLabel &L) : DIEValue(isLabel), Label(L) {}
311 /// EmitValue - Emit label value.
313 virtual void EmitValue(Dwarf *D, unsigned Form) const;
315 /// SizeOf - Determine size of label value in bytes.
317 virtual unsigned SizeOf(const TargetData *TD, unsigned Form) const;
319 // Implement isa/cast/dyncast.
320 static bool classof(const DIEDwarfLabel *) { return true; }
321 static bool classof(const DIEValue *L) { return L->getType() == isLabel; }
324 virtual void print(raw_ostream &O);
328 //===--------------------------------------------------------------------===//
329 /// DIEObjectLabel - A label to an object in code or data.
331 class DIEObjectLabel : public DIEValue {
332 const std::string Label;
334 explicit DIEObjectLabel(const std::string &L)
335 : DIEValue(isAsIsLabel), Label(L) {}
337 /// EmitValue - Emit label value.
339 virtual void EmitValue(Dwarf *D, unsigned Form) const;
341 /// SizeOf - Determine size of label value in bytes.
343 virtual unsigned SizeOf(const TargetData *TD, unsigned Form) const;
345 // Implement isa/cast/dyncast.
346 static bool classof(const DIEObjectLabel *) { return true; }
347 static bool classof(const DIEValue *L) {
348 return L->getType() == isAsIsLabel;
352 virtual void print(raw_ostream &O);
356 //===--------------------------------------------------------------------===//
357 /// DIESectionOffset - A section offset DIE.
359 class DIESectionOffset : public DIEValue {
361 const DWLabel Section;
365 DIESectionOffset(const DWLabel &Lab, const DWLabel &Sec,
366 bool isEH = false, bool useSet = true)
367 : DIEValue(isSectionOffset), Label(Lab), Section(Sec),
368 IsEH(isEH), UseSet(useSet) {}
370 /// EmitValue - Emit section offset.
372 virtual void EmitValue(Dwarf *D, unsigned Form) const;
374 /// SizeOf - Determine size of section offset value in bytes.
376 virtual unsigned SizeOf(const TargetData *TD, unsigned Form) const;
378 // Implement isa/cast/dyncast.
379 static bool classof(const DIESectionOffset *) { return true; }
380 static bool classof(const DIEValue *D) {
381 return D->getType() == isSectionOffset;
385 virtual void print(raw_ostream &O);
389 //===--------------------------------------------------------------------===//
390 /// DIEDelta - A simple label difference DIE.
392 class DIEDelta : public DIEValue {
393 const DWLabel LabelHi;
394 const DWLabel LabelLo;
396 DIEDelta(const DWLabel &Hi, const DWLabel &Lo)
397 : DIEValue(isDelta), LabelHi(Hi), LabelLo(Lo) {}
399 /// EmitValue - Emit delta value.
401 virtual void EmitValue(Dwarf *D, unsigned Form) const;
403 /// SizeOf - Determine size of delta value in bytes.
405 virtual unsigned SizeOf(const TargetData *TD, unsigned Form) const;
407 // Implement isa/cast/dyncast.
408 static bool classof(const DIEDelta *) { return true; }
409 static bool classof(const DIEValue *D) { return D->getType() == isDelta; }
412 virtual void print(raw_ostream &O);
416 //===--------------------------------------------------------------------===//
417 /// DIEntry - A pointer to another debug information entry. An instance of
418 /// this class can also be used as a proxy for a debug information entry not
419 /// yet defined (ie. types.)
420 class DIEEntry : public DIEValue {
423 explicit DIEEntry(DIE *E) : DIEValue(isEntry), Entry(E) {}
425 DIE *getEntry() const { return Entry; }
426 void setEntry(DIE *E) { Entry = E; }
428 /// EmitValue - Emit debug information entry offset.
430 virtual void EmitValue(Dwarf *D, unsigned Form) const;
432 /// SizeOf - Determine size of debug information entry in bytes.
434 virtual unsigned SizeOf(const TargetData *TD, unsigned Form) const {
435 return sizeof(int32_t);
438 // Implement isa/cast/dyncast.
439 static bool classof(const DIEEntry *) { return true; }
440 static bool classof(const DIEValue *E) { return E->getType() == isEntry; }
443 virtual void print(raw_ostream &O);
447 //===--------------------------------------------------------------------===//
448 /// DIEBlock - A block of values. Primarily used for location expressions.
450 class DIEBlock : public DIEValue, public DIE {
451 unsigned Size; // Size in bytes excluding size header.
454 : DIEValue(isBlock), DIE(0), Size(0) {}
455 virtual ~DIEBlock() {}
457 /// ComputeSize - calculate the size of the block.
459 unsigned ComputeSize(const TargetData *TD);
461 /// BestForm - Choose the best form for data.
463 unsigned BestForm() const {
464 if ((unsigned char)Size == Size) return dwarf::DW_FORM_block1;
465 if ((unsigned short)Size == Size) return dwarf::DW_FORM_block2;
466 if ((unsigned int)Size == Size) return dwarf::DW_FORM_block4;
467 return dwarf::DW_FORM_block;
470 /// EmitValue - Emit block data.
472 virtual void EmitValue(Dwarf *D, unsigned Form) const;
474 /// SizeOf - Determine size of block data in bytes.
476 virtual unsigned SizeOf(const TargetData *TD, unsigned Form) const;
478 // Implement isa/cast/dyncast.
479 static bool classof(const DIEBlock *) { return true; }
480 static bool classof(const DIEValue *E) { return E->getType() == isBlock; }
483 virtual void print(raw_ostream &O);
487 } // end llvm namespace