blob: f189713c77ab30bd8d0473dc163e87dae5b6636e [file] [log] [blame]
Justin Bognerf8d79192014-03-21 17:24:48 +00001//=-- InstrProfReader.cpp - Instrumented profiling reader -------------------=//
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 clang's
11// instrumentation based PGO and coverage.
12//
13//===----------------------------------------------------------------------===//
14
15#include "llvm/ProfileData/InstrProfReader.h"
Benjamin Kramer0a446fd2015-03-01 21:28:53 +000016#include "llvm/ADT/STLExtras.h"
Justin Bognerf8d79192014-03-21 17:24:48 +000017#include <cassert>
18
19using namespace llvm;
20
Diego Novillofcd55602014-11-03 00:51:45 +000021static ErrorOr<std::unique_ptr<MemoryBuffer>>
22setupMemoryBuffer(std::string Path) {
Rafael Espindolaadf21f22014-07-06 17:43:13 +000023 ErrorOr<std::unique_ptr<MemoryBuffer>> BufferOrErr =
24 MemoryBuffer::getFileOrSTDIN(Path);
25 if (std::error_code EC = BufferOrErr.getError())
Justin Bognerf8d79192014-03-21 17:24:48 +000026 return EC;
Justin Bogner2b6c5372015-02-18 01:58:17 +000027 return std::move(BufferOrErr.get());
Justin Bognerb7aa2632014-04-18 21:48:40 +000028}
29
Rafael Espindoladb4ed0b2014-06-13 02:24:39 +000030static std::error_code initializeReader(InstrProfReader &Reader) {
Justin Bognerb7aa2632014-04-18 21:48:40 +000031 return Reader.readHeader();
32}
33
Diego Novillofcd55602014-11-03 00:51:45 +000034ErrorOr<std::unique_ptr<InstrProfReader>>
35InstrProfReader::create(std::string Path) {
Justin Bognerb7aa2632014-04-18 21:48:40 +000036 // Set up the buffer to read.
Diego Novillofcd55602014-11-03 00:51:45 +000037 auto BufferOrError = setupMemoryBuffer(Path);
38 if (std::error_code EC = BufferOrError.getError())
Justin Bognerb7aa2632014-04-18 21:48:40 +000039 return EC;
Justin Bogner2b6c5372015-02-18 01:58:17 +000040 return InstrProfReader::create(std::move(BufferOrError.get()));
41}
Justin Bognerf8d79192014-03-21 17:24:48 +000042
Justin Bogner2b6c5372015-02-18 01:58:17 +000043ErrorOr<std::unique_ptr<InstrProfReader>>
44InstrProfReader::create(std::unique_ptr<MemoryBuffer> Buffer) {
45 // Sanity check the buffer.
46 if (Buffer->getBufferSize() > std::numeric_limits<unsigned>::max())
47 return instrprof_error::too_large;
48
Diego Novillofcd55602014-11-03 00:51:45 +000049 std::unique_ptr<InstrProfReader> Result;
Duncan P. N. Exon Smith09a67f42014-03-21 20:42:31 +000050 // Create the reader.
Justin Bognerb7aa2632014-04-18 21:48:40 +000051 if (IndexedInstrProfReader::hasFormat(*Buffer))
52 Result.reset(new IndexedInstrProfReader(std::move(Buffer)));
53 else if (RawInstrProfReader64::hasFormat(*Buffer))
Duncan P. N. Exon Smith46803612014-03-23 03:38:12 +000054 Result.reset(new RawInstrProfReader64(std::move(Buffer)));
55 else if (RawInstrProfReader32::hasFormat(*Buffer))
56 Result.reset(new RawInstrProfReader32(std::move(Buffer)));
Nathan Slingerland4f823662015-11-13 03:47:58 +000057 else if (TextInstrProfReader::hasFormat(*Buffer))
Nathan Slingerland911ced62015-11-12 18:39:26 +000058 Result.reset(new TextInstrProfReader(std::move(Buffer)));
Nathan Slingerland4f823662015-11-13 03:47:58 +000059 else
60 return instrprof_error::unrecognized_format;
Duncan P. N. Exon Smith09a67f42014-03-21 20:42:31 +000061
Justin Bognerb7aa2632014-04-18 21:48:40 +000062 // Initialize the reader and return the result.
Diego Novillofcd55602014-11-03 00:51:45 +000063 if (std::error_code EC = initializeReader(*Result))
64 return EC;
65
66 return std::move(Result);
Justin Bognerb7aa2632014-04-18 21:48:40 +000067}
68
Justin Bognerab89ed72015-02-16 21:28:58 +000069ErrorOr<std::unique_ptr<IndexedInstrProfReader>>
70IndexedInstrProfReader::create(std::string Path) {
Justin Bognerb7aa2632014-04-18 21:48:40 +000071 // Set up the buffer to read.
Diego Novillofcd55602014-11-03 00:51:45 +000072 auto BufferOrError = setupMemoryBuffer(Path);
73 if (std::error_code EC = BufferOrError.getError())
Justin Bognerb7aa2632014-04-18 21:48:40 +000074 return EC;
Justin Bogner2b6c5372015-02-18 01:58:17 +000075 return IndexedInstrProfReader::create(std::move(BufferOrError.get()));
76}
Justin Bognerb7aa2632014-04-18 21:48:40 +000077
Justin Bogner2b6c5372015-02-18 01:58:17 +000078
79ErrorOr<std::unique_ptr<IndexedInstrProfReader>>
80IndexedInstrProfReader::create(std::unique_ptr<MemoryBuffer> Buffer) {
81 // Sanity check the buffer.
82 if (Buffer->getBufferSize() > std::numeric_limits<unsigned>::max())
83 return instrprof_error::too_large;
Justin Bognerab89ed72015-02-16 21:28:58 +000084
Justin Bognerb7aa2632014-04-18 21:48:40 +000085 // Create the reader.
86 if (!IndexedInstrProfReader::hasFormat(*Buffer))
87 return instrprof_error::bad_magic;
Justin Bogner2b6c5372015-02-18 01:58:17 +000088 auto Result = llvm::make_unique<IndexedInstrProfReader>(std::move(Buffer));
Justin Bognerb7aa2632014-04-18 21:48:40 +000089
90 // Initialize the reader and return the result.
Justin Bognerab89ed72015-02-16 21:28:58 +000091 if (std::error_code EC = initializeReader(*Result))
92 return EC;
93
94 return std::move(Result);
Justin Bognerf8d79192014-03-21 17:24:48 +000095}
96
97void InstrProfIterator::Increment() {
98 if (Reader->readNextRecord(Record))
99 *this = InstrProfIterator();
100}
101
Nathan Slingerland4f823662015-11-13 03:47:58 +0000102bool TextInstrProfReader::hasFormat(const MemoryBuffer &Buffer) {
103 // Verify that this really looks like plain ASCII text by checking a
104 // 'reasonable' number of characters (up to profile magic size).
105 size_t count = std::min(Buffer.getBufferSize(), sizeof(uint64_t));
106 StringRef buffer = Buffer.getBufferStart();
Vedant Kumar2491dd12015-12-11 00:40:05 +0000107 return count == 0 ||
108 std::all_of(buffer.begin(), buffer.begin() + count,
109 [](char c) { return ::isprint(c) || ::isspace(c); });
Nathan Slingerland4f823662015-11-13 03:47:58 +0000110}
111
Xinliang David Lia716cc52015-12-20 06:22:13 +0000112std::error_code TextInstrProfReader::readHeader() {
113 Symtab.reset(new InstrProfSymtab());
114 return success();
115}
116
Xinliang David Lie3bf4fd32015-12-14 18:44:01 +0000117std::error_code
118TextInstrProfReader::readValueProfileData(InstrProfRecord &Record) {
119
120#define CHECK_LINE_END(Line) \
121 if (Line.is_at_end()) \
122 return error(instrprof_error::truncated);
123#define READ_NUM(Str, Dst) \
124 if ((Str).getAsInteger(10, (Dst))) \
125 return error(instrprof_error::malformed);
126#define VP_READ_ADVANCE(Val) \
127 CHECK_LINE_END(Line); \
128 uint32_t Val; \
129 READ_NUM((*Line), (Val)); \
130 Line++;
131
132 if (Line.is_at_end())
133 return success();
Xinliang David Lia716cc52015-12-20 06:22:13 +0000134
Xinliang David Lie3bf4fd32015-12-14 18:44:01 +0000135 uint32_t NumValueKinds;
136 if (Line->getAsInteger(10, NumValueKinds)) {
137 // No value profile data
138 return success();
139 }
140 if (NumValueKinds == 0 || NumValueKinds > IPVK_Last + 1)
141 return error(instrprof_error::malformed);
142 Line++;
143
144 for (uint32_t VK = 0; VK < NumValueKinds; VK++) {
145 VP_READ_ADVANCE(ValueKind);
146 if (ValueKind > IPVK_Last)
147 return error(instrprof_error::malformed);
148 VP_READ_ADVANCE(NumValueSites);
149 if (!NumValueSites)
150 continue;
151
152 Record.reserveSites(VK, NumValueSites);
153 for (uint32_t S = 0; S < NumValueSites; S++) {
154 VP_READ_ADVANCE(NumValueData);
155
156 std::vector<InstrProfValueData> CurrentValues;
157 for (uint32_t V = 0; V < NumValueData; V++) {
158 CHECK_LINE_END(Line);
159 std::pair<StringRef, StringRef> VD = Line->split(':');
160 uint64_t TakenCount, Value;
Xinliang David Lia716cc52015-12-20 06:22:13 +0000161 if (VK == IPVK_IndirectCallTarget) {
162 Symtab->addFuncName(VD.first);
163 Value = IndexedInstrProf::ComputeHash(VD.first);
164 } else {
Xinliang David Lie3bf4fd32015-12-14 18:44:01 +0000165 READ_NUM(VD.first, Value);
166 }
Xinliang David Lia716cc52015-12-20 06:22:13 +0000167 READ_NUM(VD.second, TakenCount);
Xinliang David Lie3bf4fd32015-12-14 18:44:01 +0000168 CurrentValues.push_back({Value, TakenCount});
169 Line++;
170 }
171 Record.addValueData(VK, S, CurrentValues.data(), NumValueData, nullptr);
172 }
173 }
174 return success();
175
176#undef CHECK_LINE_END
177#undef READ_NUM
178#undef VP_READ_ADVANCE
179}
180
Rafael Espindoladb4ed0b2014-06-13 02:24:39 +0000181std::error_code TextInstrProfReader::readNextRecord(InstrProfRecord &Record) {
Justin Bognercf36a362014-07-29 22:29:23 +0000182 // Skip empty lines and comments.
183 while (!Line.is_at_end() && (Line->empty() || Line->startswith("#")))
Justin Bognerf8d79192014-03-21 17:24:48 +0000184 ++Line;
185 // If we hit EOF while looking for a name, we're done.
Xinliang David Lia716cc52015-12-20 06:22:13 +0000186 if (Line.is_at_end()) {
187 Symtab->finalizeSymtab();
Justin Bognerf8d79192014-03-21 17:24:48 +0000188 return error(instrprof_error::eof);
Xinliang David Lia716cc52015-12-20 06:22:13 +0000189 }
Justin Bognerf8d79192014-03-21 17:24:48 +0000190
191 // Read the function name.
192 Record.Name = *Line++;
Xinliang David Lia716cc52015-12-20 06:22:13 +0000193 Symtab->addFuncName(Record.Name);
Justin Bognerf8d79192014-03-21 17:24:48 +0000194
195 // Read the function hash.
196 if (Line.is_at_end())
197 return error(instrprof_error::truncated);
Justin Bognerf95ca072015-03-09 18:54:49 +0000198 if ((Line++)->getAsInteger(0, Record.Hash))
Justin Bognerf8d79192014-03-21 17:24:48 +0000199 return error(instrprof_error::malformed);
200
201 // Read the number of counters.
202 uint64_t NumCounters;
203 if (Line.is_at_end())
204 return error(instrprof_error::truncated);
205 if ((Line++)->getAsInteger(10, NumCounters))
206 return error(instrprof_error::malformed);
Justin Bognerb59d7c72014-04-25 02:45:33 +0000207 if (NumCounters == 0)
208 return error(instrprof_error::malformed);
Justin Bognerf8d79192014-03-21 17:24:48 +0000209
210 // Read each counter and fill our internal storage with the values.
Justin Bogner3a7d44c2015-06-22 23:58:05 +0000211 Record.Counts.clear();
212 Record.Counts.reserve(NumCounters);
Justin Bognerf8d79192014-03-21 17:24:48 +0000213 for (uint64_t I = 0; I < NumCounters; ++I) {
214 if (Line.is_at_end())
215 return error(instrprof_error::truncated);
216 uint64_t Count;
217 if ((Line++)->getAsInteger(10, Count))
218 return error(instrprof_error::malformed);
Justin Bogner3a7d44c2015-06-22 23:58:05 +0000219 Record.Counts.push_back(Count);
Justin Bognerf8d79192014-03-21 17:24:48 +0000220 }
Justin Bognerf8d79192014-03-21 17:24:48 +0000221
Xinliang David Lie3bf4fd32015-12-14 18:44:01 +0000222 // Check if value profile data exists and read it if so.
223 if (std::error_code EC = readValueProfileData(Record))
224 return EC;
225
Xinliang David Lia716cc52015-12-20 06:22:13 +0000226 // This is needed to avoid two pass parsing because llvm-profdata
227 // does dumping while reading.
228 Symtab->finalizeSymtab();
Justin Bognerf8d79192014-03-21 17:24:48 +0000229 return success();
230}
Duncan P. N. Exon Smith24b4b652014-03-21 18:26:05 +0000231
Duncan P. N. Exon Smith46803612014-03-23 03:38:12 +0000232template <class IntPtrT>
Duncan P. N. Exon Smith46803612014-03-23 03:38:12 +0000233bool RawInstrProfReader<IntPtrT>::hasFormat(const MemoryBuffer &DataBuffer) {
Duncan P. N. Exon Smithd7d83472014-03-24 00:47:18 +0000234 if (DataBuffer.getBufferSize() < sizeof(uint64_t))
Duncan P. N. Exon Smith46803612014-03-23 03:38:12 +0000235 return false;
Duncan P. N. Exon Smithd7d83472014-03-24 00:47:18 +0000236 uint64_t Magic =
237 *reinterpret_cast<const uint64_t *>(DataBuffer.getBufferStart());
Xinliang David Lidab183ed2015-10-18 01:02:29 +0000238 return RawInstrProf::getMagic<IntPtrT>() == Magic ||
239 sys::getSwappedBytes(RawInstrProf::getMagic<IntPtrT>()) == Magic;
Duncan P. N. Exon Smith46803612014-03-23 03:38:12 +0000240}
241
242template <class IntPtrT>
Rafael Espindoladb4ed0b2014-06-13 02:24:39 +0000243std::error_code RawInstrProfReader<IntPtrT>::readHeader() {
Duncan P. N. Exon Smith09a67f42014-03-21 20:42:31 +0000244 if (!hasFormat(*DataBuffer))
245 return error(instrprof_error::bad_magic);
Xinliang David Lidab183ed2015-10-18 01:02:29 +0000246 if (DataBuffer->getBufferSize() < sizeof(RawInstrProf::Header))
Duncan P. N. Exon Smith531bb482014-03-21 20:42:28 +0000247 return error(instrprof_error::bad_header);
Xinliang David Lidab183ed2015-10-18 01:02:29 +0000248 auto *Header = reinterpret_cast<const RawInstrProf::Header *>(
249 DataBuffer->getBufferStart());
250 ShouldSwapBytes = Header->Magic != RawInstrProf::getMagic<IntPtrT>();
Duncan P. N. Exon Smith24b4b652014-03-21 18:26:05 +0000251 return readHeader(*Header);
252}
253
Justin Bognera119f322014-05-16 00:38:00 +0000254template <class IntPtrT>
Rafael Espindoladb4ed0b2014-06-13 02:24:39 +0000255std::error_code
256RawInstrProfReader<IntPtrT>::readNextHeader(const char *CurrentPos) {
Justin Bognera119f322014-05-16 00:38:00 +0000257 const char *End = DataBuffer->getBufferEnd();
258 // Skip zero padding between profiles.
259 while (CurrentPos != End && *CurrentPos == 0)
260 ++CurrentPos;
261 // If there's nothing left, we're done.
262 if (CurrentPos == End)
263 return instrprof_error::eof;
264 // If there isn't enough space for another header, this is probably just
265 // garbage at the end of the file.
Xinliang David Lidab183ed2015-10-18 01:02:29 +0000266 if (CurrentPos + sizeof(RawInstrProf::Header) > End)
Justin Bognera119f322014-05-16 00:38:00 +0000267 return instrprof_error::malformed;
Justin Bogner54b11282014-09-12 21:22:55 +0000268 // The writer ensures each profile is padded to start at an aligned address.
269 if (reinterpret_cast<size_t>(CurrentPos) % alignOf<uint64_t>())
270 return instrprof_error::malformed;
Justin Bognera119f322014-05-16 00:38:00 +0000271 // The magic should have the same byte order as in the previous header.
272 uint64_t Magic = *reinterpret_cast<const uint64_t *>(CurrentPos);
Xinliang David Lidab183ed2015-10-18 01:02:29 +0000273 if (Magic != swap(RawInstrProf::getMagic<IntPtrT>()))
Justin Bognera119f322014-05-16 00:38:00 +0000274 return instrprof_error::bad_magic;
275
276 // There's another profile to read, so we need to process the header.
Xinliang David Lidab183ed2015-10-18 01:02:29 +0000277 auto *Header = reinterpret_cast<const RawInstrProf::Header *>(CurrentPos);
Justin Bognera119f322014-05-16 00:38:00 +0000278 return readHeader(*Header);
279}
280
Duncan P. N. Exon Smith46803612014-03-23 03:38:12 +0000281template <class IntPtrT>
Xinliang David Lia716cc52015-12-20 06:22:13 +0000282void RawInstrProfReader<IntPtrT>::createSymtab(InstrProfSymtab &Symtab) {
Xinliang David Lia82d6c02016-02-08 18:13:49 +0000283 Symtab.create(StringRef(NamesStart, NamesSize));
Xinliang David Lia716cc52015-12-20 06:22:13 +0000284 for (const RawInstrProf::ProfileData<IntPtrT> *I = Data; I != DataEnd; ++I) {
Xinliang David Lia716cc52015-12-20 06:22:13 +0000285 const IntPtrT FPtr = swap(I->FunctionPointer);
286 if (!FPtr)
287 continue;
Xinliang David Lia82d6c02016-02-08 18:13:49 +0000288 Symtab.mapAddress(FPtr, I->NameRef);
Xinliang David Lia716cc52015-12-20 06:22:13 +0000289 }
290 Symtab.finalizeSymtab();
291}
292
293template <class IntPtrT>
294std::error_code
295RawInstrProfReader<IntPtrT>::readHeader(const RawInstrProf::Header &Header) {
Xinliang David Lidab183ed2015-10-18 01:02:29 +0000296 if (swap(Header.Version) != RawInstrProf::Version)
Duncan P. N. Exon Smith24b4b652014-03-21 18:26:05 +0000297 return error(instrprof_error::unsupported_version);
298
299 CountersDelta = swap(Header.CountersDelta);
300 NamesDelta = swap(Header.NamesDelta);
301 auto DataSize = swap(Header.DataSize);
302 auto CountersSize = swap(Header.CountersSize);
Xinliang David Lia82d6c02016-02-08 18:13:49 +0000303 NamesSize = swap(Header.NamesSize);
Betul Buyukkurt6fac1742015-11-18 18:14:55 +0000304 auto ValueDataSize = swap(Header.ValueDataSize);
305 ValueKindLast = swap(Header.ValueKindLast);
306
307 auto DataSizeInBytes = DataSize * sizeof(RawInstrProf::ProfileData<IntPtrT>);
308 auto PaddingSize = getNumPaddingBytes(NamesSize);
Duncan P. N. Exon Smith24b4b652014-03-21 18:26:05 +0000309
Xinliang David Lidab183ed2015-10-18 01:02:29 +0000310 ptrdiff_t DataOffset = sizeof(RawInstrProf::Header);
Betul Buyukkurt6fac1742015-11-18 18:14:55 +0000311 ptrdiff_t CountersOffset = DataOffset + DataSizeInBytes;
Duncan P. N. Exon Smith24b4b652014-03-21 18:26:05 +0000312 ptrdiff_t NamesOffset = CountersOffset + sizeof(uint64_t) * CountersSize;
Betul Buyukkurt6fac1742015-11-18 18:14:55 +0000313 ptrdiff_t ValueDataOffset = NamesOffset + NamesSize + PaddingSize;
314 size_t ProfileSize = ValueDataOffset + ValueDataSize;
Duncan P. N. Exon Smith24b4b652014-03-21 18:26:05 +0000315
Justin Bognera119f322014-05-16 00:38:00 +0000316 auto *Start = reinterpret_cast<const char *>(&Header);
317 if (Start + ProfileSize > DataBuffer->getBufferEnd())
Duncan P. N. Exon Smith531bb482014-03-21 20:42:28 +0000318 return error(instrprof_error::bad_header);
Duncan P. N. Exon Smith24b4b652014-03-21 18:26:05 +0000319
Xinliang David Lidab183ed2015-10-18 01:02:29 +0000320 Data = reinterpret_cast<const RawInstrProf::ProfileData<IntPtrT> *>(
321 Start + DataOffset);
Duncan P. N. Exon Smith24b4b652014-03-21 18:26:05 +0000322 DataEnd = Data + DataSize;
Duncan P. N. Exon Smithd7d83472014-03-24 00:47:18 +0000323 CountersStart = reinterpret_cast<const uint64_t *>(Start + CountersOffset);
324 NamesStart = Start + NamesOffset;
Xinliang David Lia716cc52015-12-20 06:22:13 +0000325 ValueDataStart = reinterpret_cast<const uint8_t *>(Start + ValueDataOffset);
Justin Bognera119f322014-05-16 00:38:00 +0000326 ProfileEnd = Start + ProfileSize;
Duncan P. N. Exon Smith24b4b652014-03-21 18:26:05 +0000327
Xinliang David Lia716cc52015-12-20 06:22:13 +0000328 std::unique_ptr<InstrProfSymtab> NewSymtab = make_unique<InstrProfSymtab>();
329 createSymtab(*NewSymtab.get());
330 Symtab = std::move(NewSymtab);
Duncan P. N. Exon Smith24b4b652014-03-21 18:26:05 +0000331 return success();
332}
333
Duncan P. N. Exon Smith46803612014-03-23 03:38:12 +0000334template <class IntPtrT>
Xinliang David Licf4a1282015-10-28 19:34:04 +0000335std::error_code RawInstrProfReader<IntPtrT>::readName(InstrProfRecord &Record) {
Xinliang David Lia82d6c02016-02-08 18:13:49 +0000336 Record.Name = getName(Data->NameRef);
Xinliang David Licf4a1282015-10-28 19:34:04 +0000337 return success();
338}
339
340template <class IntPtrT>
341std::error_code RawInstrProfReader<IntPtrT>::readFuncHash(
342 InstrProfRecord &Record) {
343 Record.Hash = swap(Data->FuncHash);
344 return success();
345}
346
347template <class IntPtrT>
348std::error_code RawInstrProfReader<IntPtrT>::readRawCounts(
349 InstrProfRecord &Record) {
Justin Bognerb59d7c72014-04-25 02:45:33 +0000350 uint32_t NumCounters = swap(Data->NumCounters);
Xinliang David Licf4a1282015-10-28 19:34:04 +0000351 IntPtrT CounterPtr = Data->CounterPtr;
Justin Bognerb59d7c72014-04-25 02:45:33 +0000352 if (NumCounters == 0)
353 return error(instrprof_error::malformed);
Xinliang David Licf4a1282015-10-28 19:34:04 +0000354
355 auto RawCounts = makeArrayRef(getCounter(CounterPtr), NumCounters);
356 auto *NamesStartAsCounter = reinterpret_cast<const uint64_t *>(NamesStart);
Duncan P. N. Exon Smith24b4b652014-03-21 18:26:05 +0000357
358 // Check bounds.
Xinliang David Licf4a1282015-10-28 19:34:04 +0000359 if (RawCounts.data() < CountersStart ||
Duncan P. N. Exon Smithd7d83472014-03-24 00:47:18 +0000360 RawCounts.data() + RawCounts.size() > NamesStartAsCounter)
Duncan P. N. Exon Smith24b4b652014-03-21 18:26:05 +0000361 return error(instrprof_error::malformed);
362
Duncan P. N. Exon Smith24b4b652014-03-21 18:26:05 +0000363 if (ShouldSwapBytes) {
Justin Bogner3a7d44c2015-06-22 23:58:05 +0000364 Record.Counts.clear();
365 Record.Counts.reserve(RawCounts.size());
Duncan P. N. Exon Smith24b4b652014-03-21 18:26:05 +0000366 for (uint64_t Count : RawCounts)
Justin Bogner3a7d44c2015-06-22 23:58:05 +0000367 Record.Counts.push_back(swap(Count));
Duncan P. N. Exon Smith24b4b652014-03-21 18:26:05 +0000368 } else
369 Record.Counts = RawCounts;
370
Xinliang David Licf4a1282015-10-28 19:34:04 +0000371 return success();
372}
373
374template <class IntPtrT>
Xinliang David Li01cb9bd2015-12-04 01:02:10 +0000375std::error_code
376RawInstrProfReader<IntPtrT>::readValueProfilingData(InstrProfRecord &Record) {
Betul Buyukkurt6fac1742015-11-18 18:14:55 +0000377
378 Record.clearValueData();
Xinliang David Lid922c262015-12-11 06:53:53 +0000379 CurValueDataSize = 0;
380 // Need to match the logic in value profile dumper code in compiler-rt:
381 uint32_t NumValueKinds = 0;
382 for (uint32_t I = 0; I < IPVK_Last + 1; I++)
383 NumValueKinds += (Data->NumValueSites[I] != 0);
384
385 if (!NumValueKinds)
Betul Buyukkurt6fac1742015-11-18 18:14:55 +0000386 return success();
387
Xinliang David Li01cb9bd2015-12-04 01:02:10 +0000388 ErrorOr<std::unique_ptr<ValueProfData>> VDataPtrOrErr =
Xinliang David Lid922c262015-12-11 06:53:53 +0000389 ValueProfData::getValueProfData(ValueDataStart,
Xinliang David Li01cb9bd2015-12-04 01:02:10 +0000390 (const unsigned char *)ProfileEnd,
391 getDataEndianness());
Betul Buyukkurt6fac1742015-11-18 18:14:55 +0000392
Xinliang David Li01cb9bd2015-12-04 01:02:10 +0000393 if (VDataPtrOrErr.getError())
394 return VDataPtrOrErr.getError();
Betul Buyukkurt6fac1742015-11-18 18:14:55 +0000395
Xinliang David Lia716cc52015-12-20 06:22:13 +0000396 VDataPtrOrErr.get()->deserializeTo(Record, &Symtab->getAddrHashMap());
Xinliang David Lid922c262015-12-11 06:53:53 +0000397 CurValueDataSize = VDataPtrOrErr.get()->getSize();
Betul Buyukkurt6fac1742015-11-18 18:14:55 +0000398 return success();
399}
400
401template <class IntPtrT>
Xinliang David Li01cb9bd2015-12-04 01:02:10 +0000402std::error_code
403RawInstrProfReader<IntPtrT>::readNextRecord(InstrProfRecord &Record) {
Xinliang David Licf4a1282015-10-28 19:34:04 +0000404 if (atEnd())
Xinliang David Li4c3ab812015-11-12 00:32:17 +0000405 if (std::error_code EC = readNextHeader(ProfileEnd))
406 return EC;
Xinliang David Licf4a1282015-10-28 19:34:04 +0000407
408 // Read name ad set it in Record.
Xinliang David Li4c3ab812015-11-12 00:32:17 +0000409 if (std::error_code EC = readName(Record))
410 return EC;
Xinliang David Licf4a1282015-10-28 19:34:04 +0000411
412 // Read FuncHash and set it in Record.
Xinliang David Li4c3ab812015-11-12 00:32:17 +0000413 if (std::error_code EC = readFuncHash(Record))
414 return EC;
Xinliang David Licf4a1282015-10-28 19:34:04 +0000415
416 // Read raw counts and set Record.
Xinliang David Li4c3ab812015-11-12 00:32:17 +0000417 if (std::error_code EC = readRawCounts(Record))
418 return EC;
Xinliang David Licf4a1282015-10-28 19:34:04 +0000419
Betul Buyukkurt6fac1742015-11-18 18:14:55 +0000420 // Read value data and set Record.
Xinliang David Li2d4803e2015-12-10 23:48:05 +0000421 if (std::error_code EC = readValueProfilingData(Record))
422 return EC;
Betul Buyukkurt6fac1742015-11-18 18:14:55 +0000423
Duncan P. N. Exon Smith24b4b652014-03-21 18:26:05 +0000424 // Iterate.
Xinliang David Licf4a1282015-10-28 19:34:04 +0000425 advanceData();
Duncan P. N. Exon Smith24b4b652014-03-21 18:26:05 +0000426 return success();
427}
Duncan P. N. Exon Smith46803612014-03-23 03:38:12 +0000428
429namespace llvm {
430template class RawInstrProfReader<uint32_t>;
431template class RawInstrProfReader<uint64_t>;
432}
Justin Bognerb7aa2632014-04-18 21:48:40 +0000433
Justin Bognerb5d368e2014-04-18 22:00:22 +0000434InstrProfLookupTrait::hash_value_type
435InstrProfLookupTrait::ComputeHash(StringRef K) {
436 return IndexedInstrProf::ComputeHash(HashType, K);
437}
438
Justin Bogner3a7d44c2015-06-22 23:58:05 +0000439typedef InstrProfLookupTrait::data_type data_type;
440typedef InstrProfLookupTrait::offset_type offset_type;
441
Xinliang David Libe969c22015-11-28 05:06:00 +0000442bool InstrProfLookupTrait::readValueProfilingData(
Justin Bogner9e9a0572015-09-29 22:13:58 +0000443 const unsigned char *&D, const unsigned char *const End) {
Xinliang David Li99556872015-11-17 23:00:40 +0000444 ErrorOr<std::unique_ptr<ValueProfData>> VDataPtrOrErr =
445 ValueProfData::getValueProfData(D, End, ValueProfDataEndianness);
Justin Bogner9e9a0572015-09-29 22:13:58 +0000446
Xinliang David Liee415892015-11-10 00:24:45 +0000447 if (VDataPtrOrErr.getError())
Justin Bogner9e9a0572015-09-29 22:13:58 +0000448 return false;
Justin Bogner9e9a0572015-09-29 22:13:58 +0000449
Xinliang David Lia716cc52015-12-20 06:22:13 +0000450 VDataPtrOrErr.get()->deserializeTo(DataBuffer.back(), nullptr);
Xinliang David Liee415892015-11-10 00:24:45 +0000451 D += VDataPtrOrErr.get()->TotalSize;
Justin Bogner9e9a0572015-09-29 22:13:58 +0000452
Justin Bogner9e9a0572015-09-29 22:13:58 +0000453 return true;
454}
455
Justin Bogner3a7d44c2015-06-22 23:58:05 +0000456data_type InstrProfLookupTrait::ReadData(StringRef K, const unsigned char *D,
457 offset_type N) {
Justin Bogner3a7d44c2015-06-22 23:58:05 +0000458 // Check if the data is corrupt. If so, don't try to read it.
459 if (N % sizeof(uint64_t))
460 return data_type();
461
462 DataBuffer.clear();
Justin Bogner3a7d44c2015-06-22 23:58:05 +0000463 std::vector<uint64_t> CounterBuffer;
Justin Bogner9e9a0572015-09-29 22:13:58 +0000464
465 using namespace support;
466 const unsigned char *End = D + N;
467 while (D < End) {
Xinliang David Lic7583872015-10-13 16:35:59 +0000468 // Read hash.
Justin Bogner9e9a0572015-09-29 22:13:58 +0000469 if (D + sizeof(uint64_t) >= End)
470 return data_type();
Justin Bogner3a7d44c2015-06-22 23:58:05 +0000471 uint64_t Hash = endian::readNext<uint64_t, little, unaligned>(D);
472
Xinliang David Lic7583872015-10-13 16:35:59 +0000473 // Initialize number of counters for FormatVersion == 1.
Justin Bogner9e9a0572015-09-29 22:13:58 +0000474 uint64_t CountsSize = N / sizeof(uint64_t) - 1;
Xinliang David Lic7583872015-10-13 16:35:59 +0000475 // If format version is different then read the number of counters.
Xinliang David Lia6b2c4f2016-01-14 02:47:01 +0000476 if (FormatVersion != IndexedInstrProf::ProfVersion::Version1) {
Justin Bogner9e9a0572015-09-29 22:13:58 +0000477 if (D + sizeof(uint64_t) > End)
478 return data_type();
479 CountsSize = endian::readNext<uint64_t, little, unaligned>(D);
480 }
Xinliang David Lic7583872015-10-13 16:35:59 +0000481 // Read counter values.
Justin Bogner9e9a0572015-09-29 22:13:58 +0000482 if (D + CountsSize * sizeof(uint64_t) > End)
Justin Bogner3a7d44c2015-06-22 23:58:05 +0000483 return data_type();
484
485 CounterBuffer.clear();
Justin Bogner9e9a0572015-09-29 22:13:58 +0000486 CounterBuffer.reserve(CountsSize);
487 for (uint64_t J = 0; J < CountsSize; ++J)
Justin Bogner3a7d44c2015-06-22 23:58:05 +0000488 CounterBuffer.push_back(endian::readNext<uint64_t, little, unaligned>(D));
489
Xinliang David Li2004f002015-11-02 05:08:23 +0000490 DataBuffer.emplace_back(K, Hash, std::move(CounterBuffer));
Justin Bogner9e9a0572015-09-29 22:13:58 +0000491
Xinliang David Lic7583872015-10-13 16:35:59 +0000492 // Read value profiling data.
Xinliang David Lia6b2c4f2016-01-14 02:47:01 +0000493 if (FormatVersion > IndexedInstrProf::ProfVersion::Version2 &&
494 !readValueProfilingData(D, End)) {
Justin Bogner9e9a0572015-09-29 22:13:58 +0000495 DataBuffer.clear();
496 return data_type();
497 }
Justin Bogner3a7d44c2015-06-22 23:58:05 +0000498 }
499 return DataBuffer;
500}
501
Xinliang David Lia28306d2015-12-01 20:26:26 +0000502template <typename HashTableImpl>
503std::error_code InstrProfReaderIndex<HashTableImpl>::getRecords(
504 StringRef FuncName, ArrayRef<InstrProfRecord> &Data) {
505 auto Iter = HashTable->find(FuncName);
506 if (Iter == HashTable->end())
Xinliang David Li4c3ab812015-11-12 00:32:17 +0000507 return instrprof_error::unknown_function;
Xinliang David Li140f4c42015-10-28 04:20:31 +0000508
509 Data = (*Iter);
Xinliang David Li4c3ab812015-11-12 00:32:17 +0000510 if (Data.empty())
511 return instrprof_error::malformed;
Xinliang David Li140f4c42015-10-28 04:20:31 +0000512
513 return instrprof_error::success;
514}
515
Xinliang David Lia28306d2015-12-01 20:26:26 +0000516template <typename HashTableImpl>
517std::error_code InstrProfReaderIndex<HashTableImpl>::getRecords(
Xinliang David Li140f4c42015-10-28 04:20:31 +0000518 ArrayRef<InstrProfRecord> &Data) {
Xinliang David Lia28306d2015-12-01 20:26:26 +0000519 if (atEnd())
520 return instrprof_error::eof;
Xinliang David Li140f4c42015-10-28 04:20:31 +0000521
522 Data = *RecordIterator;
523
Xinliang David Li2d4803e2015-12-10 23:48:05 +0000524 if (Data.empty())
525 return instrprof_error::malformed;
Xinliang David Li140f4c42015-10-28 04:20:31 +0000526
527 return instrprof_error::success;
528}
529
Xinliang David Lia28306d2015-12-01 20:26:26 +0000530template <typename HashTableImpl>
531InstrProfReaderIndex<HashTableImpl>::InstrProfReaderIndex(
532 const unsigned char *Buckets, const unsigned char *const Payload,
533 const unsigned char *const Base, IndexedInstrProf::HashT HashType,
534 uint64_t Version) {
Xinliang David Li140f4c42015-10-28 04:20:31 +0000535 FormatVersion = Version;
Xinliang David Lia28306d2015-12-01 20:26:26 +0000536 HashTable.reset(HashTableImpl::Create(
537 Buckets, Payload, Base,
538 typename HashTableImpl::InfoType(HashType, Version)));
Xinliang David Lia28306d2015-12-01 20:26:26 +0000539 RecordIterator = HashTable->data_begin();
Xinliang David Li140f4c42015-10-28 04:20:31 +0000540}
541
Justin Bognerb7aa2632014-04-18 21:48:40 +0000542bool IndexedInstrProfReader::hasFormat(const MemoryBuffer &DataBuffer) {
Xinliang David Li4c3ab812015-11-12 00:32:17 +0000543 if (DataBuffer.getBufferSize() < 8)
544 return false;
Justin Bognerb7aa2632014-04-18 21:48:40 +0000545 using namespace support;
546 uint64_t Magic =
547 endian::read<uint64_t, little, aligned>(DataBuffer.getBufferStart());
Xinliang David Lic7583872015-10-13 16:35:59 +0000548 // Verify that it's magical.
Justin Bognerb7aa2632014-04-18 21:48:40 +0000549 return Magic == IndexedInstrProf::Magic;
550}
551
Xinliang David Li6c93ee82016-02-03 04:08:18 +0000552const unsigned char *
553IndexedInstrProfReader::readSummary(IndexedInstrProf::ProfVersion Version,
554 const unsigned char *Cur) {
555 using namespace support;
556 if (Version >= IndexedInstrProf::Version4) {
557 const IndexedInstrProf::Summary *SummaryInLE =
558 reinterpret_cast<const IndexedInstrProf::Summary *>(Cur);
559 uint64_t NFields =
560 endian::byte_swap<uint64_t, little>(SummaryInLE->NumSummaryFields);
561 uint64_t NEntries =
562 endian::byte_swap<uint64_t, little>(SummaryInLE->NumCutoffEntries);
563 uint32_t SummarySize =
564 IndexedInstrProf::Summary::getSize(NFields, NEntries);
565 std::unique_ptr<IndexedInstrProf::Summary> SummaryData =
566 IndexedInstrProf::allocSummary(SummarySize);
567
568 const uint64_t *Src = reinterpret_cast<const uint64_t *>(SummaryInLE);
569 uint64_t *Dst = reinterpret_cast<uint64_t *>(SummaryData.get());
570 for (unsigned I = 0; I < SummarySize / sizeof(uint64_t); I++)
571 Dst[I] = endian::byte_swap<uint64_t, little>(Src[I]);
572
573 // initialize ProfileSummary using the SummaryData from disk.
574 this->Summary = llvm::make_unique<ProfileSummary>(*(SummaryData.get()));
575 return Cur + SummarySize;
576 } else {
577 // For older version of profile data, we need to compute on the fly:
578 using namespace IndexedInstrProf;
579 std::vector<uint32_t> Cutoffs(&SummaryCutoffs[0],
580 &SummaryCutoffs[NumSummaryCutoffs]);
581 this->Summary = llvm::make_unique<ProfileSummary>(Cutoffs);
582 this->Summary->computeDetailedSummary();
583 return Cur;
584 }
585}
586
Rafael Espindoladb4ed0b2014-06-13 02:24:39 +0000587std::error_code IndexedInstrProfReader::readHeader() {
Aaron Ballmana7c9ed52014-05-01 17:16:24 +0000588 const unsigned char *Start =
589 (const unsigned char *)DataBuffer->getBufferStart();
Justin Bognerb7aa2632014-04-18 21:48:40 +0000590 const unsigned char *Cur = Start;
Aaron Ballmana7c9ed52014-05-01 17:16:24 +0000591 if ((const unsigned char *)DataBuffer->getBufferEnd() - Cur < 24)
Justin Bognerb7aa2632014-04-18 21:48:40 +0000592 return error(instrprof_error::truncated);
593
594 using namespace support;
595
Xinliang David Lidab183ed2015-10-18 01:02:29 +0000596 auto *Header = reinterpret_cast<const IndexedInstrProf::Header *>(Cur);
597 Cur += sizeof(IndexedInstrProf::Header);
598
Justin Bognerb7aa2632014-04-18 21:48:40 +0000599 // Check the magic number.
Xinliang David Lidab183ed2015-10-18 01:02:29 +0000600 uint64_t Magic = endian::byte_swap<uint64_t, little>(Header->Magic);
Justin Bognerb7aa2632014-04-18 21:48:40 +0000601 if (Magic != IndexedInstrProf::Magic)
602 return error(instrprof_error::bad_magic);
603
604 // Read the version.
Xinliang David Li140f4c42015-10-28 04:20:31 +0000605 uint64_t FormatVersion = endian::byte_swap<uint64_t, little>(Header->Version);
Xinliang David Lia6b2c4f2016-01-14 02:47:01 +0000606 if (FormatVersion > IndexedInstrProf::ProfVersion::CurrentVersion)
Justin Bognerb7aa2632014-04-18 21:48:40 +0000607 return error(instrprof_error::unsupported_version);
608
Xinliang David Li6c93ee82016-02-03 04:08:18 +0000609 Cur = readSummary((IndexedInstrProf::ProfVersion)FormatVersion, Cur);
Justin Bognerb7aa2632014-04-18 21:48:40 +0000610
611 // Read the hash type and start offset.
612 IndexedInstrProf::HashT HashType = static_cast<IndexedInstrProf::HashT>(
Xinliang David Lidab183ed2015-10-18 01:02:29 +0000613 endian::byte_swap<uint64_t, little>(Header->HashType));
Justin Bognerb7aa2632014-04-18 21:48:40 +0000614 if (HashType > IndexedInstrProf::HashT::Last)
615 return error(instrprof_error::unsupported_hash_type);
Xinliang David Lidab183ed2015-10-18 01:02:29 +0000616
617 uint64_t HashOffset = endian::byte_swap<uint64_t, little>(Header->HashOffset);
Justin Bognerb7aa2632014-04-18 21:48:40 +0000618
619 // The rest of the file is an on disk hash table.
Xinliang David Lia28306d2015-12-01 20:26:26 +0000620 InstrProfReaderIndexBase *IndexPtr = nullptr;
621 IndexPtr = new InstrProfReaderIndex<OnDiskHashTableImplV3>(
622 Start + HashOffset, Cur, Start, HashType, FormatVersion);
623 Index.reset(IndexPtr);
Justin Bognerb7aa2632014-04-18 21:48:40 +0000624 return success();
625}
626
Xinliang David Lia716cc52015-12-20 06:22:13 +0000627InstrProfSymtab &IndexedInstrProfReader::getSymtab() {
628 if (Symtab.get())
629 return *Symtab.get();
630
631 std::unique_ptr<InstrProfSymtab> NewSymtab = make_unique<InstrProfSymtab>();
632 Index->populateSymtab(*NewSymtab.get());
633
634 Symtab = std::move(NewSymtab);
635 return *Symtab.get();
636}
637
Xinliang David Li6aa216c2015-11-06 07:54:21 +0000638ErrorOr<InstrProfRecord>
639IndexedInstrProfReader::getInstrProfRecord(StringRef FuncName,
640 uint64_t FuncHash) {
Xinliang David Li140f4c42015-10-28 04:20:31 +0000641 ArrayRef<InstrProfRecord> Data;
Xinliang David Lia28306d2015-12-01 20:26:26 +0000642 std::error_code EC = Index->getRecords(FuncName, Data);
Xinliang David Li4c3ab812015-11-12 00:32:17 +0000643 if (EC != instrprof_error::success)
644 return EC;
Justin Bogner821d7472014-08-01 22:50:07 +0000645 // Found it. Look for counters with the right hash.
Justin Bogner3a7d44c2015-06-22 23:58:05 +0000646 for (unsigned I = 0, E = Data.size(); I < E; ++I) {
Justin Bogner821d7472014-08-01 22:50:07 +0000647 // Check for a match and fill the vector if there is one.
Justin Bogner3a7d44c2015-06-22 23:58:05 +0000648 if (Data[I].Hash == FuncHash) {
Xinliang David Li2004f002015-11-02 05:08:23 +0000649 return std::move(Data[I]);
Justin Bogner821d7472014-08-01 22:50:07 +0000650 }
651 }
652 return error(instrprof_error::hash_mismatch);
Justin Bognerb7aa2632014-04-18 21:48:40 +0000653}
654
Xinliang David Li6aa216c2015-11-06 07:54:21 +0000655std::error_code
656IndexedInstrProfReader::getFunctionCounts(StringRef FuncName, uint64_t FuncHash,
657 std::vector<uint64_t> &Counts) {
Xinliang David Li2004f002015-11-02 05:08:23 +0000658 ErrorOr<InstrProfRecord> Record = getInstrProfRecord(FuncName, FuncHash);
Xinliang David Li6aa216c2015-11-06 07:54:21 +0000659 if (std::error_code EC = Record.getError())
660 return EC;
Xinliang David Li2004f002015-11-02 05:08:23 +0000661
662 Counts = Record.get().Counts;
663 return success();
664}
665
Xinliang David Li140f4c42015-10-28 04:20:31 +0000666std::error_code IndexedInstrProfReader::readNextRecord(
667 InstrProfRecord &Record) {
Justin Bogner3a7d44c2015-06-22 23:58:05 +0000668 static unsigned RecordIndex = 0;
Xinliang David Li140f4c42015-10-28 04:20:31 +0000669
670 ArrayRef<InstrProfRecord> Data;
671
Xinliang David Lia28306d2015-12-01 20:26:26 +0000672 std::error_code EC = Index->getRecords(Data);
Xinliang David Li4c3ab812015-11-12 00:32:17 +0000673 if (EC != instrprof_error::success)
674 return error(EC);
Xinliang David Li140f4c42015-10-28 04:20:31 +0000675
Justin Bogner3a7d44c2015-06-22 23:58:05 +0000676 Record = Data[RecordIndex++];
677 if (RecordIndex >= Data.size()) {
Xinliang David Lia28306d2015-12-01 20:26:26 +0000678 Index->advanceToNextKey();
Justin Bogner3a7d44c2015-06-22 23:58:05 +0000679 RecordIndex = 0;
Justin Bogner821d7472014-08-01 22:50:07 +0000680 }
Justin Bognerb7aa2632014-04-18 21:48:40 +0000681 return success();
682}