lib/CodeGen/AsmPrinter/DIE.h

   1 //===--- lib/CodeGen/DIE.h - DWARF Info Entries -----------------*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // Data structures for DWARF info entries.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #ifndef CODEGEN_ASMPRINTER_DIE_H__
  15 #define CODEGEN_ASMPRINTER_DIE_H__
  16
  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 <vector>
  22
  23 namespace llvm {
  24   class AsmPrinter;
  25   class DwarfPrinter;
  26   class TargetData;
  27   class MCSymbol;
  28   class raw_ostream;
  29
  30   //===--------------------------------------------------------------------===//
  31   /// DIEAbbrevData - Dwarf abbreviation data, describes the one attribute of a
  32   /// Dwarf abbreviation.
  33   class DIEAbbrevData {
  34     /// Attribute - Dwarf attribute code.
  35     ///
  36     unsigned Attribute;
  37
  38     /// Form - Dwarf form code.
  39     ///
  40     unsigned Form;
  41   public:
  42     DIEAbbrevData(unsigned A, unsigned F) : Attribute(A), Form(F) {}
  43
  44     // Accessors.
  45     unsigned getAttribute() const { return Attribute; }
  46     unsigned getForm()      const { return Form; }
  47
  48     /// Profile - Used to gather unique data for the abbreviation folding set.
  49     ///
  50     void Profile(FoldingSetNodeID &ID) const;
  51   };
  52
  53   //===--------------------------------------------------------------------===//
  54   /// DIEAbbrev - Dwarf abbreviation, describes the organization of a debug
  55   /// information object.
  56   class DIEAbbrev : public FoldingSetNode {
  57     /// Tag - Dwarf tag code.
  58     ///
  59     unsigned Tag;
  60
  61     /// Unique number for node.
  62     ///
  63     unsigned Number;
  64
  65     /// ChildrenFlag - Dwarf children flag.
  66     ///
  67     unsigned ChildrenFlag;
  68
  69     /// Data - Raw data bytes for abbreviation.
  70     ///
  71     SmallVector<DIEAbbrevData, 8> Data;
  72
  73   public:
  74     DIEAbbrev(unsigned T, unsigned C) : Tag(T), ChildrenFlag(C), Data() {}
  75     virtual ~DIEAbbrev() {}
  76
  77     // Accessors.
  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; }
  85
  86     /// AddAttribute - Adds another set of attribute information to the
  87     /// abbreviation.
  88     void AddAttribute(unsigned Attribute, unsigned Form) {
  89       Data.push_back(DIEAbbrevData(Attribute, Form));
  90     }
  91
  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));
  96     }
  97
  98     /// Profile - Used to gather unique data for the abbreviation folding set.
  99     ///
 100     void Profile(FoldingSetNodeID &ID) const;
 101
 102     /// Emit - Print the abbreviation using the specified asm printer.
 103     ///
 104     void Emit(const DwarfPrinter *DP) const;
 105
 106 #ifndef NDEBUG
 107     void print(raw_ostream &O);
 108     void dump();
 109 #endif
 110   };
 111
 112   //===--------------------------------------------------------------------===//
 113   /// DIE - A structured debug information entry.  Has an abbreviation which
 114   /// describes it's organization.
 115   class DIEValue;
 116
 117   class DIE {
 118   protected:
 119     /// Abbrev - Buffer for constructing abbreviation.
 120     ///
 121     DIEAbbrev Abbrev;
 122
 123     /// Offset - Offset in debug info section.
 124     ///
 125     unsigned Offset;
 126
 127     /// Size - Size of instance + children.
 128     ///
 129     unsigned Size;
 130
 131     /// Children DIEs.
 132     ///
 133     std::vector<DIE *> Children;
 134
 135     DIE *Parent;
 136
 137     /// Attributes values.
 138     ///
 139     SmallVector<DIEValue*, 32> Values;
 140
 141     // Private data for print()
 142     mutable unsigned IndentCount;
 143   public:
 144     explicit DIE(unsigned Tag)
 145       : Abbrev(Tag, dwarf::DW_CHILDREN_no), Offset(0),
 146         Size(0), Parent (0), IndentCount(0) {}
 147     virtual ~DIE();
 148
 149     // Accessors.
 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; }
 161
 162     /// addValue - Add a value and attributes to a DIE.
 163     ///
 164     void addValue(unsigned Attribute, unsigned Form, DIEValue *Value) {
 165       Abbrev.AddAttribute(Attribute, Form);
 166       Values.push_back(Value);
 167     }
 168
 169     /// SiblingOffset - Return the offset of the debug information entry's
 170     /// sibling.
 171     unsigned getSiblingOffset() const { return Offset + Size; }
 172
 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.
 176     ///
 177     DIEValue *addSiblingOffset();
 178
 179     /// addChild - Add a child to the DIE.
 180     ///
 181     void addChild(DIE *Child) {
 182       if (Child->getParent()) {
 183         assert (Child->getParent() == this && "Unexpected DIE Parent!");
 184         return;
 185       }
 186       Abbrev.setChildrenFlag(dwarf::DW_CHILDREN_yes);
 187       Children.push_back(Child);
 188       Child->Parent = this;
 189     }
 190
 191 #ifndef NDEBUG
 192     void print(raw_ostream &O, unsigned IncIndent = 0);
 193     void dump();
 194 #endif
 195   };
 196
 197   //===--------------------------------------------------------------------===//
 198   /// DIEValue - A debug information entry value.
 199   ///
 200   class DIEValue {
 201   public:
 202     enum {
 203       isInteger,
 204       isString,
 205       isLabel,
 206       isSectionOffset,
 207       isDelta,
 208       isEntry,
 209       isBlock
 210     };
 211   protected:
 212     /// Type - Type of data stored in the value.
 213     ///
 214     unsigned Type;
 215   public:
 216     explicit DIEValue(unsigned T) : Type(T) {}
 217     virtual ~DIEValue() {}
 218
 219     // Accessors
 220     unsigned getType()  const { return Type; }
 221
 222     /// EmitValue - Emit value via the Dwarf writer.
 223     ///
 224     virtual void EmitValue(DwarfPrinter *D, unsigned Form) const = 0;
 225
 226     /// SizeOf - Return the size of a value in bytes.
 227     ///
 228     virtual unsigned SizeOf(const TargetData *TD, unsigned Form) const = 0;
 229
 230     // Implement isa/cast/dyncast.
 231     static bool classof(const DIEValue *) { return true; }
 232
 233 #ifndef NDEBUG
 234     virtual void print(raw_ostream &O) = 0;
 235     void dump();
 236 #endif
 237   };
 238
 239   //===--------------------------------------------------------------------===//
 240   /// DIEInteger - An integer value DIE.
 241   ///
 242   class DIEInteger : public DIEValue {
 243     uint64_t Integer;
 244   public:
 245     explicit DIEInteger(uint64_t I) : DIEValue(isInteger), Integer(I) {}
 246
 247     /// BestForm - Choose the best form for integer.
 248     ///
 249     static unsigned BestForm(bool IsSigned, uint64_t Int) {
 250       if (IsSigned) {
 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;
 254       } else {
 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;
 258       }
 259       return dwarf::DW_FORM_data8;
 260     }
 261
 262     /// EmitValue - Emit integer of appropriate size.
 263     ///
 264     virtual void EmitValue(DwarfPrinter *D, unsigned Form) const;
 265
 266     /// SizeOf - Determine size of integer value in bytes.
 267     ///
 268     virtual unsigned SizeOf(const TargetData *TD, unsigned Form) const;
 269
 270
 271     // Implement isa/cast/dyncast.
 272     static bool classof(const DIEInteger *) { return true; }
 273     static bool classof(const DIEValue *I) { return I->getType() == isInteger; }
 274
 275 #ifndef NDEBUG
 276     virtual void print(raw_ostream &O);
 277 #endif
 278   };
 279
 280   //===--------------------------------------------------------------------===//
 281   /// DIEString - A string value DIE. This DIE keeps string reference only.
 282   ///
 283   class DIEString : public DIEValue {
 284     const StringRef Str;
 285   public:
 286     explicit DIEString(const StringRef S) : DIEValue(isString), Str(S) {}
 287
 288     /// EmitValue - Emit string value.
 289     ///
 290     virtual void EmitValue(DwarfPrinter *D, unsigned Form) const;
 291
 292     /// SizeOf - Determine size of string value in bytes.
 293     ///
 294     virtual unsigned SizeOf(const TargetData *, unsigned /*Form*/) const {
 295       return Str.size() + sizeof(char); // sizeof('\0');
 296     }
 297
 298     // Implement isa/cast/dyncast.
 299     static bool classof(const DIEString *) { return true; }
 300     static bool classof(const DIEValue *S) { return S->getType() == isString; }
 301
 302 #ifndef NDEBUG
 303     virtual void print(raw_ostream &O);
 304 #endif
 305   };
 306
 307   //===--------------------------------------------------------------------===//
 308   /// DIELabel - A label expression DIE.
 309   //
 310   class DIELabel : public DIEValue {
 311     const MCSymbol *Label;
 312   public:
 313     explicit DIELabel(const MCSymbol *L) : DIEValue(isLabel), Label(L) {}
 314
 315     /// EmitValue - Emit label value.
 316     ///
 317     virtual void EmitValue(DwarfPrinter *D, unsigned Form) const;
 318
 319     /// SizeOf - Determine size of label value in bytes.
 320     ///
 321     virtual unsigned SizeOf(const TargetData *TD, unsigned Form) const;
 322
 323     // Implement isa/cast/dyncast.
 324     static bool classof(const DIELabel *)  { return true; }
 325     static bool classof(const DIEValue *L) { return L->getType() == isLabel; }
 326
 327 #ifndef NDEBUG
 328     virtual void print(raw_ostream &O);
 329 #endif
 330   };
 331
 332   //===--------------------------------------------------------------------===//
 333   /// DIEDelta - A simple label difference DIE.
 334   ///
 335   class DIEDelta : public DIEValue {
 336     const MCSymbol *LabelHi;
 337     const MCSymbol *LabelLo;
 338   public:
 339     DIEDelta(const MCSymbol *Hi, const MCSymbol *Lo)
 340       : DIEValue(isDelta), LabelHi(Hi), LabelLo(Lo) {}
 341
 342     /// EmitValue - Emit delta value.
 343     ///
 344     virtual void EmitValue(DwarfPrinter *D, unsigned Form) const;
 345
 346     /// SizeOf - Determine size of delta value in bytes.
 347     ///
 348     virtual unsigned SizeOf(const TargetData *TD, unsigned Form) const;
 349
 350     // Implement isa/cast/dyncast.
 351     static bool classof(const DIEDelta *)  { return true; }
 352     static bool classof(const DIEValue *D) { return D->getType() == isDelta; }
 353
 354 #ifndef NDEBUG
 355     virtual void print(raw_ostream &O);
 356 #endif
 357   };
 358
 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 {
 364     DIE *const Entry;
 365   public:
 366     explicit DIEEntry(DIE *E) : DIEValue(isEntry), Entry(E) {}
 367
 368     DIE *getEntry() const { return Entry; }
 369
 370     /// EmitValue - Emit debug information entry offset.
 371     ///
 372     virtual void EmitValue(DwarfPrinter *D, unsigned Form) const;
 373
 374     /// SizeOf - Determine size of debug information entry in bytes.
 375     ///
 376     virtual unsigned SizeOf(const TargetData *TD, unsigned Form) const {
 377       return sizeof(int32_t);
 378     }
 379
 380     // Implement isa/cast/dyncast.
 381     static bool classof(const DIEEntry *)  { return true; }
 382     static bool classof(const DIEValue *E) { return E->getType() == isEntry; }
 383
 384 #ifndef NDEBUG
 385     virtual void print(raw_ostream &O);
 386 #endif
 387   };
 388
 389   //===--------------------------------------------------------------------===//
 390   /// DIEBlock - A block of values.  Primarily used for location expressions.
 391   //
 392   class DIEBlock : public DIEValue, public DIE {
 393     unsigned Size;                // Size in bytes excluding size header.
 394   public:
 395     DIEBlock()
 396       : DIEValue(isBlock), DIE(0), Size(0) {}
 397     virtual ~DIEBlock() {}
 398
 399     /// ComputeSize - calculate the size of the block.
 400     ///
 401     unsigned ComputeSize(const TargetData *TD);
 402
 403     /// BestForm - Choose the best form for data.
 404     ///
 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;
 410     }
 411
 412     /// EmitValue - Emit block data.
 413     ///
 414     virtual void EmitValue(DwarfPrinter *D, unsigned Form) const;
 415
 416     /// SizeOf - Determine size of block data in bytes.
 417     ///
 418     virtual unsigned SizeOf(const TargetData *TD, unsigned Form) const;
 419
 420     // Implement isa/cast/dyncast.
 421     static bool classof(const DIEBlock *)  { return true; }
 422     static bool classof(const DIEValue *E) { return E->getType() == isBlock; }
 423
 424 #ifndef NDEBUG
 425     virtual void print(raw_ostream &O);
 426 #endif
 427   };
 428
 429 } // end llvm namespace
 430
 431 #endif