1 //=-- InstrProfReader.h - Instrumented profiling readers ----------*- C++ -*-=//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file contains support for reading profiling data for instrumentation
11 // based PGO and coverage.
13 //===----------------------------------------------------------------------===//
15 #ifndef LLVM_PROFILEDATA_INSTRPROFREADER_H
16 #define LLVM_PROFILEDATA_INSTRPROFREADER_H
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"
30 class InstrProfReader;
32 /// A file format agnostic iterator over profiling data.
33 class InstrProfIterator : public std::iterator<std::input_iterator_tag,
35 InstrProfReader *Reader;
36 InstrProfRecord Record;
40 InstrProfIterator() : Reader(nullptr) {}
41 InstrProfIterator(InstrProfReader *Reader) : Reader(Reader) { Increment(); }
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; }
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;
56 InstrProfReader() : LastError(instrprof_error::success) {}
57 virtual ~InstrProfReader() {}
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(); }
68 /// String table for holding a unique copy of all the strings in the profile.
69 InstrProfStringTable StringTable;
71 /// Set the current std::error_code and return same.
72 std::error_code error(std::error_code EC) {
77 /// Clear the current error code and return a successful one.
78 std::error_code success() { return error(instrprof_error::success); }
81 /// Return true if the reader has finished reading the profile data.
82 bool isEOF() { return LastError == instrprof_error::eof; }
83 /// Return true if the reader encountered an error reading profiling data.
84 bool hasError() { return LastError && !isEOF(); }
85 /// Get the current error code.
86 std::error_code getError() { return LastError; }
88 /// Factory method to create an appropriately typed reader for the given
90 static ErrorOr<std::unique_ptr<InstrProfReader>> create(std::string Path);
92 static ErrorOr<std::unique_ptr<InstrProfReader>>
93 create(std::unique_ptr<MemoryBuffer> Buffer);
96 /// Reader for the simple text based instrprof format.
98 /// This format is a simple text format that's suitable for test data. Records
99 /// are separated by one or more blank lines, and record fields are separated by
102 /// Each record consists of a function name, a function hash, a number of
103 /// counters, and then each counter value, in that order.
104 class TextInstrProfReader : public InstrProfReader {
106 /// The profile data file contents.
107 std::unique_ptr<MemoryBuffer> DataBuffer;
108 /// Iterator over the profile data.
111 TextInstrProfReader(const TextInstrProfReader &) = delete;
112 TextInstrProfReader &operator=(const TextInstrProfReader &) = delete;
114 TextInstrProfReader(std::unique_ptr<MemoryBuffer> DataBuffer_)
115 : DataBuffer(std::move(DataBuffer_)), Line(*DataBuffer, true, '#') {}
118 std::error_code readHeader() override { return success(); }
119 /// Read a single record.
120 std::error_code readNextRecord(InstrProfRecord &Record) override;
123 /// Reader for the raw instrprof binary format from runtime.
125 /// This format is a raw memory dump of the instrumentation-baed profiling data
126 /// from the runtime. It has no index.
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 {
133 /// The profile data file contents.
134 std::unique_ptr<MemoryBuffer> DataBuffer;
136 bool ShouldSwapBytes;
137 uint64_t CountersDelta;
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;
145 RawInstrProfReader(const RawInstrProfReader &) = delete;
146 RawInstrProfReader &operator=(const RawInstrProfReader &) = delete;
148 RawInstrProfReader(std::unique_ptr<MemoryBuffer> DataBuffer)
149 : DataBuffer(std::move(DataBuffer)) { }
151 static bool hasFormat(const MemoryBuffer &DataBuffer);
152 std::error_code readHeader() override;
153 std::error_code readNextRecord(InstrProfRecord &Record) override;
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;
162 const uint64_t *getCounter(IntPtrT CounterPtr) const {
163 ptrdiff_t Offset = (swap(CounterPtr) - CountersDelta) / sizeof(uint64_t);
164 return CountersStart + Offset;
166 const char *getName(IntPtrT NamePtr) const {
167 ptrdiff_t Offset = (swap(NamePtr) - NamesDelta) / sizeof(char);
168 return NamesStart + Offset;
172 typedef RawInstrProfReader<uint32_t> RawInstrProfReader32;
173 typedef RawInstrProfReader<uint64_t> RawInstrProfReader64;
175 namespace IndexedInstrProf {
176 enum class HashT : uint32_t;
179 /// Trait for lookups into the on-disk hash table for the binary instrprof
181 class InstrProfLookupTrait {
182 std::vector<InstrProfRecord> DataBuffer;
183 IndexedInstrProf::HashT HashType;
184 unsigned FormatVersion;
185 std::vector<std::pair<uint64_t, const char *>> HashKeys;
188 InstrProfLookupTrait(IndexedInstrProf::HashT HashType, unsigned FormatVersion)
189 : HashType(HashType), FormatVersion(FormatVersion) {}
191 typedef ArrayRef<InstrProfRecord> data_type;
193 typedef StringRef internal_key_type;
194 typedef StringRef external_key_type;
195 typedef uint64_t hash_value_type;
196 typedef uint64_t offset_type;
198 static bool EqualKey(StringRef A, StringRef B) { return A == B; }
199 static StringRef GetInternalKey(StringRef K) { return K; }
200 static StringRef GetExternalKey(StringRef K) { return K; }
202 hash_value_type ComputeHash(StringRef K);
204 void setHashKeys(std::vector<std::pair<uint64_t, const char *>> HashKeys) {
205 this->HashKeys = std::move(HashKeys);
207 static std::pair<offset_type, offset_type>
208 ReadKeyDataLength(const unsigned char *&D) {
209 using namespace support;
210 offset_type KeyLen = endian::readNext<offset_type, little, unaligned>(D);
211 offset_type DataLen = endian::readNext<offset_type, little, unaligned>(D);
212 return std::make_pair(KeyLen, DataLen);
215 StringRef ReadKey(const unsigned char *D, offset_type N) {
216 return StringRef((const char *)D, N);
219 bool ReadValueProfilingData(const unsigned char *&D,
220 const unsigned char *const End);
221 data_type ReadData(StringRef K, const unsigned char *D, offset_type N);
224 typedef OnDiskIterableChainedHashTable<InstrProfLookupTrait>
225 InstrProfReaderIndex;
227 /// Reader for the indexed binary instrprof format.
228 class IndexedInstrProfReader : public InstrProfReader {
230 /// The profile data file contents.
231 std::unique_ptr<MemoryBuffer> DataBuffer;
232 /// The index into the profile data.
233 std::unique_ptr<InstrProfReaderIndex> Index;
234 /// Iterator over the profile data.
235 InstrProfReaderIndex::data_iterator RecordIterator;
236 /// The file format version of the profile data.
237 uint64_t FormatVersion;
238 /// The maximal execution count among all functions.
239 uint64_t MaxFunctionCount;
241 IndexedInstrProfReader(const IndexedInstrProfReader &) = delete;
242 IndexedInstrProfReader &operator=(const IndexedInstrProfReader &) = delete;
244 IndexedInstrProfReader(std::unique_ptr<MemoryBuffer> DataBuffer)
245 : DataBuffer(std::move(DataBuffer)), Index(nullptr) {}
247 /// Return true if the given buffer is in an indexed instrprof format.
248 static bool hasFormat(const MemoryBuffer &DataBuffer);
250 /// Read the file header.
251 std::error_code readHeader() override;
252 /// Read a single record.
253 std::error_code readNextRecord(InstrProfRecord &Record) override;
255 /// Fill Counts with the profile data for the given function name.
256 std::error_code getFunctionCounts(StringRef FuncName, uint64_t FuncHash,
257 std::vector<uint64_t> &Counts);
258 /// Return the maximum of all known function counts.
259 uint64_t getMaximumFunctionCount() { return MaxFunctionCount; }
261 /// Factory method to create an indexed reader.
262 static ErrorOr<std::unique_ptr<IndexedInstrProfReader>>
263 create(std::string Path);
265 static ErrorOr<std::unique_ptr<IndexedInstrProfReader>>
266 create(std::unique_ptr<MemoryBuffer> Buffer);
269 } // end namespace llvm