Coverage Report

Created: 2018-10-23 15:26

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