1 //===- llvm-cov.cpp - LLVM coverage tool ----------------------------------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // llvm-cov is a command line tools to analyze and report coverage information.
12 //===----------------------------------------------------------------------===//
14 #include "llvm/ADT/SmallString.h"
15 #include "llvm/Support/CommandLine.h"
16 #include "llvm/Support/FileSystem.h"
17 #include "llvm/Support/GCOV.h"
18 #include "llvm/Support/ManagedStatic.h"
19 #include "llvm/Support/MemoryObject.h"
20 #include "llvm/Support/Path.h"
21 #include "llvm/Support/PrettyStackTrace.h"
22 #include "llvm/Support/Signals.h"
23 #include "llvm/Support/system_error.h"
26 static cl::opt<std::string> SourceFile(cl::Positional, cl::Required,
27 cl::desc("SOURCEFILE"));
29 static cl::opt<bool> AllBlocks("a", cl::init(false),
30 cl::desc("Display all basic blocks"));
31 static cl::alias AllBlocksA("all-blocks", cl::aliasopt(AllBlocks));
33 static cl::opt<bool> BranchProb("b", cl::init(false),
34 cl::desc("Display branch probabilities"));
35 static cl::alias BranchProbA("branch-probabilities", cl::aliasopt(BranchProb));
37 static cl::opt<bool> BranchCount("c", cl::init(false),
38 cl::desc("Display branch counts instead "
39 "of percentages (requires -b)"));
40 static cl::alias BranchCountA("branch-counts", cl::aliasopt(BranchCount));
42 static cl::opt<bool> FuncSummary("f", cl::init(false),
43 cl::desc("Show coverage for each function"));
44 static cl::alias FuncSummaryA("function-summaries", cl::aliasopt(FuncSummary));
46 static cl::opt<std::string>
47 ObjectDir("o", cl::value_desc("DIR|FILE"), cl::init(""),
48 cl::desc("Find objects in DIR or based on FILE's path"));
49 static cl::alias ObjectDirA("object-directory", cl::aliasopt(ObjectDir));
50 static cl::alias ObjectDirB("object-file", cl::aliasopt(ObjectDir));
52 static cl::opt<bool> PreservePaths("p", cl::init(false),
53 cl::desc("Preserve path components"));
54 static cl::alias PreservePathsA("preserve-paths", cl::aliasopt(PreservePaths));
56 static cl::opt<bool> UncondBranch("u", cl::init(false),
57 cl::desc("Display unconditional branch info "
59 static cl::alias UncondBranchA("unconditional-branches",
60 cl::aliasopt(UncondBranch));
62 static cl::OptionCategory DebugCat("Internal and debugging options");
63 static cl::opt<bool> DumpGCOV("dump", cl::init(false), cl::cat(DebugCat),
64 cl::desc("Dump the gcov file to stderr"));
65 static cl::opt<std::string> InputGCNO("gcno", cl::cat(DebugCat), cl::init(""),
66 cl::desc("Override inferred gcno file"));
67 static cl::opt<std::string> InputGCDA("gcda", cl::cat(DebugCat), cl::init(""),
68 cl::desc("Override inferred gcda file"));
70 //===----------------------------------------------------------------------===//
71 int main(int argc, char **argv) {
72 // Print a stack trace if we signal out.
73 sys::PrintStackTraceOnErrorSignal();
74 PrettyStackTraceProgram X(argc, argv);
75 llvm_shutdown_obj Y; // Call llvm_shutdown() on exit.
77 cl::ParseCommandLineOptions(argc, argv, "LLVM code coverage tool\n");
79 SmallString<128> CoverageFileStem(ObjectDir);
80 if (CoverageFileStem.empty()) {
81 // If no directory was specified with -o, look next to the source file.
82 CoverageFileStem = sys::path::parent_path(SourceFile);
83 sys::path::append(CoverageFileStem, sys::path::stem(SourceFile));
84 } else if (sys::fs::is_directory(ObjectDir))
85 // A directory name was given. Use it and the source file name.
86 sys::path::append(CoverageFileStem, sys::path::stem(SourceFile));
88 // A file was given. Ignore the source file and look next to this file.
89 sys::path::replace_extension(CoverageFileStem, "");
91 if (InputGCNO.empty())
92 InputGCNO = (CoverageFileStem.str() + ".gcno").str();
93 if (InputGCDA.empty())
94 InputGCDA = (CoverageFileStem.str() + ".gcda").str();
98 std::unique_ptr<MemoryBuffer> GCNO_Buff;
99 if (error_code ec = MemoryBuffer::getFileOrSTDIN(InputGCNO, GCNO_Buff)) {
100 errs() << InputGCNO << ": " << ec.message() << "\n";
103 GCOVBuffer GCNO_GB(GCNO_Buff.get());
104 if (!GF.readGCNO(GCNO_GB)) {
105 errs() << "Invalid .gcno File!\n";
109 std::unique_ptr<MemoryBuffer> GCDA_Buff;
110 if (error_code ec = MemoryBuffer::getFileOrSTDIN(InputGCDA, GCDA_Buff)) {
111 if (ec != errc::no_such_file_or_directory) {
112 errs() << InputGCDA << ": " << ec.message() << "\n";
115 // Clear the filename to make it clear we didn't read anything.
118 GCOVBuffer GCDA_GB(GCDA_Buff.get());
119 if (!GF.readGCDA(GCDA_GB)) {
120 errs() << "Invalid .gcda File!\n";
128 GCOVOptions Options(AllBlocks, BranchProb, BranchCount, FuncSummary,
129 PreservePaths, UncondBranch);
130 FileInfo FI(Options);
131 GF.collectLineCounts(FI);
132 FI.print(InputGCNO, InputGCDA);