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