1 //===- CodeCoverage.cpp - Coverage tool based on profiling instrumentation-===// 2 // 3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. 4 // See https://llvm.org/LICENSE.txt for license information. 5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception 6 // 7 //===----------------------------------------------------------------------===// 8 // 9 // The 'CodeCoverageTool' class implements a command line tool to analyze and 10 // report coverage information using the profiling instrumentation and code 11 // coverage mapping. 12 // 13 //===----------------------------------------------------------------------===// 14 15 #include "CoverageExporterJson.h" 16 #include "CoverageExporterLcov.h" 17 #include "CoverageFilters.h" 18 #include "CoverageReport.h" 19 #include "CoverageSummaryInfo.h" 20 #include "CoverageViewOptions.h" 21 #include "RenderingSupport.h" 22 #include "SourceCoverageView.h" 23 #include "llvm/ADT/SmallString.h" 24 #include "llvm/ADT/StringRef.h" 25 #include "llvm/ADT/Triple.h" 26 #include "llvm/ProfileData/Coverage/CoverageMapping.h" 27 #include "llvm/ProfileData/InstrProfReader.h" 28 #include "llvm/Support/CommandLine.h" 29 #include "llvm/Support/FileSystem.h" 30 #include "llvm/Support/Format.h" 31 #include "llvm/Support/MemoryBuffer.h" 32 #include "llvm/Support/Path.h" 33 #include "llvm/Support/Process.h" 34 #include "llvm/Support/Program.h" 35 #include "llvm/Support/ScopedPrinter.h" 36 #include "llvm/Support/SpecialCaseList.h" 37 #include "llvm/Support/ThreadPool.h" 38 #include "llvm/Support/Threading.h" 39 #include "llvm/Support/ToolOutputFile.h" 40 #include "llvm/Support/VirtualFileSystem.h" 41 42 #include <functional> 43 #include <map> 44 #include <optional> 45 #include <system_error> 46 47 using namespace llvm; 48 using namespace coverage; 49 50 void exportCoverageDataToJson(const coverage::CoverageMapping &CoverageMapping, 51 const CoverageViewOptions &Options, 52 raw_ostream &OS); 53 54 namespace { 55 /// The implementation of the coverage tool. 56 class CodeCoverageTool { 57 public: 58 enum Command { 59 /// The show command. 60 Show, 61 /// The report command. 62 Report, 63 /// The export command. 64 Export 65 }; 66 67 int run(Command Cmd, int argc, const char **argv); 68 69 private: 70 /// Print the error message to the error output stream. 71 void error(const Twine &Message, StringRef Whence = ""); 72 73 /// Print the warning message to the error output stream. 74 void warning(const Twine &Message, StringRef Whence = ""); 75 76 /// Convert \p Path into an absolute path and append it to the list 77 /// of collected paths. 78 void addCollectedPath(const std::string &Path); 79 80 /// If \p Path is a regular file, collect the path. If it's a 81 /// directory, recursively collect all of the paths within the directory. 82 void collectPaths(const std::string &Path); 83 84 /// Check if the two given files are the same file. 85 bool isEquivalentFile(StringRef FilePath1, StringRef FilePath2); 86 87 /// Retrieve a file status with a cache. 88 Optional<sys::fs::file_status> getFileStatus(StringRef FilePath); 89 90 /// Return a memory buffer for the given source file. 91 ErrorOr<const MemoryBuffer &> getSourceFile(StringRef SourceFile); 92 93 /// Create source views for the expansions of the view. 94 void attachExpansionSubViews(SourceCoverageView &View, 95 ArrayRef<ExpansionRecord> Expansions, 96 const CoverageMapping &Coverage); 97 98 /// Create source views for the branches of the view. 99 void attachBranchSubViews(SourceCoverageView &View, StringRef SourceName, 100 ArrayRef<CountedRegion> Branches, 101 const MemoryBuffer &File, 102 CoverageData &CoverageInfo); 103 104 /// Create the source view of a particular function. 105 std::unique_ptr<SourceCoverageView> 106 createFunctionView(const FunctionRecord &Function, 107 const CoverageMapping &Coverage); 108 109 /// Create the main source view of a particular source file. 110 std::unique_ptr<SourceCoverageView> 111 createSourceFileView(StringRef SourceFile, const CoverageMapping &Coverage); 112 113 /// Load the coverage mapping data. Return nullptr if an error occurred. 114 std::unique_ptr<CoverageMapping> load(); 115 116 /// Create a mapping from files in the Coverage data to local copies 117 /// (path-equivalence). 118 void remapPathNames(const CoverageMapping &Coverage); 119 120 /// Remove input source files which aren't mapped by \p Coverage. 121 void removeUnmappedInputs(const CoverageMapping &Coverage); 122 123 /// If a demangler is available, demangle all symbol names. 124 void demangleSymbols(const CoverageMapping &Coverage); 125 126 /// Write out a source file view to the filesystem. 127 void writeSourceFileView(StringRef SourceFile, CoverageMapping *Coverage, 128 CoveragePrinter *Printer, bool ShowFilenames); 129 130 typedef llvm::function_ref<int(int, const char **)> CommandLineParserType; 131 132 int doShow(int argc, const char **argv, 133 CommandLineParserType commandLineParser); 134 135 int doReport(int argc, const char **argv, 136 CommandLineParserType commandLineParser); 137 138 int doExport(int argc, const char **argv, 139 CommandLineParserType commandLineParser); 140 141 std::vector<StringRef> ObjectFilenames; 142 CoverageViewOptions ViewOpts; 143 CoverageFiltersMatchAll Filters; 144 CoverageFilters IgnoreFilenameFilters; 145 146 /// True if InputSourceFiles are provided. 147 bool HadSourceFiles = false; 148 149 /// The path to the indexed profile. 150 std::string PGOFilename; 151 152 /// A list of input source files. 153 std::vector<std::string> SourceFiles; 154 155 /// In -path-equivalence mode, this maps the absolute paths from the coverage 156 /// mapping data to the input source files. 157 StringMap<std::string> RemappedFilenames; 158 159 /// The coverage data path to be remapped from, and the source path to be 160 /// remapped to, when using -path-equivalence. 161 std::optional<std::pair<std::string, std::string>> PathRemapping; 162 163 /// File status cache used when finding the same file. 164 StringMap<Optional<sys::fs::file_status>> FileStatusCache; 165 166 /// The architecture the coverage mapping data targets. 167 std::vector<StringRef> CoverageArches; 168 169 /// A cache for demangled symbols. 170 DemangleCache DC; 171 172 /// A lock which guards printing to stderr. 173 std::mutex ErrsLock; 174 175 /// A container for input source file buffers. 176 std::mutex LoadedSourceFilesLock; 177 std::vector<std::pair<std::string, std::unique_ptr<MemoryBuffer>>> 178 LoadedSourceFiles; 179 180 /// Allowlist from -name-allowlist to be used for filtering. 181 std::unique_ptr<SpecialCaseList> NameAllowlist; 182 }; 183 } 184 185 static std::string getErrorString(const Twine &Message, StringRef Whence, 186 bool Warning) { 187 std::string Str = (Warning ? "warning" : "error"); 188 Str += ": "; 189 if (!Whence.empty()) 190 Str += Whence.str() + ": "; 191 Str += Message.str() + "\n"; 192 return Str; 193 } 194 195 void CodeCoverageTool::error(const Twine &Message, StringRef Whence) { 196 std::unique_lock<std::mutex> Guard{ErrsLock}; 197 ViewOpts.colored_ostream(errs(), raw_ostream::RED) 198 << getErrorString(Message, Whence, false); 199 } 200 201 void CodeCoverageTool::warning(const Twine &Message, StringRef Whence) { 202 std::unique_lock<std::mutex> Guard{ErrsLock}; 203 ViewOpts.colored_ostream(errs(), raw_ostream::RED) 204 << getErrorString(Message, Whence, true); 205 } 206 207 void CodeCoverageTool::addCollectedPath(const std::string &Path) { 208 SmallString<128> EffectivePath(Path); 209 if (std::error_code EC = sys::fs::make_absolute(EffectivePath)) { 210 error(EC.message(), Path); 211 return; 212 } 213 sys::path::remove_dots(EffectivePath, /*remove_dot_dot=*/true); 214 if (!IgnoreFilenameFilters.matchesFilename(EffectivePath)) 215 SourceFiles.emplace_back(EffectivePath.str()); 216 HadSourceFiles = !SourceFiles.empty(); 217 } 218 219 void CodeCoverageTool::collectPaths(const std::string &Path) { 220 llvm::sys::fs::file_status Status; 221 llvm::sys::fs::status(Path, Status); 222 if (!llvm::sys::fs::exists(Status)) { 223 if (PathRemapping) 224 addCollectedPath(Path); 225 else 226 warning("Source file doesn't exist, proceeded by ignoring it.", Path); 227 return; 228 } 229 230 if (llvm::sys::fs::is_regular_file(Status)) { 231 addCollectedPath(Path); 232 return; 233 } 234 235 if (llvm::sys::fs::is_directory(Status)) { 236 std::error_code EC; 237 for (llvm::sys::fs::recursive_directory_iterator F(Path, EC), E; 238 F != E; F.increment(EC)) { 239 240 auto Status = F->status(); 241 if (!Status) { 242 warning(Status.getError().message(), F->path()); 243 continue; 244 } 245 246 if (Status->type() == llvm::sys::fs::file_type::regular_file) 247 addCollectedPath(F->path()); 248 } 249 } 250 } 251 252 Optional<sys::fs::file_status> 253 CodeCoverageTool::getFileStatus(StringRef FilePath) { 254 auto It = FileStatusCache.try_emplace(FilePath); 255 auto &CachedStatus = It.first->getValue(); 256 if (!It.second) 257 return CachedStatus; 258 259 sys::fs::file_status Status; 260 if (!sys::fs::status(FilePath, Status)) 261 CachedStatus = Status; 262 return CachedStatus; 263 } 264 265 bool CodeCoverageTool::isEquivalentFile(StringRef FilePath1, 266 StringRef FilePath2) { 267 auto Status1 = getFileStatus(FilePath1); 268 auto Status2 = getFileStatus(FilePath2); 269 return Status1 && Status2 && sys::fs::equivalent(*Status1, *Status2); 270 } 271 272 ErrorOr<const MemoryBuffer &> 273 CodeCoverageTool::getSourceFile(StringRef SourceFile) { 274 // If we've remapped filenames, look up the real location for this file. 275 std::unique_lock<std::mutex> Guard{LoadedSourceFilesLock}; 276 if (!RemappedFilenames.empty()) { 277 auto Loc = RemappedFilenames.find(SourceFile); 278 if (Loc != RemappedFilenames.end()) 279 SourceFile = Loc->second; 280 } 281 for (const auto &Files : LoadedSourceFiles) 282 if (isEquivalentFile(SourceFile, Files.first)) 283 return *Files.second; 284 auto Buffer = MemoryBuffer::getFile(SourceFile); 285 if (auto EC = Buffer.getError()) { 286 error(EC.message(), SourceFile); 287 return EC; 288 } 289 LoadedSourceFiles.emplace_back(std::string(SourceFile), 290 std::move(Buffer.get())); 291 return *LoadedSourceFiles.back().second; 292 } 293 294 void CodeCoverageTool::attachExpansionSubViews( 295 SourceCoverageView &View, ArrayRef<ExpansionRecord> Expansions, 296 const CoverageMapping &Coverage) { 297 if (!ViewOpts.ShowExpandedRegions) 298 return; 299 for (const auto &Expansion : Expansions) { 300 auto ExpansionCoverage = Coverage.getCoverageForExpansion(Expansion); 301 if (ExpansionCoverage.empty()) 302 continue; 303 auto SourceBuffer = getSourceFile(ExpansionCoverage.getFilename()); 304 if (!SourceBuffer) 305 continue; 306 307 auto SubViewBranches = ExpansionCoverage.getBranches(); 308 auto SubViewExpansions = ExpansionCoverage.getExpansions(); 309 auto SubView = 310 SourceCoverageView::create(Expansion.Function.Name, SourceBuffer.get(), 311 ViewOpts, std::move(ExpansionCoverage)); 312 attachExpansionSubViews(*SubView, SubViewExpansions, Coverage); 313 attachBranchSubViews(*SubView, Expansion.Function.Name, SubViewBranches, 314 SourceBuffer.get(), ExpansionCoverage); 315 View.addExpansion(Expansion.Region, std::move(SubView)); 316 } 317 } 318 319 void CodeCoverageTool::attachBranchSubViews(SourceCoverageView &View, 320 StringRef SourceName, 321 ArrayRef<CountedRegion> Branches, 322 const MemoryBuffer &File, 323 CoverageData &CoverageInfo) { 324 if (!ViewOpts.ShowBranchCounts && !ViewOpts.ShowBranchPercents) 325 return; 326 327 const auto *NextBranch = Branches.begin(); 328 const auto *EndBranch = Branches.end(); 329 330 // Group branches that have the same line number into the same subview. 331 while (NextBranch != EndBranch) { 332 std::vector<CountedRegion> ViewBranches; 333 unsigned CurrentLine = NextBranch->LineStart; 334 335 while (NextBranch != EndBranch && CurrentLine == NextBranch->LineStart) 336 ViewBranches.push_back(*NextBranch++); 337 338 if (!ViewBranches.empty()) { 339 auto SubView = SourceCoverageView::create(SourceName, File, ViewOpts, 340 std::move(CoverageInfo)); 341 View.addBranch(CurrentLine, ViewBranches, std::move(SubView)); 342 } 343 } 344 } 345 346 std::unique_ptr<SourceCoverageView> 347 CodeCoverageTool::createFunctionView(const FunctionRecord &Function, 348 const CoverageMapping &Coverage) { 349 auto FunctionCoverage = Coverage.getCoverageForFunction(Function); 350 if (FunctionCoverage.empty()) 351 return nullptr; 352 auto SourceBuffer = getSourceFile(FunctionCoverage.getFilename()); 353 if (!SourceBuffer) 354 return nullptr; 355 356 auto Branches = FunctionCoverage.getBranches(); 357 auto Expansions = FunctionCoverage.getExpansions(); 358 auto View = SourceCoverageView::create(DC.demangle(Function.Name), 359 SourceBuffer.get(), ViewOpts, 360 std::move(FunctionCoverage)); 361 attachExpansionSubViews(*View, Expansions, Coverage); 362 attachBranchSubViews(*View, DC.demangle(Function.Name), Branches, 363 SourceBuffer.get(), FunctionCoverage); 364 365 return View; 366 } 367 368 std::unique_ptr<SourceCoverageView> 369 CodeCoverageTool::createSourceFileView(StringRef SourceFile, 370 const CoverageMapping &Coverage) { 371 auto SourceBuffer = getSourceFile(SourceFile); 372 if (!SourceBuffer) 373 return nullptr; 374 auto FileCoverage = Coverage.getCoverageForFile(SourceFile); 375 if (FileCoverage.empty()) 376 return nullptr; 377 378 auto Branches = FileCoverage.getBranches(); 379 auto Expansions = FileCoverage.getExpansions(); 380 auto View = SourceCoverageView::create(SourceFile, SourceBuffer.get(), 381 ViewOpts, std::move(FileCoverage)); 382 attachExpansionSubViews(*View, Expansions, Coverage); 383 attachBranchSubViews(*View, SourceFile, Branches, SourceBuffer.get(), 384 FileCoverage); 385 if (!ViewOpts.ShowFunctionInstantiations) 386 return View; 387 388 for (const auto &Group : Coverage.getInstantiationGroups(SourceFile)) { 389 // Skip functions which have a single instantiation. 390 if (Group.size() < 2) 391 continue; 392 393 for (const FunctionRecord *Function : Group.getInstantiations()) { 394 std::unique_ptr<SourceCoverageView> SubView{nullptr}; 395 396 StringRef Funcname = DC.demangle(Function->Name); 397 398 if (Function->ExecutionCount > 0) { 399 auto SubViewCoverage = Coverage.getCoverageForFunction(*Function); 400 auto SubViewExpansions = SubViewCoverage.getExpansions(); 401 auto SubViewBranches = SubViewCoverage.getBranches(); 402 SubView = SourceCoverageView::create( 403 Funcname, SourceBuffer.get(), ViewOpts, std::move(SubViewCoverage)); 404 attachExpansionSubViews(*SubView, SubViewExpansions, Coverage); 405 attachBranchSubViews(*SubView, SourceFile, SubViewBranches, 406 SourceBuffer.get(), SubViewCoverage); 407 } 408 409 unsigned FileID = Function->CountedRegions.front().FileID; 410 unsigned Line = 0; 411 for (const auto &CR : Function->CountedRegions) 412 if (CR.FileID == FileID) 413 Line = std::max(CR.LineEnd, Line); 414 View->addInstantiation(Funcname, Line, std::move(SubView)); 415 } 416 } 417 return View; 418 } 419 420 static bool modifiedTimeGT(StringRef LHS, StringRef RHS) { 421 sys::fs::file_status Status; 422 if (sys::fs::status(LHS, Status)) 423 return false; 424 auto LHSTime = Status.getLastModificationTime(); 425 if (sys::fs::status(RHS, Status)) 426 return false; 427 auto RHSTime = Status.getLastModificationTime(); 428 return LHSTime > RHSTime; 429 } 430 431 std::unique_ptr<CoverageMapping> CodeCoverageTool::load() { 432 for (StringRef ObjectFilename : ObjectFilenames) 433 if (modifiedTimeGT(ObjectFilename, PGOFilename)) 434 warning("profile data may be out of date - object is newer", 435 ObjectFilename); 436 auto CoverageOrErr = 437 CoverageMapping::load(ObjectFilenames, PGOFilename, CoverageArches, 438 ViewOpts.CompilationDirectory); 439 if (Error E = CoverageOrErr.takeError()) { 440 error("Failed to load coverage: " + toString(std::move(E))); 441 return nullptr; 442 } 443 auto Coverage = std::move(CoverageOrErr.get()); 444 unsigned Mismatched = Coverage->getMismatchedCount(); 445 if (Mismatched) { 446 warning(Twine(Mismatched) + " functions have mismatched data"); 447 448 if (ViewOpts.Debug) { 449 for (const auto &HashMismatch : Coverage->getHashMismatches()) 450 errs() << "hash-mismatch: " 451 << "No profile record found for '" << HashMismatch.first << "'" 452 << " with hash = 0x" << Twine::utohexstr(HashMismatch.second) 453 << '\n'; 454 } 455 } 456 457 remapPathNames(*Coverage); 458 459 if (!SourceFiles.empty()) 460 removeUnmappedInputs(*Coverage); 461 462 demangleSymbols(*Coverage); 463 464 return Coverage; 465 } 466 467 void CodeCoverageTool::remapPathNames(const CoverageMapping &Coverage) { 468 if (!PathRemapping) 469 return; 470 471 // Convert remapping paths to native paths with trailing seperators. 472 auto nativeWithTrailing = [](StringRef Path) -> std::string { 473 if (Path.empty()) 474 return ""; 475 SmallString<128> NativePath; 476 sys::path::native(Path, NativePath); 477 sys::path::remove_dots(NativePath, true); 478 if (!NativePath.empty() && !sys::path::is_separator(NativePath.back())) 479 NativePath += sys::path::get_separator(); 480 return NativePath.c_str(); 481 }; 482 std::string RemapFrom = nativeWithTrailing(PathRemapping->first); 483 std::string RemapTo = nativeWithTrailing(PathRemapping->second); 484 485 // Create a mapping from coverage data file paths to local paths. 486 for (StringRef Filename : Coverage.getUniqueSourceFiles()) { 487 SmallString<128> NativeFilename; 488 sys::path::native(Filename, NativeFilename); 489 sys::path::remove_dots(NativeFilename, true); 490 if (NativeFilename.startswith(RemapFrom)) { 491 RemappedFilenames[Filename] = 492 RemapTo + NativeFilename.substr(RemapFrom.size()).str(); 493 } 494 } 495 496 // Convert input files from local paths to coverage data file paths. 497 StringMap<std::string> InvRemappedFilenames; 498 for (const auto &RemappedFilename : RemappedFilenames) 499 InvRemappedFilenames[RemappedFilename.getValue()] = 500 std::string(RemappedFilename.getKey()); 501 502 for (std::string &Filename : SourceFiles) { 503 SmallString<128> NativeFilename; 504 sys::path::native(Filename, NativeFilename); 505 auto CovFileName = InvRemappedFilenames.find(NativeFilename); 506 if (CovFileName != InvRemappedFilenames.end()) 507 Filename = CovFileName->second; 508 } 509 } 510 511 void CodeCoverageTool::removeUnmappedInputs(const CoverageMapping &Coverage) { 512 std::vector<StringRef> CoveredFiles = Coverage.getUniqueSourceFiles(); 513 514 // The user may have specified source files which aren't in the coverage 515 // mapping. Filter these files away. 516 llvm::erase_if(SourceFiles, [&](const std::string &SF) { 517 return !std::binary_search(CoveredFiles.begin(), CoveredFiles.end(), SF); 518 }); 519 } 520 521 void CodeCoverageTool::demangleSymbols(const CoverageMapping &Coverage) { 522 if (!ViewOpts.hasDemangler()) 523 return; 524 525 // Pass function names to the demangler in a temporary file. 526 int InputFD; 527 SmallString<256> InputPath; 528 std::error_code EC = 529 sys::fs::createTemporaryFile("demangle-in", "list", InputFD, InputPath); 530 if (EC) { 531 error(InputPath, EC.message()); 532 return; 533 } 534 ToolOutputFile InputTOF{InputPath, InputFD}; 535 536 unsigned NumSymbols = 0; 537 for (const auto &Function : Coverage.getCoveredFunctions()) { 538 InputTOF.os() << Function.Name << '\n'; 539 ++NumSymbols; 540 } 541 InputTOF.os().close(); 542 543 // Use another temporary file to store the demangler's output. 544 int OutputFD; 545 SmallString<256> OutputPath; 546 EC = sys::fs::createTemporaryFile("demangle-out", "list", OutputFD, 547 OutputPath); 548 if (EC) { 549 error(OutputPath, EC.message()); 550 return; 551 } 552 ToolOutputFile OutputTOF{OutputPath, OutputFD}; 553 OutputTOF.os().close(); 554 555 // Invoke the demangler. 556 std::vector<StringRef> ArgsV; 557 for (StringRef Arg : ViewOpts.DemanglerOpts) 558 ArgsV.push_back(Arg); 559 std::optional<StringRef> Redirects[] = { 560 InputPath.str(), OutputPath.str(), {""}}; 561 std::string ErrMsg; 562 int RC = sys::ExecuteAndWait(ViewOpts.DemanglerOpts[0], ArgsV, 563 /*env=*/None, Redirects, /*secondsToWait=*/0, 564 /*memoryLimit=*/0, &ErrMsg); 565 if (RC) { 566 error(ErrMsg, ViewOpts.DemanglerOpts[0]); 567 return; 568 } 569 570 // Parse the demangler's output. 571 auto BufOrError = MemoryBuffer::getFile(OutputPath); 572 if (!BufOrError) { 573 error(OutputPath, BufOrError.getError().message()); 574 return; 575 } 576 577 std::unique_ptr<MemoryBuffer> DemanglerBuf = std::move(*BufOrError); 578 579 SmallVector<StringRef, 8> Symbols; 580 StringRef DemanglerData = DemanglerBuf->getBuffer(); 581 DemanglerData.split(Symbols, '\n', /*MaxSplit=*/NumSymbols, 582 /*KeepEmpty=*/false); 583 if (Symbols.size() != NumSymbols) { 584 error("Demangler did not provide expected number of symbols"); 585 return; 586 } 587 588 // Cache the demangled names. 589 unsigned I = 0; 590 for (const auto &Function : Coverage.getCoveredFunctions()) 591 // On Windows, lines in the demangler's output file end with "\r\n". 592 // Splitting by '\n' keeps '\r's, so cut them now. 593 DC.DemangledNames[Function.Name] = std::string(Symbols[I++].rtrim()); 594 } 595 596 void CodeCoverageTool::writeSourceFileView(StringRef SourceFile, 597 CoverageMapping *Coverage, 598 CoveragePrinter *Printer, 599 bool ShowFilenames) { 600 auto View = createSourceFileView(SourceFile, *Coverage); 601 if (!View) { 602 warning("The file '" + SourceFile + "' isn't covered."); 603 return; 604 } 605 606 auto OSOrErr = Printer->createViewFile(SourceFile, /*InToplevel=*/false); 607 if (Error E = OSOrErr.takeError()) { 608 error("Could not create view file!", toString(std::move(E))); 609 return; 610 } 611 auto OS = std::move(OSOrErr.get()); 612 613 View->print(*OS.get(), /*Wholefile=*/true, 614 /*ShowSourceName=*/ShowFilenames, 615 /*ShowTitle=*/ViewOpts.hasOutputDirectory()); 616 Printer->closeViewFile(std::move(OS)); 617 } 618 619 int CodeCoverageTool::run(Command Cmd, int argc, const char **argv) { 620 cl::opt<std::string> CovFilename( 621 cl::Positional, cl::desc("Covered executable or object file.")); 622 623 cl::list<std::string> CovFilenames( 624 "object", cl::desc("Coverage executable or object file")); 625 626 cl::opt<bool> DebugDumpCollectedObjects( 627 "dump-collected-objects", cl::Optional, cl::Hidden, 628 cl::desc("Show the collected coverage object files")); 629 630 cl::list<std::string> InputSourceFiles(cl::Positional, 631 cl::desc("<Source files>")); 632 633 cl::opt<bool> DebugDumpCollectedPaths( 634 "dump-collected-paths", cl::Optional, cl::Hidden, 635 cl::desc("Show the collected paths to source files")); 636 637 cl::opt<std::string, true> PGOFilename( 638 "instr-profile", cl::Required, cl::location(this->PGOFilename), 639 cl::desc( 640 "File with the profile data obtained after an instrumented run")); 641 642 cl::list<std::string> Arches( 643 "arch", cl::desc("architectures of the coverage mapping binaries")); 644 645 cl::opt<bool> DebugDump("dump", cl::Optional, 646 cl::desc("Show internal debug dump")); 647 648 cl::opt<CoverageViewOptions::OutputFormat> Format( 649 "format", cl::desc("Output format for line-based coverage reports"), 650 cl::values(clEnumValN(CoverageViewOptions::OutputFormat::Text, "text", 651 "Text output"), 652 clEnumValN(CoverageViewOptions::OutputFormat::HTML, "html", 653 "HTML output"), 654 clEnumValN(CoverageViewOptions::OutputFormat::Lcov, "lcov", 655 "lcov tracefile output")), 656 cl::init(CoverageViewOptions::OutputFormat::Text)); 657 658 cl::opt<std::string> PathRemap( 659 "path-equivalence", cl::Optional, 660 cl::desc("<from>,<to> Map coverage data paths to local source file " 661 "paths")); 662 663 cl::OptionCategory FilteringCategory("Function filtering options"); 664 665 cl::list<std::string> NameFilters( 666 "name", cl::Optional, 667 cl::desc("Show code coverage only for functions with the given name"), 668 cl::cat(FilteringCategory)); 669 670 cl::list<std::string> NameFilterFiles( 671 "name-allowlist", cl::Optional, 672 cl::desc("Show code coverage only for functions listed in the given " 673 "file"), 674 cl::cat(FilteringCategory)); 675 676 cl::list<std::string> NameRegexFilters( 677 "name-regex", cl::Optional, 678 cl::desc("Show code coverage only for functions that match the given " 679 "regular expression"), 680 cl::cat(FilteringCategory)); 681 682 cl::list<std::string> IgnoreFilenameRegexFilters( 683 "ignore-filename-regex", cl::Optional, 684 cl::desc("Skip source code files with file paths that match the given " 685 "regular expression"), 686 cl::cat(FilteringCategory)); 687 688 cl::opt<double> RegionCoverageLtFilter( 689 "region-coverage-lt", cl::Optional, 690 cl::desc("Show code coverage only for functions with region coverage " 691 "less than the given threshold"), 692 cl::cat(FilteringCategory)); 693 694 cl::opt<double> RegionCoverageGtFilter( 695 "region-coverage-gt", cl::Optional, 696 cl::desc("Show code coverage only for functions with region coverage " 697 "greater than the given threshold"), 698 cl::cat(FilteringCategory)); 699 700 cl::opt<double> LineCoverageLtFilter( 701 "line-coverage-lt", cl::Optional, 702 cl::desc("Show code coverage only for functions with line coverage less " 703 "than the given threshold"), 704 cl::cat(FilteringCategory)); 705 706 cl::opt<double> LineCoverageGtFilter( 707 "line-coverage-gt", cl::Optional, 708 cl::desc("Show code coverage only for functions with line coverage " 709 "greater than the given threshold"), 710 cl::cat(FilteringCategory)); 711 712 cl::opt<cl::boolOrDefault> UseColor( 713 "use-color", cl::desc("Emit colored output (default=autodetect)"), 714 cl::init(cl::BOU_UNSET)); 715 716 cl::list<std::string> DemanglerOpts( 717 "Xdemangler", cl::desc("<demangler-path>|<demangler-option>")); 718 719 cl::opt<bool> RegionSummary( 720 "show-region-summary", cl::Optional, 721 cl::desc("Show region statistics in summary table"), 722 cl::init(true)); 723 724 cl::opt<bool> BranchSummary( 725 "show-branch-summary", cl::Optional, 726 cl::desc("Show branch condition statistics in summary table"), 727 cl::init(true)); 728 729 cl::opt<bool> InstantiationSummary( 730 "show-instantiation-summary", cl::Optional, 731 cl::desc("Show instantiation statistics in summary table")); 732 733 cl::opt<bool> SummaryOnly( 734 "summary-only", cl::Optional, 735 cl::desc("Export only summary information for each source file")); 736 737 cl::opt<unsigned> NumThreads( 738 "num-threads", cl::init(0), 739 cl::desc("Number of merge threads to use (default: autodetect)")); 740 cl::alias NumThreadsA("j", cl::desc("Alias for --num-threads"), 741 cl::aliasopt(NumThreads)); 742 743 cl::opt<std::string> CompilationDirectory( 744 "compilation-dir", cl::init(""), 745 cl::desc("Directory used as a base for relative coverage mapping paths")); 746 747 auto commandLineParser = [&, this](int argc, const char **argv) -> int { 748 cl::ParseCommandLineOptions(argc, argv, "LLVM code coverage tool\n"); 749 ViewOpts.Debug = DebugDump; 750 751 if (!CovFilename.empty()) 752 ObjectFilenames.emplace_back(CovFilename); 753 for (const std::string &Filename : CovFilenames) 754 ObjectFilenames.emplace_back(Filename); 755 if (ObjectFilenames.empty()) { 756 errs() << "No filenames specified!\n"; 757 ::exit(1); 758 } 759 760 if (DebugDumpCollectedObjects) { 761 for (StringRef OF : ObjectFilenames) 762 outs() << OF << '\n'; 763 ::exit(0); 764 } 765 766 ViewOpts.Format = Format; 767 switch (ViewOpts.Format) { 768 case CoverageViewOptions::OutputFormat::Text: 769 ViewOpts.Colors = UseColor == cl::BOU_UNSET 770 ? sys::Process::StandardOutHasColors() 771 : UseColor == cl::BOU_TRUE; 772 break; 773 case CoverageViewOptions::OutputFormat::HTML: 774 if (UseColor == cl::BOU_FALSE) 775 errs() << "Color output cannot be disabled when generating html.\n"; 776 ViewOpts.Colors = true; 777 break; 778 case CoverageViewOptions::OutputFormat::Lcov: 779 if (UseColor == cl::BOU_TRUE) 780 errs() << "Color output cannot be enabled when generating lcov.\n"; 781 ViewOpts.Colors = false; 782 break; 783 } 784 785 // If path-equivalence was given and is a comma seperated pair then set 786 // PathRemapping. 787 if (!PathRemap.empty()) { 788 auto EquivPair = StringRef(PathRemap).split(','); 789 if (EquivPair.first.empty() || EquivPair.second.empty()) { 790 error("invalid argument '" + PathRemap + 791 "', must be in format 'from,to'", 792 "-path-equivalence"); 793 return 1; 794 } 795 796 PathRemapping = {std::string(EquivPair.first), 797 std::string(EquivPair.second)}; 798 } 799 800 // If a demangler is supplied, check if it exists and register it. 801 if (!DemanglerOpts.empty()) { 802 auto DemanglerPathOrErr = sys::findProgramByName(DemanglerOpts[0]); 803 if (!DemanglerPathOrErr) { 804 error("Could not find the demangler!", 805 DemanglerPathOrErr.getError().message()); 806 return 1; 807 } 808 DemanglerOpts[0] = *DemanglerPathOrErr; 809 ViewOpts.DemanglerOpts.swap(DemanglerOpts); 810 } 811 812 // Read in -name-allowlist files. 813 if (!NameFilterFiles.empty()) { 814 std::string SpecialCaseListErr; 815 NameAllowlist = SpecialCaseList::create( 816 NameFilterFiles, *vfs::getRealFileSystem(), SpecialCaseListErr); 817 if (!NameAllowlist) 818 error(SpecialCaseListErr); 819 } 820 821 // Create the function filters 822 if (!NameFilters.empty() || NameAllowlist || !NameRegexFilters.empty()) { 823 auto NameFilterer = std::make_unique<CoverageFilters>(); 824 for (const auto &Name : NameFilters) 825 NameFilterer->push_back(std::make_unique<NameCoverageFilter>(Name)); 826 if (NameAllowlist && !NameFilterFiles.empty()) 827 NameFilterer->push_back( 828 std::make_unique<NameAllowlistCoverageFilter>(*NameAllowlist)); 829 for (const auto &Regex : NameRegexFilters) 830 NameFilterer->push_back( 831 std::make_unique<NameRegexCoverageFilter>(Regex)); 832 Filters.push_back(std::move(NameFilterer)); 833 } 834 835 if (RegionCoverageLtFilter.getNumOccurrences() || 836 RegionCoverageGtFilter.getNumOccurrences() || 837 LineCoverageLtFilter.getNumOccurrences() || 838 LineCoverageGtFilter.getNumOccurrences()) { 839 auto StatFilterer = std::make_unique<CoverageFilters>(); 840 if (RegionCoverageLtFilter.getNumOccurrences()) 841 StatFilterer->push_back(std::make_unique<RegionCoverageFilter>( 842 RegionCoverageFilter::LessThan, RegionCoverageLtFilter)); 843 if (RegionCoverageGtFilter.getNumOccurrences()) 844 StatFilterer->push_back(std::make_unique<RegionCoverageFilter>( 845 RegionCoverageFilter::GreaterThan, RegionCoverageGtFilter)); 846 if (LineCoverageLtFilter.getNumOccurrences()) 847 StatFilterer->push_back(std::make_unique<LineCoverageFilter>( 848 LineCoverageFilter::LessThan, LineCoverageLtFilter)); 849 if (LineCoverageGtFilter.getNumOccurrences()) 850 StatFilterer->push_back(std::make_unique<LineCoverageFilter>( 851 RegionCoverageFilter::GreaterThan, LineCoverageGtFilter)); 852 Filters.push_back(std::move(StatFilterer)); 853 } 854 855 // Create the ignore filename filters. 856 for (const auto &RE : IgnoreFilenameRegexFilters) 857 IgnoreFilenameFilters.push_back( 858 std::make_unique<NameRegexCoverageFilter>(RE)); 859 860 if (!Arches.empty()) { 861 for (const std::string &Arch : Arches) { 862 if (Triple(Arch).getArch() == llvm::Triple::ArchType::UnknownArch) { 863 error("Unknown architecture: " + Arch); 864 return 1; 865 } 866 CoverageArches.emplace_back(Arch); 867 } 868 if (CoverageArches.size() == 1) 869 CoverageArches.insert(CoverageArches.end(), ObjectFilenames.size() - 1, 870 CoverageArches[0]); 871 if (CoverageArches.size() != ObjectFilenames.size()) { 872 error("Number of architectures doesn't match the number of objects"); 873 return 1; 874 } 875 } 876 877 // IgnoreFilenameFilters are applied even when InputSourceFiles specified. 878 for (const std::string &File : InputSourceFiles) 879 collectPaths(File); 880 881 if (DebugDumpCollectedPaths) { 882 for (const std::string &SF : SourceFiles) 883 outs() << SF << '\n'; 884 ::exit(0); 885 } 886 887 ViewOpts.ShowBranchSummary = BranchSummary; 888 ViewOpts.ShowRegionSummary = RegionSummary; 889 ViewOpts.ShowInstantiationSummary = InstantiationSummary; 890 ViewOpts.ExportSummaryOnly = SummaryOnly; 891 ViewOpts.NumThreads = NumThreads; 892 ViewOpts.CompilationDirectory = CompilationDirectory; 893 894 return 0; 895 }; 896 897 switch (Cmd) { 898 case Show: 899 return doShow(argc, argv, commandLineParser); 900 case Report: 901 return doReport(argc, argv, commandLineParser); 902 case Export: 903 return doExport(argc, argv, commandLineParser); 904 } 905 return 0; 906 } 907 908 int CodeCoverageTool::doShow(int argc, const char **argv, 909 CommandLineParserType commandLineParser) { 910 911 cl::OptionCategory ViewCategory("Viewing options"); 912 913 cl::opt<bool> ShowLineExecutionCounts( 914 "show-line-counts", cl::Optional, 915 cl::desc("Show the execution counts for each line"), cl::init(true), 916 cl::cat(ViewCategory)); 917 918 cl::opt<bool> ShowRegions( 919 "show-regions", cl::Optional, 920 cl::desc("Show the execution counts for each region"), 921 cl::cat(ViewCategory)); 922 923 cl::opt<CoverageViewOptions::BranchOutputType> ShowBranches( 924 "show-branches", cl::Optional, 925 cl::desc("Show coverage for branch conditions"), cl::cat(ViewCategory), 926 cl::values(clEnumValN(CoverageViewOptions::BranchOutputType::Count, 927 "count", "Show True/False counts"), 928 clEnumValN(CoverageViewOptions::BranchOutputType::Percent, 929 "percent", "Show True/False percent")), 930 cl::init(CoverageViewOptions::BranchOutputType::Off)); 931 932 cl::opt<bool> ShowBestLineRegionsCounts( 933 "show-line-counts-or-regions", cl::Optional, 934 cl::desc("Show the execution counts for each line, or the execution " 935 "counts for each region on lines that have multiple regions"), 936 cl::cat(ViewCategory)); 937 938 cl::opt<bool> ShowExpansions("show-expansions", cl::Optional, 939 cl::desc("Show expanded source regions"), 940 cl::cat(ViewCategory)); 941 942 cl::opt<bool> ShowInstantiations("show-instantiations", cl::Optional, 943 cl::desc("Show function instantiations"), 944 cl::init(true), cl::cat(ViewCategory)); 945 946 cl::opt<std::string> ShowOutputDirectory( 947 "output-dir", cl::init(""), 948 cl::desc("Directory in which coverage information is written out")); 949 cl::alias ShowOutputDirectoryA("o", cl::desc("Alias for --output-dir"), 950 cl::aliasopt(ShowOutputDirectory)); 951 952 cl::opt<uint32_t> TabSize( 953 "tab-size", cl::init(2), 954 cl::desc( 955 "Set tab expansion size for html coverage reports (default = 2)")); 956 957 cl::opt<std::string> ProjectTitle( 958 "project-title", cl::Optional, 959 cl::desc("Set project title for the coverage report")); 960 961 cl::opt<std::string> CovWatermark( 962 "coverage-watermark", cl::Optional, 963 cl::desc("<high>,<low> value indicate thresholds for high and low" 964 "coverage watermark")); 965 966 auto Err = commandLineParser(argc, argv); 967 if (Err) 968 return Err; 969 970 if (ViewOpts.Format == CoverageViewOptions::OutputFormat::Lcov) { 971 error("Lcov format should be used with 'llvm-cov export'."); 972 return 1; 973 } 974 975 ViewOpts.HighCovWatermark = 100.0; 976 ViewOpts.LowCovWatermark = 80.0; 977 if (!CovWatermark.empty()) { 978 auto WaterMarkPair = StringRef(CovWatermark).split(','); 979 if (WaterMarkPair.first.empty() || WaterMarkPair.second.empty()) { 980 error("invalid argument '" + CovWatermark + 981 "', must be in format 'high,low'", 982 "-coverage-watermark"); 983 return 1; 984 } 985 986 char *EndPointer = nullptr; 987 ViewOpts.HighCovWatermark = 988 strtod(WaterMarkPair.first.begin(), &EndPointer); 989 if (EndPointer != WaterMarkPair.first.end()) { 990 error("invalid number '" + WaterMarkPair.first + 991 "', invalid value for 'high'", 992 "-coverage-watermark"); 993 return 1; 994 } 995 996 ViewOpts.LowCovWatermark = 997 strtod(WaterMarkPair.second.begin(), &EndPointer); 998 if (EndPointer != WaterMarkPair.second.end()) { 999 error("invalid number '" + WaterMarkPair.second + 1000 "', invalid value for 'low'", 1001 "-coverage-watermark"); 1002 return 1; 1003 } 1004 1005 if (ViewOpts.HighCovWatermark > 100 || ViewOpts.LowCovWatermark < 0 || 1006 ViewOpts.HighCovWatermark <= ViewOpts.LowCovWatermark) { 1007 error( 1008 "invalid number range '" + CovWatermark + 1009 "', must be both high and low should be between 0-100, and high " 1010 "> low", 1011 "-coverage-watermark"); 1012 return 1; 1013 } 1014 } 1015 1016 ViewOpts.ShowLineNumbers = true; 1017 ViewOpts.ShowLineStats = ShowLineExecutionCounts.getNumOccurrences() != 0 || 1018 !ShowRegions || ShowBestLineRegionsCounts; 1019 ViewOpts.ShowRegionMarkers = ShowRegions || ShowBestLineRegionsCounts; 1020 ViewOpts.ShowExpandedRegions = ShowExpansions; 1021 ViewOpts.ShowBranchCounts = 1022 ShowBranches == CoverageViewOptions::BranchOutputType::Count; 1023 ViewOpts.ShowBranchPercents = 1024 ShowBranches == CoverageViewOptions::BranchOutputType::Percent; 1025 ViewOpts.ShowFunctionInstantiations = ShowInstantiations; 1026 ViewOpts.ShowOutputDirectory = ShowOutputDirectory; 1027 ViewOpts.TabSize = TabSize; 1028 ViewOpts.ProjectTitle = ProjectTitle; 1029 1030 if (ViewOpts.hasOutputDirectory()) { 1031 if (auto E = sys::fs::create_directories(ViewOpts.ShowOutputDirectory)) { 1032 error("Could not create output directory!", E.message()); 1033 return 1; 1034 } 1035 } 1036 1037 sys::fs::file_status Status; 1038 if (std::error_code EC = sys::fs::status(PGOFilename, Status)) { 1039 error("Could not read profile data!" + EC.message(), PGOFilename); 1040 return 1; 1041 } 1042 1043 auto ModifiedTime = Status.getLastModificationTime(); 1044 std::string ModifiedTimeStr = to_string(ModifiedTime); 1045 size_t found = ModifiedTimeStr.rfind(':'); 1046 ViewOpts.CreatedTimeStr = (found != std::string::npos) 1047 ? "Created: " + ModifiedTimeStr.substr(0, found) 1048 : "Created: " + ModifiedTimeStr; 1049 1050 auto Coverage = load(); 1051 if (!Coverage) 1052 return 1; 1053 1054 auto Printer = CoveragePrinter::create(ViewOpts); 1055 1056 if (SourceFiles.empty() && !HadSourceFiles) 1057 // Get the source files from the function coverage mapping. 1058 for (StringRef Filename : Coverage->getUniqueSourceFiles()) { 1059 if (!IgnoreFilenameFilters.matchesFilename(Filename)) 1060 SourceFiles.push_back(std::string(Filename)); 1061 } 1062 1063 // Create an index out of the source files. 1064 if (ViewOpts.hasOutputDirectory()) { 1065 if (Error E = Printer->createIndexFile(SourceFiles, *Coverage, Filters)) { 1066 error("Could not create index file!", toString(std::move(E))); 1067 return 1; 1068 } 1069 } 1070 1071 if (!Filters.empty()) { 1072 // Build the map of filenames to functions. 1073 std::map<llvm::StringRef, std::vector<const FunctionRecord *>> 1074 FilenameFunctionMap; 1075 for (const auto &SourceFile : SourceFiles) 1076 for (const auto &Function : Coverage->getCoveredFunctions(SourceFile)) 1077 if (Filters.matches(*Coverage.get(), Function)) 1078 FilenameFunctionMap[SourceFile].push_back(&Function); 1079 1080 // Only print filter matching functions for each file. 1081 for (const auto &FileFunc : FilenameFunctionMap) { 1082 StringRef File = FileFunc.first; 1083 const auto &Functions = FileFunc.second; 1084 1085 auto OSOrErr = Printer->createViewFile(File, /*InToplevel=*/false); 1086 if (Error E = OSOrErr.takeError()) { 1087 error("Could not create view file!", toString(std::move(E))); 1088 return 1; 1089 } 1090 auto OS = std::move(OSOrErr.get()); 1091 1092 bool ShowTitle = ViewOpts.hasOutputDirectory(); 1093 for (const auto *Function : Functions) { 1094 auto FunctionView = createFunctionView(*Function, *Coverage); 1095 if (!FunctionView) { 1096 warning("Could not read coverage for '" + Function->Name + "'."); 1097 continue; 1098 } 1099 FunctionView->print(*OS.get(), /*WholeFile=*/false, 1100 /*ShowSourceName=*/true, ShowTitle); 1101 ShowTitle = false; 1102 } 1103 1104 Printer->closeViewFile(std::move(OS)); 1105 } 1106 return 0; 1107 } 1108 1109 // Show files 1110 bool ShowFilenames = 1111 (SourceFiles.size() != 1) || ViewOpts.hasOutputDirectory() || 1112 (ViewOpts.Format == CoverageViewOptions::OutputFormat::HTML); 1113 1114 ThreadPoolStrategy S = hardware_concurrency(ViewOpts.NumThreads); 1115 if (ViewOpts.NumThreads == 0) { 1116 // If NumThreads is not specified, create one thread for each input, up to 1117 // the number of hardware cores. 1118 S = heavyweight_hardware_concurrency(SourceFiles.size()); 1119 S.Limit = true; 1120 } 1121 1122 if (!ViewOpts.hasOutputDirectory() || S.ThreadsRequested == 1) { 1123 for (const std::string &SourceFile : SourceFiles) 1124 writeSourceFileView(SourceFile, Coverage.get(), Printer.get(), 1125 ShowFilenames); 1126 } else { 1127 // In -output-dir mode, it's safe to use multiple threads to print files. 1128 ThreadPool Pool(S); 1129 for (const std::string &SourceFile : SourceFiles) 1130 Pool.async(&CodeCoverageTool::writeSourceFileView, this, SourceFile, 1131 Coverage.get(), Printer.get(), ShowFilenames); 1132 Pool.wait(); 1133 } 1134 1135 return 0; 1136 } 1137 1138 int CodeCoverageTool::doReport(int argc, const char **argv, 1139 CommandLineParserType commandLineParser) { 1140 cl::opt<bool> ShowFunctionSummaries( 1141 "show-functions", cl::Optional, cl::init(false), 1142 cl::desc("Show coverage summaries for each function")); 1143 1144 auto Err = commandLineParser(argc, argv); 1145 if (Err) 1146 return Err; 1147 1148 if (ViewOpts.Format == CoverageViewOptions::OutputFormat::HTML) { 1149 error("HTML output for summary reports is not yet supported."); 1150 return 1; 1151 } else if (ViewOpts.Format == CoverageViewOptions::OutputFormat::Lcov) { 1152 error("Lcov format should be used with 'llvm-cov export'."); 1153 return 1; 1154 } 1155 1156 sys::fs::file_status Status; 1157 if (std::error_code EC = sys::fs::status(PGOFilename, Status)) { 1158 error("Could not read profile data!" + EC.message(), PGOFilename); 1159 return 1; 1160 } 1161 1162 auto Coverage = load(); 1163 if (!Coverage) 1164 return 1; 1165 1166 CoverageReport Report(ViewOpts, *Coverage.get()); 1167 if (!ShowFunctionSummaries) { 1168 if (SourceFiles.empty()) 1169 Report.renderFileReports(llvm::outs(), IgnoreFilenameFilters); 1170 else 1171 Report.renderFileReports(llvm::outs(), SourceFiles); 1172 } else { 1173 if (SourceFiles.empty()) { 1174 error("Source files must be specified when -show-functions=true is " 1175 "specified"); 1176 return 1; 1177 } 1178 1179 Report.renderFunctionReports(SourceFiles, DC, llvm::outs()); 1180 } 1181 return 0; 1182 } 1183 1184 int CodeCoverageTool::doExport(int argc, const char **argv, 1185 CommandLineParserType commandLineParser) { 1186 1187 cl::OptionCategory ExportCategory("Exporting options"); 1188 1189 cl::opt<bool> SkipExpansions("skip-expansions", cl::Optional, 1190 cl::desc("Don't export expanded source regions"), 1191 cl::cat(ExportCategory)); 1192 1193 cl::opt<bool> SkipFunctions("skip-functions", cl::Optional, 1194 cl::desc("Don't export per-function data"), 1195 cl::cat(ExportCategory)); 1196 1197 cl::opt<bool> SkipBranches("skip-branches", cl::Optional, 1198 cl::desc("Don't export branch data (LCOV)"), 1199 cl::cat(ExportCategory)); 1200 1201 auto Err = commandLineParser(argc, argv); 1202 if (Err) 1203 return Err; 1204 1205 ViewOpts.SkipExpansions = SkipExpansions; 1206 ViewOpts.SkipFunctions = SkipFunctions; 1207 ViewOpts.SkipBranches = SkipBranches; 1208 1209 if (ViewOpts.Format != CoverageViewOptions::OutputFormat::Text && 1210 ViewOpts.Format != CoverageViewOptions::OutputFormat::Lcov) { 1211 error("Coverage data can only be exported as textual JSON or an " 1212 "lcov tracefile."); 1213 return 1; 1214 } 1215 1216 sys::fs::file_status Status; 1217 if (std::error_code EC = sys::fs::status(PGOFilename, Status)) { 1218 error("Could not read profile data!" + EC.message(), PGOFilename); 1219 return 1; 1220 } 1221 1222 auto Coverage = load(); 1223 if (!Coverage) { 1224 error("Could not load coverage information"); 1225 return 1; 1226 } 1227 1228 std::unique_ptr<CoverageExporter> Exporter; 1229 1230 switch (ViewOpts.Format) { 1231 case CoverageViewOptions::OutputFormat::Text: 1232 Exporter = std::make_unique<CoverageExporterJson>(*Coverage.get(), 1233 ViewOpts, outs()); 1234 break; 1235 case CoverageViewOptions::OutputFormat::HTML: 1236 // Unreachable because we should have gracefully terminated with an error 1237 // above. 1238 llvm_unreachable("Export in HTML is not supported!"); 1239 case CoverageViewOptions::OutputFormat::Lcov: 1240 Exporter = std::make_unique<CoverageExporterLcov>(*Coverage.get(), 1241 ViewOpts, outs()); 1242 break; 1243 } 1244 1245 if (SourceFiles.empty()) 1246 Exporter->renderRoot(IgnoreFilenameFilters); 1247 else 1248 Exporter->renderRoot(SourceFiles); 1249 1250 return 0; 1251 } 1252 1253 int showMain(int argc, const char *argv[]) { 1254 CodeCoverageTool Tool; 1255 return Tool.run(CodeCoverageTool::Show, argc, argv); 1256 } 1257 1258 int reportMain(int argc, const char *argv[]) { 1259 CodeCoverageTool Tool; 1260 return Tool.run(CodeCoverageTool::Report, argc, argv); 1261 } 1262 1263 int exportMain(int argc, const char *argv[]) { 1264 CodeCoverageTool Tool; 1265 return Tool.run(CodeCoverageTool::Export, argc, argv); 1266 } 1267