1 //=-- 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"
16 #include "llvm/ADT/STLExtras.h"
17 #include <cassert>
18 
19 using namespace llvm;
20 
21 static ErrorOr<std::unique_ptr<MemoryBuffer>>
22 setupMemoryBuffer(std::string Path) {
23   ErrorOr<std::unique_ptr<MemoryBuffer>> BufferOrErr =
24       MemoryBuffer::getFileOrSTDIN(Path);
25   if (std::error_code EC = BufferOrErr.getError())
26     return EC;
27   return std::move(BufferOrErr.get());
28 }
29 
30 static std::error_code initializeReader(InstrProfReader &Reader) {
31   return Reader.readHeader();
32 }
33 
34 ErrorOr<std::unique_ptr<InstrProfReader>>
35 InstrProfReader::create(std::string Path) {
36   // Set up the buffer to read.
37   auto BufferOrError = setupMemoryBuffer(Path);
38   if (std::error_code EC = BufferOrError.getError())
39     return EC;
40   return InstrProfReader::create(std::move(BufferOrError.get()));
41 }
42 
43 ErrorOr<std::unique_ptr<InstrProfReader>>
44 InstrProfReader::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 
49   std::unique_ptr<InstrProfReader> Result;
50   // Create the reader.
51   if (IndexedInstrProfReader::hasFormat(*Buffer))
52     Result.reset(new IndexedInstrProfReader(std::move(Buffer)));
53   else if (RawInstrProfReader64::hasFormat(*Buffer))
54     Result.reset(new RawInstrProfReader64(std::move(Buffer)));
55   else if (RawInstrProfReader32::hasFormat(*Buffer))
56     Result.reset(new RawInstrProfReader32(std::move(Buffer)));
57   else if (TextInstrProfReader::hasFormat(*Buffer))
58     Result.reset(new TextInstrProfReader(std::move(Buffer)));
59   else
60     return instrprof_error::unrecognized_format;
61 
62   // Initialize the reader and return the result.
63   if (std::error_code EC = initializeReader(*Result))
64     return EC;
65 
66   return std::move(Result);
67 }
68 
69 ErrorOr<std::unique_ptr<IndexedInstrProfReader>>
70 IndexedInstrProfReader::create(std::string Path) {
71   // Set up the buffer to read.
72   auto BufferOrError = setupMemoryBuffer(Path);
73   if (std::error_code EC = BufferOrError.getError())
74     return EC;
75   return IndexedInstrProfReader::create(std::move(BufferOrError.get()));
76 }
77 
78 
79 ErrorOr<std::unique_ptr<IndexedInstrProfReader>>
80 IndexedInstrProfReader::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;
84 
85   // Create the reader.
86   if (!IndexedInstrProfReader::hasFormat(*Buffer))
87     return instrprof_error::bad_magic;
88   auto Result = llvm::make_unique<IndexedInstrProfReader>(std::move(Buffer));
89 
90   // Initialize the reader and return the result.
91   if (std::error_code EC = initializeReader(*Result))
92     return EC;
93 
94   return std::move(Result);
95 }
96 
97 void InstrProfIterator::Increment() {
98   if (Reader->readNextRecord(Record))
99     *this = InstrProfIterator();
100 }
101 
102 bool 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();
107   return count == 0 ||
108          std::all_of(buffer.begin(), buffer.begin() + count,
109                      [](char c) { return ::isprint(c) || ::isspace(c); });
110 }
111 
112 // Read the profile variant flag from the header: ":FE" means this is a FE
113 // generated profile. ":IR" means this is an IR level profile. Other strings
114 // with a leading ':' will be reported an error format.
115 std::error_code TextInstrProfReader::readHeader() {
116   Symtab.reset(new InstrProfSymtab());
117   bool IsIRInstr = false;
118   if (!Line->startswith(":")) {
119     IsIRLevelProfile = false;
120     return success();
121   }
122   StringRef Str = (Line)->substr(1);
123   if (Str.equals_lower("ir"))
124     IsIRInstr = true;
125   else if (Str.equals_lower("fe"))
126     IsIRInstr = false;
127   else
128     return instrprof_error::bad_header;
129 
130   ++Line;
131   IsIRLevelProfile = IsIRInstr;
132   return success();
133 }
134 
135 std::error_code
136 TextInstrProfReader::readValueProfileData(InstrProfRecord &Record) {
137 
138 #define CHECK_LINE_END(Line)                                                   \
139   if (Line.is_at_end())                                                        \
140     return error(instrprof_error::truncated);
141 #define READ_NUM(Str, Dst)                                                     \
142   if ((Str).getAsInteger(10, (Dst)))                                           \
143     return error(instrprof_error::malformed);
144 #define VP_READ_ADVANCE(Val)                                                   \
145   CHECK_LINE_END(Line);                                                        \
146   uint32_t Val;                                                                \
147   READ_NUM((*Line), (Val));                                                    \
148   Line++;
149 
150   if (Line.is_at_end())
151     return success();
152 
153   uint32_t NumValueKinds;
154   if (Line->getAsInteger(10, NumValueKinds)) {
155     // No value profile data
156     return success();
157   }
158   if (NumValueKinds == 0 || NumValueKinds > IPVK_Last + 1)
159     return error(instrprof_error::malformed);
160   Line++;
161 
162   for (uint32_t VK = 0; VK < NumValueKinds; VK++) {
163     VP_READ_ADVANCE(ValueKind);
164     if (ValueKind > IPVK_Last)
165       return error(instrprof_error::malformed);
166     VP_READ_ADVANCE(NumValueSites);
167     if (!NumValueSites)
168       continue;
169 
170     Record.reserveSites(VK, NumValueSites);
171     for (uint32_t S = 0; S < NumValueSites; S++) {
172       VP_READ_ADVANCE(NumValueData);
173 
174       std::vector<InstrProfValueData> CurrentValues;
175       for (uint32_t V = 0; V < NumValueData; V++) {
176         CHECK_LINE_END(Line);
177         std::pair<StringRef, StringRef> VD = Line->split(':');
178         uint64_t TakenCount, Value;
179         if (VK == IPVK_IndirectCallTarget) {
180           Symtab->addFuncName(VD.first);
181           Value = IndexedInstrProf::ComputeHash(VD.first);
182         } else {
183           READ_NUM(VD.first, Value);
184         }
185         READ_NUM(VD.second, TakenCount);
186         CurrentValues.push_back({Value, TakenCount});
187         Line++;
188       }
189       Record.addValueData(VK, S, CurrentValues.data(), NumValueData, nullptr);
190     }
191   }
192   return success();
193 
194 #undef CHECK_LINE_END
195 #undef READ_NUM
196 #undef VP_READ_ADVANCE
197 }
198 
199 std::error_code TextInstrProfReader::readNextRecord(InstrProfRecord &Record) {
200   // Skip empty lines and comments.
201   while (!Line.is_at_end() && (Line->empty() || Line->startswith("#")))
202     ++Line;
203   // If we hit EOF while looking for a name, we're done.
204   if (Line.is_at_end()) {
205     Symtab->finalizeSymtab();
206     return error(instrprof_error::eof);
207   }
208 
209   // Read the function name.
210   Record.Name = *Line++;
211   Symtab->addFuncName(Record.Name);
212 
213   // Read the function hash.
214   if (Line.is_at_end())
215     return error(instrprof_error::truncated);
216   if ((Line++)->getAsInteger(0, Record.Hash))
217     return error(instrprof_error::malformed);
218 
219   // Read the number of counters.
220   uint64_t NumCounters;
221   if (Line.is_at_end())
222     return error(instrprof_error::truncated);
223   if ((Line++)->getAsInteger(10, NumCounters))
224     return error(instrprof_error::malformed);
225   if (NumCounters == 0)
226     return error(instrprof_error::malformed);
227 
228   // Read each counter and fill our internal storage with the values.
229   Record.Counts.clear();
230   Record.Counts.reserve(NumCounters);
231   for (uint64_t I = 0; I < NumCounters; ++I) {
232     if (Line.is_at_end())
233       return error(instrprof_error::truncated);
234     uint64_t Count;
235     if ((Line++)->getAsInteger(10, Count))
236       return error(instrprof_error::malformed);
237     Record.Counts.push_back(Count);
238   }
239 
240   // Check if value profile data exists and read it if so.
241   if (std::error_code EC = readValueProfileData(Record))
242     return EC;
243 
244   // This is needed to avoid two pass parsing because llvm-profdata
245   // does dumping while reading.
246   Symtab->finalizeSymtab();
247   return success();
248 }
249 
250 template <class IntPtrT>
251 bool RawInstrProfReader<IntPtrT>::hasFormat(const MemoryBuffer &DataBuffer) {
252   if (DataBuffer.getBufferSize() < sizeof(uint64_t))
253     return false;
254   uint64_t Magic =
255     *reinterpret_cast<const uint64_t *>(DataBuffer.getBufferStart());
256   return RawInstrProf::getMagic<IntPtrT>() == Magic ||
257          sys::getSwappedBytes(RawInstrProf::getMagic<IntPtrT>()) == Magic;
258 }
259 
260 template <class IntPtrT>
261 std::error_code RawInstrProfReader<IntPtrT>::readHeader() {
262   if (!hasFormat(*DataBuffer))
263     return error(instrprof_error::bad_magic);
264   if (DataBuffer->getBufferSize() < sizeof(RawInstrProf::Header))
265     return error(instrprof_error::bad_header);
266   auto *Header = reinterpret_cast<const RawInstrProf::Header *>(
267       DataBuffer->getBufferStart());
268   ShouldSwapBytes = Header->Magic != RawInstrProf::getMagic<IntPtrT>();
269   return readHeader(*Header);
270 }
271 
272 template <class IntPtrT>
273 std::error_code
274 RawInstrProfReader<IntPtrT>::readNextHeader(const char *CurrentPos) {
275   const char *End = DataBuffer->getBufferEnd();
276   // Skip zero padding between profiles.
277   while (CurrentPos != End && *CurrentPos == 0)
278     ++CurrentPos;
279   // If there's nothing left, we're done.
280   if (CurrentPos == End)
281     return instrprof_error::eof;
282   // If there isn't enough space for another header, this is probably just
283   // garbage at the end of the file.
284   if (CurrentPos + sizeof(RawInstrProf::Header) > End)
285     return instrprof_error::malformed;
286   // The writer ensures each profile is padded to start at an aligned address.
287   if (reinterpret_cast<size_t>(CurrentPos) % alignOf<uint64_t>())
288     return instrprof_error::malformed;
289   // The magic should have the same byte order as in the previous header.
290   uint64_t Magic = *reinterpret_cast<const uint64_t *>(CurrentPos);
291   if (Magic != swap(RawInstrProf::getMagic<IntPtrT>()))
292     return instrprof_error::bad_magic;
293 
294   // There's another profile to read, so we need to process the header.
295   auto *Header = reinterpret_cast<const RawInstrProf::Header *>(CurrentPos);
296   return readHeader(*Header);
297 }
298 
299 template <class IntPtrT>
300 std::error_code
301 RawInstrProfReader<IntPtrT>::createSymtab(InstrProfSymtab &Symtab) {
302   std::error_code EC = Symtab.create(StringRef(NamesStart, NamesSize));
303   if (EC)
304     return EC;
305   for (const RawInstrProf::ProfileData<IntPtrT> *I = Data; I != DataEnd; ++I) {
306     const IntPtrT FPtr = swap(I->FunctionPointer);
307     if (!FPtr)
308       continue;
309     Symtab.mapAddress(FPtr, I->NameRef);
310   }
311   Symtab.finalizeSymtab();
312   return success();
313 }
314 
315 template <class IntPtrT>
316 std::error_code
317 RawInstrProfReader<IntPtrT>::readHeader(const RawInstrProf::Header &Header) {
318   Version = swap(Header.Version);
319   if (GET_VERSION(Version) != RawInstrProf::Version)
320     return error(instrprof_error::unsupported_version);
321 
322   CountersDelta = swap(Header.CountersDelta);
323   NamesDelta = swap(Header.NamesDelta);
324   auto DataSize = swap(Header.DataSize);
325   auto CountersSize = swap(Header.CountersSize);
326   NamesSize = swap(Header.NamesSize);
327   auto ValueDataSize = swap(Header.ValueDataSize);
328   ValueKindLast = swap(Header.ValueKindLast);
329 
330   auto DataSizeInBytes = DataSize * sizeof(RawInstrProf::ProfileData<IntPtrT>);
331   auto PaddingSize = getNumPaddingBytes(NamesSize);
332 
333   ptrdiff_t DataOffset = sizeof(RawInstrProf::Header);
334   ptrdiff_t CountersOffset = DataOffset + DataSizeInBytes;
335   ptrdiff_t NamesOffset = CountersOffset + sizeof(uint64_t) * CountersSize;
336   ptrdiff_t ValueDataOffset = NamesOffset + NamesSize + PaddingSize;
337   size_t ProfileSize = ValueDataOffset + ValueDataSize;
338 
339   auto *Start = reinterpret_cast<const char *>(&Header);
340   if (Start + ProfileSize > DataBuffer->getBufferEnd())
341     return error(instrprof_error::bad_header);
342 
343   Data = reinterpret_cast<const RawInstrProf::ProfileData<IntPtrT> *>(
344       Start + DataOffset);
345   DataEnd = Data + DataSize;
346   CountersStart = reinterpret_cast<const uint64_t *>(Start + CountersOffset);
347   NamesStart = Start + NamesOffset;
348   ValueDataStart = reinterpret_cast<const uint8_t *>(Start + ValueDataOffset);
349   ProfileEnd = Start + ProfileSize;
350 
351   std::unique_ptr<InstrProfSymtab> NewSymtab = make_unique<InstrProfSymtab>();
352   if (auto EC = createSymtab(*NewSymtab.get()))
353     return EC;
354 
355   Symtab = std::move(NewSymtab);
356   return success();
357 }
358 
359 template <class IntPtrT>
360 std::error_code RawInstrProfReader<IntPtrT>::readName(InstrProfRecord &Record) {
361   Record.Name = getName(Data->NameRef);
362   return success();
363 }
364 
365 template <class IntPtrT>
366 std::error_code RawInstrProfReader<IntPtrT>::readFuncHash(
367     InstrProfRecord &Record) {
368   Record.Hash = swap(Data->FuncHash);
369   return success();
370 }
371 
372 template <class IntPtrT>
373 std::error_code RawInstrProfReader<IntPtrT>::readRawCounts(
374     InstrProfRecord &Record) {
375   uint32_t NumCounters = swap(Data->NumCounters);
376   IntPtrT CounterPtr = Data->CounterPtr;
377   if (NumCounters == 0)
378     return error(instrprof_error::malformed);
379 
380   auto RawCounts = makeArrayRef(getCounter(CounterPtr), NumCounters);
381   auto *NamesStartAsCounter = reinterpret_cast<const uint64_t *>(NamesStart);
382 
383   // Check bounds.
384   if (RawCounts.data() < CountersStart ||
385       RawCounts.data() + RawCounts.size() > NamesStartAsCounter)
386     return error(instrprof_error::malformed);
387 
388   if (ShouldSwapBytes) {
389     Record.Counts.clear();
390     Record.Counts.reserve(RawCounts.size());
391     for (uint64_t Count : RawCounts)
392       Record.Counts.push_back(swap(Count));
393   } else
394     Record.Counts = RawCounts;
395 
396   return success();
397 }
398 
399 template <class IntPtrT>
400 std::error_code
401 RawInstrProfReader<IntPtrT>::readValueProfilingData(InstrProfRecord &Record) {
402 
403   Record.clearValueData();
404   CurValueDataSize = 0;
405   // Need to match the logic in value profile dumper code in compiler-rt:
406   uint32_t NumValueKinds = 0;
407   for (uint32_t I = 0; I < IPVK_Last + 1; I++)
408     NumValueKinds += (Data->NumValueSites[I] != 0);
409 
410   if (!NumValueKinds)
411     return success();
412 
413   ErrorOr<std::unique_ptr<ValueProfData>> VDataPtrOrErr =
414       ValueProfData::getValueProfData(ValueDataStart,
415                                       (const unsigned char *)ProfileEnd,
416                                       getDataEndianness());
417 
418   if (VDataPtrOrErr.getError())
419     return VDataPtrOrErr.getError();
420 
421   // Note that besides deserialization, this also performs the conversion for
422   // indirect call targets.  The function pointers from the raw profile are
423   // remapped into function name hashes.
424   VDataPtrOrErr.get()->deserializeTo(Record, &Symtab->getAddrHashMap());
425   CurValueDataSize = VDataPtrOrErr.get()->getSize();
426   return success();
427 }
428 
429 template <class IntPtrT>
430 std::error_code
431 RawInstrProfReader<IntPtrT>::readNextRecord(InstrProfRecord &Record) {
432   if (atEnd())
433     if (std::error_code EC = readNextHeader(ProfileEnd))
434       return EC;
435 
436   // Read name ad set it in Record.
437   if (std::error_code EC = readName(Record))
438     return EC;
439 
440   // Read FuncHash and set it in Record.
441   if (std::error_code EC = readFuncHash(Record))
442     return EC;
443 
444   // Read raw counts and set Record.
445   if (std::error_code EC = readRawCounts(Record))
446     return EC;
447 
448   // Read value data and set Record.
449   if (std::error_code EC = readValueProfilingData(Record))
450     return EC;
451 
452   // Iterate.
453   advanceData();
454   return success();
455 }
456 
457 namespace llvm {
458 template class RawInstrProfReader<uint32_t>;
459 template class RawInstrProfReader<uint64_t>;
460 }
461 
462 InstrProfLookupTrait::hash_value_type
463 InstrProfLookupTrait::ComputeHash(StringRef K) {
464   return IndexedInstrProf::ComputeHash(HashType, K);
465 }
466 
467 typedef InstrProfLookupTrait::data_type data_type;
468 typedef InstrProfLookupTrait::offset_type offset_type;
469 
470 bool InstrProfLookupTrait::readValueProfilingData(
471     const unsigned char *&D, const unsigned char *const End) {
472   ErrorOr<std::unique_ptr<ValueProfData>> VDataPtrOrErr =
473       ValueProfData::getValueProfData(D, End, ValueProfDataEndianness);
474 
475   if (VDataPtrOrErr.getError())
476     return false;
477 
478   VDataPtrOrErr.get()->deserializeTo(DataBuffer.back(), nullptr);
479   D += VDataPtrOrErr.get()->TotalSize;
480 
481   return true;
482 }
483 
484 data_type InstrProfLookupTrait::ReadData(StringRef K, const unsigned char *D,
485                                          offset_type N) {
486   // Check if the data is corrupt. If so, don't try to read it.
487   if (N % sizeof(uint64_t))
488     return data_type();
489 
490   DataBuffer.clear();
491   std::vector<uint64_t> CounterBuffer;
492 
493   using namespace support;
494   const unsigned char *End = D + N;
495   while (D < End) {
496     // Read hash.
497     if (D + sizeof(uint64_t) >= End)
498       return data_type();
499     uint64_t Hash = endian::readNext<uint64_t, little, unaligned>(D);
500 
501     // Initialize number of counters for GET_VERSION(FormatVersion) == 1.
502     uint64_t CountsSize = N / sizeof(uint64_t) - 1;
503     // If format version is different then read the number of counters.
504     if (GET_VERSION(FormatVersion) != IndexedInstrProf::ProfVersion::Version1) {
505       if (D + sizeof(uint64_t) > End)
506         return data_type();
507       CountsSize = endian::readNext<uint64_t, little, unaligned>(D);
508     }
509     // Read counter values.
510     if (D + CountsSize * sizeof(uint64_t) > End)
511       return data_type();
512 
513     CounterBuffer.clear();
514     CounterBuffer.reserve(CountsSize);
515     for (uint64_t J = 0; J < CountsSize; ++J)
516       CounterBuffer.push_back(endian::readNext<uint64_t, little, unaligned>(D));
517 
518     DataBuffer.emplace_back(K, Hash, std::move(CounterBuffer));
519 
520     // Read value profiling data.
521     if (GET_VERSION(FormatVersion) > IndexedInstrProf::ProfVersion::Version2 &&
522         !readValueProfilingData(D, End)) {
523       DataBuffer.clear();
524       return data_type();
525     }
526   }
527   return DataBuffer;
528 }
529 
530 template <typename HashTableImpl>
531 std::error_code InstrProfReaderIndex<HashTableImpl>::getRecords(
532     StringRef FuncName, ArrayRef<InstrProfRecord> &Data) {
533   auto Iter = HashTable->find(FuncName);
534   if (Iter == HashTable->end())
535     return instrprof_error::unknown_function;
536 
537   Data = (*Iter);
538   if (Data.empty())
539     return instrprof_error::malformed;
540 
541   return instrprof_error::success;
542 }
543 
544 template <typename HashTableImpl>
545 std::error_code InstrProfReaderIndex<HashTableImpl>::getRecords(
546     ArrayRef<InstrProfRecord> &Data) {
547   if (atEnd())
548     return instrprof_error::eof;
549 
550   Data = *RecordIterator;
551 
552   if (Data.empty())
553     return instrprof_error::malformed;
554 
555   return instrprof_error::success;
556 }
557 
558 template <typename HashTableImpl>
559 InstrProfReaderIndex<HashTableImpl>::InstrProfReaderIndex(
560     const unsigned char *Buckets, const unsigned char *const Payload,
561     const unsigned char *const Base, IndexedInstrProf::HashT HashType,
562     uint64_t Version) {
563   FormatVersion = Version;
564   HashTable.reset(HashTableImpl::Create(
565       Buckets, Payload, Base,
566       typename HashTableImpl::InfoType(HashType, Version)));
567   RecordIterator = HashTable->data_begin();
568 }
569 
570 bool IndexedInstrProfReader::hasFormat(const MemoryBuffer &DataBuffer) {
571   if (DataBuffer.getBufferSize() < 8)
572     return false;
573   using namespace support;
574   uint64_t Magic =
575       endian::read<uint64_t, little, aligned>(DataBuffer.getBufferStart());
576   // Verify that it's magical.
577   return Magic == IndexedInstrProf::Magic;
578 }
579 
580 const unsigned char *
581 IndexedInstrProfReader::readSummary(IndexedInstrProf::ProfVersion Version,
582                                     const unsigned char *Cur) {
583   using namespace support;
584   if (Version >= IndexedInstrProf::Version4) {
585     const IndexedInstrProf::Summary *SummaryInLE =
586         reinterpret_cast<const IndexedInstrProf::Summary *>(Cur);
587     uint64_t NFields =
588         endian::byte_swap<uint64_t, little>(SummaryInLE->NumSummaryFields);
589     uint64_t NEntries =
590         endian::byte_swap<uint64_t, little>(SummaryInLE->NumCutoffEntries);
591     uint32_t SummarySize =
592         IndexedInstrProf::Summary::getSize(NFields, NEntries);
593     std::unique_ptr<IndexedInstrProf::Summary> SummaryData =
594         IndexedInstrProf::allocSummary(SummarySize);
595 
596     const uint64_t *Src = reinterpret_cast<const uint64_t *>(SummaryInLE);
597     uint64_t *Dst = reinterpret_cast<uint64_t *>(SummaryData.get());
598     for (unsigned I = 0; I < SummarySize / sizeof(uint64_t); I++)
599       Dst[I] = endian::byte_swap<uint64_t, little>(Src[I]);
600 
601     // initialize InstrProfSummary using the SummaryData from disk.
602     this->Summary = llvm::make_unique<InstrProfSummary>(*(SummaryData.get()));
603     return Cur + SummarySize;
604   } else {
605     // For older version of profile data, we need to compute on the fly:
606     using namespace IndexedInstrProf;
607     this->Summary =
608         llvm::make_unique<InstrProfSummary>(ProfileSummary::DefaultCutoffs);
609     this->Summary->computeDetailedSummary();
610     return Cur;
611   }
612 }
613 
614 std::error_code IndexedInstrProfReader::readHeader() {
615   const unsigned char *Start =
616       (const unsigned char *)DataBuffer->getBufferStart();
617   const unsigned char *Cur = Start;
618   if ((const unsigned char *)DataBuffer->getBufferEnd() - Cur < 24)
619     return error(instrprof_error::truncated);
620 
621   using namespace support;
622 
623   auto *Header = reinterpret_cast<const IndexedInstrProf::Header *>(Cur);
624   Cur += sizeof(IndexedInstrProf::Header);
625 
626   // Check the magic number.
627   uint64_t Magic = endian::byte_swap<uint64_t, little>(Header->Magic);
628   if (Magic != IndexedInstrProf::Magic)
629     return error(instrprof_error::bad_magic);
630 
631   // Read the version.
632   uint64_t FormatVersion = endian::byte_swap<uint64_t, little>(Header->Version);
633   if (GET_VERSION(FormatVersion) >
634       IndexedInstrProf::ProfVersion::CurrentVersion)
635     return error(instrprof_error::unsupported_version);
636 
637   Cur = readSummary((IndexedInstrProf::ProfVersion)FormatVersion, Cur);
638 
639   // Read the hash type and start offset.
640   IndexedInstrProf::HashT HashType = static_cast<IndexedInstrProf::HashT>(
641       endian::byte_swap<uint64_t, little>(Header->HashType));
642   if (HashType > IndexedInstrProf::HashT::Last)
643     return error(instrprof_error::unsupported_hash_type);
644 
645   uint64_t HashOffset = endian::byte_swap<uint64_t, little>(Header->HashOffset);
646 
647   // The rest of the file is an on disk hash table.
648   InstrProfReaderIndexBase *IndexPtr = nullptr;
649   IndexPtr = new InstrProfReaderIndex<OnDiskHashTableImplV3>(
650       Start + HashOffset, Cur, Start, HashType, FormatVersion);
651   Index.reset(IndexPtr);
652   return success();
653 }
654 
655 InstrProfSymtab &IndexedInstrProfReader::getSymtab() {
656   if (Symtab.get())
657     return *Symtab.get();
658 
659   std::unique_ptr<InstrProfSymtab> NewSymtab = make_unique<InstrProfSymtab>();
660   Index->populateSymtab(*NewSymtab.get());
661 
662   Symtab = std::move(NewSymtab);
663   return *Symtab.get();
664 }
665 
666 ErrorOr<InstrProfRecord>
667 IndexedInstrProfReader::getInstrProfRecord(StringRef FuncName,
668                                            uint64_t FuncHash) {
669   ArrayRef<InstrProfRecord> Data;
670   std::error_code EC = Index->getRecords(FuncName, Data);
671   if (EC != instrprof_error::success)
672     return EC;
673   // Found it. Look for counters with the right hash.
674   for (unsigned I = 0, E = Data.size(); I < E; ++I) {
675     // Check for a match and fill the vector if there is one.
676     if (Data[I].Hash == FuncHash) {
677       return std::move(Data[I]);
678     }
679   }
680   return error(instrprof_error::hash_mismatch);
681 }
682 
683 std::error_code
684 IndexedInstrProfReader::getFunctionCounts(StringRef FuncName, uint64_t FuncHash,
685                                           std::vector<uint64_t> &Counts) {
686   ErrorOr<InstrProfRecord> Record = getInstrProfRecord(FuncName, FuncHash);
687   if (std::error_code EC = Record.getError())
688     return EC;
689 
690   Counts = Record.get().Counts;
691   return success();
692 }
693 
694 std::error_code IndexedInstrProfReader::readNextRecord(
695     InstrProfRecord &Record) {
696   static unsigned RecordIndex = 0;
697 
698   ArrayRef<InstrProfRecord> Data;
699 
700   std::error_code EC = Index->getRecords(Data);
701   if (EC != instrprof_error::success)
702     return error(EC);
703 
704   Record = Data[RecordIndex++];
705   if (RecordIndex >= Data.size()) {
706     Index->advanceToNextKey();
707     RecordIndex = 0;
708   }
709   return success();
710 }
711