tools/llvm-cov/llvm-cov.cpp

   1 //===- llvm-cov.cpp - LLVM coverage tool ----------------------------------===//
   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 // llvm-cov is a command line tools to analyze and report coverage information.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #include "llvm/ADT/OwningPtr.h"
  15 #include "llvm/ADT/SmallString.h"
  16 #include "llvm/Support/CommandLine.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"
  24 using namespace llvm;
  25
  26 static cl::opt<std::string> SourceFile(cl::Positional, cl::Required,
  27                                        cl::desc("SOURCEFILE"));
  28
  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));
  32
  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));
  36
  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));
  41
  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));
  45
  46 static cl::opt<std::string> ObjectDir("o", cl::value_desc("DIR"), cl::init(""),
  47                                       cl::desc("Search for objects in DIR"));
  48 static cl::alias ObjectDirA("object-directory", cl::aliasopt(ObjectDir));
  49
  50 static cl::opt<bool> UncondBranch("u", cl::init(false),
  51                                   cl::desc("Display unconditional branch info "
  52                                            "(requires -b)"));
  53 static cl::alias UncondBranchA("unconditional-branches",
  54                                cl::aliasopt(UncondBranch));
  55
  56 static cl::OptionCategory DebugCat("Internal and debugging options");
  57 static cl::opt<bool> DumpGCOV("dump", cl::init(false), cl::cat(DebugCat),
  58                               cl::desc("Dump the gcov file to stderr"));
  59 static cl::opt<std::string> InputGCNO("gcno", cl::cat(DebugCat), cl::init(""),
  60                                       cl::desc("Override inferred gcno file"));
  61 static cl::opt<std::string> InputGCDA("gcda", cl::cat(DebugCat), cl::init(""),
  62                                       cl::desc("Override inferred gcda file"));
  63
  64 //===----------------------------------------------------------------------===//
  65 int main(int argc, char **argv) {
  66   // Print a stack trace if we signal out.
  67   sys::PrintStackTraceOnErrorSignal();
  68   PrettyStackTraceProgram X(argc, argv);
  69   llvm_shutdown_obj Y;  // Call llvm_shutdown() on exit.
  70
  71   cl::ParseCommandLineOptions(argc, argv, "LLVM code coverage tool\n");
  72
  73   SmallString<128> CoverageFileStem(ObjectDir);
  74   if (CoverageFileStem.empty())
  75     CoverageFileStem = sys::path::parent_path(SourceFile);
  76   sys::path::append(CoverageFileStem, sys::path::stem(SourceFile));
  77
  78   if (InputGCNO.empty())
  79     InputGCNO = (CoverageFileStem.str() + ".gcno").str();
  80   if (InputGCDA.empty())
  81     InputGCDA = (CoverageFileStem.str() + ".gcda").str();
  82
  83   GCOVFile GF;
  84
  85   OwningPtr<MemoryBuffer> GCNO_Buff;
  86   if (error_code ec = MemoryBuffer::getFileOrSTDIN(InputGCNO, GCNO_Buff)) {
  87     errs() << InputGCNO << ": " << ec.message() << "\n";
  88     return 1;
  89   }
  90   GCOVBuffer GCNO_GB(GCNO_Buff.get());
  91   if (!GF.readGCNO(GCNO_GB)) {
  92     errs() << "Invalid .gcno File!\n";
  93     return 1;
  94   }
  95
  96   OwningPtr<MemoryBuffer> GCDA_Buff;
  97   if (error_code ec = MemoryBuffer::getFileOrSTDIN(InputGCDA, GCDA_Buff)) {
  98     if (ec != errc::no_such_file_or_directory) {
  99       errs() << InputGCDA << ": " << ec.message() << "\n";
 100       return 1;
 101     }
 102     // Clear the filename to make it clear we didn't read anything.
 103     InputGCDA = "-";
 104   } else {
 105     GCOVBuffer GCDA_GB(GCDA_Buff.get());
 106     if (!GF.readGCDA(GCDA_GB)) {
 107       errs() << "Invalid .gcda File!\n";
 108       return 1;
 109     }
 110   }
 111
 112   if (DumpGCOV)
 113     GF.dump();
 114
 115   GCOVOptions Options(AllBlocks, BranchProb, BranchCount, FuncSummary,
 116                       UncondBranch);
 117   FileInfo FI(Options);
 118   GF.collectLineCounts(FI);
 119   FI.print(InputGCNO, InputGCDA);
 120   return 0;
 121 }