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 "llvm/MC/MCExpr.h"
  22 #include <vector>
  23
  24 namespace llvm {
  25   class AsmPrinter;
  26   class MCSymbol;
  27   class MCSymbolRefExpr;
  28   class raw_ostream;
  29
  30   //===--------------------------------------------------------------------===//
  31   /// DIEAbbrevData - Dwarf abbreviation data, describes one attribute of a
  32   /// Dwarf abbreviation.
  33   class DIEAbbrevData {
  34     /// Attribute - Dwarf attribute code.
  35     ///
  36     uint16_t Attribute;
  37
  38     /// Form - Dwarf form code.
  39     ///
  40     uint16_t Form;
  41   public:
  42     DIEAbbrevData(uint16_t A, uint16_t F) : Attribute(A), Form(F) {}
  43
  44     // Accessors.
  45     uint16_t getAttribute() const { return Attribute; }
  46     uint16_t 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     uint16_t Tag;
  60
  61     /// ChildrenFlag - Dwarf children flag.
  62     ///
  63     uint16_t ChildrenFlag;
  64
  65     /// Unique number for node.
  66     ///
  67     unsigned Number;
  68
  69     /// Data - Raw data bytes for abbreviation.
  70     ///
  71     SmallVector<DIEAbbrevData, 12> Data;
  72
  73   public:
  74     DIEAbbrev(uint16_t T, uint16_t C) : Tag(T), ChildrenFlag(C), Data() {}
  75
  76     // Accessors.
  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; }
  84
  85     /// AddAttribute - Adds another set of attribute information to the
  86     /// abbreviation.
  87     void AddAttribute(uint16_t Attribute, uint16_t Form) {
  88       Data.push_back(DIEAbbrevData(Attribute, Form));
  89     }
  90
  91     /// Profile - Used to gather unique data for the abbreviation folding set.
  92     ///
  93     void Profile(FoldingSetNodeID &ID) const;
  94
  95     /// Emit - Print the abbreviation using the specified asm printer.
  96     ///
  97     void Emit(AsmPrinter *AP) const;
  98
  99 #ifndef NDEBUG
 100     void print(raw_ostream &O);
 101     void dump();
 102 #endif
 103   };
 104
 105   //===--------------------------------------------------------------------===//
 106   /// DIE - A structured debug information entry.  Has an abbreviation which
 107   /// describes its organization.
 108   class DIEValue;
 109
 110   class DIE {
 111   protected:
 112     /// Offset - Offset in debug info section.
 113     ///
 114     unsigned Offset;
 115
 116     /// Size - Size of instance + children.
 117     ///
 118     unsigned Size;
 119
 120     /// Abbrev - Buffer for constructing abbreviation.
 121     ///
 122     DIEAbbrev Abbrev;
 123
 124     /// Children DIEs.
 125     ///
 126     std::vector<DIE *> Children;
 127
 128     DIE *Parent;
 129
 130     /// Attribute values.
 131     ///
 132     SmallVector<DIEValue*, 12> Values;
 133
 134 #ifndef NDEBUG
 135     // Private data for print()
 136     mutable unsigned IndentCount;
 137 #endif
 138   public:
 139     explicit DIE(unsigned Tag)
 140       : Offset(0), Size(0), Abbrev(Tag, dwarf::DW_CHILDREN_no), Parent(0) {}
 141     virtual ~DIE();
 142
 143     // Accessors.
 144     DIEAbbrev &getAbbrev() { return Abbrev; }
 145     unsigned getAbbrevNumber() const { return Abbrev.getNumber(); }
 146     unsigned 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
 153     /// to.
 154     DIE *getCompileUnit();
 155     void setTag(unsigned Tag) { Abbrev.setTag(Tag); }
 156     void setOffset(unsigned O) { Offset = O; }
 157     void setSize(unsigned S) { Size = S; }
 158
 159     /// addValue - Add a value and attributes to a DIE.
 160     ///
 161     void addValue(unsigned Attribute, unsigned Form, DIEValue *Value) {
 162       Abbrev.AddAttribute(Attribute, Form);
 163       Values.push_back(Value);
 164     }
 165
 166     /// addChild - Add a child to the DIE.
 167     ///
 168     void addChild(DIE *Child) {
 169       if (Child->getParent()) {
 170         assert (Child->getParent() == this && "Unexpected DIE Parent!");
 171         return;
 172       }
 173       Abbrev.setChildrenFlag(dwarf::DW_CHILDREN_yes);
 174       Children.push_back(Child);
 175       Child->Parent = this;
 176     }
 177
 178 #ifndef NDEBUG
 179     void print(raw_ostream &O, unsigned IndentCount = 0) const;
 180     void dump();
 181 #endif
 182   };
 183
 184   //===--------------------------------------------------------------------===//
 185   /// DIEValue - A debug information entry value.
 186   ///
 187   class DIEValue {
 188     virtual void anchor();
 189   public:
 190     enum {
 191       isInteger,
 192       isString,
 193       isLabel,
 194       isDelta,
 195       isEntry,
 196       isBlock
 197     };
 198   protected:
 199     /// Type - Type of data stored in the value.
 200     ///
 201     unsigned Type;
 202   public:
 203     explicit DIEValue(unsigned T) : Type(T) {}
 204     virtual ~DIEValue() {}
 205
 206     // Accessors
 207     unsigned getType()  const { return Type; }
 208
 209     /// EmitValue - Emit value via the Dwarf writer.
 210     ///
 211     virtual void EmitValue(AsmPrinter *AP, unsigned Form) const = 0;
 212
 213     /// SizeOf - Return the size of a value in bytes.
 214     ///
 215     virtual unsigned SizeOf(AsmPrinter *AP, unsigned Form) const = 0;
 216
 217 #ifndef NDEBUG
 218     virtual void print(raw_ostream &O) const = 0;
 219     void dump() const;
 220 #endif
 221   };
 222
 223   //===--------------------------------------------------------------------===//
 224   /// DIEInteger - An integer value DIE.
 225   ///
 226   class DIEInteger : public DIEValue {
 227     uint64_t Integer;
 228   public:
 229     explicit DIEInteger(uint64_t I) : DIEValue(isInteger), Integer(I) {}
 230
 231     /// BestForm - Choose the best form for integer.
 232     ///
 233     static unsigned BestForm(bool IsSigned, uint64_t Int) {
 234       if (IsSigned) {
 235         const int64_t SignedInt = Int;
 236         if ((char)Int == SignedInt)     return dwarf::DW_FORM_data1;
 237         if ((short)Int == SignedInt)    return dwarf::DW_FORM_data2;
 238         if ((int)Int == SignedInt)      return dwarf::DW_FORM_data4;
 239       } else {
 240         if ((unsigned char)Int == Int)  return dwarf::DW_FORM_data1;
 241         if ((unsigned short)Int == Int) return dwarf::DW_FORM_data2;
 242         if ((unsigned int)Int == Int)   return dwarf::DW_FORM_data4;
 243       }
 244       return dwarf::DW_FORM_data8;
 245     }
 246
 247     /// EmitValue - Emit integer of appropriate size.
 248     ///
 249     virtual void EmitValue(AsmPrinter *AP, unsigned Form) const;
 250
 251     uint64_t getValue() const { return Integer; }
 252
 253     /// SizeOf - Determine size of integer value in bytes.
 254     ///
 255     virtual unsigned SizeOf(AsmPrinter *AP, unsigned Form) const;
 256
 257     // Implement isa/cast/dyncast.
 258     static bool classof(const DIEValue *I) { return I->getType() == isInteger; }
 259
 260 #ifndef NDEBUG
 261     virtual void print(raw_ostream &O) const;
 262 #endif
 263   };
 264
 265   //===--------------------------------------------------------------------===//
 266   /// DIELabel - A label expression DIE.
 267   //
 268   class DIELabel : public DIEValue {
 269     const MCSymbolRefExpr *Label;
 270   public:
 271     explicit DIELabel(const MCSymbolRefExpr *L) : DIEValue(isLabel), Label(L) {}
 272     explicit DIELabel(const MCSymbol *Sym, MCContext &Ctxt)
 273         : DIEValue(isLabel), Label(MCSymbolRefExpr::Create(Sym, Ctxt)) {}
 274
 275     /// EmitValue - Emit label value.
 276     ///
 277     virtual void EmitValue(AsmPrinter *AP, unsigned Form) const;
 278
 279     /// getValue - Get MCSymbol.
 280     ///
 281     const MCSymbolRefExpr *getValue() const { return Label; }
 282
 283     /// SizeOf - Determine size of label value in bytes.
 284     ///
 285     virtual unsigned SizeOf(AsmPrinter *AP, unsigned Form) const;
 286
 287     // Implement isa/cast/dyncast.
 288     static bool classof(const DIEValue *L) { return L->getType() == isLabel; }
 289
 290 #ifndef NDEBUG
 291     virtual void print(raw_ostream &O) const;
 292 #endif
 293   };
 294
 295   //===--------------------------------------------------------------------===//
 296   /// DIEDelta - A simple label difference DIE.
 297   ///
 298   class DIEDelta : public DIEValue {
 299     const MCSymbol *LabelHi;
 300     const MCSymbol *LabelLo;
 301   public:
 302     DIEDelta(const MCSymbol *Hi, const MCSymbol *Lo)
 303       : DIEValue(isDelta), LabelHi(Hi), LabelLo(Lo) {}
 304
 305     /// EmitValue - Emit delta value.
 306     ///
 307     virtual void EmitValue(AsmPrinter *AP, unsigned Form) const;
 308
 309     /// SizeOf - Determine size of delta value in bytes.
 310     ///
 311     virtual unsigned SizeOf(AsmPrinter *AP, unsigned Form) const;
 312
 313     // Implement isa/cast/dyncast.
 314     static bool classof(const DIEValue *D) { return D->getType() == isDelta; }
 315
 316 #ifndef NDEBUG
 317     virtual void print(raw_ostream &O) const;
 318 #endif
 319   };
 320
 321   //===--------------------------------------------------------------------===//
 322   /// DIEEntry - A pointer to another debug information entry.  An instance of
 323   /// this class can also be used as a proxy for a debug information entry not
 324   /// yet defined (ie. types.)
 325   class DIEEntry : public DIEValue {
 326     DIE *const Entry;
 327   public:
 328     explicit DIEEntry(DIE *E) : DIEValue(isEntry), Entry(E) {
 329       assert(E && "Cannot construct a DIEEntry with a null DIE");
 330     }
 331
 332     DIE *getEntry() const { return Entry; }
 333
 334     /// EmitValue - Emit debug information entry offset.
 335     ///
 336     virtual void EmitValue(AsmPrinter *AP, unsigned Form) const;
 337
 338     /// SizeOf - Determine size of debug information entry in bytes.
 339     ///
 340     virtual unsigned SizeOf(AsmPrinter *AP, unsigned Form) const {
 341       return sizeof(int32_t);
 342     }
 343
 344     // Implement isa/cast/dyncast.
 345     static bool classof(const DIEValue *E) { return E->getType() == isEntry; }
 346
 347 #ifndef NDEBUG
 348     virtual void print(raw_ostream &O) const;
 349 #endif
 350   };
 351
 352   //===--------------------------------------------------------------------===//
 353   /// DIEBlock - A block of values.  Primarily used for location expressions.
 354   //
 355   class DIEBlock : public DIEValue, public DIE {
 356     unsigned Size;                // Size in bytes excluding size header.
 357   public:
 358     DIEBlock()
 359       : DIEValue(isBlock), DIE(0), Size(0) {}
 360     virtual ~DIEBlock() {}
 361
 362     /// ComputeSize - calculate the size of the block.
 363     ///
 364     unsigned ComputeSize(AsmPrinter *AP);
 365
 366     /// BestForm - Choose the best form for data.
 367     ///
 368     unsigned BestForm() const {
 369       if ((unsigned char)Size == Size)  return dwarf::DW_FORM_block1;
 370       if ((unsigned short)Size == Size) return dwarf::DW_FORM_block2;
 371       if ((unsigned int)Size == Size)   return dwarf::DW_FORM_block4;
 372       return dwarf::DW_FORM_block;
 373     }
 374
 375     /// EmitValue - Emit block data.
 376     ///
 377     virtual void EmitValue(AsmPrinter *AP, unsigned Form) const;
 378
 379     /// SizeOf - Determine size of block data in bytes.
 380     ///
 381     virtual unsigned SizeOf(AsmPrinter *AP, unsigned Form) const;
 382
 383     // Implement isa/cast/dyncast.
 384     static bool classof(const DIEValue *E) { return E->getType() == isBlock; }
 385
 386 #ifndef NDEBUG
 387     virtual void print(raw_ostream &O) const;
 388 #endif
 389   };
 390
 391 } // end llvm namespace
 392
 393 #endif