include/llvm/ProfileData/InstrProfReader.h

   1 //=-- InstrProfReader.h - Instrumented profiling readers ----------*- 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 // This file contains support for reading profiling data for instrumentation
  11 // based PGO and coverage.
  12 //
  13 //===----------------------------------------------------------------------===//
  14
  15 #ifndef LLVM_PROFILEDATA_INSTRPROFREADER_H
  16 #define LLVM_PROFILEDATA_INSTRPROFREADER_H
  17
  18 #include "llvm/ADT/ArrayRef.h"
  19 #include "llvm/ADT/StringExtras.h"
  20 #include "llvm/ProfileData/InstrProf.h"
  21 #include "llvm/Support/EndianStream.h"
  22 #include "llvm/Support/ErrorOr.h"
  23 #include "llvm/Support/LineIterator.h"
  24 #include "llvm/Support/MemoryBuffer.h"
  25 #include "llvm/Support/OnDiskHashTable.h"
  26 #include <iterator>
  27
  28 namespace llvm {
  29
  30 class InstrProfReader;
  31
  32 /// A file format agnostic iterator over profiling data.
  33 class InstrProfIterator : public std::iterator<std::input_iterator_tag,
  34                                                InstrProfRecord> {
  35   InstrProfReader *Reader;
  36   InstrProfRecord Record;
  37
  38   void Increment();
  39 public:
  40   InstrProfIterator() : Reader(nullptr) {}
  41   InstrProfIterator(InstrProfReader *Reader) : Reader(Reader) { Increment(); }
  42
  43   InstrProfIterator &operator++() { Increment(); return *this; }
  44   bool operator==(const InstrProfIterator &RHS) { return Reader == RHS.Reader; }
  45   bool operator!=(const InstrProfIterator &RHS) { return Reader != RHS.Reader; }
  46   InstrProfRecord &operator*() { return Record; }
  47   InstrProfRecord *operator->() { return &Record; }
  48 };
  49
  50 /// Base class and interface for reading profiling data of any known instrprof
  51 /// format. Provides an iterator over InstrProfRecords.
  52 class InstrProfReader {
  53   std::error_code LastError;
  54
  55 public:
  56   InstrProfReader() : LastError(instrprof_error::success) {}
  57   virtual ~InstrProfReader() {}
  58
  59   /// Read the header.  Required before reading first record.
  60   virtual std::error_code readHeader() = 0;
  61   /// Read a single record.
  62   virtual std::error_code readNextRecord(InstrProfRecord &Record) = 0;
  63   /// Iterator over profile data.
  64   InstrProfIterator begin() { return InstrProfIterator(this); }
  65   InstrProfIterator end() { return InstrProfIterator(); }
  66
  67  protected:
  68   /// Set the current std::error_code and return same.
  69   std::error_code error(std::error_code EC) {
  70     LastError = EC;
  71     return EC;
  72   }
  73
  74   /// Clear the current error code and return a successful one.
  75   std::error_code success() { return error(instrprof_error::success); }
  76
  77 public:
  78   /// Return true if the reader has finished reading the profile data.
  79   bool isEOF() { return LastError == instrprof_error::eof; }
  80   /// Return true if the reader encountered an error reading profiling data.
  81   bool hasError() { return LastError && !isEOF(); }
  82   /// Get the current error code.
  83   std::error_code getError() { return LastError; }
  84
  85   /// Factory method to create an appropriately typed reader for the given
  86   /// instrprof file.
  87   static ErrorOr<std::unique_ptr<InstrProfReader>> create(std::string Path);
  88
  89   static ErrorOr<std::unique_ptr<InstrProfReader>>
  90   create(std::unique_ptr<MemoryBuffer> Buffer);
  91 };
  92
  93 /// Reader for the simple text based instrprof format.
  94 ///
  95 /// This format is a simple text format that's suitable for test data. Records
  96 /// are separated by one or more blank lines, and record fields are separated by
  97 /// new lines.
  98 ///
  99 /// Each record consists of a function name, a function hash, a number of
 100 /// counters, and then each counter value, in that order.
 101 class TextInstrProfReader : public InstrProfReader {
 102 private:
 103   /// The profile data file contents.
 104   std::unique_ptr<MemoryBuffer> DataBuffer;
 105   /// Iterator over the profile data.
 106   line_iterator Line;
 107
 108   TextInstrProfReader(const TextInstrProfReader &) = delete;
 109   TextInstrProfReader &operator=(const TextInstrProfReader &) = delete;
 110 public:
 111   TextInstrProfReader(std::unique_ptr<MemoryBuffer> DataBuffer_)
 112       : DataBuffer(std::move(DataBuffer_)), Line(*DataBuffer, true, '#') {}
 113
 114   /// Return true if the given buffer is in text instrprof format.
 115   static bool hasFormat(const MemoryBuffer &Buffer);
 116
 117   /// Read the header.
 118   std::error_code readHeader() override { return success(); }
 119   /// Read a single record.
 120   std::error_code readNextRecord(InstrProfRecord &Record) override;
 121 };
 122
 123 /// Reader for the raw instrprof binary format from runtime.
 124 ///
 125 /// This format is a raw memory dump of the instrumentation-baed profiling data
 126 /// from the runtime.  It has no index.
 127 ///
 128 /// Templated on the unsigned type whose size matches pointers on the platform
 129 /// that wrote the profile.
 130 template <class IntPtrT>
 131 class RawInstrProfReader : public InstrProfReader {
 132 private:
 133   /// The profile data file contents.
 134   std::unique_ptr<MemoryBuffer> DataBuffer;
 135
 136   bool ShouldSwapBytes;
 137   uint64_t CountersDelta;
 138   uint64_t NamesDelta;
 139   const RawInstrProf::ProfileData<IntPtrT> *Data;
 140   const RawInstrProf::ProfileData<IntPtrT> *DataEnd;
 141   const uint64_t *CountersStart;
 142   const char *NamesStart;
 143   const char *ProfileEnd;
 144
 145   RawInstrProfReader(const RawInstrProfReader &) = delete;
 146   RawInstrProfReader &operator=(const RawInstrProfReader &) = delete;
 147 public:
 148   RawInstrProfReader(std::unique_ptr<MemoryBuffer> DataBuffer)
 149       : DataBuffer(std::move(DataBuffer)) { }
 150
 151   static bool hasFormat(const MemoryBuffer &DataBuffer);
 152   std::error_code readHeader() override;
 153   std::error_code readNextRecord(InstrProfRecord &Record) override;
 154
 155 private:
 156   std::error_code readNextHeader(const char *CurrentPos);
 157   std::error_code readHeader(const RawInstrProf::Header &Header);
 158   template <class IntT>
 159   IntT swap(IntT Int) const {
 160     return ShouldSwapBytes ? sys::getSwappedBytes(Int) : Int;
 161   }
 162
 163   std::error_code readName(InstrProfRecord &Record);
 164   std::error_code readFuncHash(InstrProfRecord &Record);
 165   std::error_code readRawCounts(InstrProfRecord &Record);
 166   bool atEnd() const { return Data == DataEnd; }
 167   void advanceData() { Data++; }
 168
 169   const uint64_t *getCounter(IntPtrT CounterPtr) const {
 170     ptrdiff_t Offset = (swap(CounterPtr) - CountersDelta) / sizeof(uint64_t);
 171     return CountersStart + Offset;
 172   }
 173   const char *getName(IntPtrT NamePtr) const {
 174     ptrdiff_t Offset = (swap(NamePtr) - NamesDelta) / sizeof(char);
 175     return NamesStart + Offset;
 176   }
 177 };
 178
 179 typedef RawInstrProfReader<uint32_t> RawInstrProfReader32;
 180 typedef RawInstrProfReader<uint64_t> RawInstrProfReader64;
 181
 182 namespace IndexedInstrProf {
 183 enum class HashT : uint32_t;
 184 }
 185
 186 /// Trait for lookups into the on-disk hash table for the binary instrprof
 187 /// format.
 188 class InstrProfLookupTrait {
 189   std::vector<InstrProfRecord> DataBuffer;
 190   IndexedInstrProf::HashT HashType;
 191   unsigned FormatVersion;
 192   // Endianness of the input value profile data.
 193   // It should be LE by default, but can be changed
 194   // for testing purpose.
 195   support::endianness ValueProfDataEndianness;
 196   std::vector<std::pair<uint64_t, const char *>> HashKeys;
 197
 198 public:
 199   InstrProfLookupTrait(IndexedInstrProf::HashT HashType, unsigned FormatVersion)
 200       : HashType(HashType), FormatVersion(FormatVersion),
 201         ValueProfDataEndianness(support::little) {}
 202
 203   typedef ArrayRef<InstrProfRecord> data_type;
 204
 205   typedef StringRef internal_key_type;
 206   typedef StringRef external_key_type;
 207   typedef uint64_t hash_value_type;
 208   typedef uint64_t offset_type;
 209
 210   static bool EqualKey(StringRef A, StringRef B) { return A == B; }
 211   static StringRef GetInternalKey(StringRef K) { return K; }
 212   static StringRef GetExternalKey(StringRef K) { return K; }
 213
 214   hash_value_type ComputeHash(StringRef K);
 215
 216   void setHashKeys(std::vector<std::pair<uint64_t, const char *>> HashKeys) {
 217     this->HashKeys = std::move(HashKeys);
 218   }
 219   static std::pair<offset_type, offset_type>
 220   ReadKeyDataLength(const unsigned char *&D) {
 221     using namespace support;
 222     offset_type KeyLen = endian::readNext<offset_type, little, unaligned>(D);
 223     offset_type DataLen = endian::readNext<offset_type, little, unaligned>(D);
 224     return std::make_pair(KeyLen, DataLen);
 225   }
 226
 227   StringRef ReadKey(const unsigned char *D, offset_type N) {
 228     return StringRef((const char *)D, N);
 229   }
 230
 231   bool ReadValueProfilingData(const unsigned char *&D,
 232                               const unsigned char *const End);
 233   data_type ReadData(StringRef K, const unsigned char *D, offset_type N);
 234
 235   // Used for testing purpose only.
 236   void setValueProfDataEndianness(support::endianness Endianness) {
 237     ValueProfDataEndianness = Endianness;
 238   }
 239 };
 240
 241 class InstrProfReaderIndex {
 242  private:
 243   typedef OnDiskIterableChainedHashTable<InstrProfLookupTrait> IndexType;
 244
 245   std::unique_ptr<IndexType> Index;
 246   IndexType::data_iterator RecordIterator;
 247   uint64_t FormatVersion;
 248
 249   // String table for holding a unique copy of all the strings in the profile.
 250   InstrProfStringTable StringTable;
 251
 252  public:
 253   InstrProfReaderIndex() : Index(nullptr) {}
 254   void Init(const unsigned char *Buckets, const unsigned char *const Payload,
 255             const unsigned char *const Base, IndexedInstrProf::HashT HashType,
 256             uint64_t Version);
 257
 258   // Read all the pofile records with the same key pointed to the current
 259   // iterator.
 260   std::error_code getRecords(ArrayRef<InstrProfRecord> &Data);
 261   // Read all the profile records with the key equal to FuncName
 262   std::error_code getRecords(StringRef FuncName,
 263                              ArrayRef<InstrProfRecord> &Data);
 264
 265   void advanceToNextKey() { RecordIterator++; }
 266   bool atEnd() const { return RecordIterator == Index->data_end(); }
 267   // Used for testing purpose only.
 268   void setValueProfDataEndianness(support::endianness Endianness) {
 269     Index->getInfoObj().setValueProfDataEndianness(Endianness);
 270   }
 271 };
 272
 273 /// Reader for the indexed binary instrprof format.
 274 class IndexedInstrProfReader : public InstrProfReader {
 275 private:
 276   /// The profile data file contents.
 277   std::unique_ptr<MemoryBuffer> DataBuffer;
 278   /// The index into the profile data.
 279   InstrProfReaderIndex Index;
 280   /// The maximal execution count among all functions.
 281   uint64_t MaxFunctionCount;
 282
 283   IndexedInstrProfReader(const IndexedInstrProfReader &) = delete;
 284   IndexedInstrProfReader &operator=(const IndexedInstrProfReader &) = delete;
 285
 286  public:
 287   IndexedInstrProfReader(std::unique_ptr<MemoryBuffer> DataBuffer)
 288       : DataBuffer(std::move(DataBuffer)), Index() {}
 289
 290   /// Return true if the given buffer is in an indexed instrprof format.
 291   static bool hasFormat(const MemoryBuffer &DataBuffer);
 292
 293   /// Read the file header.
 294   std::error_code readHeader() override;
 295   /// Read a single record.
 296   std::error_code readNextRecord(InstrProfRecord &Record) override;
 297
 298   /// Return the pointer to InstrProfRecord associated with FuncName
 299   /// and FuncHash
 300   ErrorOr<InstrProfRecord> getInstrProfRecord(StringRef FuncName,
 301                                               uint64_t FuncHash);
 302
 303   /// Fill Counts with the profile data for the given function name.
 304   std::error_code getFunctionCounts(StringRef FuncName, uint64_t FuncHash,
 305                                     std::vector<uint64_t> &Counts);
 306   /// Return the maximum of all known function counts.
 307   uint64_t getMaximumFunctionCount() { return MaxFunctionCount; }
 308
 309   /// Factory method to create an indexed reader.
 310   static ErrorOr<std::unique_ptr<IndexedInstrProfReader>>
 311   create(std::string Path);
 312
 313   static ErrorOr<std::unique_ptr<IndexedInstrProfReader>>
 314   create(std::unique_ptr<MemoryBuffer> Buffer);
 315
 316   // Used for testing purpose only.
 317   void setValueProfDataEndianness(support::endianness Endianness) {
 318     Index.setValueProfDataEndianness(Endianness);
 319   }
 320 };
 321
 322 } // end namespace llvm
 323
 324 #endif