lib/ProfileData/CoverageMappingReader.cpp

   1 //=-- CoverageMappingReader.cpp - Code coverage mapping reader ----*- 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 coverage mapping data for
  11 // instrumentation based coverage.
  12 //
  13 //===----------------------------------------------------------------------===//
  14
  15 #include "llvm/ProfileData/CoverageMappingReader.h"
  16 #include "llvm/ADT/DenseSet.h"
  17 #include "llvm/Object/MachOUniversal.h"
  18 #include "llvm/Object/ObjectFile.h"
  19 #include "llvm/Support/Debug.h"
  20 #include "llvm/Support/Endian.h"
  21 #include "llvm/Support/LEB128.h"
  22 #include "llvm/Support/MathExtras.h"
  23 #include "llvm/Support/raw_ostream.h"
  24
  25 using namespace llvm;
  26 using namespace coverage;
  27 using namespace object;
  28
  29 #define DEBUG_TYPE "coverage-mapping"
  30
  31 void CoverageMappingIterator::increment() {
  32   // Check if all the records were read or if an error occurred while reading
  33   // the next record.
  34   if (Reader->readNextRecord(Record))
  35     *this = CoverageMappingIterator();
  36 }
  37
  38 std::error_code RawCoverageReader::readULEB128(uint64_t &Result) {
  39   if (Data.size() < 1)
  40     return coveragemap_error::truncated;
  41   unsigned N = 0;
  42   Result = decodeULEB128(reinterpret_cast<const uint8_t *>(Data.data()), &N);
  43   if (N > Data.size())
  44     return coveragemap_error::malformed;
  45   Data = Data.substr(N);
  46   return std::error_code();
  47 }
  48
  49 std::error_code RawCoverageReader::readIntMax(uint64_t &Result,
  50                                               uint64_t MaxPlus1) {
  51   if (auto Err = readULEB128(Result))
  52     return Err;
  53   if (Result >= MaxPlus1)
  54     return coveragemap_error::malformed;
  55   return std::error_code();
  56 }
  57
  58 std::error_code RawCoverageReader::readSize(uint64_t &Result) {
  59   if (auto Err = readULEB128(Result))
  60     return Err;
  61   // Sanity check the number.
  62   if (Result > Data.size())
  63     return coveragemap_error::malformed;
  64   return std::error_code();
  65 }
  66
  67 std::error_code RawCoverageReader::readString(StringRef &Result) {
  68   uint64_t Length;
  69   if (auto Err = readSize(Length))
  70     return Err;
  71   Result = Data.substr(0, Length);
  72   Data = Data.substr(Length);
  73   return std::error_code();
  74 }
  75
  76 std::error_code RawCoverageFilenamesReader::read() {
  77   uint64_t NumFilenames;
  78   if (auto Err = readSize(NumFilenames))
  79     return Err;
  80   for (size_t I = 0; I < NumFilenames; ++I) {
  81     StringRef Filename;
  82     if (auto Err = readString(Filename))
  83       return Err;
  84     Filenames.push_back(Filename);
  85   }
  86   return std::error_code();
  87 }
  88
  89 std::error_code RawCoverageMappingReader::decodeCounter(unsigned Value,
  90                                                         Counter &C) {
  91   auto Tag = Value & Counter::EncodingTagMask;
  92   switch (Tag) {
  93   case Counter::Zero:
  94     C = Counter::getZero();
  95     return std::error_code();
  96   case Counter::CounterValueReference:
  97     C = Counter::getCounter(Value >> Counter::EncodingTagBits);
  98     return std::error_code();
  99   default:
 100     break;
 101   }
 102   Tag -= Counter::Expression;
 103   switch (Tag) {
 104   case CounterExpression::Subtract:
 105   case CounterExpression::Add: {
 106     auto ID = Value >> Counter::EncodingTagBits;
 107     if (ID >= Expressions.size())
 108       return coveragemap_error::malformed;
 109     Expressions[ID].Kind = CounterExpression::ExprKind(Tag);
 110     C = Counter::getExpression(ID);
 111     break;
 112   }
 113   default:
 114     return coveragemap_error::malformed;
 115   }
 116   return std::error_code();
 117 }
 118
 119 std::error_code RawCoverageMappingReader::readCounter(Counter &C) {
 120   uint64_t EncodedCounter;
 121   if (auto Err =
 122           readIntMax(EncodedCounter, std::numeric_limits<unsigned>::max()))
 123     return Err;
 124   if (auto Err = decodeCounter(EncodedCounter, C))
 125     return Err;
 126   return std::error_code();
 127 }
 128
 129 static const unsigned EncodingExpansionRegionBit = 1
 130                                                    << Counter::EncodingTagBits;
 131
 132 /// \brief Read the sub-array of regions for the given inferred file id.
 133 /// \param NumFileIDs the number of file ids that are defined for this
 134 /// function.
 135 std::error_code RawCoverageMappingReader::readMappingRegionsSubArray(
 136     std::vector<CounterMappingRegion> &MappingRegions, unsigned InferredFileID,
 137     size_t NumFileIDs) {
 138   uint64_t NumRegions;
 139   if (auto Err = readSize(NumRegions))
 140     return Err;
 141   unsigned LineStart = 0;
 142   for (size_t I = 0; I < NumRegions; ++I) {
 143     Counter C;
 144     CounterMappingRegion::RegionKind Kind = CounterMappingRegion::CodeRegion;
 145
 146     // Read the combined counter + region kind.
 147     uint64_t EncodedCounterAndRegion;
 148     if (auto Err = readIntMax(EncodedCounterAndRegion,
 149                               std::numeric_limits<unsigned>::max()))
 150       return Err;
 151     unsigned Tag = EncodedCounterAndRegion & Counter::EncodingTagMask;
 152     uint64_t ExpandedFileID = 0;
 153     if (Tag != Counter::Zero) {
 154       if (auto Err = decodeCounter(EncodedCounterAndRegion, C))
 155         return Err;
 156     } else {
 157       // Is it an expansion region?
 158       if (EncodedCounterAndRegion & EncodingExpansionRegionBit) {
 159         Kind = CounterMappingRegion::ExpansionRegion;
 160         ExpandedFileID = EncodedCounterAndRegion >>
 161                          Counter::EncodingCounterTagAndExpansionRegionTagBits;
 162         if (ExpandedFileID >= NumFileIDs)
 163           return coveragemap_error::malformed;
 164       } else {
 165         switch (EncodedCounterAndRegion >>
 166                 Counter::EncodingCounterTagAndExpansionRegionTagBits) {
 167         case CounterMappingRegion::CodeRegion:
 168           // Don't do anything when we have a code region with a zero counter.
 169           break;
 170         case CounterMappingRegion::SkippedRegion:
 171           Kind = CounterMappingRegion::SkippedRegion;
 172           break;
 173         default:
 174           return coveragemap_error::malformed;
 175         }
 176       }
 177     }
 178
 179     // Read the source range.
 180     uint64_t LineStartDelta, ColumnStart, NumLines, ColumnEnd;
 181     if (auto Err =
 182             readIntMax(LineStartDelta, std::numeric_limits<unsigned>::max()))
 183       return Err;
 184     if (auto Err = readULEB128(ColumnStart))
 185       return Err;
 186     if (ColumnStart > std::numeric_limits<unsigned>::max())
 187       return coveragemap_error::malformed;
 188     if (auto Err = readIntMax(NumLines, std::numeric_limits<unsigned>::max()))
 189       return Err;
 190     if (auto Err = readIntMax(ColumnEnd, std::numeric_limits<unsigned>::max()))
 191       return Err;
 192     LineStart += LineStartDelta;
 193     // Adjust the column locations for the empty regions that are supposed to
 194     // cover whole lines. Those regions should be encoded with the
 195     // column range (1 -> std::numeric_limits<unsigned>::max()), but because
 196     // the encoded std::numeric_limits<unsigned>::max() is several bytes long,
 197     // we set the column range to (0 -> 0) to ensure that the column start and
 198     // column end take up one byte each.
 199     // The std::numeric_limits<unsigned>::max() is used to represent a column
 200     // position at the end of the line without knowing the length of that line.
 201     if (ColumnStart == 0 && ColumnEnd == 0) {
 202       ColumnStart = 1;
 203       ColumnEnd = std::numeric_limits<unsigned>::max();
 204     }
 205
 206     DEBUG({
 207       dbgs() << "Counter in file " << InferredFileID << " " << LineStart << ":"
 208              << ColumnStart << " -> " << (LineStart + NumLines) << ":"
 209              << ColumnEnd << ", ";
 210       if (Kind == CounterMappingRegion::ExpansionRegion)
 211         dbgs() << "Expands to file " << ExpandedFileID;
 212       else
 213         CounterMappingContext(Expressions).dump(C, dbgs());
 214       dbgs() << "\n";
 215     });
 216
 217     MappingRegions.push_back(CounterMappingRegion(
 218         C, InferredFileID, ExpandedFileID, LineStart, ColumnStart,
 219         LineStart + NumLines, ColumnEnd, Kind));
 220   }
 221   return std::error_code();
 222 }
 223
 224 std::error_code RawCoverageMappingReader::read() {
 225
 226   // Read the virtual file mapping.
 227   llvm::SmallVector<unsigned, 8> VirtualFileMapping;
 228   uint64_t NumFileMappings;
 229   if (auto Err = readSize(NumFileMappings))
 230     return Err;
 231   for (size_t I = 0; I < NumFileMappings; ++I) {
 232     uint64_t FilenameIndex;
 233     if (auto Err = readIntMax(FilenameIndex, TranslationUnitFilenames.size()))
 234       return Err;
 235     VirtualFileMapping.push_back(FilenameIndex);
 236   }
 237
 238   // Construct the files using unique filenames and virtual file mapping.
 239   for (auto I : VirtualFileMapping) {
 240     Filenames.push_back(TranslationUnitFilenames[I]);
 241   }
 242
 243   // Read the expressions.
 244   uint64_t NumExpressions;
 245   if (auto Err = readSize(NumExpressions))
 246     return Err;
 247   // Create an array of dummy expressions that get the proper counters
 248   // when the expressions are read, and the proper kinds when the counters
 249   // are decoded.
 250   Expressions.resize(
 251       NumExpressions,
 252       CounterExpression(CounterExpression::Subtract, Counter(), Counter()));
 253   for (size_t I = 0; I < NumExpressions; ++I) {
 254     if (auto Err = readCounter(Expressions[I].LHS))
 255       return Err;
 256     if (auto Err = readCounter(Expressions[I].RHS))
 257       return Err;
 258   }
 259
 260   // Read the mapping regions sub-arrays.
 261   for (unsigned InferredFileID = 0, S = VirtualFileMapping.size();
 262        InferredFileID < S; ++InferredFileID) {
 263     if (auto Err = readMappingRegionsSubArray(MappingRegions, InferredFileID,
 264                                               VirtualFileMapping.size()))
 265       return Err;
 266   }
 267
 268   // Set the counters for the expansion regions.
 269   // i.e. Counter of expansion region = counter of the first region
 270   // from the expanded file.
 271   // Perform multiple passes to correctly propagate the counters through
 272   // all the nested expansion regions.
 273   SmallVector<CounterMappingRegion *, 8> FileIDExpansionRegionMapping;
 274   FileIDExpansionRegionMapping.resize(VirtualFileMapping.size(), nullptr);
 275   for (unsigned Pass = 1, S = VirtualFileMapping.size(); Pass < S; ++Pass) {
 276     for (auto &R : MappingRegions) {
 277       if (R.Kind != CounterMappingRegion::ExpansionRegion)
 278         continue;
 279       assert(!FileIDExpansionRegionMapping[R.ExpandedFileID]);
 280       FileIDExpansionRegionMapping[R.ExpandedFileID] = &R;
 281     }
 282     for (auto &R : MappingRegions) {
 283       if (FileIDExpansionRegionMapping[R.FileID]) {
 284         FileIDExpansionRegionMapping[R.FileID]->Count = R.Count;
 285         FileIDExpansionRegionMapping[R.FileID] = nullptr;
 286       }
 287     }
 288   }
 289
 290   return std::error_code();
 291 }
 292
 293 std::error_code InstrProfSymtab::create(SectionRef &Section) {
 294   if (auto Err = Section.getContents(Data))
 295     return Err;
 296   Address = Section.getAddress();
 297   return std::error_code();
 298 }
 299
 300 StringRef InstrProfSymtab::getFuncName(uint64_t Pointer, size_t Size) {
 301   if (Pointer < Address)
 302     return StringRef();
 303   auto Offset = Pointer - Address;
 304   if (Offset + Size > Data.size())
 305     return StringRef();
 306   return Data.substr(Pointer - Address, Size);
 307 }
 308
 309 template <typename T, support::endianness Endian>
 310 static std::error_code readCoverageMappingData(
 311     InstrProfSymtab &ProfileNames, StringRef Data,
 312     std::vector<BinaryCoverageReader::ProfileMappingRecord> &Records,
 313     std::vector<StringRef> &Filenames) {
 314   using namespace support;
 315   llvm::DenseSet<T> UniqueFunctionMappingData;
 316
 317   // Read the records in the coverage data section.
 318   for (const char *Buf = Data.data(), *End = Buf + Data.size(); Buf < End;) {
 319     if (Buf + sizeof(CovMapHeader) > End)
 320       return coveragemap_error::malformed;
 321     auto CovHeader = reinterpret_cast<const coverage::CovMapHeader *>(Buf);
 322     uint32_t NRecords =
 323         endian::byte_swap<uint32_t, Endian>(CovHeader->NRecords);
 324     uint32_t FilenamesSize =
 325         endian::byte_swap<uint32_t, Endian>(CovHeader->FilenamesSize);
 326     uint32_t CoverageSize =
 327         endian::byte_swap<uint32_t, Endian>(CovHeader->CoverageSize);
 328     uint32_t Version = endian::byte_swap<uint32_t, Endian>(CovHeader->Version);
 329     Buf = reinterpret_cast<const char *>(++CovHeader);
 330
 331     if (Version > coverage::CoverageMappingCurrentVersion)
 332       return coveragemap_error::unsupported_version;
 333
 334     // Skip past the function records, saving the start and end for later.
 335     const char *FunBuf = Buf;
 336     Buf += NRecords * sizeof(coverage::CovMapFunctionRecord<T>);
 337     const char *FunEnd = Buf;
 338
 339     // Get the filenames.
 340     if (Buf + FilenamesSize > End)
 341       return coveragemap_error::malformed;
 342     size_t FilenamesBegin = Filenames.size();
 343     RawCoverageFilenamesReader Reader(StringRef(Buf, FilenamesSize), Filenames);
 344     if (auto Err = Reader.read())
 345       return Err;
 346     Buf += FilenamesSize;
 347
 348     // We'll read the coverage mapping records in the loop below.
 349     const char *CovBuf = Buf;
 350     Buf += CoverageSize;
 351     const char *CovEnd = Buf;
 352
 353     if (Buf > End)
 354       return coveragemap_error::malformed;
 355     // Each coverage map has an alignment of 8, so we need to adjust alignment
 356     // before reading the next map.
 357     Buf += alignmentAdjustment(Buf, 8);
 358
 359     auto CFR =
 360         reinterpret_cast<const coverage::CovMapFunctionRecord<T> *>(FunBuf);
 361     while ((const char *)CFR < FunEnd) {
 362       // Read the function information
 363       T NamePtr = endian::byte_swap<T, Endian>(CFR->NamePtr);
 364       uint32_t NameSize = endian::byte_swap<uint32_t, Endian>(CFR->NameSize);
 365       uint32_t DataSize = endian::byte_swap<uint32_t, Endian>(CFR->DataSize);
 366       uint64_t FuncHash = endian::byte_swap<uint64_t, Endian>(CFR->FuncHash);
 367       CFR++;
 368
 369       // Now use that to read the coverage data.
 370       if (CovBuf + DataSize > CovEnd)
 371         return coveragemap_error::malformed;
 372       auto Mapping = StringRef(CovBuf, DataSize);
 373       CovBuf += DataSize;
 374
 375       // Ignore this record if we already have a record that points to the same
 376       // function name. This is useful to ignore the redundant records for the
 377       // functions with ODR linkage.
 378       if (!UniqueFunctionMappingData.insert(NamePtr).second)
 379         continue;
 380
 381       // Finally, grab the name and create a record.
 382       StringRef FuncName = ProfileNames.getFuncName(NamePtr, NameSize);
 383       if (NameSize && FuncName.empty())
 384         return coveragemap_error::malformed;
 385       Records.push_back(BinaryCoverageReader::ProfileMappingRecord(
 386           CoverageMappingVersion(Version), FuncName, FuncHash, Mapping,
 387           FilenamesBegin, Filenames.size() - FilenamesBegin));
 388     }
 389   }
 390
 391   return std::error_code();
 392 }
 393
 394 static const char *TestingFormatMagic = "llvmcovmtestdata";
 395
 396 static std::error_code loadTestingFormat(StringRef Data,
 397                                          InstrProfSymtab &ProfileNames,
 398                                          StringRef &CoverageMapping,
 399                                          uint8_t &BytesInAddress,
 400                                          support::endianness &Endian) {
 401   BytesInAddress = 8;
 402   Endian = support::endianness::little;
 403
 404   Data = Data.substr(StringRef(TestingFormatMagic).size());
 405   if (Data.size() < 1)
 406     return coveragemap_error::truncated;
 407   unsigned N = 0;
 408   auto ProfileNamesSize =
 409       decodeULEB128(reinterpret_cast<const uint8_t *>(Data.data()), &N);
 410   if (N > Data.size())
 411     return coveragemap_error::malformed;
 412   Data = Data.substr(N);
 413   if (Data.size() < 1)
 414     return coveragemap_error::truncated;
 415   N = 0;
 416   uint64_t Address =
 417       decodeULEB128(reinterpret_cast<const uint8_t *>(Data.data()), &N);
 418   if (N > Data.size())
 419     return coveragemap_error::malformed;
 420   Data = Data.substr(N);
 421   if (Data.size() < ProfileNamesSize)
 422     return coveragemap_error::malformed;
 423   ProfileNames.create(Data.substr(0, ProfileNamesSize), Address);
 424   CoverageMapping = Data.substr(ProfileNamesSize);
 425   return std::error_code();
 426 }
 427
 428 static ErrorOr<SectionRef> lookupSection(ObjectFile &OF, StringRef Name) {
 429   StringRef FoundName;
 430   for (const auto &Section : OF.sections()) {
 431     if (auto EC = Section.getName(FoundName))
 432       return EC;
 433     if (FoundName == Name)
 434       return Section;
 435   }
 436   return coveragemap_error::no_data_found;
 437 }
 438
 439 static std::error_code
 440 loadBinaryFormat(MemoryBufferRef ObjectBuffer, InstrProfSymtab &ProfileNames,
 441                  StringRef &CoverageMapping, uint8_t &BytesInAddress,
 442                  support::endianness &Endian, StringRef Arch) {
 443   auto BinOrErr = object::createBinary(ObjectBuffer);
 444   if (std::error_code EC = BinOrErr.getError())
 445     return EC;
 446   auto Bin = std::move(BinOrErr.get());
 447   std::unique_ptr<ObjectFile> OF;
 448   if (auto *Universal = dyn_cast<object::MachOUniversalBinary>(Bin.get())) {
 449     // If we have a universal binary, try to look up the object for the
 450     // appropriate architecture.
 451     auto ObjectFileOrErr = Universal->getObjectForArch(Arch);
 452     if (std::error_code EC = ObjectFileOrErr.getError())
 453       return EC;
 454     OF = std::move(ObjectFileOrErr.get());
 455   } else if (isa<object::ObjectFile>(Bin.get())) {
 456     // For any other object file, upcast and take ownership.
 457     OF.reset(cast<object::ObjectFile>(Bin.release()));
 458     // If we've asked for a particular arch, make sure they match.
 459     if (!Arch.empty() && OF->getArch() != Triple(Arch).getArch())
 460       return object_error::arch_not_found;
 461   } else
 462     // We can only handle object files.
 463     return coveragemap_error::malformed;
 464
 465   // The coverage uses native pointer sizes for the object it's written in.
 466   BytesInAddress = OF->getBytesInAddress();
 467   Endian = OF->isLittleEndian() ? support::endianness::little
 468                                 : support::endianness::big;
 469
 470   // Look for the sections that we are interested in.
 471   auto NamesSection = lookupSection(*OF, getInstrProfNameSectionName(false));
 472   if (auto EC = NamesSection.getError())
 473     return EC;
 474   auto CoverageSection =
 475       lookupSection(*OF, getInstrProfCoverageSectionName(false));
 476   if (auto EC = CoverageSection.getError())
 477     return EC;
 478
 479   // Get the contents of the given sections.
 480   if (std::error_code EC = CoverageSection->getContents(CoverageMapping))
 481     return EC;
 482   if (std::error_code EC = ProfileNames.create(*NamesSection))
 483     return EC;
 484
 485   return std::error_code();
 486 }
 487
 488 ErrorOr<std::unique_ptr<BinaryCoverageReader>>
 489 BinaryCoverageReader::create(std::unique_ptr<MemoryBuffer> &ObjectBuffer,
 490                              StringRef Arch) {
 491   std::unique_ptr<BinaryCoverageReader> Reader(new BinaryCoverageReader());
 492
 493   InstrProfSymtab ProfileNames;
 494   StringRef Coverage;
 495   uint8_t BytesInAddress;
 496   support::endianness Endian;
 497   std::error_code EC;
 498   if (ObjectBuffer->getBuffer().startswith(TestingFormatMagic))
 499     // This is a special format used for testing.
 500     EC = loadTestingFormat(ObjectBuffer->getBuffer(), ProfileNames, Coverage,
 501                            BytesInAddress, Endian);
 502   else
 503     EC = loadBinaryFormat(ObjectBuffer->getMemBufferRef(), ProfileNames,
 504                           Coverage, BytesInAddress, Endian, Arch);
 505   if (EC)
 506     return EC;
 507
 508   if (BytesInAddress == 4 && Endian == support::endianness::little)
 509     EC = readCoverageMappingData<uint32_t, support::endianness::little>(
 510         ProfileNames, Coverage, Reader->MappingRecords, Reader->Filenames);
 511   else if (BytesInAddress == 4 && Endian == support::endianness::big)
 512     EC = readCoverageMappingData<uint32_t, support::endianness::big>(
 513         ProfileNames, Coverage, Reader->MappingRecords, Reader->Filenames);
 514   else if (BytesInAddress == 8 && Endian == support::endianness::little)
 515     EC = readCoverageMappingData<uint64_t, support::endianness::little>(
 516         ProfileNames, Coverage, Reader->MappingRecords, Reader->Filenames);
 517   else if (BytesInAddress == 8 && Endian == support::endianness::big)
 518     EC = readCoverageMappingData<uint64_t, support::endianness::big>(
 519         ProfileNames, Coverage, Reader->MappingRecords, Reader->Filenames);
 520   else
 521     return coveragemap_error::malformed;
 522   if (EC)
 523     return EC;
 524   return std::move(Reader);
 525 }
 526
 527 std::error_code
 528 BinaryCoverageReader::readNextRecord(CoverageMappingRecord &Record) {
 529   if (CurrentRecord >= MappingRecords.size())
 530     return coveragemap_error::eof;
 531
 532   FunctionsFilenames.clear();
 533   Expressions.clear();
 534   MappingRegions.clear();
 535   auto &R = MappingRecords[CurrentRecord];
 536   RawCoverageMappingReader Reader(
 537       R.CoverageMapping,
 538       makeArrayRef(Filenames).slice(R.FilenamesBegin, R.FilenamesSize),
 539       FunctionsFilenames, Expressions, MappingRegions);
 540   if (auto Err = Reader.read())
 541     return Err;
 542
 543   Record.FunctionName = R.FunctionName;
 544   Record.FunctionHash = R.FunctionHash;
 545   Record.Filenames = FunctionsFilenames;
 546   Record.Expressions = Expressions;
 547   Record.MappingRegions = MappingRegions;
 548
 549   ++CurrentRecord;
 550   return std::error_code();
 551 }