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 "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"
  22 #include <vector>
  23
  24 namespace llvm {
  25   class AsmPrinter;
  26   class DwarfPrinter;
  27   class TargetData;
  28   class MCSymbol;
  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     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
 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     ///
 175     void addSiblingOffset();
 176
 177     /// addChild - Add a child to the DIE.
 178     ///
 179     void addChild(DIE *Child) {
 180       if (Child->getParent()) {
 181         assert (Child->getParent() == this && "Unexpected DIE Parent!");
 182         return;
 183       }
 184       Abbrev.setChildrenFlag(dwarf::DW_CHILDREN_yes);
 185       Children.push_back(Child);
 186       Child->Parent = this;
 187     }
 188
 189 #ifndef NDEBUG
 190     void print(raw_ostream &O, unsigned IncIndent = 0);
 191     void dump();
 192 #endif
 193   };
 194
 195   //===--------------------------------------------------------------------===//
 196   /// DIEValue - A debug information entry value.
 197   ///
 198   class DIEValue {
 199   public:
 200     enum {
 201       isInteger,
 202       isString,
 203       isLabel,
 204       isAsIsLabel,
 205       isSectionOffset,
 206       isDelta,
 207       isEntry,
 208       isBlock
 209     };
 210   protected:
 211     /// Type - Type of data stored in the value.
 212     ///
 213     unsigned Type;
 214   public:
 215     explicit DIEValue(unsigned T) : Type(T) {}
 216     virtual ~DIEValue() {}
 217
 218     // Accessors
 219     unsigned getType()  const { return Type; }
 220
 221     /// EmitValue - Emit value via the Dwarf writer.
 222     ///
 223     virtual void EmitValue(DwarfPrinter *D, unsigned Form) const = 0;
 224
 225     /// SizeOf - Return the size of a value in bytes.
 226     ///
 227     virtual unsigned SizeOf(const TargetData *TD, unsigned Form) const = 0;
 228
 229     // Implement isa/cast/dyncast.
 230     static bool classof(const DIEValue *) { return true; }
 231
 232 #ifndef NDEBUG
 233     virtual void print(raw_ostream &O) = 0;
 234     void dump();
 235 #endif
 236   };
 237
 238   //===--------------------------------------------------------------------===//
 239   /// DIEInteger - An integer value DIE.
 240   ///
 241   class DIEInteger : public DIEValue {
 242     uint64_t Integer;
 243   public:
 244     explicit DIEInteger(uint64_t I) : DIEValue(isInteger), Integer(I) {}
 245
 246     /// BestForm - Choose the best form for integer.
 247     ///
 248     static unsigned BestForm(bool IsSigned, uint64_t Int) {
 249       if (IsSigned) {
 250         if ((char)Int == (signed)Int)   return dwarf::DW_FORM_data1;
 251         if ((short)Int == (signed)Int)  return dwarf::DW_FORM_data2;
 252         if ((int)Int == (signed)Int)    return dwarf::DW_FORM_data4;
 253       } else {
 254         if ((unsigned char)Int == Int)  return dwarf::DW_FORM_data1;
 255         if ((unsigned short)Int == Int) return dwarf::DW_FORM_data2;
 256         if ((unsigned int)Int == Int)   return dwarf::DW_FORM_data4;
 257       }
 258       return dwarf::DW_FORM_data8;
 259     }
 260
 261     /// EmitValue - Emit integer of appropriate size.
 262     ///
 263     virtual void EmitValue(DwarfPrinter *D, unsigned Form) const;
 264
 265     /// SizeOf - Determine size of integer value in bytes.
 266     ///
 267     virtual unsigned SizeOf(const TargetData *TD, unsigned Form) const;
 268
 269
 270     // Implement isa/cast/dyncast.
 271     static bool classof(const DIEInteger *) { return true; }
 272     static bool classof(const DIEValue *I) { return I->getType() == isInteger; }
 273
 274 #ifndef NDEBUG
 275     virtual void print(raw_ostream &O);
 276 #endif
 277   };
 278
 279   //===--------------------------------------------------------------------===//
 280   /// DIEString - A string value DIE. This DIE keeps string reference only.
 281   ///
 282   class DIEString : public DIEValue {
 283     const StringRef Str;
 284   public:
 285     explicit DIEString(const StringRef S) : DIEValue(isString), Str(S) {}
 286
 287     /// EmitValue - Emit string value.
 288     ///
 289     virtual void EmitValue(DwarfPrinter *D, unsigned Form) const;
 290
 291     /// SizeOf - Determine size of string value in bytes.
 292     ///
 293     virtual unsigned SizeOf(const TargetData *, unsigned /*Form*/) const {
 294       return Str.size() + sizeof(char); // sizeof('\0');
 295     }
 296
 297     // Implement isa/cast/dyncast.
 298     static bool classof(const DIEString *) { return true; }
 299     static bool classof(const DIEValue *S) { return S->getType() == isString; }
 300
 301 #ifndef NDEBUG
 302     virtual void print(raw_ostream &O);
 303 #endif
 304   };
 305
 306   //===--------------------------------------------------------------------===//
 307   /// DIEDwarfLabel - A Dwarf internal label expression DIE.
 308   //
 309   class DIEDwarfLabel : public DIEValue {
 310     const DWLabel Label;
 311   public:
 312     explicit DIEDwarfLabel(const DWLabel &L) : DIEValue(isLabel), Label(L) {}
 313
 314     /// EmitValue - Emit label value.
 315     ///
 316     virtual void EmitValue(DwarfPrinter *D, unsigned Form) const;
 317
 318     /// SizeOf - Determine size of label value in bytes.
 319     ///
 320     virtual unsigned SizeOf(const TargetData *TD, unsigned Form) const;
 321
 322     // Implement isa/cast/dyncast.
 323     static bool classof(const DIEDwarfLabel *)  { return true; }
 324     static bool classof(const DIEValue *L) { return L->getType() == isLabel; }
 325
 326 #ifndef NDEBUG
 327     virtual void print(raw_ostream &O);
 328 #endif
 329   };
 330
 331   //===--------------------------------------------------------------------===//
 332   /// DIEObjectLabel - A label to an object in code or data.
 333   //
 334   class DIEObjectLabel : public DIEValue {
 335     const MCSymbol *Sym;
 336   public:
 337     explicit DIEObjectLabel(const MCSymbol *S)
 338       : DIEValue(isAsIsLabel), Sym(S) {}
 339
 340     /// EmitValue - Emit label value.
 341     ///
 342     virtual void EmitValue(DwarfPrinter *D, unsigned Form) const;
 343
 344     /// SizeOf - Determine size of label value in bytes.
 345     ///
 346     virtual unsigned SizeOf(const TargetData *TD, unsigned Form) const;
 347
 348     // Implement isa/cast/dyncast.
 349     static bool classof(const DIEObjectLabel *) { return true; }
 350     static bool classof(const DIEValue *L) {
 351       return L->getType() == isAsIsLabel;
 352     }
 353
 354 #ifndef NDEBUG
 355     virtual void print(raw_ostream &O);
 356 #endif
 357   };
 358
 359   //===--------------------------------------------------------------------===//
 360   /// DIESectionOffset - A section offset DIE.
 361   ///
 362   class DIESectionOffset : public DIEValue {
 363     const DWLabel Label;
 364     const DWLabel Section;
 365     bool IsEH : 1;
 366     bool UseSet : 1;
 367   public:
 368     DIESectionOffset(const DWLabel &Lab, const DWLabel &Sec,
 369                      bool isEH = false, bool useSet = true)
 370       : DIEValue(isSectionOffset), Label(Lab), Section(Sec),
 371         IsEH(isEH), UseSet(useSet) {}
 372
 373     /// EmitValue - Emit section offset.
 374     ///
 375     virtual void EmitValue(DwarfPrinter *D, unsigned Form) const;
 376
 377     /// SizeOf - Determine size of section offset value in bytes.
 378     ///
 379     virtual unsigned SizeOf(const TargetData *TD, unsigned Form) const;
 380
 381     // Implement isa/cast/dyncast.
 382     static bool classof(const DIESectionOffset *)  { return true; }
 383     static bool classof(const DIEValue *D) {
 384       return D->getType() == isSectionOffset;
 385     }
 386
 387 #ifndef NDEBUG
 388     virtual void print(raw_ostream &O);
 389 #endif
 390   };
 391
 392   //===--------------------------------------------------------------------===//
 393   /// DIEDelta - A simple label difference DIE.
 394   ///
 395   class DIEDelta : public DIEValue {
 396     const DWLabel LabelHi;
 397     const DWLabel LabelLo;
 398   public:
 399     DIEDelta(const DWLabel &Hi, const DWLabel &Lo)
 400       : DIEValue(isDelta), LabelHi(Hi), LabelLo(Lo) {}
 401
 402     /// EmitValue - Emit delta value.
 403     ///
 404     virtual void EmitValue(DwarfPrinter *D, unsigned Form) const;
 405
 406     /// SizeOf - Determine size of delta value in bytes.
 407     ///
 408     virtual unsigned SizeOf(const TargetData *TD, unsigned Form) const;
 409
 410     // Implement isa/cast/dyncast.
 411     static bool classof(const DIEDelta *)  { return true; }
 412     static bool classof(const DIEValue *D) { return D->getType() == isDelta; }
 413
 414 #ifndef NDEBUG
 415     virtual void print(raw_ostream &O);
 416 #endif
 417   };
 418
 419   //===--------------------------------------------------------------------===//
 420   /// DIEntry - A pointer to another debug information entry.  An instance of
 421   /// this class can also be used as a proxy for a debug information entry not
 422   /// yet defined (ie. types.)
 423   class DIEEntry : public DIEValue {
 424     DIE *Entry;
 425   public:
 426     explicit DIEEntry(DIE *E) : DIEValue(isEntry), Entry(E) {}
 427
 428     DIE *getEntry() const { return Entry; }
 429     void setEntry(DIE *E) { Entry = E; }
 430
 431     /// EmitValue - Emit debug information entry offset.
 432     ///
 433     virtual void EmitValue(DwarfPrinter *D, unsigned Form) const;
 434
 435     /// SizeOf - Determine size of debug information entry in bytes.
 436     ///
 437     virtual unsigned SizeOf(const TargetData *TD, unsigned Form) const {
 438       return sizeof(int32_t);
 439     }
 440
 441     // Implement isa/cast/dyncast.
 442     static bool classof(const DIEEntry *)  { return true; }
 443     static bool classof(const DIEValue *E) { return E->getType() == isEntry; }
 444
 445 #ifndef NDEBUG
 446     virtual void print(raw_ostream &O);
 447 #endif
 448   };
 449
 450   //===--------------------------------------------------------------------===//
 451   /// DIEBlock - A block of values.  Primarily used for location expressions.
 452   //
 453   class DIEBlock : public DIEValue, public DIE {
 454     unsigned Size;                // Size in bytes excluding size header.
 455   public:
 456     DIEBlock()
 457       : DIEValue(isBlock), DIE(0), Size(0) {}
 458     virtual ~DIEBlock() {}
 459
 460     /// ComputeSize - calculate the size of the block.
 461     ///
 462     unsigned ComputeSize(const TargetData *TD);
 463
 464     /// BestForm - Choose the best form for data.
 465     ///
 466     unsigned BestForm() const {
 467       if ((unsigned char)Size == Size)  return dwarf::DW_FORM_block1;
 468       if ((unsigned short)Size == Size) return dwarf::DW_FORM_block2;
 469       if ((unsigned int)Size == Size)   return dwarf::DW_FORM_block4;
 470       return dwarf::DW_FORM_block;
 471     }
 472
 473     /// EmitValue - Emit block data.
 474     ///
 475     virtual void EmitValue(DwarfPrinter *D, unsigned Form) const;
 476
 477     /// SizeOf - Determine size of block data in bytes.
 478     ///
 479     virtual unsigned SizeOf(const TargetData *TD, unsigned Form) const;
 480
 481     // Implement isa/cast/dyncast.
 482     static bool classof(const DIEBlock *)  { return true; }
 483     static bool classof(const DIEValue *E) { return E->getType() == isBlock; }
 484
 485 #ifndef NDEBUG
 486     virtual void print(raw_ostream &O);
 487 #endif
 488   };
 489
 490 } // end llvm namespace
 491
 492 #endif