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 Dwarf;
  27   class TargetData;
  28
  29   //===--------------------------------------------------------------------===//
  30   /// DIEAbbrevData - Dwarf abbreviation data, describes the one attribute of a
  31   /// Dwarf abbreviation.
  32   class VISIBILITY_HIDDEN DIEAbbrevData {
  33     /// Attribute - Dwarf attribute code.
  34     ///
  35     unsigned Attribute;
  36
  37     /// Form - Dwarf form code.
  38     ///
  39     unsigned Form;
  40   public:
  41     DIEAbbrevData(unsigned A, unsigned F) : Attribute(A), Form(F) {}
  42
  43     // Accessors.
  44     unsigned getAttribute() const { return Attribute; }
  45     unsigned getForm()      const { return Form; }
  46
  47     /// Profile - Used to gather unique data for the abbreviation folding set.
  48     ///
  49     void Profile(FoldingSetNodeID &ID) const;
  50   };
  51
  52   //===--------------------------------------------------------------------===//
  53   /// DIEAbbrev - Dwarf abbreviation, describes the organization of a debug
  54   /// information object.
  55   class VISIBILITY_HIDDEN DIEAbbrev : public FoldingSetNode {
  56     /// Tag - Dwarf tag code.
  57     ///
  58     unsigned Tag;
  59
  60     /// Unique number for node.
  61     ///
  62     unsigned Number;
  63
  64     /// ChildrenFlag - Dwarf children flag.
  65     ///
  66     unsigned ChildrenFlag;
  67
  68     /// Data - Raw data bytes for abbreviation.
  69     ///
  70     SmallVector<DIEAbbrevData, 8> Data;
  71   public:
  72     DIEAbbrev(unsigned T, unsigned C) : Tag(T), ChildrenFlag(C), Data() {}
  73     virtual ~DIEAbbrev() {}
  74
  75     // Accessors.
  76     unsigned getTag() const { return Tag; }
  77     unsigned getNumber() const { return Number; }
  78     unsigned getChildrenFlag() const { return ChildrenFlag; }
  79     const SmallVector<DIEAbbrevData, 8> &getData() const { return Data; }
  80     void setTag(unsigned T) { Tag = T; }
  81     void setChildrenFlag(unsigned CF) { ChildrenFlag = CF; }
  82     void setNumber(unsigned N) { Number = N; }
  83
  84     /// AddAttribute - Adds another set of attribute information to the
  85     /// abbreviation.
  86     void AddAttribute(unsigned Attribute, unsigned Form) {
  87       Data.push_back(DIEAbbrevData(Attribute, Form));
  88     }
  89
  90     /// AddFirstAttribute - Adds a set of attribute information to the front
  91     /// of the abbreviation.
  92     void AddFirstAttribute(unsigned Attribute, unsigned Form) {
  93       Data.insert(Data.begin(), DIEAbbrevData(Attribute, Form));
  94     }
  95
  96     /// Profile - Used to gather unique data for the abbreviation folding set.
  97     ///
  98     void Profile(FoldingSetNodeID &ID) const;
  99
 100     /// Emit - Print the abbreviation using the specified asm printer.
 101     ///
 102     void Emit(const AsmPrinter *Asm) const;
 103
 104 #ifndef NDEBUG
 105     void print(raw_ostream &O);
 106     void dump();
 107 #endif
 108   };
 109
 110   //===--------------------------------------------------------------------===//
 111   /// DIE - A structured debug information entry.  Has an abbreviation which
 112   /// describes it's organization.
 113   class CompileUnit;
 114   class DIEValue;
 115
 116   class VISIBILITY_HIDDEN DIE : public FoldingSetNode {
 117   protected:
 118     /// Abbrev - Buffer for constructing abbreviation.
 119     ///
 120     DIEAbbrev Abbrev;
 121
 122     /// Offset - Offset in debug info section.
 123     ///
 124     unsigned Offset;
 125
 126     /// Size - Size of instance + children.
 127     ///
 128     unsigned Size;
 129
 130     /// Children DIEs.
 131     ///
 132     std::vector<DIE *> Children;
 133
 134     /// Attributes values.
 135     ///
 136     SmallVector<DIEValue*, 32> Values;
 137
 138     /// Abstract compile unit.
 139     CompileUnit *AbstractCU;
 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), 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     CompileUnit *getAbstractCompileUnit() const { return AbstractCU; }
 158
 159     void setTag(unsigned Tag) { Abbrev.setTag(Tag); }
 160     void setOffset(unsigned O) { Offset = O; }
 161     void setSize(unsigned S) { Size = S; }
 162     void setAbstractCompileUnit(CompileUnit *CU) { AbstractCU = CU; }
 163
 164     /// AddValue - Add a value and attributes to a DIE.
 165     ///
 166     void AddValue(unsigned Attribute, unsigned Form, DIEValue *Value) {
 167       Abbrev.AddAttribute(Attribute, Form);
 168       Values.push_back(Value);
 169     }
 170
 171     /// SiblingOffset - Return the offset of the debug information entry's
 172     /// sibling.
 173     unsigned SiblingOffset() const { return Offset + Size; }
 174
 175     /// AddSiblingOffset - Add a sibling offset field to the front of the DIE.
 176     ///
 177     void AddSiblingOffset();
 178
 179     /// AddChild - Add a child to the DIE.
 180     ///
 181     void AddChild(DIE *Child) {
 182       Abbrev.setChildrenFlag(dwarf::DW_CHILDREN_yes);
 183       Children.push_back(Child);
 184     }
 185
 186     /// Detach - Detaches objects connected to it after copying.
 187     ///
 188     void Detach() {
 189       Children.clear();
 190     }
 191
 192     /// Profile - Used to gather unique data for the value folding set.
 193     ///
 194     void Profile(FoldingSetNodeID &ID) ;
 195
 196 #ifndef NDEBUG
 197     void print(raw_ostream &O, unsigned IncIndent = 0);
 198     void dump();
 199 #endif
 200   };
 201
 202   //===--------------------------------------------------------------------===//
 203   /// DIEValue - A debug information entry value.
 204   ///
 205   class VISIBILITY_HIDDEN DIEValue : public FoldingSetNode {
 206   public:
 207     enum {
 208       isInteger,
 209       isString,
 210       isLabel,
 211       isAsIsLabel,
 212       isSectionOffset,
 213       isDelta,
 214       isEntry,
 215       isBlock
 216     };
 217   protected:
 218     /// Type - Type of data stored in the value.
 219     ///
 220     unsigned Type;
 221   public:
 222     explicit DIEValue(unsigned T) : Type(T) {}
 223     virtual ~DIEValue() {}
 224
 225     // Accessors
 226     unsigned getType()  const { return Type; }
 227
 228     /// EmitValue - Emit value via the Dwarf writer.
 229     ///
 230     virtual void EmitValue(Dwarf *D, unsigned Form) const = 0;
 231
 232     /// SizeOf - Return the size of a value in bytes.
 233     ///
 234     virtual unsigned SizeOf(const TargetData *TD, unsigned Form) const = 0;
 235
 236     /// Profile - Used to gather unique data for the value folding set.
 237     ///
 238     virtual void Profile(FoldingSetNodeID &ID) = 0;
 239
 240     // Implement isa/cast/dyncast.
 241     static bool classof(const DIEValue *) { return true; }
 242
 243 #ifndef NDEBUG
 244     virtual void print(raw_ostream &O) = 0;
 245     void dump();
 246 #endif
 247   };
 248
 249   //===--------------------------------------------------------------------===//
 250   /// DIEInteger - An integer value DIE.
 251   ///
 252   class VISIBILITY_HIDDEN DIEInteger : public DIEValue {
 253     uint64_t Integer;
 254   public:
 255     explicit DIEInteger(uint64_t I) : DIEValue(isInteger), Integer(I) {}
 256
 257     /// BestForm - Choose the best form for integer.
 258     ///
 259     static unsigned BestForm(bool IsSigned, uint64_t Int) {
 260       if (IsSigned) {
 261         if ((char)Int == (signed)Int)   return dwarf::DW_FORM_data1;
 262         if ((short)Int == (signed)Int)  return dwarf::DW_FORM_data2;
 263         if ((int)Int == (signed)Int)    return dwarf::DW_FORM_data4;
 264       } else {
 265         if ((unsigned char)Int == Int)  return dwarf::DW_FORM_data1;
 266         if ((unsigned short)Int == Int) return dwarf::DW_FORM_data2;
 267         if ((unsigned int)Int == Int)   return dwarf::DW_FORM_data4;
 268       }
 269       return dwarf::DW_FORM_data8;
 270     }
 271
 272     /// EmitValue - Emit integer of appropriate size.
 273     ///
 274     virtual void EmitValue(Dwarf *D, unsigned Form) const;
 275
 276     /// SizeOf - Determine size of integer value in bytes.
 277     ///
 278     virtual unsigned SizeOf(const TargetData *TD, unsigned Form) const;
 279
 280     /// Profile - Used to gather unique data for the value folding set.
 281     ///
 282     static void Profile(FoldingSetNodeID &ID, unsigned Int);
 283     virtual void Profile(FoldingSetNodeID &ID);
 284
 285     // Implement isa/cast/dyncast.
 286     static bool classof(const DIEInteger *) { return true; }
 287     static bool classof(const DIEValue *I) { return I->getType() == isInteger; }
 288
 289 #ifndef NDEBUG
 290     virtual void print(raw_ostream &O);
 291 #endif
 292   };
 293
 294   //===--------------------------------------------------------------------===//
 295   /// DIEString - A string value DIE.
 296   ///
 297   class VISIBILITY_HIDDEN DIEString : public DIEValue {
 298     const std::string Str;
 299   public:
 300     explicit DIEString(const std::string &S) : DIEValue(isString), Str(S) {}
 301
 302     /// EmitValue - Emit string value.
 303     ///
 304     virtual void EmitValue(Dwarf *D, unsigned Form) const;
 305
 306     /// SizeOf - Determine size of string value in bytes.
 307     ///
 308     virtual unsigned SizeOf(const TargetData *, unsigned /*Form*/) const {
 309       return Str.size() + sizeof(char); // sizeof('\0');
 310     }
 311
 312     /// Profile - Used to gather unique data for the value folding set.
 313     ///
 314     static void Profile(FoldingSetNodeID &ID, const std::string &Str);
 315     virtual void Profile(FoldingSetNodeID &ID);
 316
 317     // Implement isa/cast/dyncast.
 318     static bool classof(const DIEString *) { return true; }
 319     static bool classof(const DIEValue *S) { return S->getType() == isString; }
 320
 321 #ifndef NDEBUG
 322     virtual void print(raw_ostream &O);
 323 #endif
 324   };
 325
 326   //===--------------------------------------------------------------------===//
 327   /// DIEDwarfLabel - A Dwarf internal label expression DIE.
 328   //
 329   class VISIBILITY_HIDDEN DIEDwarfLabel : public DIEValue {
 330     const DWLabel Label;
 331   public:
 332     explicit DIEDwarfLabel(const DWLabel &L) : DIEValue(isLabel), Label(L) {}
 333
 334     /// EmitValue - Emit label value.
 335     ///
 336     virtual void EmitValue(Dwarf *D, unsigned Form) const;
 337
 338     /// SizeOf - Determine size of label value in bytes.
 339     ///
 340     virtual unsigned SizeOf(const TargetData *TD, unsigned Form) const;
 341
 342     /// Profile - Used to gather unique data for the value folding set.
 343     ///
 344     static void Profile(FoldingSetNodeID &ID, const DWLabel &Label);
 345     virtual void Profile(FoldingSetNodeID &ID);
 346
 347     // Implement isa/cast/dyncast.
 348     static bool classof(const DIEDwarfLabel *)  { return true; }
 349     static bool classof(const DIEValue *L) { return L->getType() == isLabel; }
 350
 351 #ifndef NDEBUG
 352     virtual void print(raw_ostream &O);
 353 #endif
 354   };
 355
 356   //===--------------------------------------------------------------------===//
 357   /// DIEObjectLabel - A label to an object in code or data.
 358   //
 359   class VISIBILITY_HIDDEN DIEObjectLabel : public DIEValue {
 360     const std::string Label;
 361   public:
 362     explicit DIEObjectLabel(const std::string &L)
 363       : DIEValue(isAsIsLabel), Label(L) {}
 364
 365     /// EmitValue - Emit label value.
 366     ///
 367     virtual void EmitValue(Dwarf *D, unsigned Form) const;
 368
 369     /// SizeOf - Determine size of label value in bytes.
 370     ///
 371     virtual unsigned SizeOf(const TargetData *TD, unsigned Form) const;
 372
 373     /// Profile - Used to gather unique data for the value folding set.
 374     ///
 375     static void Profile(FoldingSetNodeID &ID, const std::string &Label);
 376     virtual void Profile(FoldingSetNodeID &ID);
 377
 378     // Implement isa/cast/dyncast.
 379     static bool classof(const DIEObjectLabel *) { return true; }
 380     static bool classof(const DIEValue *L) {
 381       return L->getType() == isAsIsLabel;
 382     }
 383
 384 #ifndef NDEBUG
 385     virtual void print(raw_ostream &O);
 386 #endif
 387   };
 388
 389   //===--------------------------------------------------------------------===//
 390   /// DIESectionOffset - A section offset DIE.
 391   ///
 392   class VISIBILITY_HIDDEN DIESectionOffset : public DIEValue {
 393     const DWLabel Label;
 394     const DWLabel Section;
 395     bool IsEH : 1;
 396     bool UseSet : 1;
 397   public:
 398     DIESectionOffset(const DWLabel &Lab, const DWLabel &Sec,
 399                      bool isEH = false, bool useSet = true)
 400       : DIEValue(isSectionOffset), Label(Lab), Section(Sec),
 401         IsEH(isEH), UseSet(useSet) {}
 402
 403     /// EmitValue - Emit section offset.
 404     ///
 405     virtual void EmitValue(Dwarf *D, unsigned Form) const;
 406
 407     /// SizeOf - Determine size of section offset value in bytes.
 408     ///
 409     virtual unsigned SizeOf(const TargetData *TD, unsigned Form) const;
 410
 411     /// Profile - Used to gather unique data for the value folding set.
 412     ///
 413     static void Profile(FoldingSetNodeID &ID, const DWLabel &Label,
 414                         const DWLabel &Section);
 415     virtual void Profile(FoldingSetNodeID &ID);
 416
 417     // Implement isa/cast/dyncast.
 418     static bool classof(const DIESectionOffset *)  { return true; }
 419     static bool classof(const DIEValue *D) {
 420       return D->getType() == isSectionOffset;
 421     }
 422
 423 #ifndef NDEBUG
 424     virtual void print(raw_ostream &O);
 425 #endif
 426   };
 427
 428   //===--------------------------------------------------------------------===//
 429   /// DIEDelta - A simple label difference DIE.
 430   ///
 431   class VISIBILITY_HIDDEN DIEDelta : public DIEValue {
 432     const DWLabel LabelHi;
 433     const DWLabel LabelLo;
 434   public:
 435     DIEDelta(const DWLabel &Hi, const DWLabel &Lo)
 436       : DIEValue(isDelta), LabelHi(Hi), LabelLo(Lo) {}
 437
 438     /// EmitValue - Emit delta value.
 439     ///
 440     virtual void EmitValue(Dwarf *D, unsigned Form) const;
 441
 442     /// SizeOf - Determine size of delta value in bytes.
 443     ///
 444     virtual unsigned SizeOf(const TargetData *TD, unsigned Form) const;
 445
 446     /// Profile - Used to gather unique data for the value folding set.
 447     ///
 448     static void Profile(FoldingSetNodeID &ID, const DWLabel &LabelHi,
 449                         const DWLabel &LabelLo);
 450     virtual void Profile(FoldingSetNodeID &ID);
 451
 452     // Implement isa/cast/dyncast.
 453     static bool classof(const DIEDelta *)  { return true; }
 454     static bool classof(const DIEValue *D) { return D->getType() == isDelta; }
 455
 456 #ifndef NDEBUG
 457     virtual void print(raw_ostream &O);
 458 #endif
 459   };
 460
 461   //===--------------------------------------------------------------------===//
 462   /// DIEntry - A pointer to another debug information entry.  An instance of
 463   /// this class can also be used as a proxy for a debug information entry not
 464   /// yet defined (ie. types.)
 465   class VISIBILITY_HIDDEN DIEEntry : public DIEValue {
 466     DIE *Entry;
 467   public:
 468     explicit DIEEntry(DIE *E) : DIEValue(isEntry), Entry(E) {}
 469
 470     DIE *getEntry() const { return Entry; }
 471     void setEntry(DIE *E) { Entry = E; }
 472
 473     /// EmitValue - Emit debug information entry offset.
 474     ///
 475     virtual void EmitValue(Dwarf *D, unsigned Form) const;
 476
 477     /// SizeOf - Determine size of debug information entry in bytes.
 478     ///
 479     virtual unsigned SizeOf(const TargetData *TD, unsigned Form) const {
 480       return sizeof(int32_t);
 481     }
 482
 483     /// Profile - Used to gather unique data for the value folding set.
 484     ///
 485     static void Profile(FoldingSetNodeID &ID, DIE *Entry);
 486     virtual void Profile(FoldingSetNodeID &ID);
 487
 488     // Implement isa/cast/dyncast.
 489     static bool classof(const DIEEntry *)  { return true; }
 490     static bool classof(const DIEValue *E) { return E->getType() == isEntry; }
 491
 492 #ifndef NDEBUG
 493     virtual void print(raw_ostream &O);
 494 #endif
 495   };
 496
 497   //===--------------------------------------------------------------------===//
 498   /// DIEBlock - A block of values.  Primarily used for location expressions.
 499   //
 500   class VISIBILITY_HIDDEN DIEBlock : public DIEValue, public DIE {
 501     unsigned Size;                // Size in bytes excluding size header.
 502   public:
 503     DIEBlock()
 504       : DIEValue(isBlock), DIE(0), Size(0) {}
 505     virtual ~DIEBlock() {}
 506
 507     /// ComputeSize - calculate the size of the block.
 508     ///
 509     unsigned ComputeSize(const TargetData *TD);
 510
 511     /// BestForm - Choose the best form for data.
 512     ///
 513     unsigned BestForm() const {
 514       if ((unsigned char)Size == Size)  return dwarf::DW_FORM_block1;
 515       if ((unsigned short)Size == Size) return dwarf::DW_FORM_block2;
 516       if ((unsigned int)Size == Size)   return dwarf::DW_FORM_block4;
 517       return dwarf::DW_FORM_block;
 518     }
 519
 520     /// EmitValue - Emit block data.
 521     ///
 522     virtual void EmitValue(Dwarf *D, unsigned Form) const;
 523
 524     /// SizeOf - Determine size of block data in bytes.
 525     ///
 526     virtual unsigned SizeOf(const TargetData *TD, unsigned Form) const;
 527
 528     /// Profile - Used to gather unique data for the value folding set.
 529     ///
 530     virtual void Profile(FoldingSetNodeID &ID);
 531
 532     // Implement isa/cast/dyncast.
 533     static bool classof(const DIEBlock *)  { return true; }
 534     static bool classof(const DIEValue *E) { return E->getType() == isBlock; }
 535
 536 #ifndef NDEBUG
 537     virtual void print(raw_ostream &O);
 538 #endif
 539   };
 540
 541 } // end llvm namespace
 542
 543 #endif