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;
73 DIEAbbrev(unsigned T, unsigned C) : Tag(T), ChildrenFlag(C), Data() {}
74 virtual ~DIEAbbrev() {}
77 unsigned getTag() const { return Tag; }
78 unsigned getNumber() const { return Number; }
79 unsigned getChildrenFlag() const { return ChildrenFlag; }
80 const SmallVector<DIEAbbrevData, 8> &getData() const { return Data; }
81 void setTag(unsigned T) { Tag = T; }
82 void setChildrenFlag(unsigned CF) { ChildrenFlag = CF; }
83 void setNumber(unsigned N) { Number = N; }
85 /// AddAttribute - Adds another set of attribute information to the
87 void AddAttribute(unsigned Attribute, unsigned Form) {
88 Data.push_back(DIEAbbrevData(Attribute, Form));
91 /// AddFirstAttribute - Adds a set of attribute information to the front
92 /// of the abbreviation.
93 void AddFirstAttribute(unsigned Attribute, unsigned Form) {
94 Data.insert(Data.begin(), DIEAbbrevData(Attribute, Form));
97 /// Profile - Used to gather unique data for the abbreviation folding set.
99 void Profile(FoldingSetNodeID &ID) const;
101 /// Emit - Print the abbreviation using the specified asm printer.
103 void Emit(const AsmPrinter *Asm) const;
106 void print(raw_ostream &O);
111 //===--------------------------------------------------------------------===//
112 /// DIE - A structured debug information entry. Has an abbreviation which
113 /// 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 SmallVector<DIEValue*, 32> &getValues() { 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; }
161 void setParent(DIE *P) { Parent = P; }
163 /// addValue - Add a value and attributes to a DIE.
165 void addValue(unsigned Attribute, unsigned Form, DIEValue *Value) {
166 Abbrev.AddAttribute(Attribute, Form);
167 Values.push_back(Value);
170 /// SiblingOffset - Return the offset of the debug information entry's
172 unsigned getSiblingOffset() const { return Offset + Size; }
174 /// addSiblingOffset - Add a sibling offset field to the front of the DIE.
176 void addSiblingOffset();
178 /// addChild - Add a child to the DIE.
180 void addChild(DIE *Child) {
181 if (Child->getParent()) {
182 assert (Child->getParent() == this && "Unexpected DIE Parent!");
185 Abbrev.setChildrenFlag(dwarf::DW_CHILDREN_yes);
186 Children.push_back(Child);
187 Child->setParent(this);
191 void print(raw_ostream &O, unsigned IncIndent = 0);
196 //===--------------------------------------------------------------------===//
197 /// 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(Dwarf *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(Dwarf *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(Dwarf *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 /// DIEDwarfLabel - A Dwarf internal label expression DIE.
310 class DIEDwarfLabel : public DIEValue {
313 explicit DIEDwarfLabel(const DWLabel &L) : DIEValue(isLabel), Label(L) {}
315 /// EmitValue - Emit label value.
317 virtual void EmitValue(Dwarf *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 DIEDwarfLabel *) { return true; }
325 static bool classof(const DIEValue *L) { return L->getType() == isLabel; }
328 virtual void print(raw_ostream &O);
332 //===--------------------------------------------------------------------===//
333 /// DIEObjectLabel - A label to an object in code or data.
335 class DIEObjectLabel : public DIEValue {
336 const std::string Label;
338 explicit DIEObjectLabel(const std::string &L)
339 : DIEValue(isAsIsLabel), Label(L) {}
341 /// EmitValue - Emit label value.
343 virtual void EmitValue(Dwarf *D, unsigned Form) const;
345 /// SizeOf - Determine size of label value in bytes.
347 virtual unsigned SizeOf(const TargetData *TD, unsigned Form) const;
349 // Implement isa/cast/dyncast.
350 static bool classof(const DIEObjectLabel *) { return true; }
351 static bool classof(const DIEValue *L) {
352 return L->getType() == isAsIsLabel;
356 virtual void print(raw_ostream &O);
360 //===--------------------------------------------------------------------===//
361 /// DIESectionOffset - A section offset DIE.
363 class DIESectionOffset : public DIEValue {
365 const DWLabel Section;
369 DIESectionOffset(const DWLabel &Lab, const DWLabel &Sec,
370 bool isEH = false, bool useSet = true)
371 : DIEValue(isSectionOffset), Label(Lab), Section(Sec),
372 IsEH(isEH), UseSet(useSet) {}
374 /// EmitValue - Emit section offset.
376 virtual void EmitValue(Dwarf *D, unsigned Form) const;
378 /// SizeOf - Determine size of section offset value in bytes.
380 virtual unsigned SizeOf(const TargetData *TD, unsigned Form) const;
382 // Implement isa/cast/dyncast.
383 static bool classof(const DIESectionOffset *) { return true; }
384 static bool classof(const DIEValue *D) {
385 return D->getType() == isSectionOffset;
389 virtual void print(raw_ostream &O);
393 //===--------------------------------------------------------------------===//
394 /// DIEDelta - A simple label difference DIE.
396 class DIEDelta : public DIEValue {
397 const DWLabel LabelHi;
398 const DWLabel LabelLo;
400 DIEDelta(const DWLabel &Hi, const DWLabel &Lo)
401 : DIEValue(isDelta), LabelHi(Hi), LabelLo(Lo) {}
403 /// EmitValue - Emit delta value.
405 virtual void EmitValue(Dwarf *D, unsigned Form) const;
407 /// SizeOf - Determine size of delta value in bytes.
409 virtual unsigned SizeOf(const TargetData *TD, unsigned Form) const;
411 // Implement isa/cast/dyncast.
412 static bool classof(const DIEDelta *) { return true; }
413 static bool classof(const DIEValue *D) { return D->getType() == isDelta; }
416 virtual void print(raw_ostream &O);
420 //===--------------------------------------------------------------------===//
421 /// DIEntry - A pointer to another debug information entry. An instance of
422 /// this class can also be used as a proxy for a debug information entry not
423 /// yet defined (ie. types.)
424 class DIEEntry : public DIEValue {
427 explicit DIEEntry(DIE *E) : DIEValue(isEntry), Entry(E) {}
429 DIE *getEntry() const { return Entry; }
430 void setEntry(DIE *E) { Entry = E; }
432 /// EmitValue - Emit debug information entry offset.
434 virtual void EmitValue(Dwarf *D, unsigned Form) const;
436 /// SizeOf - Determine size of debug information entry in bytes.
438 virtual unsigned SizeOf(const TargetData *TD, unsigned Form) const {
439 return sizeof(int32_t);
442 // Implement isa/cast/dyncast.
443 static bool classof(const DIEEntry *) { return true; }
444 static bool classof(const DIEValue *E) { return E->getType() == isEntry; }
447 virtual void print(raw_ostream &O);
451 //===--------------------------------------------------------------------===//
452 /// DIEBlock - A block of values. Primarily used for location expressions.
454 class DIEBlock : public DIEValue, public DIE {
455 unsigned Size; // Size in bytes excluding size header.
458 : DIEValue(isBlock), DIE(0), Size(0) {}
459 virtual ~DIEBlock() {}
461 /// ComputeSize - calculate the size of the block.
463 unsigned ComputeSize(const TargetData *TD);
465 /// BestForm - Choose the best form for data.
467 unsigned BestForm() const {
468 if ((unsigned char)Size == Size) return dwarf::DW_FORM_block1;
469 if ((unsigned short)Size == Size) return dwarf::DW_FORM_block2;
470 if ((unsigned int)Size == Size) return dwarf::DW_FORM_block4;
471 return dwarf::DW_FORM_block;
474 /// EmitValue - Emit block data.
476 virtual void EmitValue(Dwarf *D, unsigned Form) const;
478 /// SizeOf - Determine size of block data in bytes.
480 virtual unsigned SizeOf(const TargetData *TD, unsigned Form) const;
482 // Implement isa/cast/dyncast.
483 static bool classof(const DIEBlock *) { return true; }
484 static bool classof(const DIEValue *E) { return E->getType() == isBlock; }
487 virtual void print(raw_ostream &O);
491 } // end llvm namespace