[llvm-cov] Add the project summary to each source file coverage report.

[MaggieYi]

Summary

This patch includes the following changes:

• Included header "Code coverage report" and include the date that the report was created.
• Included title (as specified in a command line option, (i.e llvm-cov -project-title="Simple Test")
• In the summary, list the elf files that the source code file has contributed to.
• Used column heading for "Line No.", "Count No.", Source".

[vsk]

tools/llvm-cov/CodeCoverage.cpp

467 ↗

(On Diff #67482)

We should handle the error_code make_absolute returns (CodeCoverageTool::warning).

470 ↗

(On Diff #67482)

We aren't calling sys::path::native in CoveragePrinter::getOutputPath() either. We should make the change to ObjectFilename and getOutputPath in the same patch, and make sure to test it with a covmapping file that includes Windows path separators. Could you tackle this in a separate patch?

627 ↗

(On Diff #67482)

Use CodeCoverageTool::error.

632 ↗

(On Diff #67482)

Please sink the global into CoverageViewOptions, so there's just one place we need to look for information like this.

633 ↗

(On Diff #67482)

It's not clear that the results of the find+substr would be uniform across platforms. I suggest just using the result of MTime.str().

tools/llvm-cov/SourceCoverageView.h

175 ↗

(On Diff #67482)

Nit about the comment: since this is a field, the word "return" seems out of place. Wdyt of "Specifies whether or not ..."?

201 ↗

(On Diff #67482)

This method does not need to be pure-virtual. Please delete it and move its logic into the renderSourceName implementations.

252 ↗

(On Diff #67482)

I think we should delete all three of these methods and replace them with something simpler: virtual void renderCellInTitle(raw_ostream &, StringRef CellText). The text viewer would provide an implementation that prints "CellText" in cyan followed by a newline. The html viewer would do something analogous.

This would force some common logic to move into SourceCoverageView::print, which is a good thing. E.g, we'd no longer have inconsistent capitalization between "renderReportTitle" in the text vs. html viewers.

255 ↗

(On Diff #67482)

This isn't pure-virtual, so it doesn't belong in this section of SourceCoverageView. Please delete it and move its logic to SourceCoverageView::print.

tools/llvm-cov/SourceCoverageViewHTML.cpp

339 ↗

(On Diff #67482)

What's wrong with using normal std::string concatenation?

340 ↗

(On Diff #67482)

Nit, mild preference for "Binary:" over "Binary file:". Also, why are there extra spaces here?

350 ↗

(On Diff #67482)

Why are there extra spaces after "Source file:"?

Nit, I'm mildly in favor of shortening "Source file" to "File", but I'll leave it up to you.

571 ↗

(On Diff #67482)

clang-format

tools/llvm-cov/SourceCoverageViewText.cpp

241 ↗

(On Diff #67482)

This looks really suspicious. I don't think this will look right with large line numbers or large execution counts. I suggest just defining this away for the text view, e.g: SourceCoverageViewText::renderTableHeader(raw_ostream &, unsigned).

[MaggieYi]

Many thanks for your comments. As I will be busy on other work in next several days, I will update the patch following your comments once I get those on track. Thanks for the patience.

[MaggieYi]

Hi Vedant,

I have updated the patch following your comments.

Thanks for your patience.

[MaggieYi]

tools/llvm-cov/CodeCoverage.cpp

470 ↗

(On Diff #67482)

Ok, I will create a separate patch for this issue.

633 ↗

(On Diff #67482)

I checked the generated report on Linux and Windows. The created time formats are the same, which is “Created: 16-01-07 13:12”. If using “MTime.st()”, the created times will be “Created: 16-01-07 13:12:48.216418700” on both Linux and Windows. Since the time string is quite long, I change the code to output the full time string if it can’t find the “:”. What do you think?

tools/llvm-cov/SourceCoverageViewHTML.cpp

340 ↗

(On Diff #67482)

Removed the extra spaces.

350 ↗

(On Diff #67482)

Again, removed the extra space. How about using “Source”?

[vsk]

This is looking really close. Just a few minor comments --

tools/llvm-cov/CodeCoverage.cpp

631 ↗

(On Diff #69027)

This takes a reference to a temporary, which might make asan upset. Please use std::string.

634 ↗

(On Diff #69027)

Sgtm, thanks.

tools/llvm-cov/SourceCoverageView.h

242 ↗

(On Diff #69027)

Please update the doxygen here to mention that the function also prints \p CellText.

243 ↗

(On Diff #69027)

Missing parameter name.

tools/llvm-cov/SourceCoverageViewHTML.cpp

343 ↗

(On Diff #69027)

Nit, this copies the source name twice. How about 'SourceFile = "Function" or "Source"; SourceFile += getSourceName();'?

347 ↗

(On Diff #69027)

Sgtm.

349 ↗

(On Diff #69027)

Nit, how about 'escape("Binary: " + getOptions().ObjectFilename)'?

552 ↗

(On Diff #69027)

Does this need to be gated with a check to hasProjectTitle()?

559 ↗

(On Diff #69027)

Ditto, do we need a check here for hasCreatedTime()?

tools/llvm-cov/SourceCoverageViewHTML.h

73 ↗

(On Diff #69027)

Missing parameter name.

tools/llvm-cov/SourceCoverageViewText.cpp

225 ↗

(On Diff #69027)

Ditto, do we need checks here for hasProjectTitle() / hasCreatedTime()?

[MaggieYi]

I have fixed the issues, Thanks.

tools/llvm-cov/SourceCoverageViewHTML.cpp

552 ↗

(On Diff #69027)

Yes, fixed it. Thanks.

559 ↗

(On Diff #69027)

Yes, fixed it. Thanks.

tools/llvm-cov/SourceCoverageViewText.cpp

225 ↗

(On Diff #69027)

Yes, fixed it. Thanks.

[vsk]

Thank you! Lgtm.

llvm/trunk/test/tools/llvm-cov/Inputs/showProjectSummary.proftext

+main
+# Func Hash:
+266
+# Num Counters:
+3
+# Counter Values:
+1
+20
+0
+

llvm/trunk/test/tools/llvm-cov/showProjectSummary.cpp

+// RUN: llvm-profdata merge -o %t.profdata %S/Inputs/showProjectSummary.proftext
+
+int main(int argc, char ** argv) {
+  int x=0;
+  for (int i = 0; i < 20; ++i)
+    x *= 2;
+  if (x >= 100)
+    x = x / 2;
+  else
+    x = x * 2;
+  return x;
+}
+
+// Test console output.
+// RUN: llvm-cov show %S/Inputs/showProjectSummary.covmapping -instr-profile %t.profdata -filename-equivalence %s | FileCheck -check-prefixes=TEXT,TEXT-FILE,TEXT-HEADER %s
+// RUN: llvm-cov show %S/Inputs/showProjectSummary.covmapping -instr-profile %t.profdata -project-title "Test Suite" -filename-equivalence %s | FileCheck -check-prefixes=TEXT-TITLE,TEXT,TEXT-FILE,TEXT-HEADER %s
+// RUN: llvm-cov show %S/Inputs/showProjectSummary.covmapping -instr-profile %t.profdata -project-title "Test Suite" -name=main -filename-equivalence %s | FileCheck -check-prefixes=TEXT-FUNCTION,TEXT-HEADER %s
+// TEXT-TITLE: Test Suite
+// TEXT: Code Coverage Report
+// TEXT: Created:
+// TEXT-FILE: showProjectSummary.cpp:
+// TEXT-FILE: showProjectSummary.covmapping:
+// TEXT-FUNCTION: main:
+
+// Test html output.
+// RUN: llvm-cov show %S/Inputs/showProjectSummary.covmapping -format=html -o %t.dir -instr-profile %t.profdata -filename-equivalence %s
+// RUN: FileCheck -check-prefixes=HTML,HTML-FILE,HTML-HEADER -input-file %t.dir/coverage/tmp/showProjectSummary.cpp.html %s
+// RUN: llvm-cov show %S/Inputs/showProjectSummary.covmapping -format=html -o %t.dir -instr-profile %t.profdata -project-title "Test Suite" -filename-equivalence %s
+// RUN: FileCheck -check-prefixes=HTML-TITLE,HTML,HTML-FILE,HTML-HEADER -input-file %t.dir/coverage/tmp/showProjectSummary.cpp.html %s
+// RUN: FileCheck -check-prefixes=HTML-TITLE,HTML -input-file %t.dir/index.html %s
+// RUN: llvm-cov show %S/Inputs/showProjectSummary.covmapping -format=html -o %t.dir -instr-profile %t.profdata  -project-title "Test Suite" -filename-equivalence -name=main %s
+// RUN: FileCheck -check-prefixes=HTML-FUNCTION,HTML-HEADER -input-file %t.dir/functions.html %s
+// HTML-TITLE: <div class='project-title'>
+// HTML-TITLE: <span>Test Suite</span>
+// HTML: <div class='report-title'>
+// HTML: <span>Code Coverage Report</span>
+// HTML: <div class='created-time'>
+// HTML: <span>Created:
+// HTML-FILE: <pre>Source:
+// HTML-FILE: showProjectSummary.cpp</pre>
+// HTML-FILE: <pre>Binary:
+// HTML-FILE: showProjectSummary.covmapping</pre>
+// HTML-FUNCTION: <pre>Function: main</pre>
+// HTML-HEADER: <tr><td><span><pre>Line No.</pre></span></td>
+// HTML-HEADER: <td><span><pre>Count No.</pre></span></td>
+// HTML-HEADER: <td><span><pre>Source</pre></span></td>

llvm/trunk/test/tools/llvm-cov/showTemplateInstantiations.cpp

 // RUN: llvm-cov show %S/Inputs/templateInstantiations.covmapping -instr-profile %S/Inputs/templateInstantiations.profdata -filename-equivalence %s | FileCheck -check-prefixes=SHARED,ALL %s
 // RUN: llvm-cov show %S/Inputs/templateInstantiations.covmapping -instr-profile %S/Inputs/templateInstantiations.profdata -filename-equivalence -name=_Z4funcIbEiT_ %s | FileCheck -check-prefixes=SHARED,FILTER %s
 
 // before coverage   // ALL:         [[@LINE]]|  |// before
                      // FILTER-NOT:[[@LINE-1]]|  |// before
 template<typename T> // ALL:         [[@LINE]]|  |template<typename T>
 int func(T x) {      // ALL-NEXT:    [[@LINE]]| 2|int func(T x) {
   if(x)              // ALL-NEXT:    [[@LINE]]| 2|  if(x)
     return 0;        // ALL-NEXT:    [[@LINE]]| 1|    return 0;
   else               // ALL-NEXT:    [[@LINE]]| 2|  else
     return 1;        // ALL-NEXT:    [[@LINE]]| 1|    return 1;
   int j = 1;         // ALL-NEXT:    [[@LINE]]| 0|  int j = 1;
 }                    // ALL-NEXT:    [[@LINE]]| 2|}
 
                      // SHARED:       {{^ *(\| )?}}_Z4funcIbEiT_:
-                     // SHARED-NEXT:  [[@LINE-9]]| 1|int func(T x) {
+                     // SHARED:       [[@LINE-9]]| 1|int func(T x) {
                      // SHARED-NEXT:  [[@LINE-9]]| 1|  if(x)
                      // SHARED-NEXT:  [[@LINE-9]]| 1|    return 0;
                      // SHARED-NEXT:  [[@LINE-9]]| 1|  else
                      // SHARED-NEXT:  [[@LINE-9]]| 0|    return 1;
                      // SHARED-NEXT:  [[@LINE-9]]| 0|  int j = 1;
                      // SHARED-NEXT:  [[@LINE-9]]| 1|}
 
                      // ALL:         {{^ *}}| _Z4funcIiEiT_:
                      // FILTER-NOT:  {{^ *(\| )?}} _Z4funcIiEiT_:
-                     // ALL-NEXT:    [[@LINE-19]]| 1|int func(T x) {
+                     // ALL:         [[@LINE-19]]| 1|int func(T x) {
                      // ALL-NEXT:    [[@LINE-19]]| 1|  if(x)
                      // ALL-NEXT:    [[@LINE-19]]| 0|    return 0;
                      // ALL-NEXT:    [[@LINE-19]]| 1|  else
                      // ALL-NEXT:    [[@LINE-19]]| 1|    return 1;
                      // ALL-NEXT:    [[@LINE-19]]| 0|  int j = 1;
                      // ALL-NEXT:    [[@LINE-19]]| 1|}
 
 int main() {         // ALL:         [[@LINE]]| 1|int main() {

 // HTML-ALL: <td class='line-number'><a name='L[[@LINE-44]]'><pre>[[@LINE-44]]</pre></a></td><td class='covered-line'><pre>2</pre></td><td class='code'><pre>int func(T x) {
 // HTML-ALL: <td class='line-number'><a name='L[[@LINE-44]]'><pre>[[@LINE-44]]</pre></a></td><td class='covered-line'><pre>2</pre></td><td class='code'><pre>  if(x)
 // HTML-ALL: <td class='line-number'><a name='L[[@LINE-44]]'><pre>[[@LINE-44]]</pre></a></td><td class='covered-line'><pre>1</pre></td><td class='code'><pre>    ret
 // HTML-ALL: <td class='line-number'><a name='L[[@LINE-44]]'><pre>[[@LINE-44]]</pre></a></td><td class='covered-line'><pre>2</pre></td><td class='code'><pre>  else
 // HTML-ALL: <td class='line-number'><a name='L[[@LINE-44]]'><pre>[[@LINE-44]]</pre></a></td><td class='covered-line'><pre>1</pre></td><td class='code'><pre>    ret
 // HTML-ALL: <td class='line-number'><a name='L[[@LINE-44]]'><pre>[[@LINE-44]]</pre></a></td><td class='uncovered-line'><pre>0</pre></td><td class='code'><pre>
 // HTML-ALL: <td class='line-number'><a name='L[[@LINE-44]]'><pre>[[@LINE-44]]</pre></a></td><td class='covered-line'><pre>2</pre></td><td class='code'><pre>}
 
-// HTML-SHARED: <div class='source-name-title'><pre>_Z4funcIbEiT_</pre></div><table>
+// HTML-SHARED: <div class='source-name-title'><pre>Function: _Z4funcIbEiT_</pre></div>
 // HTML-SHARED: <td class='line-number'><a name='L[[@LINE-53]]'><pre>[[@LINE-53]]</pre></a></td><td class='covered-line'><pre>1</pre></td><td class='code'><pre>int func(T x) {
 // HTML-SHARED: <td class='line-number'><a name='L[[@LINE-53]]'><pre>[[@LINE-53]]</pre></a></td><td class='covered-line'><pre>1</pre></td><td class='code'><pre>  if(x)
 // HTML-SHARED: <td class='line-number'><a name='L[[@LINE-53]]'><pre>[[@LINE-53]]</pre></a></td><td class='covered-line'><pre>1</pre></td><td class='code'><pre>    ret
 // HTML-SHARED: <td class='line-number'><a name='L[[@LINE-53]]'><pre>[[@LINE-53]]</pre></a></td><td class='covered-line'><pre>1</pre></td><td class='code'><pre>  else
 // HTML-SHARED: <td class='line-number'><a name='L[[@LINE-53]]'><pre>[[@LINE-53]]</pre></a></td><td class='uncovered-line'><pre>0</pre></td><td class='code'><pre>
 // HTML-SHARED: <td class='line-number'><a name='L[[@LINE-53]]'><pre>[[@LINE-53]]</pre></a></td><td class='uncovered-line'><pre>0</pre></td><td class='code'><pre>
 // HTML-SHARED: <td class='line-number'><a name='L[[@LINE-53]]'><pre>[[@LINE-53]]</pre></a></td><td class='covered-line'><pre>1</pre></td><td class='code'><pre>}
 
-// HTML-ALL: <div class='source-name-title'><pre>_Z4funcIiEiT_</pre></div><table>
+// HTML-ALL: <div class='source-name-title'><pre>Function: _Z4funcIiEiT_</pre></div>
 // HTML-FILTER-NOT: <div class='source-name-title'><pre>_Z4funcIiEiT_</pre></div><table>
 // HTML-ALL: <td class='line-number'><a name='L[[@LINE-63]]'><pre>[[@LINE-63]]</pre></a></td><td class='covered-line'><pre>1</pre></td><td class='code'><pre>int func(T x) {
 // HTML-ALL: <td class='line-number'><a name='L[[@LINE-63]]'><pre>[[@LINE-63]]</pre></a></td><td class='covered-line'><pre>1</pre></td><td class='code'><pre>  if(x)
 // HTML-ALL: <td class='line-number'><a name='L[[@LINE-63]]'><pre>[[@LINE-63]]</pre></a></td><td class='uncovered-line'><pre>0</pre></td><td class='code'><pre>
 // HTML-ALL: <td class='line-number'><a name='L[[@LINE-63]]'><pre>[[@LINE-63]]</pre></a></td><td class='covered-line'><pre>1</pre></td><td class='code'><pre>  else
 // HTML-ALL: <td class='line-number'><a name='L[[@LINE-63]]'><pre>[[@LINE-63]]</pre></a></td><td class='covered-line'><pre>1</pre></td><td class='code'><pre>    ret
 // HTML-ALL: <td class='line-number'><a name='L[[@LINE-63]]'><pre>[[@LINE-63]]</pre></a></td><td class='uncovered-line'><pre>0</pre></td><td class='code'><pre>
 // HTML-ALL: <td class='line-number'><a name='L[[@LINE-63]]'><pre>[[@LINE-63]]</pre></a></td><td class='covered-line'><pre>1</pre></td><td class='code'><pre>}

llvm/trunk/tools/llvm-cov/CodeCoverage.cpp

CodeCoverageTool::createFunctionView(const FunctionRecord &Function,
   auto FunctionCoverage = Coverage.getCoverageForFunction(Function);
   if (FunctionCoverage.empty())
     return nullptr;
   auto SourceBuffer = getSourceFile(FunctionCoverage.getFilename());
   if (!SourceBuffer)
     return nullptr;
 
   auto Expansions = FunctionCoverage.getExpansions();
-  auto View = SourceCoverageView::create(getSymbolForHumans(Function.Name),
-                                         SourceBuffer.get(), ViewOpts,
-                                         std::move(FunctionCoverage));
+  auto View = SourceCoverageView::create(
+      getSymbolForHumans(Function.Name), SourceBuffer.get(), ViewOpts,
+      std::move(FunctionCoverage), /*FunctionView=*/true);
   attachExpansionSubViews(*View, Expansions, Coverage);
 
   return View;
 }
 
 std::unique_ptr<SourceCoverageView>
 CodeCoverageTool::createSourceFileView(StringRef SourceFile,
                                        const CoverageMapping &Coverage) {
auto View = SourceCoverageView::create(SourceFile, SourceBuffer.get(),
                                          ViewOpts, std::move(FileCoverage));
   attachExpansionSubViews(*View, Expansions, Coverage);
 
   for (const auto *Function : Coverage.getInstantiations(SourceFile)) {
     auto SubViewCoverage = Coverage.getCoverageForFunction(*Function);
     auto SubViewExpansions = SubViewCoverage.getExpansions();
     auto SubView = SourceCoverageView::create(
         getSymbolForHumans(Function->Name), SourceBuffer.get(), ViewOpts,
-        std::move(SubViewCoverage));
+        std::move(SubViewCoverage), /*FunctionView=*/true);
     attachExpansionSubViews(*SubView, SubViewExpansions, Coverage);
 
     if (SubView) {
       unsigned FileID = Function->CountedRegions.front().FileID;
       unsigned Line = 0;
       for (const auto &CR : Function->CountedRegions)
         if (CR.FileID == FileID)
           Line = std::max(CR.LineEnd, Line);
cl::list<std::string> DemanglerOpts(
       "Xdemangler", cl::desc("<demangler-path>|<demangler-option>"));
 
   auto commandLineParser = [&, this](int argc, const char **argv) -> int {
     cl::ParseCommandLineOptions(argc, argv, "LLVM code coverage tool\n");
     ViewOpts.Debug = DebugDump;
     CompareFilenamesOnly = FilenameEquivalence;
 
     ViewOpts.Format = Format;
+    SmallString<128> ObjectFilePath(this->ObjectFilename);
+    if (std::error_code EC = sys::fs::make_absolute(ObjectFilePath)) {
+      error(EC.message(), this->ObjectFilename);
+      return 1;
+    }
+    ViewOpts.ObjectFilename = ObjectFilePath.c_str();
     switch (ViewOpts.Format) {
     case CoverageViewOptions::OutputFormat::Text:
       ViewOpts.Colors = UseColor == cl::BOU_UNSET
                             ? sys::Process::StandardOutHasColors()
                             : UseColor == cl::BOU_TRUE;
       break;
     case CoverageViewOptions::OutputFormat::HTML:
       if (UseColor == cl::BOU_FALSE)
int CodeCoverageTool::show(int argc, const char **argv,
   cl::alias ShowOutputDirectoryA("o", cl::desc("Alias for --output-dir"),
                                  cl::aliasopt(ShowOutputDirectory));
 
   cl::opt<uint32_t> TabSize(
       "tab-size", cl::init(2),
       cl::desc(
           "Set tab expansion size for html coverage reports (default = 2)"));
 
+  cl::opt<std::string> ProjectTitle(
+      "project-title", cl::Optional,
+      cl::desc("Set project title for the coverage report"));
+
   auto Err = commandLineParser(argc, argv);
   if (Err)
     return Err;
 
   ViewOpts.ShowLineNumbers = true;
   ViewOpts.ShowLineStats = ShowLineExecutionCounts.getNumOccurrences() != 0 ||
                            !ShowRegions || ShowBestLineRegionsCounts;
   ViewOpts.ShowRegionMarkers = ShowRegions || ShowBestLineRegionsCounts;
   ViewOpts.ShowLineStatsOrRegionMarkers = ShowBestLineRegionsCounts;
   ViewOpts.ShowExpandedRegions = ShowExpansions;
   ViewOpts.ShowFunctionInstantiations = ShowInstantiations;
   ViewOpts.ShowOutputDirectory = ShowOutputDirectory;
   ViewOpts.TabSize = TabSize;
+  ViewOpts.ProjectTitle = ProjectTitle;
 
   if (ViewOpts.hasOutputDirectory()) {
     if (auto E = sys::fs::create_directories(ViewOpts.ShowOutputDirectory)) {
       error("Could not create output directory!", E.message());
       return 1;
     }
   }
 
+  sys::fs::file_status Status;
+  if (sys::fs::status(PGOFilename, Status)) {
+    error("profdata file error: can not get the file status. \n");
+    return 1;
+  }
+
+  auto ModifiedTime = Status.getLastModificationTime();
+  std::string ModifiedTimeStr = ModifiedTime.str();
+  size_t found = ModifiedTimeStr.rfind(":");
+  ViewOpts.CreatedTimeStr = (found != std::string::npos)
+                                ? "Created: " + ModifiedTimeStr.substr(0, found)
+                                : "Created: " + ModifiedTimeStr;
+
   auto Coverage = load();
   if (!Coverage)
     return 1;
 
   auto Printer = CoveragePrinter::create(ViewOpts);
 
   if (!Filters.empty()) {
     auto OSOrErr = Printer->createViewFile("functions", /*InToplevel=*/true);
for (const auto &Function : Coverage->getCoveredFunctions()) {
       mainView->print(*OS.get(), /*WholeFile=*/false, /*ShowSourceName=*/true);
     }
 
     Printer->closeViewFile(std::move(OS));
     return 0;
   }
 
   // Show files
-  bool ShowFilenames = SourceFiles.size() != 1;
+  bool ShowFilenames =
+      (SourceFiles.size() != 1) ||
+      (ViewOpts.Format == CoverageViewOptions::OutputFormat::HTML);
 
   if (SourceFiles.empty())
     // Get the source files from the function coverage mapping.
     for (StringRef Filename : Coverage->getUniqueSourceFiles())
       SourceFiles.push_back(Filename);
 
   // Create an index out of the source files.
   if (ViewOpts.hasOutputDirectory()) {

llvm/trunk/tools/llvm-cov/CoverageViewOptions.h

struct CoverageViewOptions {
   bool ShowLineStatsOrRegionMarkers;
   bool ShowExpandedRegions;
   bool ShowFunctionInstantiations;
   bool ShowFullFilenames;
   OutputFormat Format;
   std::string ShowOutputDirectory;
   std::vector<std::string> DemanglerOpts;
   uint32_t TabSize;
+  std::string ProjectTitle;
+  std::string ObjectFilename;
+  std::string CreatedTimeStr;
 
   /// \brief Change the output's stream color if the colors are enabled.
   ColoredRawOstream colored_ostream(raw_ostream &OS,
                                     raw_ostream::Colors Color) const {
     return llvm::colored_ostream(OS, Color, Colors);
   }
 
   /// \brief Check if an output directory has been specified.
   bool hasOutputDirectory() const { return !ShowOutputDirectory.empty(); }
 
   /// \brief Check if a demangler has been specified.
   bool hasDemangler() const { return !DemanglerOpts.empty(); }
+
+  /// \brief Check if a project title has been specified.
+  bool hasProjectTitle() const { return !ProjectTitle.empty(); }
+
+  /// \brief Check if the created time of the profile data file is available.
+  bool hasCreatedTime() const { return !CreatedTimeStr.empty(); }
 };
 }
 
 #endif // LLVM_COV_COVERAGEVIEWOPTIONS_H

llvm/trunk/tools/llvm-cov/SourceCoverageView.h

class SourceCoverageView {
 
   /// A container for all expansions (e.g macros) in the source on display.
   std::vector<ExpansionView> ExpansionSubViews;
 
   /// A container for all instantiations (e.g template functions) in the source
   /// on display.
   std::vector<InstantiationView> InstantiationSubViews;
 
+  /// Specifies whether or not the view is a function view.
+  bool FunctionView;
+
 protected:
   struct LineRef {
     StringRef Line;
     int64_t LineNo;
 
     LineRef(StringRef Line, int64_t LineNo) : Line(Line), LineNo(LineNo) {}
   };
 
   using CoverageSegmentArray = ArrayRef<const coverage::CoverageSegment *>;
 
   /// @name Rendering Interface
   /// @{
 
   /// \brief Render a header for the view.
   virtual void renderViewHeader(raw_ostream &OS) = 0;
 
   /// \brief Render a footer for the view.
   virtual void renderViewFooter(raw_ostream &OS) = 0;
 
   /// \brief Render the source name for the view.
-  virtual void renderSourceName(raw_ostream &OS) = 0;
+  virtual void renderSourceName(raw_ostream &OS, bool WholeFile) = 0;
 
   /// \brief Render the line prefix at the given \p ViewDepth.
   virtual void renderLinePrefix(raw_ostream &OS, unsigned ViewDepth) = 0;
 
   /// \brief Render the line suffix at the given \p ViewDepth.
   virtual void renderLineSuffix(raw_ostream &OS, unsigned ViewDepth) = 0;
 
   /// \brief Render a view divider at the given \p ViewDepth.
protected:
   /// \brief Render an expansion view and any nested views.
   virtual void renderExpansionView(raw_ostream &OS, ExpansionView &ESV,
                                    unsigned ViewDepth) = 0;
 
   /// \brief Render an instantiation view and any nested views.
   virtual void renderInstantiationView(raw_ostream &OS, InstantiationView &ISV,
                                        unsigned ViewDepth) = 0;
 
+  /// \brief Render the project title, the report title \p CellText and the
+  /// created time for the view.
+  virtual void renderCellInTitle(raw_ostream &OS, StringRef CellText) = 0;
+
+  /// \brief Render the table header for a given source file
+  virtual void renderTableHeader(raw_ostream &OS, unsigned IndentLevel = 0) = 0;
+
   /// @}
 
   /// \brief Format a count using engineering notation with 3 significant
   /// digits.
   static std::string formatCount(uint64_t N);
 
   /// \brief Check if region marker output is expected for a line.
   bool shouldRenderRegionMarkers(bool LineHasMultipleRegions) const;
 
   /// \brief Check if there are any sub-views attached to this view.
   bool hasSubViews() const;
 
   SourceCoverageView(StringRef SourceName, const MemoryBuffer &File,
                      const CoverageViewOptions &Options,
-                     coverage::CoverageData &&CoverageInfo)
+                     coverage::CoverageData &&CoverageInfo, bool FunctionView)
       : SourceName(SourceName), File(File), Options(Options),
-        CoverageInfo(std::move(CoverageInfo)) {}
+        CoverageInfo(std::move(CoverageInfo)), FunctionView(FunctionView) {}
 
 public:
   static std::unique_ptr<SourceCoverageView>
   create(StringRef SourceName, const MemoryBuffer &File,
          const CoverageViewOptions &Options,
-         coverage::CoverageData &&CoverageInfo);
+         coverage::CoverageData &&CoverageInfo, bool FucntionView = false);
 
   virtual ~SourceCoverageView() {}
 
   StringRef getSourceName() const { return SourceName; }
 
+  bool isFunctionView() const { return FunctionView; }
+
   const CoverageViewOptions &getOptions() const { return Options; }
 
   /// \brief Add an expansion subview to this view.
   void addExpansion(const coverage::CounterMappingRegion &Region,
                     std::unique_ptr<SourceCoverageView> View);
 
   /// \brief Add a function instantiation subview to this view.
   void addInstantiation(StringRef FunctionName, unsigned Line,

llvm/trunk/tools/llvm-cov/SourceCoverageView.cpp

 
 bool SourceCoverageView::hasSubViews() const {
   return !ExpansionSubViews.empty() || !InstantiationSubViews.empty();
 }
 
 std::unique_ptr<SourceCoverageView>
 SourceCoverageView::create(StringRef SourceName, const MemoryBuffer &File,
                            const CoverageViewOptions &Options,
-                           coverage::CoverageData &&CoverageInfo) {
+                           coverage::CoverageData &&CoverageInfo,
+                           bool FunctionView) {
   switch (Options.Format) {
   case CoverageViewOptions::OutputFormat::Text:
-    return llvm::make_unique<SourceCoverageViewText>(SourceName, File, Options,
-                                                     std::move(CoverageInfo));
+    return llvm::make_unique<SourceCoverageViewText>(
+        SourceName, File, Options, std::move(CoverageInfo), FunctionView);
   case CoverageViewOptions::OutputFormat::HTML:
-    return llvm::make_unique<SourceCoverageViewHTML>(SourceName, File, Options,
-                                                     std::move(CoverageInfo));
+    return llvm::make_unique<SourceCoverageViewHTML>(
+        SourceName, File, Options, std::move(CoverageInfo), FunctionView);
   }
   llvm_unreachable("Unknown coverage output format!");
 }
 
 void SourceCoverageView::addExpansion(
     const coverage::CounterMappingRegion &Region,
     std::unique_ptr<SourceCoverageView> View) {
   ExpansionSubViews.emplace_back(Region, std::move(View));
 }
 
 void SourceCoverageView::addInstantiation(
     StringRef FunctionName, unsigned Line,
     std::unique_ptr<SourceCoverageView> View) {
   InstantiationSubViews.emplace_back(FunctionName, Line, std::move(View));
 }
 
 void SourceCoverageView::print(raw_ostream &OS, bool WholeFile,
                                bool ShowSourceName, unsigned ViewDepth) {
-  if (ShowSourceName)
-    renderSourceName(OS);
+  if (WholeFile)
+    renderCellInTitle(OS, "Code Coverage Report");
 
   renderViewHeader(OS);
 
+  if (ShowSourceName)
+    renderSourceName(OS, WholeFile);
+
+  renderTableHeader(OS, ViewDepth);
   // We need the expansions and instantiations sorted so we can go through them
   // while we iterate lines.
   std::sort(ExpansionSubViews.begin(), ExpansionSubViews.end());
   std::sort(InstantiationSubViews.begin(), InstantiationSubViews.end());
   auto NextESV = ExpansionSubViews.begin();
   auto EndESV = ExpansionSubViews.end();
   auto NextISV = InstantiationSubViews.begin();
   auto EndISV = InstantiationSubViews.end();

llvm/trunk/tools/llvm-cov/SourceCoverageViewHTML.h

 };
 
 /// \brief A code coverage view which supports html-based rendering.
 class SourceCoverageViewHTML : public SourceCoverageView {
   void renderViewHeader(raw_ostream &OS) override;
 
   void renderViewFooter(raw_ostream &OS) override;
 
-  void renderSourceName(raw_ostream &OS) override;
+  void renderSourceName(raw_ostream &OS, bool WholeFile) override;
 
   void renderLinePrefix(raw_ostream &OS, unsigned ViewDepth) override;
 
   void renderLineSuffix(raw_ostream &OS, unsigned ViewDepth) override;
 
   void renderViewDivider(raw_ostream &OS, unsigned ViewDepth) override;
 
   void renderLine(raw_ostream &OS, LineRef L,
class SourceCoverageViewHTML : public SourceCoverageView {
   void renderLineCoverageColumn(raw_ostream &OS,
                                 const LineCoverageStats &Line) override;
 
   void renderLineNumberColumn(raw_ostream &OS, unsigned LineNo) override;
 
   void renderRegionMarkers(raw_ostream &OS, CoverageSegmentArray Segments,
                            unsigned ViewDepth) override;
 
+  void renderCellInTitle(raw_ostream &OS, StringRef CellText) override;
+
+  void renderTableHeader(raw_ostream &OS, unsigned IndentLevel) override;
+
 public:
   SourceCoverageViewHTML(StringRef SourceName, const MemoryBuffer &File,
                          const CoverageViewOptions &Options,
-                         coverage::CoverageData &&CoverageInfo)
-      : SourceCoverageView(SourceName, File, Options, std::move(CoverageInfo)) {
-  }
+                         coverage::CoverageData &&CoverageInfo,
+                         bool FunctionView)
+      : SourceCoverageView(SourceName, File, Options, std::move(CoverageInfo),
+                           FunctionView) {}
 };
 
 } // namespace llvm
 
 #endif // LLVM_COV_SOURCECOVERAGEVIEWHTML_H

llvm/trunk/tools/llvm-cov/SourceCoverageViewHTML.cpp

 /// \file This file implements the html coverage renderer.
 ///
 //===----------------------------------------------------------------------===//
 
 #include "SourceCoverageViewHTML.h"
 #include "llvm/ADT/Optional.h"
 #include "llvm/ADT/SmallString.h"
 #include "llvm/ADT/StringExtras.h"
+#include "llvm/Support/FileSystem.h"
 #include "llvm/Support/Path.h"
 
 using namespace llvm;
 
 namespace {
 
 // Return a string with the special characters in \p Str escaped.
 std::string escape(StringRef Str, const CoverageViewOptions &Opts) {

 pre {
   margin-top: 0px !important;
   margin-bottom: 0px !important;
 }
 .source-name-title {
   padding: 5px 10px;
   border-bottom: 1px solid #dbdbdb;
   background-color: #eee;
+  line-height: 35px;
 }
 .centered {
   display: table;
-  margin-left: auto;
+  margin-left: left;
   margin-right: auto;
   border: 1px solid #dbdbdb;
   border-radius: 3px;
 }
 .expansion-view {
   background-color: rgba(0, 0, 0, 0);
   margin-left: 0px;
   margin-top: 5px;
th, td {
   border-left: solid 1px #eee;
 }
 td:first-child {
   border-left: none;
 }
 td:last-child {
   border-right: none;
 }
+.project-title {
+  font-size:36.0pt;
+  line-height:200%;
+  font-family:Calibri;
+  font-weight: bold;
+}
+.report-title {
+  font-size:16.0pt;
+  line-height:120%;
+  font-family:Arial;
+  font-weight: bold;
+}
+.created-time {
+  font-size:14.0pt;
+  line-height:120%;
+  font-family:Arial;
+}
 )";
 
 const char *EndHeader = "</head>";
 
 const char *BeginCenteredDiv = "<div class='centered'>";
 
 const char *EndCenteredDiv = "</div>";
 

 const char *BeginExpansionDiv = "<div class='expansion-view'>";
 
 const char *EndExpansionDiv = "</div>";
 
 const char *BeginTable = "<table>";
 
 const char *EndTable = "</table>";
 
+const char *BeginProjectTitleDiv = "<div class='project-title'>";
+
+const char *EndProjectTitleDiv = "</div>";
+
+const char *BeginReportTitleDiv = "<div class='report-title'>";
+
+const char *EndReportTitleDiv = "</div>";
+
+const char *BeginCreatedTimeDiv = "<div class='created-time'>";
+
+const char *EndCreatedTimeDiv = "</div>";
+
+const char *LineBreak = "<br>";
+
 std::string getPathToStyle(StringRef ViewPath) {
   std::string PathToStyle = "";
   std::string PathSep = sys::path::get_separator();
   unsigned NumSeps = ViewPath.count(PathSep);
   for (unsigned I = 0, E = NumSeps; I < E; ++I)
     PathToStyle += ".." + PathSep;
   return PathToStyle + "style.css";
 }
 
 void emitPrelude(raw_ostream &OS, const CoverageViewOptions &Opts,
                  const std::string &PathToStyle = "") {
   OS << "<!doctype html>"
         "<html>"
      << BeginHeader;
 
   // Link to a stylesheet if one is available. Otherwise, use the default style.
   if (PathToStyle.empty())
     OS << "<style>" << CSSForCoverage << "</style>";
   else
     OS << "<link rel='stylesheet' type='text/css' href='"
        << escape(PathToStyle, Opts) << "'>";
 
-  OS << EndHeader << "<body>" << BeginCenteredDiv;
+  OS << EndHeader << "<body>";
 }
 
 void emitEpilog(raw_ostream &OS) {
-  OS << EndCenteredDiv << "</body>"
-                          "</html>";
+  OS << "</body>"
+     << "</html>";
 }
 
 } // anonymous namespace
 
 Expected<CoveragePrinter::OwnedStream>
 CoveragePrinterHTML::createViewFile(StringRef Path, bool InToplevel) {
   auto OSOrErr = createOutputStream(Path, "html", InToplevel);
   if (!OSOrErr)
Error CoveragePrinterHTML::createIndexFile(ArrayRef<StringRef> SourceFiles) {
   if (Error E = OSOrErr.takeError())
     return E;
   auto OS = std::move(OSOrErr.get());
   raw_ostream &OSRef = *OS.get();
 
   // Emit a table containing links to reports for each file in the covmapping.
   assert(Opts.hasOutputDirectory() && "No output directory for index file");
   emitPrelude(OSRef, Opts, getPathToStyle(""));
+  if (Opts.hasProjectTitle())
+    OSRef << BeginProjectTitleDiv
+          << tag("span", escape(Opts.ProjectTitle, Opts)) << EndProjectTitleDiv;
+  OSRef << BeginReportTitleDiv
+        << tag("span", escape("Code Coverage Report", Opts))
+        << EndReportTitleDiv;
+  if (Opts.hasCreatedTime())
+    OSRef << BeginCreatedTimeDiv
+          << tag("span", escape(Opts.CreatedTimeStr, Opts))
+          << EndCreatedTimeDiv;
+  OSRef << LineBreak;
+  OSRef << BeginCenteredDiv << BeginTable;
   OSRef << BeginSourceNameDiv << "Index" << EndSourceNameDiv;
-  OSRef << BeginTable;
   for (StringRef SF : SourceFiles) {
     std::string LinkText = escape(sys::path::relative_path(SF), Opts);
     std::string LinkTarget =
         escape(getOutputPath(SF, "html", /*InToplevel=*/false), Opts);
     OSRef << tag("tr", tag("td", tag("pre", a(LinkTarget, LinkText), "code")));
   }
-  OSRef << EndTable;
+  OSRef << EndTable << EndCenteredDiv;
   emitEpilog(OSRef);
 
   // Emit the default stylesheet.
   auto CSSOrErr = createOutputStream("style", "css", /*InToplevel=*/true);
   if (Error E = CSSOrErr.takeError())
     return E;
 
   OwnedStream CSS = std::move(CSSOrErr.get());
   CSS->operator<<(CSSForCoverage);
 
   return Error::success();
 }
 
 void SourceCoverageViewHTML::renderViewHeader(raw_ostream &OS) {
-  OS << BeginTable;
+  OS << LineBreak << BeginCenteredDiv << BeginTable;
 }
 
 void SourceCoverageViewHTML::renderViewFooter(raw_ostream &OS) {
-  OS << EndTable;
+  OS << EndTable << EndCenteredDiv;
 }
 
-void SourceCoverageViewHTML::renderSourceName(raw_ostream &OS) {
-  OS << BeginSourceNameDiv << tag("pre", escape(getSourceName(), getOptions()))
-     << EndSourceNameDiv;
+void SourceCoverageViewHTML::renderSourceName(raw_ostream &OS, bool WholeFile) {
+  OS << BeginSourceNameDiv;
+  // Render the source name for the view.
+  std::string SourceFile = isFunctionView() ? "Function: " : "Source: ";
+  SourceFile += getSourceName().str();
+  OS << tag("pre", escape(SourceFile, getOptions()));
+  // Render the object file name for the view.
+  if (WholeFile)
+    OS << tag("pre",
+              escape("Binary: " + getOptions().ObjectFilename, getOptions()));
+  OS << EndSourceNameDiv;
 }
 
 void SourceCoverageViewHTML::renderLinePrefix(raw_ostream &OS, unsigned) {
   OS << "<tr>";
 }
 
 void SourceCoverageViewHTML::renderLineSuffix(raw_ostream &OS, unsigned) {
   // If this view has sub-views, renderLine() cannot close the view's cell.

 
 void SourceCoverageViewHTML::renderInstantiationView(raw_ostream &OS,
                                                      InstantiationView &ISV,
                                                      unsigned ViewDepth) {
   OS << BeginExpansionDiv;
   ISV.View->print(OS, /*WholeFile=*/false, /*ShowSourceName=*/true, ViewDepth);
   OS << EndExpansionDiv;
 }
+
+void SourceCoverageViewHTML::renderCellInTitle(raw_ostream &OS,
+                                               StringRef CellText) {
+  if (getOptions().hasProjectTitle())
+    OS << BeginProjectTitleDiv
+       << tag("span", escape(getOptions().ProjectTitle, getOptions()))
+       << EndProjectTitleDiv;
+
+  OS << BeginReportTitleDiv << tag("span", escape(CellText, getOptions()))
+     << EndReportTitleDiv;
+
+  if (getOptions().hasCreatedTime())
+    OS << BeginCreatedTimeDiv
+       << tag("span", escape(getOptions().CreatedTimeStr, getOptions()))
+       << EndCreatedTimeDiv;
+}
+
+void SourceCoverageViewHTML::renderTableHeader(raw_ostream &OS,
+                                               unsigned ViewDepth) {
+  renderLinePrefix(OS, ViewDepth);
+  OS << tag("td", tag("span", tag("pre", escape("Line No.", getOptions()))))
+     << tag("td", tag("span", tag("pre", escape("Count No.", getOptions()))))
+     << tag("td", tag("span", tag("pre", escape("Source", getOptions()))));
+  renderLineSuffix(OS, ViewDepth);
+}

llvm/trunk/tools/llvm-cov/SourceCoverageViewText.h

 };
 
 /// \brief A code coverage view which supports text-based rendering.
 class SourceCoverageViewText : public SourceCoverageView {
   void renderViewHeader(raw_ostream &OS) override;
 
   void renderViewFooter(raw_ostream &OS) override;
 
-  void renderSourceName(raw_ostream &OS) override;
+  void renderSourceName(raw_ostream &OS, bool WholeFile) override;
 
   void renderLinePrefix(raw_ostream &OS, unsigned ViewDepth) override;
 
   void renderLineSuffix(raw_ostream &OS, unsigned ViewDepth) override;
 
   void renderViewDivider(raw_ostream &OS, unsigned ViewDepth) override;
 
   void renderLine(raw_ostream &OS, LineRef L,
class SourceCoverageViewText : public SourceCoverageView {
   void renderLineCoverageColumn(raw_ostream &OS,
                                 const LineCoverageStats &Line) override;
 
   void renderLineNumberColumn(raw_ostream &OS, unsigned LineNo) override;
 
   void renderRegionMarkers(raw_ostream &OS, CoverageSegmentArray Segments,
                            unsigned ViewDepth) override;
 
+  void renderCellInTitle(raw_ostream &OS, StringRef CellText) override;
+
+  void renderTableHeader(raw_ostream &OS, unsigned IndentLevel) override;
+
 public:
   SourceCoverageViewText(StringRef SourceName, const MemoryBuffer &File,
                          const CoverageViewOptions &Options,
-                         coverage::CoverageData &&CoverageInfo)
-      : SourceCoverageView(SourceName, File, Options, std::move(CoverageInfo)) {
-  }
+                         coverage::CoverageData &&CoverageInfo,
+                         bool FunctionView)
+      : SourceCoverageView(SourceName, File, Options, std::move(CoverageInfo),
+                           FunctionView) {}
 };
 
 } // namespace llvm
 
 #endif // LLVM_COV_SOURCECOVERAGEVIEWTEXT_H

llvm/trunk/tools/llvm-cov/SourceCoverageViewText.cpp

 }
 
 } // anonymous namespace
 
 void SourceCoverageViewText::renderViewHeader(raw_ostream &) {}
 
 void SourceCoverageViewText::renderViewFooter(raw_ostream &) {}
 
-void SourceCoverageViewText::renderSourceName(raw_ostream &OS) {
+void SourceCoverageViewText::renderSourceName(raw_ostream &OS, bool WholeFile) {
   getOptions().colored_ostream(OS, raw_ostream::CYAN) << getSourceName()
                                                       << ":\n";
+  if (WholeFile) {
+    getOptions().colored_ostream(OS, raw_ostream::CYAN)
+        << getOptions().ObjectFilename << ":\n";
+  }
 }
 
 void SourceCoverageViewText::renderLinePrefix(raw_ostream &OS,
                                               unsigned ViewDepth) {
   for (unsigned I = 0; I < ViewDepth; ++I)
     OS << "  |";
 }
 

 
 void SourceCoverageViewText::renderInstantiationView(raw_ostream &OS,
                                                      InstantiationView &ISV,
                                                      unsigned ViewDepth) {
   renderLinePrefix(OS, ViewDepth);
   OS << ' ';
   ISV.View->print(OS, /*WholeFile=*/false, /*ShowSourceName=*/true, ViewDepth);
 }
+
+void SourceCoverageViewText::renderCellInTitle(raw_ostream &OS,
+                                               StringRef CellText) {
+  if (getOptions().hasProjectTitle())
+    getOptions().colored_ostream(OS, raw_ostream::CYAN)
+        << getOptions().ProjectTitle << "\n";
+
+  getOptions().colored_ostream(OS, raw_ostream::CYAN) << CellText << "\n";
+
+  if (getOptions().hasCreatedTime())
+    getOptions().colored_ostream(OS, raw_ostream::CYAN)
+        << getOptions().CreatedTimeStr << "\n";
+}
+
+void SourceCoverageViewText::renderTableHeader(raw_ostream &, unsigned) {}