DwarfAccelTable.h   [plain text]

//==-- llvm/CodeGen/DwarfAccelTable.h - Dwarf Accelerator Tables -*- C++ -*-==//
//
//                     The LLVM Compiler Infrastructure
//
// This file is distributed under the University of Illinois Open Source
// License. See LICENSE.TXT for details.
//
//===----------------------------------------------------------------------===//
//
// This file contains support for writing dwarf accelerator tables.
//
//===----------------------------------------------------------------------===//

#ifndef LLVM_LIB_CODEGEN_ASMPRINTER_DWARFACCELTABLE_H
#define LLVM_LIB_CODEGEN_ASMPRINTER_DWARFACCELTABLE_H

#include "llvm/ADT/ArrayRef.h"
#include "llvm/ADT/StringMap.h"
#include "llvm/CodeGen/DIE.h"
#include "llvm/MC/MCSymbol.h"
#include "llvm/Support/Compiler.h"
#include "llvm/Support/DataTypes.h"
#include "llvm/Support/Debug.h"
#include "llvm/Support/Dwarf.h"
#include "llvm/Support/ErrorHandling.h"
#include "llvm/Support/Format.h"
#include "llvm/Support/FormattedStream.h"
#include <vector>

// The dwarf accelerator tables are an indirect hash table optimized
// for null lookup rather than access to known data. They are output into
// an on-disk format that looks like this:
//
// .-------------.
// |  HEADER     |
// |-------------|
// |  BUCKETS    |
// |-------------|
// |  HASHES     |
// |-------------|
// |  OFFSETS    |
// |-------------|
// |  DATA       |
// `-------------'
//
// where the header contains a magic number, version, type of hash function,
// the number of buckets, total number of hashes, and room for a special
// struct of data and the length of that struct.
//
// The buckets contain an index (e.g. 6) into the hashes array. The hashes
// section contains all of the 32-bit hash values in contiguous memory, and
// the offsets contain the offset into the data area for the particular
// hash.
//
// For a lookup example, we could hash a function name and take it modulo the
// number of buckets giving us our bucket. From there we take the bucket value
// as an index into the hashes table and look at each successive hash as long
// as the hash value is still the same modulo result (bucket value) as earlier.
// If we have a match we look at that same entry in the offsets table and
// grab the offset in the data for our final match.

namespace llvm {

class AsmPrinter;
class DwarfDebug;

class DwarfAccelTable {
public:
  static uint32_t HashDJB(StringRef Str, uint32_t h = 5381) {
    for (unsigned i = 0, e = Str.size(); i != e; ++i)
      h = ((h << 5) + h) + (unsigned char)Str[i];
    return h;
  }
private:
  // Helper function to compute the number of buckets needed based on
  // the number of unique hashes.
  void ComputeBucketCount(void);

  struct TableHeader {
    uint32_t magic;           // 'HASH' magic value to allow endian detection
    uint16_t version;         // Version number.
    uint16_t hash_function;   // The hash function enumeration that was used.
    uint32_t bucket_count;    // The number of buckets in this hash table.
    uint32_t hashes_count;    // The total number of unique hash values
                              // and hash data offsets in this table.
    uint32_t header_data_len; // The bytes to skip to get to the hash
                              // indexes (buckets) for correct alignment.
    // Also written to disk is the implementation specific header data.

    static const uint32_t MagicHash = 0x48415348;

