xref: /llvm-project-15.0.7/llvm/lib/ProfileData/InstrProfReader.cpp (revision 09a67f45)

//=-- InstrProfReader.cpp - Instrumented profiling reader -------------------=//
//
//                     The LLVM Compiler Infrastructure
//
// This file is distributed under the University of Illinois Open Source
// License. See LICENSE.TXT for details.
//
//===----------------------------------------------------------------------===//
//
// This file contains support for reading profiling data for clang's
// instrumentation based PGO and coverage.
//
//===----------------------------------------------------------------------===//

#include "llvm/ProfileData/InstrProfReader.h"
#include "llvm/ProfileData/InstrProf.h"

#include <cassert>

using namespace llvm;

error_code InstrProfReader::create(std::string Path,
                                   std::unique_ptr<InstrProfReader> &Result) {
  std::unique_ptr<MemoryBuffer> Buffer;
  if (error_code EC = MemoryBuffer::getFileOrSTDIN(Path, Buffer))
    return EC;

  // Sanity check the file.
  if (Buffer->getBufferSize() > std::numeric_limits<unsigned>::max())
    return instrprof_error::too_large;

  // Create the reader.
  if (RawInstrProfReader::hasFormat(*Buffer))
    Result.reset(new RawInstrProfReader(Buffer));
  else
    Result.reset(new TextInstrProfReader(Buffer));

  // Read the header and return the result.
  return Result->readHeader();
}

void InstrProfIterator::Increment() {
  if (Reader->readNextRecord(Record))
    *this = InstrProfIterator();
}

error_code TextInstrProfReader::readNextRecord(InstrProfRecord &Record) {
  // Skip empty lines.
  while (!Line.is_at_end() && Line->empty())
    ++Line;
  // If we hit EOF while looking for a name, we're done.
  if (Line.is_at_end())
    return error(instrprof_error::eof);

  // Read the function name.
  Record.Name = *Line++;

  // Read the function hash.
  if (Line.is_at_end())
    return error(instrprof_error::truncated);
  if ((Line++)->getAsInteger(10, Record.Hash))
    return error(instrprof_error::malformed);

  // Read the number of counters.
  uint64_t NumCounters;
  if (Line.is_at_end())
    return error(instrprof_error::truncated);
  if ((Line++)->getAsInteger(10, NumCounters))
    return error(instrprof_error::malformed);

  // Read each counter and fill our internal storage with the values.
  Counts.clear();
  Counts.reserve(NumCounters);
  for (uint64_t I = 0; I < NumCounters; ++I) {
    if (Line.is_at_end())
      return error(instrprof_error::truncated);
    uint64_t Count;
    if ((Line++)->getAsInteger(10, Count))
      return error(instrprof_error::malformed);
    Counts.push_back(Count);
  }
  // Give the record a reference to our internal counter storage.
  Record.Counts = Counts;

  return success();
}

RawInstrProfReader::RawInstrProfReader(std::unique_ptr<MemoryBuffer> &DataBuffer)
    : DataBuffer(DataBuffer.release()) { }

static uint64_t getRawMagic() {
  return
    uint64_t('l') << 56 |
    uint64_t('p') << 48 |
    uint64_t('r') << 40 |
    uint64_t('o') << 32 |
    uint64_t('f') << 24 |
    uint64_t('r') << 16 |
    uint64_t('a') <<  8 |
    uint64_t('w');
}

bool RawInstrProfReader::hasFormat(const MemoryBuffer &DataBuffer) {
  if (DataBuffer.getBufferSize() < sizeof(getRawMagic()))
    return false;
  const RawHeader *Header = (const RawHeader *)DataBuffer.getBufferStart();
  return getRawMagic() == Header->Magic ||
    sys::SwapByteOrder(getRawMagic()) == Header->Magic;
}

error_code RawInstrProfReader::readHeader() {
  if (!hasFormat(*DataBuffer))
    return error(instrprof_error::bad_magic);
  if (DataBuffer->getBufferSize() < sizeof(RawHeader))
    return error(instrprof_error::bad_header);
  const RawHeader *Header = (const RawHeader *)DataBuffer->getBufferStart();
  ShouldSwapBytes = Header->Magic != getRawMagic();
  return readHeader(*Header);
}

static uint64_t getRawVersion() {
  return 1;
}

error_code RawInstrProfReader::readHeader(const RawHeader &Header) {
  if (swap(Header.Version) != getRawVersion())
    return error(instrprof_error::unsupported_version);

  CountersDelta = swap(Header.CountersDelta);
  NamesDelta = swap(Header.NamesDelta);
  auto DataSize = swap(Header.DataSize);
  auto CountersSize = swap(Header.CountersSize);
  auto NamesSize = swap(Header.NamesSize);

  ptrdiff_t DataOffset = sizeof(RawHeader);
  ptrdiff_t CountersOffset = DataOffset + sizeof(ProfileData) * DataSize;
  ptrdiff_t NamesOffset = CountersOffset + sizeof(uint64_t) * CountersSize;
  size_t FileSize = NamesOffset + sizeof(char) * NamesSize;

  if (FileSize != DataBuffer->getBufferSize())
    return error(instrprof_error::bad_header);

  Data = (ProfileData *)(DataBuffer->getBufferStart() + DataOffset);
  DataEnd = Data + DataSize;
  CountersStart = (uint64_t *)(DataBuffer->getBufferStart() + CountersOffset);
  NamesStart = DataBuffer->getBufferStart() + NamesOffset;

  return success();
}

error_code RawInstrProfReader::readNextRecord(InstrProfRecord &Record) {
  if (Data == DataEnd)
    return error(instrprof_error::eof);

  // Get the raw data.
  StringRef RawName(getName(Data->NamePtr), swap(Data->NameSize));
  auto RawCounts = makeArrayRef(getCounter(Data->CounterPtr),
                                swap(Data->NumCounters));

  // Check bounds.
  if (RawName.data() < NamesStart ||
      RawName.data() + RawName.size() > DataBuffer->getBufferEnd() ||
      RawCounts.data() < CountersStart ||
      RawCounts.data() + RawCounts.size() > (uint64_t *)NamesStart)
    return error(instrprof_error::malformed);

  // Store the data in Record, byte-swapping as necessary.
  Record.Hash = swap(Data->FuncHash);
  Record.Name = RawName;
  if (ShouldSwapBytes) {
    Counts.clear();
    Counts.reserve(RawCounts.size());
    for (uint64_t Count : RawCounts)
      Counts.push_back(swap(Count));
    Record.Counts = Counts;
  } else
    Record.Counts = RawCounts;

  // Iterate.
  ++Data;
  return success();
}