//===- unittest/ProfileData/CoverageMappingTest.cpp -------------------------=// // // The LLVM Compiler Infrastructure // // This file is distributed under the University of Illinois Open Source // License. See LICENSE.TXT for details. // //===----------------------------------------------------------------------===// #include "llvm/ProfileData/Coverage/CoverageMapping.h" #include "llvm/ProfileData/Coverage/CoverageMappingReader.h" #include "llvm/ProfileData/Coverage/CoverageMappingWriter.h" #include "llvm/ProfileData/InstrProfReader.h" #include "llvm/ProfileData/InstrProfWriter.h" #include "llvm/Support/raw_ostream.h" #include "gtest/gtest.h" #include using namespace llvm; using namespace coverage; static ::testing::AssertionResult NoError(Error E) { if (!E) return ::testing::AssertionSuccess(); return ::testing::AssertionFailure() << "error: " << toString(std::move(E)) << "\n"; } namespace llvm { namespace coverage { void PrintTo(const Counter &C, ::std::ostream *os) { if (C.isZero()) *os << "Zero"; else if (C.isExpression()) *os << "Expression " << C.getExpressionID(); else *os << "Counter " << C.getCounterID(); } void PrintTo(const CoverageSegment &S, ::std::ostream *os) { *os << "CoverageSegment(" << S.Line << ", " << S.Col << ", "; if (S.HasCount) *os << S.Count << ", "; *os << (S.IsRegionEntry ? "true" : "false") << ")"; } } } namespace { struct OutputFunctionCoverageData { StringRef Name; uint64_t Hash; std::vector Filenames; std::vector Regions; void fillCoverageMappingRecord(CoverageMappingRecord &Record) const { Record.FunctionName = Name; Record.FunctionHash = Hash; Record.Filenames = Filenames; Record.Expressions = {}; Record.MappingRegions = Regions; } }; struct CoverageMappingReaderMock : CoverageMappingReader { ArrayRef Functions; CoverageMappingReaderMock(ArrayRef Functions) : Functions(Functions) {} Error readNextRecord(CoverageMappingRecord &Record) override { if (Functions.empty()) return make_error(coveragemap_error::eof); Functions.front().fillCoverageMappingRecord(Record); Functions = Functions.slice(1); return Error::success(); } }; struct InputFunctionCoverageData { // Maps the global file index from CoverageMappingTest.Files // to the index of that file within this function. We can't just use // global file indexes here because local indexes have to be dense. // This map is used during serialization to create the virtual file mapping // (from local fileId to global Index) in the head of the per-function // coverage mapping data. SmallDenseMap ReverseVirtualFileMapping; std::string Name; uint64_t Hash; std::vector Regions; InputFunctionCoverageData(std::string Name, uint64_t Hash) : Name(std::move(Name)), Hash(Hash) {} }; struct CoverageMappingTest : ::testing::Test { StringMap Files; std::vector InputFunctions; std::vector OutputFunctions; InstrProfWriter ProfileWriter; std::unique_ptr ProfileReader; std::unique_ptr LoadedCoverage; void SetUp() override { ProfileWriter.setOutputSparse(false); } unsigned getGlobalFileIndex(StringRef Name) { auto R = Files.find(Name); if (R != Files.end()) return R->second; unsigned Index = Files.size(); Files.try_emplace(Name, Index); return Index; } // Return the file index of file 'Name' for the current function. // Add the file into the global map if necesary. // See also InputFunctionCoverageData::ReverseVirtualFileMapping // for additional comments. unsigned getFileIndexForFunction(StringRef Name) { unsigned GlobalIndex = getGlobalFileIndex(Name); auto &CurrentFunctionFileMapping = InputFunctions.back().ReverseVirtualFileMapping; auto R = CurrentFunctionFileMapping.find(GlobalIndex); if (R != CurrentFunctionFileMapping.end()) return R->second; unsigned IndexInFunction = CurrentFunctionFileMapping.size(); CurrentFunctionFileMapping.insert( std::make_pair(GlobalIndex, IndexInFunction)); return IndexInFunction; } void startFunction(StringRef FuncName, uint64_t Hash) { InputFunctions.emplace_back(FuncName.str(), Hash); } void addCMR(Counter C, StringRef File, unsigned LS, unsigned CS, unsigned LE, unsigned CE) { InputFunctions.back().Regions.push_back(CounterMappingRegion::makeRegion( C, getFileIndexForFunction(File), LS, CS, LE, CE)); } void addExpansionCMR(StringRef File, StringRef ExpandedFile, unsigned LS, unsigned CS, unsigned LE, unsigned CE) { InputFunctions.back().Regions.push_back(CounterMappingRegion::makeExpansion( getFileIndexForFunction(File), getFileIndexForFunction(ExpandedFile), LS, CS, LE, CE)); } std::string writeCoverageRegions(InputFunctionCoverageData &Data) { SmallVector FileIDs(Data.ReverseVirtualFileMapping.size()); for (const auto &E : Data.ReverseVirtualFileMapping) FileIDs[E.second] = E.first; std::string Coverage; llvm::raw_string_ostream OS(Coverage); CoverageMappingWriter(FileIDs, None, Data.Regions).write(OS); return OS.str(); } void readCoverageRegions(std::string Coverage, OutputFunctionCoverageData &Data) { SmallVector Filenames(Files.size()); for (const auto &E : Files) Filenames[E.getValue()] = E.getKey(); std::vector Expressions; RawCoverageMappingReader Reader(Coverage, Filenames, Data.Filenames, Expressions, Data.Regions); ASSERT_TRUE(NoError(Reader.read())); } void writeAndReadCoverageRegions(bool EmitFilenames = true) { OutputFunctions.resize(InputFunctions.size()); for (unsigned I = 0; I < InputFunctions.size(); ++I) { std::string Regions = writeCoverageRegions(InputFunctions[I]); readCoverageRegions(Regions, OutputFunctions[I]); OutputFunctions[I].Name = InputFunctions[I].Name; OutputFunctions[I].Hash = InputFunctions[I].Hash; if (!EmitFilenames) OutputFunctions[I].Filenames.clear(); } } void readProfCounts() { auto Profile = ProfileWriter.writeBuffer(); auto ReaderOrErr = IndexedInstrProfReader::create(std::move(Profile)); ASSERT_TRUE(NoError(ReaderOrErr.takeError())); ProfileReader = std::move(ReaderOrErr.get()); } void loadCoverageMapping(bool EmitFilenames = true) { readProfCounts(); writeAndReadCoverageRegions(EmitFilenames); CoverageMappingReaderMock CovReader(OutputFunctions); auto CoverageOrErr = CoverageMapping::load(CovReader, *ProfileReader); ASSERT_TRUE(NoError(CoverageOrErr.takeError())); LoadedCoverage = std::move(CoverageOrErr.get()); } }; struct MaybeSparseCoverageMappingTest : public CoverageMappingTest, public ::testing::WithParamInterface { void SetUp() { CoverageMappingTest::SetUp(); ProfileWriter.setOutputSparse(GetParam()); } }; TEST_P(MaybeSparseCoverageMappingTest, basic_write_read) { startFunction("func", 0x1234); addCMR(Counter::getCounter(0), "foo", 1, 1, 1, 1); addCMR(Counter::getCounter(1), "foo", 2, 1, 2, 2); addCMR(Counter::getZero(), "foo", 3, 1, 3, 4); addCMR(Counter::getCounter(2), "foo", 4, 1, 4, 8); addCMR(Counter::getCounter(3), "bar", 1, 2, 3, 4); writeAndReadCoverageRegions(); ASSERT_EQ(1u, InputFunctions.size()); ASSERT_EQ(1u, OutputFunctions.size()); InputFunctionCoverageData &Input = InputFunctions.back(); OutputFunctionCoverageData &Output = OutputFunctions.back(); size_t N = makeArrayRef(Input.Regions).size(); ASSERT_EQ(N, Output.Regions.size()); for (size_t I = 0; I < N; ++I) { ASSERT_EQ(Input.Regions[I].Count, Output.Regions[I].Count); ASSERT_EQ(Input.Regions[I].FileID, Output.Regions[I].FileID); ASSERT_EQ(Input.Regions[I].startLoc(), Output.Regions[I].startLoc()); ASSERT_EQ(Input.Regions[I].endLoc(), Output.Regions[I].endLoc()); ASSERT_EQ(Input.Regions[I].Kind, Output.Regions[I].Kind); } } TEST_P(MaybeSparseCoverageMappingTest, correct_deserialize_for_more_than_two_files) { const char *FileNames[] = {"bar", "baz", "foo"}; static const unsigned N = array_lengthof(FileNames); startFunction("func", 0x1234); for (unsigned I = 0; I < N; ++I) // Use LineStart to hold the index of the file name // in order to preserve that information during possible sorting of CMRs. addCMR(Counter::getCounter(0), FileNames[I], I, 1, I, 1); writeAndReadCoverageRegions(); ASSERT_EQ(1u, OutputFunctions.size()); OutputFunctionCoverageData &Output = OutputFunctions.back(); ASSERT_EQ(N, Output.Regions.size()); ASSERT_EQ(N, Output.Filenames.size()); for (unsigned I = 0; I < N; ++I) { ASSERT_GT(N, Output.Regions[I].FileID); ASSERT_GT(N, Output.Regions[I].LineStart); EXPECT_EQ(FileNames[Output.Regions[I].LineStart], Output.Filenames[Output.Regions[I].FileID]); } } TEST_P(MaybeSparseCoverageMappingTest, load_coverage_for_more_than_two_files) { InstrProfRecord Record("func", 0x1234, {0}); NoError(ProfileWriter.addRecord(std::move(Record))); const char *FileNames[] = {"bar", "baz", "foo"}; static const unsigned N = array_lengthof(FileNames); startFunction("func", 0x1234); for (unsigned I = 0; I < N; ++I) // Use LineStart to hold the index of the file name // in order to preserve that information during possible sorting of CMRs. addCMR(Counter::getCounter(0), FileNames[I], I, 1, I, 1); loadCoverageMapping(); for (unsigned I = 0; I < N; ++I) { CoverageData Data = LoadedCoverage->getCoverageForFile(FileNames[I]); ASSERT_TRUE(!Data.empty()); EXPECT_EQ(I, Data.begin()->Line); } } TEST_P(MaybeSparseCoverageMappingTest, load_coverage_for_several_functions) { InstrProfRecord RecordFunc1("func1", 0x1234, {10}); NoError(ProfileWriter.addRecord(std::move(RecordFunc1))); InstrProfRecord RecordFunc2("func2", 0x2345, {20}); NoError(ProfileWriter.addRecord(std::move(RecordFunc2))); startFunction("func1", 0x1234); addCMR(Counter::getCounter(0), "foo", 1, 1, 5, 5); startFunction("func2", 0x2345); addCMR(Counter::getCounter(0), "bar", 2, 2, 6, 6); loadCoverageMapping(); const auto FunctionRecords = LoadedCoverage->getCoveredFunctions(); EXPECT_EQ(2U, std::distance(FunctionRecords.begin(), FunctionRecords.end())); for (const auto &FunctionRecord : FunctionRecords) { CoverageData Data = LoadedCoverage->getCoverageForFunction(FunctionRecord); std::vector Segments(Data.begin(), Data.end()); ASSERT_EQ(2U, Segments.size()); if (FunctionRecord.Name == "func1") { EXPECT_EQ(CoverageSegment(1, 1, 10, true), Segments[0]); EXPECT_EQ(CoverageSegment(5, 5, false), Segments[1]); } else { ASSERT_EQ("func2", FunctionRecord.Name); EXPECT_EQ(CoverageSegment(2, 2, 20, true), Segments[0]); EXPECT_EQ(CoverageSegment(6, 6, false), Segments[1]); } } } TEST_P(MaybeSparseCoverageMappingTest, expansion_gets_first_counter) { startFunction("func", 0x1234); addCMR(Counter::getCounter(1), "foo", 10, 1, 10, 2); // This starts earlier in "foo", so the expansion should get its counter. addCMR(Counter::getCounter(2), "foo", 1, 1, 20, 1); addExpansionCMR("bar", "foo", 3, 3, 3, 3); writeAndReadCoverageRegions(); ASSERT_EQ(1u, OutputFunctions.size()); OutputFunctionCoverageData &Output = OutputFunctions.back(); ASSERT_EQ(CounterMappingRegion::ExpansionRegion, Output.Regions[2].Kind); ASSERT_EQ(Counter::getCounter(2), Output.Regions[2].Count); ASSERT_EQ(3U, Output.Regions[2].LineStart); } TEST_P(MaybeSparseCoverageMappingTest, basic_coverage_iteration) { InstrProfRecord Record("func", 0x1234, {30, 20, 10, 0}); NoError(ProfileWriter.addRecord(std::move(Record))); startFunction("func", 0x1234); addCMR(Counter::getCounter(0), "file1", 1, 1, 9, 9); addCMR(Counter::getCounter(1), "file1", 1, 1, 4, 7); addCMR(Counter::getCounter(2), "file1", 5, 8, 9, 1); addCMR(Counter::getCounter(3), "file1", 10, 10, 11, 11); loadCoverageMapping(); CoverageData Data = LoadedCoverage->getCoverageForFile("file1"); std::vector Segments(Data.begin(), Data.end()); ASSERT_EQ(7U, Segments.size()); ASSERT_EQ(CoverageSegment(1, 1, 20, true), Segments[0]); ASSERT_EQ(CoverageSegment(4, 7, 30, false), Segments[1]); ASSERT_EQ(CoverageSegment(5, 8, 10, true), Segments[2]); ASSERT_EQ(CoverageSegment(9, 1, 30, false), Segments[3]); ASSERT_EQ(CoverageSegment(9, 9, false), Segments[4]); ASSERT_EQ(CoverageSegment(10, 10, 0, true), Segments[5]); ASSERT_EQ(CoverageSegment(11, 11, false), Segments[6]); } TEST_P(MaybeSparseCoverageMappingTest, uncovered_function) { startFunction("func", 0x1234); addCMR(Counter::getZero(), "file1", 1, 2, 3, 4); loadCoverageMapping(); CoverageData Data = LoadedCoverage->getCoverageForFile("file1"); std::vector Segments(Data.begin(), Data.end()); ASSERT_EQ(2U, Segments.size()); ASSERT_EQ(CoverageSegment(1, 2, 0, true), Segments[0]); ASSERT_EQ(CoverageSegment(3, 4, false), Segments[1]); } TEST_P(MaybeSparseCoverageMappingTest, uncovered_function_with_mapping) { startFunction("func", 0x1234); addCMR(Counter::getCounter(0), "file1", 1, 1, 9, 9); addCMR(Counter::getCounter(1), "file1", 1, 1, 4, 7); loadCoverageMapping(); CoverageData Data = LoadedCoverage->getCoverageForFile("file1"); std::vector Segments(Data.begin(), Data.end()); ASSERT_EQ(3U, Segments.size()); ASSERT_EQ(CoverageSegment(1, 1, 0, true), Segments[0]); ASSERT_EQ(CoverageSegment(4, 7, 0, false), Segments[1]); ASSERT_EQ(CoverageSegment(9, 9, false), Segments[2]); } TEST_P(MaybeSparseCoverageMappingTest, combine_regions) { InstrProfRecord Record("func", 0x1234, {10, 20, 30}); NoError(ProfileWriter.addRecord(std::move(Record))); startFunction("func", 0x1234); addCMR(Counter::getCounter(0), "file1", 1, 1, 9, 9); addCMR(Counter::getCounter(1), "file1", 3, 3, 4, 4); addCMR(Counter::getCounter(2), "file1", 3, 3, 4, 4); loadCoverageMapping(); CoverageData Data = LoadedCoverage->getCoverageForFile("file1"); std::vector Segments(Data.begin(), Data.end()); ASSERT_EQ(4U, Segments.size()); ASSERT_EQ(CoverageSegment(1, 1, 10, true), Segments[0]); ASSERT_EQ(CoverageSegment(3, 3, 50, true), Segments[1]); ASSERT_EQ(CoverageSegment(4, 4, 10, false), Segments[2]); ASSERT_EQ(CoverageSegment(9, 9, false), Segments[3]); } TEST_P(MaybeSparseCoverageMappingTest, restore_combined_counter_after_nested_region) { InstrProfRecord Record("func", 0x1234, {10, 20, 40}); NoError(ProfileWriter.addRecord(std::move(Record))); startFunction("func", 0x1234); addCMR(Counter::getCounter(0), "file1", 1, 1, 9, 9); addCMR(Counter::getCounter(1), "file1", 1, 1, 9, 9); addCMR(Counter::getCounter(2), "file1", 3, 3, 5, 5); loadCoverageMapping(); CoverageData Data = LoadedCoverage->getCoverageForFile("file1"); std::vector Segments(Data.begin(), Data.end()); ASSERT_EQ(4U, Segments.size()); EXPECT_EQ(CoverageSegment(1, 1, 30, true), Segments[0]); EXPECT_EQ(CoverageSegment(3, 3, 40, true), Segments[1]); EXPECT_EQ(CoverageSegment(5, 5, 30, false), Segments[2]); EXPECT_EQ(CoverageSegment(9, 9, false), Segments[3]); } // If CodeRegions and ExpansionRegions cover the same area, // only counts of CodeRegions should be used. TEST_P(MaybeSparseCoverageMappingTest, dont_combine_expansions) { InstrProfRecord Record1("func", 0x1234, {10, 20}); InstrProfRecord Record2("func", 0x1234, {0, 0}); NoError(ProfileWriter.addRecord(std::move(Record1))); NoError(ProfileWriter.addRecord(std::move(Record2))); startFunction("func", 0x1234); addCMR(Counter::getCounter(0), "file1", 1, 1, 9, 9); addCMR(Counter::getCounter(1), "file1", 3, 3, 4, 4); addCMR(Counter::getCounter(1), "include1", 6, 6, 7, 7); addExpansionCMR("file1", "include1", 3, 3, 4, 4); loadCoverageMapping(); CoverageData Data = LoadedCoverage->getCoverageForFile("file1"); std::vector Segments(Data.begin(), Data.end()); ASSERT_EQ(4U, Segments.size()); ASSERT_EQ(CoverageSegment(1, 1, 10, true), Segments[0]); ASSERT_EQ(CoverageSegment(3, 3, 20, true), Segments[1]); ASSERT_EQ(CoverageSegment(4, 4, 10, false), Segments[2]); ASSERT_EQ(CoverageSegment(9, 9, false), Segments[3]); } // If an area is covered only by ExpansionRegions, they should be combinated. TEST_P(MaybeSparseCoverageMappingTest, combine_expansions) { InstrProfRecord Record("func", 0x1234, {2, 3, 7}); NoError(ProfileWriter.addRecord(std::move(Record))); startFunction("func", 0x1234); addCMR(Counter::getCounter(1), "include1", 1, 1, 1, 10); addCMR(Counter::getCounter(2), "include2", 1, 1, 1, 10); addCMR(Counter::getCounter(0), "file", 1, 1, 5, 5); addExpansionCMR("file", "include1", 3, 1, 3, 5); addExpansionCMR("file", "include2", 3, 1, 3, 5); loadCoverageMapping(); CoverageData Data = LoadedCoverage->getCoverageForFile("file"); std::vector Segments(Data.begin(), Data.end()); ASSERT_EQ(4U, Segments.size()); EXPECT_EQ(CoverageSegment(1, 1, 2, true), Segments[0]); EXPECT_EQ(CoverageSegment(3, 1, 10, true), Segments[1]); EXPECT_EQ(CoverageSegment(3, 5, 2, false), Segments[2]); EXPECT_EQ(CoverageSegment(5, 5, false), Segments[3]); } TEST_P(MaybeSparseCoverageMappingTest, strip_filename_prefix) { InstrProfRecord Record("file1:func", 0x1234, {0}); NoError(ProfileWriter.addRecord(std::move(Record))); startFunction("file1:func", 0x1234); addCMR(Counter::getCounter(0), "file1", 1, 1, 9, 9); loadCoverageMapping(); std::vector Names; for (const auto &Func : LoadedCoverage->getCoveredFunctions()) Names.push_back(Func.Name); ASSERT_EQ(1U, Names.size()); ASSERT_EQ("func", Names[0]); } TEST_P(MaybeSparseCoverageMappingTest, strip_unknown_filename_prefix) { InstrProfRecord Record(":func", 0x1234, {0}); NoError(ProfileWriter.addRecord(std::move(Record))); startFunction(":func", 0x1234); addCMR(Counter::getCounter(0), "", 1, 1, 9, 9); loadCoverageMapping(/*EmitFilenames=*/false); std::vector Names; for (const auto &Func : LoadedCoverage->getCoveredFunctions()) Names.push_back(Func.Name); ASSERT_EQ(1U, Names.size()); ASSERT_EQ("func", Names[0]); } TEST_P(MaybeSparseCoverageMappingTest, dont_detect_false_instantiations) { InstrProfRecord Record1("foo", 0x1234, {10}); InstrProfRecord Record2("bar", 0x2345, {20}); NoError(ProfileWriter.addRecord(std::move(Record1))); NoError(ProfileWriter.addRecord(std::move(Record2))); startFunction("foo", 0x1234); addCMR(Counter::getCounter(0), "expanded", 1, 1, 1, 10); addExpansionCMR("main", "expanded", 4, 1, 4, 5); startFunction("bar", 0x2345); addCMR(Counter::getCounter(0), "expanded", 1, 1, 1, 10); addExpansionCMR("main", "expanded", 9, 1, 9, 5); loadCoverageMapping(); std::vector Instantiations = LoadedCoverage->getInstantiations("expanded"); ASSERT_TRUE(Instantiations.empty()); } TEST_P(MaybeSparseCoverageMappingTest, load_coverage_for_expanded_file) { InstrProfRecord Record("func", 0x1234, {10}); NoError(ProfileWriter.addRecord(std::move(Record))); startFunction("func", 0x1234); addCMR(Counter::getCounter(0), "expanded", 1, 1, 1, 10); addExpansionCMR("main", "expanded", 4, 1, 4, 5); loadCoverageMapping(); CoverageData Data = LoadedCoverage->getCoverageForFile("expanded"); std::vector Segments(Data.begin(), Data.end()); ASSERT_EQ(2U, Segments.size()); EXPECT_EQ(CoverageSegment(1, 1, 10, true), Segments[0]); EXPECT_EQ(CoverageSegment(1, 10, false), Segments[1]); } INSTANTIATE_TEST_CASE_P(MaybeSparse, MaybeSparseCoverageMappingTest, ::testing::Bool()); } // end anonymous namespace