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"
21 #include "llvm/MC/MCExpr.h"
27 class MCSymbolRefExpr;
30 //===--------------------------------------------------------------------===//
31 /// DIEAbbrevData - Dwarf abbreviation data, describes one attribute of a
32 /// Dwarf abbreviation.
34 /// Attribute - Dwarf attribute code.
38 /// Form - Dwarf form code.
42 DIEAbbrevData(uint16_t A, uint16_t F) : Attribute(A), Form(F) {}
45 uint16_t getAttribute() const { return Attribute; }
46 uint16_t 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 /// ChildrenFlag - Dwarf children flag.
63 uint16_t ChildrenFlag;
65 /// Unique number for node.
69 /// Data - Raw data bytes for abbreviation.
71 SmallVector<DIEAbbrevData, 12> Data;
74 DIEAbbrev(uint16_t T, uint16_t C) : Tag(T), ChildrenFlag(C), Data() {}
77 uint16_t getTag() const { return Tag; }
78 unsigned getNumber() const { return Number; }
79 uint16_t getChildrenFlag() const { return ChildrenFlag; }
80 const SmallVectorImpl<DIEAbbrevData> &getData() const { return Data; }
81 void setTag(uint16_t T) { Tag = T; }
82 void setChildrenFlag(uint16_t CF) { ChildrenFlag = CF; }
83 void setNumber(unsigned N) { Number = N; }
85 /// AddAttribute - Adds another set of attribute information to the
87 void AddAttribute(uint16_t Attribute, uint16_t Form) {
88 Data.push_back(DIEAbbrevData(Attribute, Form));
91 /// Profile - Used to gather unique data for the abbreviation folding set.
93 void Profile(FoldingSetNodeID &ID) const;
95 /// Emit - Print the abbreviation using the specified asm printer.
97 void Emit(AsmPrinter *AP) const;
100 void print(raw_ostream &O);
105 //===--------------------------------------------------------------------===//
106 /// DIE - A structured debug information entry. Has an abbreviation which
107 /// describes its organization.
112 /// Offset - Offset in debug info section.
116 /// Size - Size of instance + children.
120 /// Abbrev - Buffer for constructing abbreviation.
126 std::vector<DIE *> Children;
130 /// Attribute values.
132 SmallVector<DIEValue*, 12> Values;
135 // Private data for print()
136 mutable unsigned IndentCount;
139 explicit DIE(unsigned Tag)
140 : Offset(0), Size(0), Abbrev(Tag, dwarf::DW_CHILDREN_no), Parent(0) {}
144 DIEAbbrev &getAbbrev() { return Abbrev; }
145 unsigned getAbbrevNumber() const { return Abbrev.getNumber(); }
146 uint16_t getTag() const { return Abbrev.getTag(); }
147 unsigned getOffset() const { return Offset; }
148 unsigned getSize() const { return Size; }
149 const std::vector<DIE *> &getChildren() const { return Children; }
150 const SmallVectorImpl<DIEValue*> &getValues() const { return Values; }
151 DIE *getParent() const { return Parent; }
152 /// Climb up the parent chain to get the compile unit DIE this DIE belongs
154 DIE *getCompileUnit();
155 void setTag(uint16_t Tag) { Abbrev.setTag(Tag); }
156 void setOffset(unsigned O) { Offset = O; }
157 void setSize(unsigned S) { Size = S; }
159 /// addValue - Add a value and attributes to a DIE.
161 void addValue(uint16_t Attribute, uint16_t Form, DIEValue *Value) {
162 Abbrev.AddAttribute(Attribute, Form);
163 Values.push_back(Value);
166 /// addChild - Add a child to the DIE.
168 void addChild(DIE *Child) {
169 if (Child->getParent()) {
170 assert (Child->getParent() == this && "Unexpected DIE Parent!");
173 Abbrev.setChildrenFlag(dwarf::DW_CHILDREN_yes);
174 Children.push_back(Child);
175 Child->Parent = this;
178 /// findAttribute - Find a value in the DIE with the attribute given, returns NULL
179 /// if no such attribute exists.
180 DIEValue *findAttribute(uint16_t Attribute);
183 void print(raw_ostream &O, unsigned IndentCount = 0) const;
188 //===--------------------------------------------------------------------===//
189 /// DIEValue - A debug information entry value.
192 virtual void anchor();
204 /// Type - Type of data stored in the value.
208 explicit DIEValue(unsigned T) : Type(T) {}
209 virtual ~DIEValue() {}
212 unsigned getType() const { return Type; }
214 /// EmitValue - Emit value via the Dwarf writer.
216 virtual void EmitValue(AsmPrinter *AP, uint16_t Form) const = 0;
218 /// SizeOf - Return the size of a value in bytes.
220 virtual unsigned SizeOf(AsmPrinter *AP, uint16_t Form) const = 0;
223 virtual void print(raw_ostream &O) const = 0;
228 //===--------------------------------------------------------------------===//
229 /// DIEInteger - An integer value DIE.
231 class DIEInteger : public DIEValue {
234 explicit DIEInteger(uint64_t I) : DIEValue(isInteger), Integer(I) {}
236 /// BestForm - Choose the best form for integer.
238 static uint16_t BestForm(bool IsSigned, uint64_t Int) {
240 const int64_t SignedInt = Int;
241 if ((char)Int == SignedInt) return dwarf::DW_FORM_data1;
242 if ((short)Int == SignedInt) return dwarf::DW_FORM_data2;
243 if ((int)Int == SignedInt) return dwarf::DW_FORM_data4;
245 if ((unsigned char)Int == Int) return dwarf::DW_FORM_data1;
246 if ((unsigned short)Int == Int) return dwarf::DW_FORM_data2;
247 if ((unsigned int)Int == Int) return dwarf::DW_FORM_data4;
249 return dwarf::DW_FORM_data8;
252 /// EmitValue - Emit integer of appropriate size.
254 virtual void EmitValue(AsmPrinter *AP, uint16_t Form) const;
256 uint64_t getValue() const { return Integer; }
258 /// SizeOf - Determine size of integer value in bytes.
260 virtual unsigned SizeOf(AsmPrinter *AP, uint16_t Form) const;
262 // Implement isa/cast/dyncast.
263 static bool classof(const DIEValue *I) { return I->getType() == isInteger; }
266 virtual void print(raw_ostream &O) const;
270 //===--------------------------------------------------------------------===//
271 /// DIEExpr - An expression DIE.
273 class DIEExpr : public DIEValue {
276 explicit DIEExpr(const MCExpr *E) : DIEValue(isExpr), Expr(E) {}
278 /// EmitValue - Emit expression value.
280 virtual void EmitValue(AsmPrinter *AP, uint16_t Form) const;
282 /// getValue - Get MCExpr.
284 const MCExpr *getValue() const { return Expr; }
286 /// SizeOf - Determine size of expression value in bytes.
288 virtual unsigned SizeOf(AsmPrinter *AP, uint16_t Form) const;
290 // Implement isa/cast/dyncast.
291 static bool classof(const DIEValue *E) { return E->getType() == isExpr; }
294 virtual void print(raw_ostream &O) const;
298 //===--------------------------------------------------------------------===//
299 /// DIELabel - A label DIE.
301 class DIELabel : public DIEValue {
302 const MCSymbol *Label;
304 explicit DIELabel(const MCSymbol *L) : DIEValue(isLabel), Label(L) {}
306 /// EmitValue - Emit label value.
308 virtual void EmitValue(AsmPrinter *AP, uint16_t Form) const;
310 /// getValue - Get MCSymbol.
312 const MCSymbol *getValue() const { return Label; }
314 /// SizeOf - Determine size of label value in bytes.
316 virtual unsigned SizeOf(AsmPrinter *AP, uint16_t Form) const;
318 // Implement isa/cast/dyncast.
319 static bool classof(const DIEValue *L) { return L->getType() == isLabel; }
322 virtual void print(raw_ostream &O) const;
326 //===--------------------------------------------------------------------===//
327 /// DIEDelta - A simple label difference DIE.
329 class DIEDelta : public DIEValue {
330 const MCSymbol *LabelHi;
331 const MCSymbol *LabelLo;
333 DIEDelta(const MCSymbol *Hi, const MCSymbol *Lo)
334 : DIEValue(isDelta), LabelHi(Hi), LabelLo(Lo) {}
336 /// EmitValue - Emit delta value.
338 virtual void EmitValue(AsmPrinter *AP, uint16_t Form) const;
340 /// SizeOf - Determine size of delta value in bytes.
342 virtual unsigned SizeOf(AsmPrinter *AP, uint16_t Form) const;
344 // Implement isa/cast/dyncast.
345 static bool classof(const DIEValue *D) { return D->getType() == isDelta; }
348 virtual void print(raw_ostream &O) const;
352 //===--------------------------------------------------------------------===//
353 /// DIEString - A container for string values.
355 class DIEString : public DIEValue {
356 const DIEValue *Access;
360 DIEString(const DIEValue *Acc, const StringRef S)
361 : DIEValue(isString), Access(Acc), Str(S) {}
363 /// getString - Grab the string out of the object.
364 StringRef getString() const { return Str; }
366 /// EmitValue - Emit delta value.
368 virtual void EmitValue(AsmPrinter *AP, uint16_t Form) const;
370 /// SizeOf - Determine size of delta value in bytes.
372 virtual unsigned SizeOf(AsmPrinter *AP, uint16_t Form) const;
374 // Implement isa/cast/dyncast.
375 static bool classof(const DIEValue *D) { return D->getType() == isString; }
378 virtual void print(raw_ostream &O) const;
382 //===--------------------------------------------------------------------===//
383 /// DIEEntry - A pointer to another debug information entry. An instance of
384 /// this class can also be used as a proxy for a debug information entry not
385 /// yet defined (ie. types.)
386 class DIEEntry : public DIEValue {
389 explicit DIEEntry(DIE *E) : DIEValue(isEntry), Entry(E) {
390 assert(E && "Cannot construct a DIEEntry with a null DIE");
393 DIE *getEntry() const { return Entry; }
395 /// EmitValue - Emit debug information entry offset.
397 virtual void EmitValue(AsmPrinter *AP, uint16_t Form) const;
399 /// SizeOf - Determine size of debug information entry in bytes.
401 virtual unsigned SizeOf(AsmPrinter *AP, uint16_t Form) const {
402 return Form == dwarf::DW_FORM_ref_addr ? getRefAddrSize(AP)
406 /// Returns size of a ref_addr entry.
407 static unsigned getRefAddrSize(AsmPrinter *AP);
409 // Implement isa/cast/dyncast.
410 static bool classof(const DIEValue *E) { return E->getType() == isEntry; }
413 virtual void print(raw_ostream &O) const;
417 //===--------------------------------------------------------------------===//
418 /// DIEBlock - A block of values. Primarily used for location expressions.
420 class DIEBlock : public DIEValue, public DIE {
421 unsigned Size; // Size in bytes excluding size header.
424 : DIEValue(isBlock), DIE(0), Size(0) {}
425 virtual ~DIEBlock() {}
427 /// ComputeSize - calculate the size of the block.
429 unsigned ComputeSize(AsmPrinter *AP);
431 /// BestForm - Choose the best form for data.
433 uint16_t BestForm() const {
434 if ((unsigned char)Size == Size) return dwarf::DW_FORM_block1;
435 if ((unsigned short)Size == Size) return dwarf::DW_FORM_block2;
436 if ((unsigned int)Size == Size) return dwarf::DW_FORM_block4;
437 return dwarf::DW_FORM_block;
440 /// EmitValue - Emit block data.
442 virtual void EmitValue(AsmPrinter *AP, uint16_t Form) const;
444 /// SizeOf - Determine size of block data in bytes.
446 virtual unsigned SizeOf(AsmPrinter *AP, uint16_t Form) const;
448 // Implement isa/cast/dyncast.
449 static bool classof(const DIEValue *E) { return E->getType() == isBlock; }
452 virtual void print(raw_ostream &O) const;
456 } // end llvm namespace