forked from OSchip/llvm-project
485 lines
17 KiB
C++
485 lines
17 KiB
C++
//===- CodeCoverage.cpp - Coverage tool based on profiling instrumentation-===//
|
|
//
|
|
// The LLVM Compiler Infrastructure
|
|
//
|
|
// This file is distributed under the University of Illinois Open Source
|
|
// License. See LICENSE.TXT for details.
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
//
|
|
// The 'CodeCoverageTool' class implements a command line tool to analyze and
|
|
// report coverage information using the profiling instrumentation and code
|
|
// coverage mapping.
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#include "RenderingSupport.h"
|
|
#include "CoverageViewOptions.h"
|
|
#include "CoverageFilters.h"
|
|
#include "SourceCoverageView.h"
|
|
#include "CoverageSummary.h"
|
|
#include "CoverageReport.h"
|
|
#include "llvm/ADT/StringRef.h"
|
|
#include "llvm/ADT/SmallString.h"
|
|
#include "llvm/ProfileData/InstrProfReader.h"
|
|
#include "llvm/ProfileData/CoverageMapping.h"
|
|
#include "llvm/ProfileData/CoverageMappingReader.h"
|
|
#include "llvm/Support/CommandLine.h"
|
|
#include "llvm/Support/FileSystem.h"
|
|
#include "llvm/Support/ManagedStatic.h"
|
|
#include "llvm/Support/MemoryObject.h"
|
|
#include "llvm/Support/Format.h"
|
|
#include "llvm/Support/Path.h"
|
|
#include "llvm/Support/Signals.h"
|
|
#include "llvm/Support/PrettyStackTrace.h"
|
|
#include <functional>
|
|
#include <system_error>
|
|
|
|
using namespace llvm;
|
|
using namespace coverage;
|
|
|
|
namespace {
|
|
/// \brief The implementation of the coverage tool.
|
|
class CodeCoverageTool {
|
|
public:
|
|
enum Command {
|
|
/// \brief The show command.
|
|
Show,
|
|
/// \brief The report command.
|
|
Report
|
|
};
|
|
|
|
/// \brief Print the error message to the error output stream.
|
|
void error(const Twine &Message, StringRef Whence = "");
|
|
|
|
/// \brief Return a memory buffer for the given source file.
|
|
ErrorOr<const MemoryBuffer &> getSourceFile(StringRef SourceFile);
|
|
|
|
/// \brief Create source views for the expansions of the view.
|
|
void attachExpansionSubViews(SourceCoverageView &View,
|
|
ArrayRef<ExpansionRecord> Expansions,
|
|
CoverageMapping &Coverage);
|
|
|
|
/// \brief Create the source view of a particular function.
|
|
std::unique_ptr<SourceCoverageView>
|
|
createFunctionView(const FunctionRecord &Function, CoverageMapping &Coverage);
|
|
|
|
/// \brief Create the main source view of a particular source file.
|
|
std::unique_ptr<SourceCoverageView>
|
|
createSourceFileView(StringRef SourceFile, CoverageMapping &Coverage);
|
|
|
|
/// \brief Load the coverage mapping data. Return true if an error occured.
|
|
std::unique_ptr<CoverageMapping> load();
|
|
|
|
int run(Command Cmd, int argc, const char **argv);
|
|
|
|
typedef std::function<int(int, const char **)> CommandLineParserType;
|
|
|
|
int show(int argc, const char **argv,
|
|
CommandLineParserType commandLineParser);
|
|
|
|
int report(int argc, const char **argv,
|
|
CommandLineParserType commandLineParser);
|
|
|
|
std::string ObjectFilename;
|
|
CoverageViewOptions ViewOpts;
|
|
std::string PGOFilename;
|
|
CoverageFiltersMatchAll Filters;
|
|
std::vector<std::string> SourceFiles;
|
|
std::vector<std::pair<std::string, std::unique_ptr<MemoryBuffer>>>
|
|
LoadedSourceFiles;
|
|
bool CompareFilenamesOnly;
|
|
StringMap<std::string> RemappedFilenames;
|
|
};
|
|
}
|
|
|
|
void CodeCoverageTool::error(const Twine &Message, StringRef Whence) {
|
|
errs() << "error: ";
|
|
if (!Whence.empty())
|
|
errs() << Whence << ": ";
|
|
errs() << Message << "\n";
|
|
}
|
|
|
|
ErrorOr<const MemoryBuffer &>
|
|
CodeCoverageTool::getSourceFile(StringRef SourceFile) {
|
|
// If we've remapped filenames, look up the real location for this file.
|
|
if (!RemappedFilenames.empty()) {
|
|
auto Loc = RemappedFilenames.find(SourceFile);
|
|
if (Loc != RemappedFilenames.end())
|
|
SourceFile = Loc->second;
|
|
}
|
|
for (const auto &Files : LoadedSourceFiles)
|
|
if (sys::fs::equivalent(SourceFile, Files.first))
|
|
return *Files.second;
|
|
auto Buffer = MemoryBuffer::getFile(SourceFile);
|
|
if (auto EC = Buffer.getError()) {
|
|
error(EC.message(), SourceFile);
|
|
return EC;
|
|
}
|
|
LoadedSourceFiles.push_back(
|
|
std::make_pair(SourceFile, std::move(Buffer.get())));
|
|
return *LoadedSourceFiles.back().second;
|
|
}
|
|
|
|
void
|
|
CodeCoverageTool::attachExpansionSubViews(SourceCoverageView &View,
|
|
ArrayRef<ExpansionRecord> Expansions,
|
|
CoverageMapping &Coverage) {
|
|
if (!ViewOpts.ShowExpandedRegions)
|
|
return;
|
|
for (const auto &Expansion : Expansions) {
|
|
auto ExpansionCoverage = Coverage.getCoverageForExpansion(Expansion);
|
|
if (ExpansionCoverage.empty())
|
|
continue;
|
|
auto SourceBuffer = getSourceFile(ExpansionCoverage.getFilename());
|
|
if (!SourceBuffer)
|
|
continue;
|
|
|
|
auto SubViewExpansions = ExpansionCoverage.getExpansions();
|
|
auto SubView = llvm::make_unique<SourceCoverageView>(
|
|
SourceBuffer.get(), ViewOpts, std::move(ExpansionCoverage));
|
|
attachExpansionSubViews(*SubView, SubViewExpansions, Coverage);
|
|
View.addExpansion(Expansion.Region, std::move(SubView));
|
|
}
|
|
}
|
|
|
|
std::unique_ptr<SourceCoverageView>
|
|
CodeCoverageTool::createFunctionView(const FunctionRecord &Function,
|
|
CoverageMapping &Coverage) {
|
|
auto FunctionCoverage = Coverage.getCoverageForFunction(Function);
|
|
if (FunctionCoverage.empty())
|
|
return nullptr;
|
|
auto SourceBuffer = getSourceFile(FunctionCoverage.getFilename());
|
|
if (!SourceBuffer)
|
|
return nullptr;
|
|
|
|
auto Expansions = FunctionCoverage.getExpansions();
|
|
auto View = llvm::make_unique<SourceCoverageView>(
|
|
SourceBuffer.get(), ViewOpts, std::move(FunctionCoverage));
|
|
attachExpansionSubViews(*View, Expansions, Coverage);
|
|
|
|
return View;
|
|
}
|
|
|
|
std::unique_ptr<SourceCoverageView>
|
|
CodeCoverageTool::createSourceFileView(StringRef SourceFile,
|
|
CoverageMapping &Coverage) {
|
|
auto SourceBuffer = getSourceFile(SourceFile);
|
|
if (!SourceBuffer)
|
|
return nullptr;
|
|
auto FileCoverage = Coverage.getCoverageForFile(SourceFile);
|
|
if (FileCoverage.empty())
|
|
return nullptr;
|
|
|
|
auto Expansions = FileCoverage.getExpansions();
|
|
auto View = llvm::make_unique<SourceCoverageView>(
|
|
SourceBuffer.get(), ViewOpts, std::move(FileCoverage));
|
|
attachExpansionSubViews(*View, Expansions, Coverage);
|
|
|
|
for (auto Function : Coverage.getInstantiations(SourceFile)) {
|
|
auto SubViewCoverage = Coverage.getCoverageForFunction(*Function);
|
|
auto SubViewExpansions = SubViewCoverage.getExpansions();
|
|
auto SubView = llvm::make_unique<SourceCoverageView>(
|
|
SourceBuffer.get(), ViewOpts, std::move(SubViewCoverage));
|
|
attachExpansionSubViews(*SubView, SubViewExpansions, Coverage);
|
|
|
|
if (SubView) {
|
|
unsigned FileID = Function->CountedRegions.front().FileID;
|
|
unsigned Line = 0;
|
|
for (const auto &CR : Function->CountedRegions)
|
|
if (CR.FileID == FileID)
|
|
Line = std::max(CR.LineEnd, Line);
|
|
View->addInstantiation(Function->Name, Line, std::move(SubView));
|
|
}
|
|
}
|
|
return View;
|
|
}
|
|
|
|
std::unique_ptr<CoverageMapping> CodeCoverageTool::load() {
|
|
auto CoverageOrErr = CoverageMapping::load(ObjectFilename, PGOFilename);
|
|
if (std::error_code EC = CoverageOrErr.getError()) {
|
|
colored_ostream(errs(), raw_ostream::RED)
|
|
<< "error: Failed to load coverage: " << EC.message();
|
|
errs() << "\n";
|
|
return nullptr;
|
|
}
|
|
auto Coverage = std::move(CoverageOrErr.get());
|
|
unsigned Mismatched = Coverage->getMismatchedCount();
|
|
if (Mismatched) {
|
|
colored_ostream(errs(), raw_ostream::RED)
|
|
<< "warning: " << Mismatched << " functions have mismatched data. ";
|
|
errs() << "\n";
|
|
}
|
|
|
|
if (CompareFilenamesOnly) {
|
|
auto CoveredFiles = Coverage.get()->getUniqueSourceFiles();
|
|
for (auto &SF : SourceFiles) {
|
|
StringRef SFBase = sys::path::filename(SF);
|
|
for (const auto &CF : CoveredFiles)
|
|
if (SFBase == sys::path::filename(CF)) {
|
|
RemappedFilenames[CF] = SF;
|
|
SF = CF;
|
|
break;
|
|
}
|
|
}
|
|
}
|
|
|
|
return Coverage;
|
|
}
|
|
|
|
int CodeCoverageTool::run(Command Cmd, int argc, const char **argv) {
|
|
// Print a stack trace if we signal out.
|
|
sys::PrintStackTraceOnErrorSignal();
|
|
PrettyStackTraceProgram X(argc, argv);
|
|
llvm_shutdown_obj Y; // Call llvm_shutdown() on exit.
|
|
|
|
cl::opt<std::string, true> ObjectFilename(
|
|
cl::Positional, cl::Required, cl::location(this->ObjectFilename),
|
|
cl::desc("Covered executable or object file."));
|
|
|
|
cl::list<std::string> InputSourceFiles(
|
|
cl::Positional, cl::desc("<Source files>"), cl::ZeroOrMore);
|
|
|
|
cl::opt<std::string, true> PGOFilename(
|
|
"instr-profile", cl::Required, cl::location(this->PGOFilename),
|
|
cl::desc(
|
|
"File with the profile data obtained after an instrumented run"));
|
|
|
|
cl::opt<bool> DebugDump("dump", cl::Optional,
|
|
cl::desc("Show internal debug dump"));
|
|
|
|
cl::opt<bool> FilenameEquivalence(
|
|
"filename-equivalence", cl::Optional,
|
|
cl::desc("Treat source files as equivalent to paths in the coverage data "
|
|
"when the file names match, even if the full paths do not"));
|
|
|
|
cl::OptionCategory FilteringCategory("Function filtering options");
|
|
|
|
cl::list<std::string> NameFilters(
|
|
"name", cl::Optional,
|
|
cl::desc("Show code coverage only for functions with the given name"),
|
|
cl::ZeroOrMore, cl::cat(FilteringCategory));
|
|
|
|
cl::list<std::string> NameRegexFilters(
|
|
"name-regex", cl::Optional,
|
|
cl::desc("Show code coverage only for functions that match the given "
|
|
"regular expression"),
|
|
cl::ZeroOrMore, cl::cat(FilteringCategory));
|
|
|
|
cl::opt<double> RegionCoverageLtFilter(
|
|
"region-coverage-lt", cl::Optional,
|
|
cl::desc("Show code coverage only for functions with region coverage "
|
|
"less than the given threshold"),
|
|
cl::cat(FilteringCategory));
|
|
|
|
cl::opt<double> RegionCoverageGtFilter(
|
|
"region-coverage-gt", cl::Optional,
|
|
cl::desc("Show code coverage only for functions with region coverage "
|
|
"greater than the given threshold"),
|
|
cl::cat(FilteringCategory));
|
|
|
|
cl::opt<double> LineCoverageLtFilter(
|
|
"line-coverage-lt", cl::Optional,
|
|
cl::desc("Show code coverage only for functions with line coverage less "
|
|
"than the given threshold"),
|
|
cl::cat(FilteringCategory));
|
|
|
|
cl::opt<double> LineCoverageGtFilter(
|
|
"line-coverage-gt", cl::Optional,
|
|
cl::desc("Show code coverage only for functions with line coverage "
|
|
"greater than the given threshold"),
|
|
cl::cat(FilteringCategory));
|
|
|
|
auto commandLineParser = [&, this](int argc, const char **argv) -> int {
|
|
cl::ParseCommandLineOptions(argc, argv, "LLVM code coverage tool\n");
|
|
ViewOpts.Debug = DebugDump;
|
|
CompareFilenamesOnly = FilenameEquivalence;
|
|
|
|
// Create the function filters
|
|
if (!NameFilters.empty() || !NameRegexFilters.empty()) {
|
|
auto NameFilterer = new CoverageFilters;
|
|
for (const auto &Name : NameFilters)
|
|
NameFilterer->push_back(llvm::make_unique<NameCoverageFilter>(Name));
|
|
for (const auto &Regex : NameRegexFilters)
|
|
NameFilterer->push_back(
|
|
llvm::make_unique<NameRegexCoverageFilter>(Regex));
|
|
Filters.push_back(std::unique_ptr<CoverageFilter>(NameFilterer));
|
|
}
|
|
if (RegionCoverageLtFilter.getNumOccurrences() ||
|
|
RegionCoverageGtFilter.getNumOccurrences() ||
|
|
LineCoverageLtFilter.getNumOccurrences() ||
|
|
LineCoverageGtFilter.getNumOccurrences()) {
|
|
auto StatFilterer = new CoverageFilters;
|
|
if (RegionCoverageLtFilter.getNumOccurrences())
|
|
StatFilterer->push_back(llvm::make_unique<RegionCoverageFilter>(
|
|
RegionCoverageFilter::LessThan, RegionCoverageLtFilter));
|
|
if (RegionCoverageGtFilter.getNumOccurrences())
|
|
StatFilterer->push_back(llvm::make_unique<RegionCoverageFilter>(
|
|
RegionCoverageFilter::GreaterThan, RegionCoverageGtFilter));
|
|
if (LineCoverageLtFilter.getNumOccurrences())
|
|
StatFilterer->push_back(llvm::make_unique<LineCoverageFilter>(
|
|
LineCoverageFilter::LessThan, LineCoverageLtFilter));
|
|
if (LineCoverageGtFilter.getNumOccurrences())
|
|
StatFilterer->push_back(llvm::make_unique<LineCoverageFilter>(
|
|
RegionCoverageFilter::GreaterThan, LineCoverageGtFilter));
|
|
Filters.push_back(std::unique_ptr<CoverageFilter>(StatFilterer));
|
|
}
|
|
|
|
for (const auto &File : InputSourceFiles) {
|
|
SmallString<128> Path(File);
|
|
if (std::error_code EC = sys::fs::make_absolute(Path)) {
|
|
errs() << "error: " << File << ": " << EC.message();
|
|
return 1;
|
|
}
|
|
SourceFiles.push_back(Path.str());
|
|
}
|
|
return 0;
|
|
};
|
|
|
|
switch (Cmd) {
|
|
case Show:
|
|
return show(argc, argv, commandLineParser);
|
|
case Report:
|
|
return report(argc, argv, commandLineParser);
|
|
}
|
|
return 0;
|
|
}
|
|
|
|
int CodeCoverageTool::show(int argc, const char **argv,
|
|
CommandLineParserType commandLineParser) {
|
|
|
|
cl::OptionCategory ViewCategory("Viewing options");
|
|
|
|
cl::opt<bool> ShowLineExecutionCounts(
|
|
"show-line-counts", cl::Optional,
|
|
cl::desc("Show the execution counts for each line"), cl::init(true),
|
|
cl::cat(ViewCategory));
|
|
|
|
cl::opt<bool> ShowRegions(
|
|
"show-regions", cl::Optional,
|
|
cl::desc("Show the execution counts for each region"),
|
|
cl::cat(ViewCategory));
|
|
|
|
cl::opt<bool> ShowBestLineRegionsCounts(
|
|
"show-line-counts-or-regions", cl::Optional,
|
|
cl::desc("Show the execution counts for each line, or the execution "
|
|
"counts for each region on lines that have multiple regions"),
|
|
cl::cat(ViewCategory));
|
|
|
|
cl::opt<bool> ShowExpansions("show-expansions", cl::Optional,
|
|
cl::desc("Show expanded source regions"),
|
|
cl::cat(ViewCategory));
|
|
|
|
cl::opt<bool> ShowInstantiations("show-instantiations", cl::Optional,
|
|
cl::desc("Show function instantiations"),
|
|
cl::cat(ViewCategory));
|
|
|
|
cl::opt<bool> NoColors("no-colors", cl::Optional,
|
|
cl::desc("Don't show text colors"), cl::init(false),
|
|
cl::cat(ViewCategory));
|
|
|
|
auto Err = commandLineParser(argc, argv);
|
|
if (Err)
|
|
return Err;
|
|
|
|
ViewOpts.Colors = !NoColors;
|
|
ViewOpts.ShowLineNumbers = true;
|
|
ViewOpts.ShowLineStats = ShowLineExecutionCounts.getNumOccurrences() != 0 ||
|
|
!ShowRegions || ShowBestLineRegionsCounts;
|
|
ViewOpts.ShowRegionMarkers = ShowRegions || ShowBestLineRegionsCounts;
|
|
ViewOpts.ShowLineStatsOrRegionMarkers = ShowBestLineRegionsCounts;
|
|
ViewOpts.ShowExpandedRegions = ShowExpansions;
|
|
ViewOpts.ShowFunctionInstantiations = ShowInstantiations;
|
|
|
|
auto Coverage = load();
|
|
if (!Coverage)
|
|
return 1;
|
|
|
|
if (!Filters.empty()) {
|
|
// Show functions
|
|
for (const auto &Function : Coverage->getCoveredFunctions()) {
|
|
if (!Filters.matches(Function))
|
|
continue;
|
|
|
|
auto mainView = createFunctionView(Function, *Coverage);
|
|
if (!mainView) {
|
|
ViewOpts.colored_ostream(outs(), raw_ostream::RED)
|
|
<< "warning: Could not read coverage for '" << Function.Name;
|
|
outs() << "\n";
|
|
continue;
|
|
}
|
|
ViewOpts.colored_ostream(outs(), raw_ostream::CYAN) << Function.Name
|
|
<< ":";
|
|
outs() << "\n";
|
|
mainView->render(outs(), /*WholeFile=*/false);
|
|
outs() << "\n";
|
|
}
|
|
return 0;
|
|
}
|
|
|
|
// Show files
|
|
bool ShowFilenames = SourceFiles.size() != 1;
|
|
|
|
if (SourceFiles.empty())
|
|
// Get the source files from the function coverage mapping
|
|
for (StringRef Filename : Coverage->getUniqueSourceFiles())
|
|
SourceFiles.push_back(Filename);
|
|
|
|
for (const auto &SourceFile : SourceFiles) {
|
|
auto mainView = createSourceFileView(SourceFile, *Coverage);
|
|
if (!mainView) {
|
|
ViewOpts.colored_ostream(outs(), raw_ostream::RED)
|
|
<< "warning: The file '" << SourceFile << "' isn't covered.";
|
|
outs() << "\n";
|
|
continue;
|
|
}
|
|
|
|
if (ShowFilenames) {
|
|
ViewOpts.colored_ostream(outs(), raw_ostream::CYAN) << SourceFile << ":";
|
|
outs() << "\n";
|
|
}
|
|
mainView->render(outs(), /*Wholefile=*/true);
|
|
if (SourceFiles.size() > 1)
|
|
outs() << "\n";
|
|
}
|
|
|
|
return 0;
|
|
}
|
|
|
|
int CodeCoverageTool::report(int argc, const char **argv,
|
|
CommandLineParserType commandLineParser) {
|
|
cl::opt<bool> NoColors("no-colors", cl::Optional,
|
|
cl::desc("Don't show text colors"), cl::init(false));
|
|
|
|
auto Err = commandLineParser(argc, argv);
|
|
if (Err)
|
|
return Err;
|
|
|
|
ViewOpts.Colors = !NoColors;
|
|
|
|
auto Coverage = load();
|
|
if (!Coverage)
|
|
return 1;
|
|
|
|
CoverageSummary Summarizer;
|
|
Summarizer.createSummaries(Coverage->getCoveredFunctions());
|
|
CoverageReport Report(ViewOpts, Summarizer);
|
|
if (SourceFiles.empty() && Filters.empty()) {
|
|
Report.renderFileReports(llvm::outs());
|
|
return 0;
|
|
}
|
|
|
|
Report.renderFunctionReports(llvm::outs());
|
|
return 0;
|
|
}
|
|
|
|
int show_main(int argc, const char **argv) {
|
|
CodeCoverageTool Tool;
|
|
return Tool.run(CodeCoverageTool::Show, argc, argv);
|
|
}
|
|
|
|
int report_main(int argc, const char **argv) {
|
|
CodeCoverageTool Tool;
|
|
return Tool.run(CodeCoverageTool::Report, argc, argv);
|
|
}
|