    TableHeader(uint32_t data_len)
        : magic(MagicHash), version(1),
          hash_function(dwarf::DW_hash_function_djb), bucket_count(0),
          hashes_count(0), header_data_len(data_len) {}

#ifndef NDEBUG
    void print(raw_ostream &O) {
      O << "Magic: " << format("0x%x", magic) << "\n"
        << "Version: " << version << "\n"
        << "Hash Function: " << hash_function << "\n"
        << "Bucket Count: " << bucket_count << "\n"
        << "Header Data Length: " << header_data_len << "\n";
    }
    void dump() { print(dbgs()); }
#endif
  };

public:
  // The HeaderData describes the form of each set of data. In general this
  // is as a list of atoms (atom_count) where each atom contains a type
  // (AtomType type) of data, and an encoding form (form). In the case of
  // data that is referenced via DW_FORM_ref_* the die_offset_base is
  // used to describe the offset for all forms in the list of atoms.
  // This also serves as a public interface of sorts.
  // When written to disk this will have the form:
  //
  // uint32_t die_offset_base
  // uint32_t atom_count
  // atom_count Atoms

  // Make these public so that they can be used as a general interface to
  // the class.
  struct Atom {
    uint16_t type; // enum AtomType
    uint16_t form; // DWARF DW_FORM_ defines

    LLVM_CONSTEXPR Atom(uint16_t type, uint16_t form)
        : type(type), form(form) {}
#ifndef NDEBUG
    void print(raw_ostream &O) {
      O << "Type: " << dwarf::AtomTypeString(type) << "\n"
        << "Form: " << dwarf::FormEncodingString(form) << "\n";
    }
    void dump() { print(dbgs()); }
#endif
  };

private:
  struct TableHeaderData {
    uint32_t die_offset_base;
    SmallVector<Atom, 3> Atoms;

    TableHeaderData(ArrayRef<Atom> AtomList, uint32_t offset = 0)
        : die_offset_base(offset), Atoms(AtomList.begin(), AtomList.end()) {}

#ifndef NDEBUG
    void print(raw_ostream &O) {
      O << "die_offset_base: " << die_offset_base << "\n";
      for (size_t i = 0; i < Atoms.size(); i++)
        Atoms[i].print(O);
    }
    void dump() { print(dbgs()); }
#endif
  };

  // The data itself consists of a str_offset, a count of the DIEs in the
  // hash and the offsets to the DIEs themselves.
  // On disk each data section is ended with a 0 KeyType as the end of the
  // hash chain.
  // On output this looks like:
  // uint32_t str_offset
  // uint32_t hash_data_count
  // HashData[hash_data_count]
public:
  struct HashDataContents {
    union {
      const DIE *Die;   // Offsets
      MCSymbol *Strp;   // debug_str offset
      uint32_t DieOffset; ///< Offset of the DIE in debug_info.
    };
    char Flags; // Specific flags to output

    HashDataContents(const DIE *D, char Flags = 0) : Die(D), Flags(Flags) {}
    HashDataContents(uint32_t DieOffset) : DieOffset(DieOffset), Flags(0) {}
    HashDataContents(MCSymbol *Strp) : Strp(Strp), Flags(-1) {}
    bool isDIE() const { return Flags != -1; }

    /// \brief Get the start of the Atom storage.
    /// Atoms are stored right after the HashDataContents object in memory.
    char *getAtomData() const {
      return (char *)(void *)(this + 1);
    }

    /// \brief Get the atom of type AtomT at \p Offset in the Atom data.
    template<typename AtomT>
    AtomT getAtom(unsigned int Offset) const {
      AtomT Atom;
      memcpy(&Atom, getAtomData() + Offset, sizeof(AtomT));
      return Atom;
    }

#ifndef NDEBUG
    void print(raw_ostream &O, const DwarfAccelTable &Table) const;
#endif
  };
  
  class HashDataContentsRef {
    const HashDataContents &Contents; ///< The entry we are populating
    const DwarfAccelTable &Table; ///< The table that owns us
    uint16_t AtomBytePos; ///< Byte position of the next Atom
    uint8_t AtomPos; ///< Index of the next Atom
    
  public:
    HashDataContentsRef(HashDataContents &Contents, DwarfAccelTable &Table)
      : Contents(Contents), Table(Table), AtomBytePos(0), AtomPos(1) {}
    
