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 "llvm/ADT/FoldingSet.h"
18 #include "llvm/ADT/SmallVector.h"
19 #include "llvm/Support/Compiler.h"
20 #include "llvm/Support/Dwarf.h"
30 //===--------------------------------------------------------------------===//
31 /// DIEAbbrevData - Dwarf abbreviation data, describes the one attribute of a
32 /// Dwarf abbreviation.
34 /// Attribute - Dwarf attribute code.
38 /// Form - Dwarf form code.
42 DIEAbbrevData(unsigned A, unsigned F) : Attribute(A), Form(F) {}
45 unsigned getAttribute() const { return Attribute; }
46 unsigned getForm() const { return Form; }
48 /// Profile - Used to gather unique data for the abbreviation folding set.
50 void Profile(FoldingSetNodeID &ID) const;
53 //===--------------------------------------------------------------------===//
54 /// DIEAbbrev - Dwarf abbreviation, describes the organization of a debug
55 /// information object.
56 class DIEAbbrev : public FoldingSetNode {
57 /// Tag - Dwarf tag code.
61 /// Unique number for node.
65 /// ChildrenFlag - Dwarf children flag.
67 unsigned ChildrenFlag;
69 /// Data - Raw data bytes for abbreviation.
71 SmallVector<DIEAbbrevData, 8> Data;
74 DIEAbbrev(unsigned T, unsigned C) : Tag(T), ChildrenFlag(C), Data() {}
75 virtual ~DIEAbbrev() {}
78 unsigned getTag() const { return Tag; }
79 unsigned getNumber() const { return Number; }
80 unsigned getChildrenFlag() const { return ChildrenFlag; }
81 const SmallVector<DIEAbbrevData, 8> &getData() const { return Data; }
82 void setTag(unsigned T) { Tag = T; }
83 void setChildrenFlag(unsigned CF) { ChildrenFlag = CF; }
84 void setNumber(unsigned N) { Number = N; }
86 /// AddAttribute - Adds another set of attribute information to the
88 void AddAttribute(unsigned Attribute, unsigned Form) {
89 Data.push_back(DIEAbbrevData(Attribute, Form));
92 /// AddFirstAttribute - Adds a set of attribute information to the front
93 /// of the abbreviation.
94 void AddFirstAttribute(unsigned Attribute, unsigned Form) {
95 Data.insert(Data.begin(), DIEAbbrevData(Attribute, Form));
98 /// Profile - Used to gather unique data for the abbreviation folding set.
100 void Profile(FoldingSetNodeID &ID) const;
102 /// Emit - Print the abbreviation using the specified asm printer.
104 void Emit(const DwarfPrinter *DP) const;
107 void print(raw_ostream &O);
112 //===--------------------------------------------------------------------===//
113 /// DIE - A structured debug information entry. Has an abbreviation which
114 /// describes it's organization.
119 /// Abbrev - Buffer for constructing abbreviation.
123 /// Offset - Offset in debug info section.
127 /// Size - Size of instance + children.
133 std::vector<DIE *> Children;
137 /// Attributes values.
139 SmallVector<DIEValue*, 32> Values;
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), Parent (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 const SmallVector<DIEValue*, 32> &getValues() const { return Values; }
157 DIE *getParent() const { return Parent; }
158 void setTag(unsigned Tag) { Abbrev.setTag(Tag); }
159 void setOffset(unsigned O) { Offset = O; }
160 void setSize(unsigned S) { Size = S; }
162 /// addValue - Add a value and attributes to a DIE.
164 void addValue(unsigned Attribute, unsigned Form, DIEValue *Value) {
165 Abbrev.AddAttribute(Attribute, Form);
166 Values.push_back(Value);
169 /// SiblingOffset - Return the offset of the debug information entry's
171 unsigned getSiblingOffset() const { return Offset + Size; }
173 /// addSiblingOffset - Add a sibling offset field to the front of the DIE.
174 /// The caller is responsible for deleting the return value at or after the
175 /// same time it destroys this DIE.
177 DIEValue *addSiblingOffset(BumpPtrAllocator &A);
179 /// addChild - Add a child to the DIE.
181 void addChild(DIE *Child) {
182 if (Child->getParent()) {
183 assert (Child->getParent() == this && "Unexpected DIE Parent!");
186 Abbrev.setChildrenFlag(dwarf::DW_CHILDREN_yes);
187 Children.push_back(Child);
188 Child->Parent = this;
192 void print(raw_ostream &O, unsigned IncIndent = 0);
197 //===--------------------------------------------------------------------===//
198 /// DIEValue - A debug information entry value.
212 /// Type - Type of data stored in the value.
216 explicit DIEValue(unsigned T) : Type(T) {}
217 virtual ~DIEValue() {}
220 unsigned getType() const { return Type; }
222 /// EmitValue - Emit value via the Dwarf writer.
224 virtual void EmitValue(DwarfPrinter *D, unsigned Form) const = 0;
226 /// SizeOf - Return the size of a value in bytes.
228 virtual unsigned SizeOf(const TargetData *TD, unsigned Form) const = 0;
230 // Implement isa/cast/dyncast.
231 static bool classof(const DIEValue *) { return true; }
234 virtual void print(raw_ostream &O) = 0;
239 //===--------------------------------------------------------------------===//
240 /// DIEInteger - An integer value DIE.
242 class DIEInteger : public DIEValue {
245 explicit DIEInteger(uint64_t I) : DIEValue(isInteger), Integer(I) {}
247 /// BestForm - Choose the best form for integer.
249 static unsigned BestForm(bool IsSigned, uint64_t Int) {
251 if ((char)Int == (signed)Int) return dwarf::DW_FORM_data1;
252 if ((short)Int == (signed)Int) return dwarf::DW_FORM_data2;
253 if ((int)Int == (signed)Int) return dwarf::DW_FORM_data4;
255 if ((unsigned char)Int == Int) return dwarf::DW_FORM_data1;
256 if ((unsigned short)Int == Int) return dwarf::DW_FORM_data2;
257 if ((unsigned int)Int == Int) return dwarf::DW_FORM_data4;
259 return dwarf::DW_FORM_data8;
262 /// EmitValue - Emit integer of appropriate size.
264 virtual void EmitValue(DwarfPrinter *D, unsigned Form) const;
266 /// SizeOf - Determine size of integer value in bytes.
268 virtual unsigned SizeOf(const TargetData *TD, unsigned Form) const;
271 // Implement isa/cast/dyncast.
272 static bool classof(const DIEInteger *) { return true; }
273 static bool classof(const DIEValue *I) { return I->getType() == isInteger; }
276 virtual void print(raw_ostream &O);
280 //===--------------------------------------------------------------------===//
281 /// DIEString - A string value DIE. This DIE keeps string reference only.
283 class DIEString : public DIEValue {
286 explicit DIEString(const StringRef S) : DIEValue(isString), Str(S) {}
288 /// EmitValue - Emit string value.
290 virtual void EmitValue(DwarfPrinter *D, unsigned Form) const;
292 /// SizeOf - Determine size of string value in bytes.
294 virtual unsigned SizeOf(const TargetData *, unsigned /*Form*/) const {
295 return Str.size() + sizeof(char); // sizeof('\0');
298 // Implement isa/cast/dyncast.
299 static bool classof(const DIEString *) { return true; }
300 static bool classof(const DIEValue *S) { return S->getType() == isString; }
303 virtual void print(raw_ostream &O);
307 //===--------------------------------------------------------------------===//
308 /// DIELabel - A label expression DIE.
310 class DIELabel : public DIEValue {
311 const MCSymbol *Label;
313 explicit DIELabel(const MCSymbol *L) : DIEValue(isLabel), Label(L) {}
315 /// EmitValue - Emit label value.
317 virtual void EmitValue(DwarfPrinter *D, unsigned Form) const;
319 /// SizeOf - Determine size of label value in bytes.
321 virtual unsigned SizeOf(const TargetData *TD, unsigned Form) const;
323 // Implement isa/cast/dyncast.
324 static bool classof(const DIELabel *) { return true; }
325 static bool classof(const DIEValue *L) { return L->getType() == isLabel; }
328 virtual void print(raw_ostream &O);
332 //===--------------------------------------------------------------------===//
333 /// DIEDelta - A simple label difference DIE.
335 class DIEDelta : public DIEValue {
336 const MCSymbol *LabelHi;
337 const MCSymbol *LabelLo;
339 DIEDelta(const MCSymbol *Hi, const MCSymbol *Lo)
340 : DIEValue(isDelta), LabelHi(Hi), LabelLo(Lo) {}
342 /// EmitValue - Emit delta value.
344 virtual void EmitValue(DwarfPrinter *D, unsigned Form) const;
346 /// SizeOf - Determine size of delta value in bytes.
348 virtual unsigned SizeOf(const TargetData *TD, unsigned Form) const;
350 // Implement isa/cast/dyncast.
351 static bool classof(const DIEDelta *) { return true; }
352 static bool classof(const DIEValue *D) { return D->getType() == isDelta; }
355 virtual void print(raw_ostream &O);
359 //===--------------------------------------------------------------------===//
360 /// DIEntry - A pointer to another debug information entry. An instance of
361 /// this class can also be used as a proxy for a debug information entry not
362 /// yet defined (ie. types.)
363 class DIEEntry : public DIEValue {
366 explicit DIEEntry(DIE *E) : DIEValue(isEntry), Entry(E) {}
368 DIE *getEntry() const { return Entry; }
370 /// EmitValue - Emit debug information entry offset.
372 virtual void EmitValue(DwarfPrinter *D, unsigned Form) const;
374 /// SizeOf - Determine size of debug information entry in bytes.
376 virtual unsigned SizeOf(const TargetData *TD, unsigned Form) const {
377 return sizeof(int32_t);
380 // Implement isa/cast/dyncast.
381 static bool classof(const DIEEntry *) { return true; }
382 static bool classof(const DIEValue *E) { return E->getType() == isEntry; }
385 virtual void print(raw_ostream &O);
389 //===--------------------------------------------------------------------===//
390 /// DIEBlock - A block of values. Primarily used for location expressions.
392 class DIEBlock : public DIEValue, public DIE {
393 unsigned Size; // Size in bytes excluding size header.
396 : DIEValue(isBlock), DIE(0), Size(0) {}
397 virtual ~DIEBlock() {}
399 /// ComputeSize - calculate the size of the block.
401 unsigned ComputeSize(const TargetData *TD);
403 /// BestForm - Choose the best form for data.
405 unsigned BestForm() const {
406 if ((unsigned char)Size == Size) return dwarf::DW_FORM_block1;
407 if ((unsigned short)Size == Size) return dwarf::DW_FORM_block2;
408 if ((unsigned int)Size == Size) return dwarf::DW_FORM_block4;
409 return dwarf::DW_FORM_block;
412 /// EmitValue - Emit block data.
414 virtual void EmitValue(DwarfPrinter *D, unsigned Form) const;
416 /// SizeOf - Determine size of block data in bytes.
418 virtual unsigned SizeOf(const TargetData *TD, unsigned Form) const;
420 // Implement isa/cast/dyncast.
421 static bool classof(const DIEBlock *) { return true; }
422 static bool classof(const DIEValue *E) { return E->getType() == isBlock; }
425 virtual void print(raw_ostream &O);
429 } // end llvm namespace