    template<typename AtomT>
    HashDataContentsRef addAtom(AtomT Atom) {
      assert(AtomBytePos + sizeof(AtomT) <= Table.getAtomsSize());
      assert(Table.checkAtomSize(AtomPos, sizeof(AtomT)));
      memcpy(Contents.getAtomData() + AtomBytePos, &Atom, sizeof(AtomT));
      ++AtomPos;
      AtomBytePos += sizeof(AtomT);
      return *this;
    }
  };
  
private:
  // String Data
  struct DataArray {
    union {
      MCSymbol *StrSym; ///< Symbol of the string in debug_str.
      uint32_t StrOffset; ///<Offset of the string in debug_str.
    };
    std::vector<HashDataContents *> Values;
    DataArray() : StrSym(nullptr) {}
  };
  friend struct HashData;
  struct HashData {
    StringRef Str;
    uint32_t HashValue;
    MCSymbol *Sym;
    DwarfAccelTable::DataArray &Data; // offsets
    HashData(StringRef S, DwarfAccelTable::DataArray &Data)
        : Str(S), Data(Data) {
      HashValue = DwarfAccelTable::HashDJB(S);
    }
#ifndef NDEBUG
    void print(raw_ostream &O, DwarfAccelTable& Table) {
      O << "Name: " << Str << "\n";
      O << "  Hash Value: " << format("0x%x", HashValue) << "\n";
      O << "  Symbol: ";
      if (Sym)
        Sym->print(O);
      else
        O << "<none>";
      O << "\n";
      for (HashDataContents *C : Data.Values)
        C->print(O, Table);
    }
    void dump(DwarfAccelTable& Table) { print(dbgs(), Table); }
#endif
  };

  DwarfAccelTable(const DwarfAccelTable &) LLVM_DELETED_FUNCTION;
  void operator=(const DwarfAccelTable &) LLVM_DELETED_FUNCTION;

  // Internal Functions
  void EmitHeader(AsmPrinter *);
  void EmitBuckets(AsmPrinter *);
  void EmitHashes(AsmPrinter *);
  void emitOffsets(AsmPrinter *, const MCSymbol *);
  void EmitData(AsmPrinter *, DwarfDebug *D);

  // Allocator for HashData and HashDataContents.
  BumpPtrAllocator Allocator;

  // Output Variables
  TableHeader Header;
  TableHeaderData HeaderData;
  std::vector<HashData *> Data;

  typedef StringMap<DataArray, BumpPtrAllocator &> StringEntries;
  StringEntries Entries;

  // Buckets/Hashes/Offsets
  typedef std::vector<HashData *> HashList;
  typedef std::vector<HashList> BucketList;
  BucketList Buckets;
  HashList Hashes;
  unsigned AtomsSize;
  bool UseDieOffsets;
  bool UseStringOffsets;
  
  // Public Implementation
public:
  DwarfAccelTable(ArrayRef<DwarfAccelTable::Atom>, bool UseDieOffset = false,
                  bool UseStringOffsets = false);
  HashDataContentsRef AddName(StringRef Name, MCSymbol *StrSym, const DIE *Die);
  HashDataContentsRef AddName(StringRef Name, uint32_t StrOffset,
                              uint32_t DIeOffset);
  void AddUID(StringRef UID, MCSymbol *UIDSym, MCSymbol *ModuleSym);

  void FinalizeTable(AsmPrinter *, StringRef);
  void emit(AsmPrinter *, const MCSymbol *, DwarfDebug *);
  unsigned getAtomsSize() const { return AtomsSize; }
  bool useDieOffssets() const { return UseDieOffsets; }
  bool useStringOffssets() const { return UseStringOffsets; }
  const TableHeaderData &getHeaderData() const { return HeaderData; }
#ifndef NDEBUG
  bool checkAtomSize(unsigned Index, unsigned ByteSize) const;
  void print(raw_ostream &O);
  void dump() { print(dbgs()); }
#endif
};
}
#endif