Create llvm-cov structured export submodule

[ehurtig]

Summary

This patch enables users to export coverage information into portable JSON for use by analysis tools and storage in document based databases. This will expose the coverage information gathered by the instrumentation in such a fashion that automated tooling will be able to process coverage information.

The export submodule is invoked just like the the report subcommand

$ llvm-cov export -instr-profile /path/to/foo.profdata /path/to/foo

The resulting JSON contains a list of Files and Functions.

Every file object contains a list of segments, expansions, and a summary of the file's region, function, and line coverage.

Every function object contains the function's name and regions

There is also a total summary for the entire object file.

A documentation patch is incoming to update https://github.com/llvm-mirror/clang/blob/master/docs/SourceBasedCodeCoverage.rst

[vsk]

Thank you for working on this! I just have small nitpicks -- functionally, this patch looks like it's in great shape.

Could you add a short (1-2 line) description of the export command to docs/CommandGuide/llvm-cov.rst?

test/tools/llvm-cov/Inputs/highlightedRanges.json

8

Can you use your shorter filename-matching regex for all filenames? Something like {{[^\"]+}}showHighlightedRanges.cpp in this case.

10

Here, it would be less brittle / more succinct to say:

CHECK-SAME: {{(\[[0-9]+,[0-9]+,[0-9]+,[0-9]+,[0-9]+\],?)+}}

We should do this for all arrays of regions/segments. If we need to change the format later on, it'll be much easier to do so this way. Plus, it's easier to check that a regex is correct vs. the actual region counts.

test/tools/llvm-cov/Inputs/showExpansions.json

35

Why are there 4 of the same filenames? It sounds like a bug.. maybe fixed by clang/r275924 (remove '..' from filenames and normalize them)?

tools/llvm-cov/CoverageExporterJson.cpp

92

No reference needed here, since an int64_t is cheaper to copy than to deref+load. Also, value should be capitalized (this applies elsewhere).

199

Stray semicolon.

202

Unused parameter. Please drop.

243

Change renderFile to accept a const CoverageData &, and pass FileCoverage by reference. That's cheaper.

264

This should be const auto &.

265

Braces around single-statement loops are usually dropped.

296

Should be const CoverageSegment &.

345

Stray semi-colon.

348

Should be const CountedRegion &.

366

Should be const FileCoverageSummary &.

[ehurtig]

test/tools/llvm-cov/Inputs/showExpansions.json

35

Yeah I thought it was a bug at first, however, I have a feeling it is expected and has to do with nested expansions. The source for showExpansions.cpp:

#define DO_SOMETHING_ELSE() \
  do {                      \
  } while (0)
#define ANOTHER_THING() \
  do {                  \
    if (0) {            \
    }                   \
  } while (0)

#define DO_SOMETHING(x)    \
  do {                     \
    if (x)                 \
      DO_SOMETHING_ELSE(); \
    else                   \
      ANOTHER_THING();     \
  } while (0)
// CHECK-DAG: Expansion at line [[@LINE-4]], 7 -> 24
// CHECK-DAG: Expansion at line [[@LINE-3]], 7 -> 20

int main(int argc, const char *argv[]) {
  for (int i = 0; i < 100; ++i)
    DO_SOMETHING(i); // CHECK-DAG: Expansion at line [[@LINE]], 5 -> 17
  return 0;
}

0. FileID for the "Main" or "Source" file.

1. For the expansion of DO_SOMETHING
2. For the expansion of ANOTHER_THING
3. For the expansion of DO_SOMETHING_ELSE

Not saying whether it is right or wrong, just offering what I think is the reason for the duplicate filenames and separate FileIDs

tools/llvm-cov/CoverageExporterJson.cpp

202

In order to match the rest of the render* functions, and specifically the renderFiles(... list of files ...) function, I have fixed the function to actually use this parameter and actually render the functions given to it.

243

There were some issues blocking this that are now resolved by some NFCs in r276474 and thus I have made the necessary changes to resolve this as well

[ehurtig]

Address review feedback

[vsk]

Thank you again for your work on this. It should make it a lot easier to build reporting/analytics tools that work with coverage data.

This LGTM. Let's leave it up for another day to see if anyone has more feedback. I think the CommandGuide change is still missing, but that's a ~1 line change we can make pre-commit.

test/tools/llvm-cov/Inputs/binary-formats.canonical.json

+// Metadata section
+// CHECK: {"version":"1.0.0","type":"llvm.coverage.json.export","data":[
+
+// Open Export
+// CHECK-SAME: {"object":"{{[^\"]+}}","files":[
+
+// File Object
+// CHECK-SAME: {"filename":"/tmp/binary-formats.c",
+// CHECK-SAME: "segments":[
+// CHECK-SAME: [4,40,100,1,1],[4,42,0,0,0]],
+// CHECK-SAME: "expansions":[],
+
+// Verify the Summary Section for the first file
+// CHECK-SAME: "summary":{
+// CHECK-SAME: "lines":{"count":1,"covered":1,"percent":100,"noncode":0},
+// CHECK-SAME: "functions":{"count":1,"covered":1,"percent":100},
+// CHECK-SAME: "regions":{"count":1,"covered":1,"notcovered":0,"percent":100}}}
+
+// Close Files Array
+// CHECK-SAME: ],
+
+// Functions List
+// CHECK-SAME: "functions":[
+// CHECK-SAME: {"name":"main","count":100,"regions":[
+// CHECK-SAME: [4,40,4,42,100,0,0,0]
+// CHECK-SAME: ],
+// CHECK-SAME: "filenames":["/tmp/binary-formats.c"]
+// CHECK-SAME: }],
+
+
+// Full Export Summary
+// CHECK-SAME: "totals":{
+// CHECK-SAME: "lines":{"count":1,"covered":1,"percent":100,"noncode":0},
+// CHECK-SAME: "functions":{"count":1,"covered":1,"percent":100},
+// CHECK-SAME: "regions":{"count":1,"covered":1,"notcovered":0,"percent":100}}
+
+// Close the export object, data array, and root object
+// CHECK-SAME: }]}

test/tools/llvm-cov/Inputs/highlightedRanges.json

+// Metadata section
+// CHECK: {"version":"1.0.0","type":"llvm.coverage.json.export","data":[
+
+// Open Export
+// CHECK-SAME: {"object":"{{[^\"]+}}","files":[
+
+// File Object
+// CHECK-SAME: {"filename":"/Users/bogner/code/llvm/test/tools/llvm-cov/showHighlightedRanges.cpp",
+// CHECK-SAME: "segments":[
+// CHECK-SAME: [3,13,1,1,1],[5,3,0,1,1],[6,2,1,1,0],[6,2,0,0,0],
+// CHECK-SAME: [8,19,1,1,1],[9,13,1,1,1],[10,11,1,1,1],[10,17,1,1,0],
+// CHECK-SAME: [10,19,1,1,1],[12,7,0,1,1],[13,6,1,1,0],[14,5,0,1,1],
+// CHECK-SAME: [15,4,1,1,0],[16,2,0,0,0],[18,13,1,1,1],[21,10,0,1,1],
+// CHECK-SAME: [23,4,1,1,0],[23,10,1,1,1],[25,4,1,1,0],[28,19,1,1,1],
+// CHECK-SAME: [28,24,1,1,0],[28,26,0,1,1],[28,29,1,1,0],[28,31,0,1,1],
+// CHECK-SAME: [30,4,1,1,0],[32,16,1,1,1],[33,17,1,1,0],[34,16,0,1,1],
+// CHECK-SAME: [34,21,1,1,0],[35,16,0,1,1],[36,17,1,1,0],[37,16,1,1,1],
+// CHECK-SAME: [37,21,1,1,0],[38,2,0,0,0],[40,12,1,1,1],[45,2,0,0,0]]
+// CHECK-SAME: "expansions":[],
+
+// Verify the Summary Section for the first file
+// CHECK-SAME: "summary":{
+// CHECK-SAME: "lines":{"count":40,"covered":26,"percent":65,"noncode":0},
+// CHECK-SAME: "functions":{"count":4,"covered":4,"percent":100},
+// CHECK-SAME: "regions":{"count":19,"covered":11,"notcovered":8,"percent":57}}}
+
+// Close Files Array
+// CHECK-SAME: ],
+
+// Functions List
+// CHECK-SAME: "functions":[
+// CHECK-SAME: {"name":"_Z4funcv","count":1,"regions":[
+// CHECK-SAME: [3,13,6,2,1,0,0,0],[5,3,6,2,0,0,0,0]
+// CHECK-SAME: ],
+// CHECK-SAME: "filenames":["/Users/bogner/code/llvm/test/tools/llvm-cov/showHighlightedRanges.cpp"]
+// CHECK-SAME: }
+// CHECK-SAME: {"name":"_Z5func2i","count":1,"regions":[
+// CHECK-SAME: [8,19,16,2,1,0,0,0],[9,13,15,4,1,0,0,0],
+// CHECK-SAME: [10,11,10,17,1,0,0,0],[10,19,13,6,1,0,0,0],
+// CHECK-SAME: [12,7,13,6,0,0,0,0],[14,5,15,4,0,0,0,0]
+// CHECK-SAME: ],
+// CHECK-SAME: "filenames":["/Users/bogner/code/llvm/test/tools/llvm-cov/showHighlightedRanges.cpp"]
+// CHECK-SAME: }
+// CHECK-SAME: {"name":"_Z4testv","count":1,"regions":[
+// CHECK-SAME: [18,13,38,2,1,0,0,0],[21,10,23,4,0,0,0,0],
+// CHECK-SAME: [23,10,25,4,1,0,0,0],[28,19,28,24,1,0,0,0],
+// CHECK-SAME: [28,26,28,29,0,0,0,0],[28,31,30,4,0,0,0,0],
+// CHECK-SAME: [32,16,33,17,1,0,0,0],[34,16,34,21,0,0,0,0],
+// CHECK-SAME: [35,16,36,17,0,0,0,0],[37,16,37,21,1,0,0,0]
+// CHECK-SAME: ],
+// CHECK-SAME: "filenames":["/Users/bogner/code/llvm/test/tools/llvm-cov/showHighlightedRanges.cpp"]
+// CHECK-SAME: }
+// CHECK-SAME: {"name":"main","count":1,"regions":[
+// CHECK-SAME: [40,12,45,2,1,0,0,0]
+// CHECK-SAME: ],
+// CHECK-SAME: "filenames":["/Users/bogner/code/llvm/test/tools/llvm-cov/showHighlightedRanges.cpp"]
+// CHECK-SAME: }],
+
+
+// Full Export Summary
+// CHECK-SAME: "totals":{
+// CHECK-SAME: "lines":{"count":40,"covered":26,"percent":65,"noncode":0},
+// CHECK-SAME: "functions":{"count":4,"covered":4,"percent":100},
+// CHECK-SAME: "regions":{"count":19,"covered":11,"notcovered":8,"percent":57}}
+
+// Close the export object, data array, and root object
+// CHECK-SAME: }]}

test/tools/llvm-cov/Inputs/lineExecutionCounts.json

+// Metadata section
+// CHECK: {"version":"1.0.0","type":"llvm.coverage.json.export","data":[
+
+// Open Export
+// CHECK-SAME: {"object":"{{[^\"]+}}","files":[
+
+// File Object
+// CHECK-SAME: {"filename":"/tmp/showLineExecutionCounts.cpp",
+// CHECK-SAME: "segments":[
+// CHECK-SAME: [6,24,161,1,1],[9,20,0,1,1],[11,4,161,1,0],[11,20,161,1,1],
+// CHECK-SAME: [13,4,161,1,0],[15,38,16261,1,1],[15,26,161,1,0],
+// CHECK-SAMEL [15,56,16100,1,1],[15,31,161,1,0],[15,66,16100,1,1],
+// CHECK-SAME: [17,4,161,1,0],[19,32,161,1,1],[19,21,161,1,0],[19,48,0,1,1],
+// CHECK-SAME: [19,29,161,1,0],[21,18,0,1,1],[21,14,161,1,0],[22,18,161,1,1],
+// CHECK-SAME: [22,14,161,1,0],[25,2,0,0,0]],
+// CHECK-SAME: "expansions":[],
+
+// Verify the Summary Section for the first file
+// CHECK-SAME: "summary":{
+// CHECK-SAME: "lines":{"count":20,"covered":16,"percent":80,"noncode":0},
+// CHECK-SAME: "functions":{"count":1,"covered":1,"percent":100},
+// CHECK-SAME: "regions":{"count":10,"covered":7,"notcovered":3,"percent":70}}}
+
+// Close Files Array
+// CHECK-SAME: ],
+
+// Functions List
+// CHECK-SAME: "functions":[
+// CHECK-SAME: {"name":"main","count":161,"regions":[
+// CHECK-SAME: [6,24,25,2,161,0,0,0],[9,20,11,4,0,0,0,0],
+// CHECK-SAME: [11,20,13,4,161,0,0,0],[15,38,15,26,16261,0,0,0],
+// CHECK-SAME: [15,56,15,31,16100,0,0,0],[15,66,17,4,16100,0,0,0],
+// CHECK-SAME: [19,32,19,21,161,0,0,0],[19,48,19,29,0,0,0,0],
+// CHECK-SAME: [21,18,21,14,0,0,0,0],[22,18,22,14,161,0,0,0]
+// CHECK-SAME: ],
+// CHECK-SAME: "filenames":["/tmp/showLineExecutionCounts.cpp"]
+// CHECK-SAME: }],
+
+
+// Full Export Summary
+// CHECK-SAME: "totals":{
+// CHECK-SAME: "lines":{"count":20,"covered":16,"percent":80,"noncode":0},
+// CHECK-SAME: "functions":{"count":1,"covered":1,"percent":100},
+// CHECK-SAME: "regions":{"count":10,"covered":7,"notcovered":3,"percent":70}}
+
+// Close the export object, data array, and root object
+// CHECK-SAME: }]}

test/tools/llvm-cov/Inputs/regionMarkers.json

+// Metadata section
+// CHECK: {"version":"1.0.0","type":"llvm.coverage.json.export","data":[
+
+// Open Export
+// CHECK-SAME: {"object":"{{[^\"]+}}","files":[
+
+// File Object
+// CHECK-SAME: {"filename":"/Users/bogner/code/llvm/test/tools/llvm-cov/showRegionMarkers.cpp",
+// CHECK-SAME: "segments":[
+// CHECK-SAME: [3,12,1111000,1,1],[6,10,0,1,1],[8,4,1111000,1,0],
+// CHECK-SAME: [8,10,1111000,1,1],[10,4,1111000,1,0],[13,19,112211000,1,1],
+// CHECK-SAME: [13,26,1111000,1,0],[13,28,111100000,1,1],[13,31,1111000,1,0],
+// CHECK-SAME: [13,33,111100000,1,1],[15,4,1111000,1,0],[17,16,1111000,1,1],
+// CHECK-SAME: [17,21,1111000,1,0],[17,24,0,1,1],[17,29,1111000,1,0],
+// CHECK-SAME: [19,9,0,1,1],[19,14,1111000,1,0],[20,9,1111000,1,1],
+// CHECK-SAME: [20,14,1111000,1,0],[23,2,0,0,0]],
+// CHECK-SAME: "expansions":[],
+
+// Verify the Summary Section for the first file
+// CHECK-SAME: "summary":{
+// CHECK-SAME: "lines":{"count":21,"covered":17,"percent":80,"noncode":0},
+// CHECK-SAME: "functions":{"count":1,"covered":1,"percent":100},
+// CHECK-SAME: "regions":{"count":10,"covered":7,"notcovered":3,"percent":70}}
+
+// Close Files Array
+// CHECK-SAME: ],
+
+// Functions List
+// CHECK-SAME: "functions":[
+// CHECK-SAME: {"name":"main","count":1111000,"regions":[
+// CHECK-SAME: [3,12,23,2,1111000,0,0,0],[6,10,8,4,0,0,0,0],
+// CHECK-SAME: [8,10,10,4,1111000,0,0,0],[13,19,13,26,112211000,0,0,0],
+// CHECK-SAME: [13,28,13,31,111100000,0,0,0],[13,33,15,4,111100000,0,0,0],
+// CHECK-SAME: [17,16,17,21,1111000,0,0,0],[17,24,17,29,0,0,0,0],
+// CHECK-SAME: [19,9,19,14,0,0,0,0],[20,9,20,14,1111000,0,0,0]
+// CHECK-SAME: ],
+// CHECK-SAME: "filenames":["/Users/bogner/code/llvm/test/tools/llvm-cov/showRegionMarkers.cpp"]
+// CHECK-SAME: }],
+
+// Full Export Summary
+// CHECK-SAME: "totals":{
+// CHECK-SAME: "lines":{"count":21,"covered":17,"percent":80,"noncode":0},
+// CHECK-SAME: "functions":{"count":1,"covered":1,"percent":100},
+// CHECK-SAME: "regions":{"count":10,"covered":7,"notcovered":3,"percent":70}}
+
+// Close the export object, data array, and root object
+// CHECK-SAME: }]}

test/tools/llvm-cov/Inputs/showExpansions.json

+// Metadata section
+// CHECK: {"version":"1.0.0","type":"llvm.coverage.json.export","data":[
+
+// Open Export
+// CHECK-SAME: {"object":"{{[^\"]+}}","files":[
+
+// File Object
+// CHECK-SAME: {"filename":"{{[^\"]+}}/showExpansions.cpp",
+// CHECK-SAME: "segments":[
+// CHECK-SAME: [4,3,99,1,1],[4,6,99,1,1],[5,4,99,1,0],
+// CHECK-SAME: [5,12,99,1,1],[5,13,99,1,0],[5,14,0,0,0],
+// CHECK-SAME: [7,3,1,1,1],[7,6,1,1,1],[8,12,0,1,1],
+// CHECK-SAME: [9,6,1,1,0],[10,4,1,1,0],[10,12,1,1,1],
+// CHECK-SAME: [10,13,1,1,0],[10,14,0,0,0],[13,3,100,1,1],
+// CHECK-SAME: [13,6,100,1,1],[15,7,99,1,1],[15,24,100,1,0],
+// CHECK-SAME: [17,7,1,1,1],[17,20,100,1,0],[18,4,100,1,0],
+// CHECK-SAME: [18,12,100,1,1],[18,13,100,1,0],[18,14,0,0,0],
+// CHECK-SAME: [22,40,1,1,1],[23,19,101,1,1],[23,26,1,1,0],
+// CHECK-SAME: [23,28,100,1,1],[23,31,1,1,0],[24,5,100,1,1],
+// CHECK-SAME: [24,17,1,1,0],[26,2,0,0,0]],
+// CHECK-SAME: "expansions":[
+// CHECK-SAME: {"source_region":[24,5,24,17,100,0,1,1],
+// CHECK-SAME: "target_regions":[
+// CHECK-SAME: [22,40,26,2,1,0,0,0],[23,19,23,26,101,0,0,0],
+// CHECK-SAME: [23,28,23,31,100,0,0,0],[24,5,24,17,100,0,1,1],
+// CHECK-SAME: [13,3,18,14,100,1,0,0],[13,6,18,4,100,1,0,0],
+// CHECK-SAME: [15,7,15,24,99,1,2,1],[17,7,17,20,1,1,3,1],
+// CHECK-SAME: [18,12,18,13,100,1,0,0],[4,3,5,14,99,2,0,0],
+// CHECK-SAME: [4,6,5,4,99,2,0,0],[5,12,5,13,99,2,0,0],
+// CHECK-SAME: [7,3,10,14,1,3,0,0],[7,6,10,4,1,3,0,0],
+// CHECK-SAME: [8,12,9,6,0,3,0,0],[10,12,10,13,1,3,0,0]],
+
+// Yes, 4 of the same filename in a row
+// CHECK-SAME: "filenames":[
+// CHECK-SAME: "{{[^\"]+}}/showExpansions.cpp","{{[^\"]+}}/showExpansions.cpp",
+// CHECK-SAME: "{{[^\"]+}}/showExpansions.cpp","{{[^\"]+}}/showExpansions.cpp"]
+// CHECK-SAME: }],
+
+// Verify the Summary Section for the first file
+// CHECK-SAME: "summary":{
+// CHECK-SAME: "lines":{"count":17,"covered":15,"percent":88,"noncode":0},
+// CHECK-SAME: "functions":{"count":1,"covered":1,"percent":100},
+// CHECK-SAME: "regions":{"count":13,"covered":12,"notcovered":1,"percent":92}}
+
+// Close Files Array
+// CHECK-SAME: ],
+
+// Functions List
+// CHECK-SAME: "functions":[
+// CHECK-SAME: {"name":"main","count":1,"regions":[
+// CHECK-SAME: [22,40,26,2,1,0,0,0],[23,19,23,26,101,0,0,0],
+// CHECK-SAME: [23,28,23,31,100,0,0,0],[24,5,24,17,100,0,1,1],
+// CHECK-SAME: [13,3,18,14,100,1,0,0],[13,6,18,4,100,1,0,0],
+// CHECK-SAME: [15,7,15,24,99,1,2,1],[17,7,17,20,1,1,3,1],
+// CHECK-SAME: [18,12,18,13,100,1,0,0],[4,3,5,14,99,2,0,0],
+// CHECK-SAME: [4,6,5,4,99,2,0,0],[5,12,5,13,99,2,0,0],
+// CHECK-SAME: [7,3,10,14,1,3,0,0],[7,6,10,4,1,3,0,0],
+// CHECK-SAME: [8,12,9,6,0,3,0,0],[10,12,10,13,1,3,0,0]],
+// CHECK-SAME: "filenames":[
+// CHECK-SAME: "{{[^\"]+}}/showExpansions.cpp",
+// CHECK-SAME: "{{[^\"]+}}/showExpansions.cpp",
+// CHECK-SAME: "{{[^\"]+}}/showExpansions.cpp",
+// CHECK-SAME: "{{[^\"]+}}/showExpansions.cpp"]
+// CHECK-SAME: }],
+
+// Full Export Summary
+// CHECK-SAME: "totals":{
+// CHECK-SAME: "lines":{"count":17,"covered":15,"percent":88,"noncode":0},
+// CHECK-SAME: "functions":{"count":1,"covered":1,"percent":100},
+// CHECK-SAME: "regions":{"count":13,"covered":12,"notcovered":1,"percent":92}}
+
+// Close the export object, data array, and root object
+// CHECK-SAME: }]}

test/tools/llvm-cov/Inputs/universal-binary.json

+// Metadata section
+// CHECK: {"version":"1.0.0","type":"llvm.coverage.json.export","data":[
+
+// Open Export
+// CHECK-SAME: {"object":"{{[^\"]+}}","files":[
+
+// File Object
+// CHECK-SAME: {"filename":"/tmp/universal-binary.c",
+// CHECK-SAME: "segments":[
+// CHECK-SAME: [4,40,100,1,1],[4,42,0,0,0]],
+// CHECK-SAME: "expansions":[],
+
+// Verify the Summary Section for the first file
+// CHECK-SAME: "summary":{
+// CHECK-SAME: "lines":{"count":1,"covered":1,"percent":100,"noncode":0},
+// CHECK-SAME: "functions":{"count":1,"covered":1,"percent":100},
+// CHECK-SAME: "regions":{"count":1,"covered":1,"notcovered":0,"percent":100}}
+
+// Close Files Array
+// CHECK-SAME: ],
+
+// Functions List
+// CHECK-SAME: "functions":[
+// CHECK-SAME: {"name":"main","count":100,"regions":[
+// CHECK-SAME: [4,40,4,42,100,0,0,0]],
+// CHECK-SAME: "filenames":["/tmp/universal-binary.c"]
+// CHECK-SAME: }],
+
+// Full Export Summary
+// CHECK-SAME: "totals":{
+// CHECK-SAME: "lines":{"count":1,"covered":1,"percent":100,"noncode":0},
+// CHECK-SAME: "functions":{"count":1,"covered":1,"percent":100},
+// CHECK-SAME: "regions":{"count":1,"covered":1,"notcovered":0,"percent":100}
+
+// Close the export object, data array, and root object
+// CHECK-SAME: }]}

test/tools/llvm-cov/binary-formats.c

 // RUN: llvm-cov show %S/Inputs/binary-formats.macho32l -instr-profile %t.profdata -filename-equivalence %s | FileCheck %s
 // RUN: llvm-cov show %S/Inputs/binary-formats.macho64l -instr-profile %t.profdata -filename-equivalence %s | FileCheck %s
 // RUN: llvm-cov show %S/Inputs/binary-formats.macho32b -instr-profile %t.profdata -filename-equivalence %s | FileCheck %s
+
+// RUN: llvm-cov export %S/Inputs/binary-formats.macho32l -instr-profile %t.profdata -filename-equivalence %s | FileCheck %S/Inputs/binary-formats.canonical.json
+// RUN: llvm-cov export %S/Inputs/binary-formats.macho64l -instr-profile %t.profdata -filename-equivalence %s | FileCheck %S/Inputs/binary-formats.canonical.json
+// RUN: llvm-cov export %S/Inputs/binary-formats.macho32b -instr-profile %t.profdata -filename-equivalence %s | FileCheck %S/Inputs/binary-formats.canonical.json

test/tools/llvm-cov/showExpansions.cpp

     DO_SOMETHING(i); // CHECK-DAG: Expansion at line [[@LINE]], 5 -> 17
   return 0;
 }
+// RUN: llvm-cov export %S/Inputs/showExpansions.covmapping -instr-profile %S/Inputs/showExpansions.profdata -filename-equivalence %s 2>&1 | FileCheck %S/Inputs/showExpansions.json

test/tools/llvm-cov/showHighlightedRanges.cpp

   func2(9);
   return 0;
 }
+// RUN: llvm-cov export %S/Inputs/highlightedRanges.covmapping -instr-profile %S/Inputs/highlightedRanges.profdata -filename-equivalence %s 2>&1 | FileCheck %S/Inputs/highlightedRanges.json

test/tools/llvm-cov/showLineExecutionCounts.cpp

 // HTML: <td class='covered-line'><pre>161</pre></td><td class='line-number'><a name='L[[@LINE-44]]'><pre>[[@LINE-44]]</pre></a></td><td class='code'><pre>}
 // HTML-WHOLE-FILE: <td class='uncovered-line'></td><td class='line-number'><a name='L[[@LINE-44]]'><pre>[[@LINE-44]]</pre></a></td><td class='code'><pre>// after
 // HTML-FILTER-NOT: <td class='uncovered-line'></td><td class='line-number'><a name='L[[@LINE-45]]'><pre>[[@LINE-45]]</pre></a></td><td class='code'><pre>// after
+
+// RUN: llvm-cov export %S/Inputs/lineExecutionCounts.covmapping -instr-profile %t.profdata -filename-equivalence -name=main %s | FileCheck %S/Inputs/lineExecutionCounts.json

test/tools/llvm-cov/showRegionMarkers.cpp

 }
 
 // RUN: llvm-cov show %S/Inputs/regionMarkers.covmapping -instr-profile %t.profdata -show-regions -dump -filename-equivalence %s 2>&1 | FileCheck %s
+
+// RUN: llvm-cov export %S/Inputs/regionMarkers.covmapping -instr-profile %t.profdata -filename-equivalence %s 2>&1  %s | FileCheck %S/Inputs/regionMarkers.json

test/tools/llvm-cov/universal-binary.c

 
 // RUN: llvm-profdata merge %S/Inputs/universal-binary.proftext -o %t.profdata
 // RUN: llvm-cov show %S/Inputs/universal-binary -instr-profile %t.profdata -filename-equivalence %s -arch x86_64 | FileCheck %s
+// RUN: llvm-cov export %S/Inputs/universal-binary -instr-profile %t.profdata -filename-equivalence %s -arch x86_64 | FileCheck %S/Inputs/universal-binary.json
+
 
 // RUN: not llvm-cov show %S/Inputs/universal-binary -instr-profile %t.profdata -filename-equivalence %s -arch i386 2>&1 | FileCheck --check-prefix=WRONG-ARCH %s
 // WRONG-ARCH: Failed to load coverage

tools/llvm-cov/CMakeLists.txt

   llvm-cov.cpp
   gcov.cpp
   CodeCoverage.cpp
+  CoverageExporterJson.cpp
   CoverageFilters.cpp
   CoverageReport.cpp
   CoverageSummaryInfo.cpp

tools/llvm-cov/CodeCoverage.cpp

 using namespace llvm;
 using namespace coverage;
 
+void exportCoverageDataToJson(StringRef ObjectFilename,
+                              const CoverageViewOptions &Options,
+                              const coverage::CoverageMapping &CoverageMapping,
+                              raw_ostream &OS);
+
 namespace {
 /// \brief The implementation of the coverage tool.
 class CodeCoverageTool {

     /// \brief The show command.
     Show,
     /// \brief The report command.
-    Report
+    Report,
+    /// \brief The export command.
+    Export
   };
 
   /// \brief Print the error message to the error output stream.

   int report(int argc, const char **argv,
              CommandLineParserType commandLineParser);
 
+  int export_(int argc, const char **argv,
+              CommandLineParserType commandLineParser);
+
   std::string ObjectFilename;
   CoverageViewOptions ViewOpts;
   std::string PGOFilename;

     return show(argc, argv, commandLineParser);
   case Report:
     return report(argc, argv, commandLineParser);
+  case Export:
+    return export_(argc, argv, commandLineParser);
   }
   return 0;
 }

   return 0;
 }
 
+int CodeCoverageTool::export_(int argc, const char **argv,
+                              CommandLineParserType commandLineParser) {
+
+  auto Err = commandLineParser(argc, argv);
+  if (Err)
+    return Err;
+
+  auto Coverage = load();
+  if (!Coverage) {
+    error("Could not load coverage information");
+    return 1;
+  }
+
+  exportCoverageDataToJson(ObjectFilename, ViewOpts, *Coverage.get(), outs());
+
+  return 0;
+}
+
 int showMain(int argc, const char *argv[]) {
   CodeCoverageTool Tool;
   return Tool.run(CodeCoverageTool::Show, argc, argv);

   CodeCoverageTool Tool;
   return Tool.run(CodeCoverageTool::Report, argc, argv);
 }
+
+int exportMain(int argc, const char *argv[]) {
+  CodeCoverageTool Tool;
+  return Tool.run(CodeCoverageTool::Export, argc, argv);
+}

tools/llvm-cov/CoverageExporterJson.cpp

+//===- CoverageExporterJson.cpp - Code coverage export --------------------===//
+//
+//                     The LLVM Compiler Infrastructure
+//
+// This file is distributed under the University of Illinois Open Source
+// License. See LICENSE.TXT for details.
+//
+//===----------------------------------------------------------------------===//
+//
+// This file implements export of a code coverage to JSON.
+//
+//===----------------------------------------------------------------------===//
+
+//===----------------------------------------------------------------------===//
+//
+// The json code coverage export follows the following format
+// Root: dict => Root Element containing metadata
+// -- Data: array => Homogeneous array of one or more export objects
+// ---- Export: dict => Json representation of one CoverageMapping
+// ------ Files: array => List of objects describing coverage for files
+// -------- File: dict => Coverage for a single file
+// ---------- Segments: array => List of Segments contained in the file
+// ------------ Segment: dict => Describes a segment of the file with a counter
+// ---------- Expansions: array => List of expansion records
+// ------------ Expansion: dict => Object that descibes a single expansion
+// -------------- CountedRegion: dict => The region to be expanded
+// -------------- TargetRegions: array => List of Regions in the expansion
+// ---------------- CountedRegion: dict => Single Region in the expansion
+// ---------- Summary: dict => Object summarizing the coverage for this file
+// ------------ LineCoverage: dict => Object summarizing line coverage
+// ------------ FunctionCoverage: dict => Object summarizing function coverage
+// ------------ RegionCoverage: dict => Object summarizing region coverage
+// ------ Functions: array => List of objects describing coverage for functions
+// -------- Function: dict => Coverage info for a single function
+// ---------- Filenames: array => List of filenames that the function relates to
+// ---- Summary: dict => Object summarizing the coverage for the entire binary
+// ------ LineCoverage: dict => Object summarizing line coverage
+// ------ FunctionCoverage: dict => Object summarizing function coverage
+// ------ RegionCoverage: dict => Object summarizing region coverage
+//
+//===----------------------------------------------------------------------===//
+
+#include "CoverageSummaryInfo.h"
+#include "CoverageViewOptions.h"
+#include "llvm/ProfileData/Coverage/CoverageMapping.h"
+#include <stack>
+
+/// \brief Major version of the JSON Coverage Export Format.
+#define LLVM_COVERAGE_EXPORT_JSON_MAJOR 1
+
+/// \brief Minor version of the JSON Coverage Export Format.
+#define LLVM_COVERAGE_EXPORT_JSON_MINOR 0
+
+/// \brief Patch version of the JSON Coverage Export Format.
+#define LLVM_COVERAGE_EXPORT_JSON_PATCH 0
+
+/// \brief Version combined as a string.
+#define LLVM_COVERAGE_EXPORT_JSON_STR "1.0.0"
+
+/// \brief Unique type identifier for JSON coverage export.
+#define LLVM_COVERAGE_EXPORT_JSON_TYPE_STR "llvm.coverage.json.export"
+
+using namespace llvm;
+using namespace coverage;
+
+class CoverageExporterJson {
+  /// \brief A Name of the object file coverage is for.
+  StringRef ObjectFilename;
+
+  /// \brief Various options to guide the coverage renderer.
+  const CoverageViewOptions &Options;
+
+  /// \brief Output stream to print JSON to.
+  raw_ostream &OS;
+
+  /// \brief The full CoverageMapping object to export.
+  CoverageMapping Coverage;
+
+  /// \brief States that the JSON rendering machine can be in.
+  enum JsonState { None, NonEmptyElement, EmptyElement };
+
+  /// \brief Tracks state of the JSON output.
+  std::stack<JsonState> State;
+
+  /// \brief Get the object filename.
+  StringRef getObjectFilename() const { return ObjectFilename; }
+
+  /// \brief Retrieve the CoverageViewOptions.
+  const CoverageViewOptions &getOptions() const { return Options; }
+
+  /// \brief Emit a serialized scalar.
+  void emitSerialized(const int64_t &value) { OS << value; }
+
+  /// \brief Emit a serialized string.
+  void emitSerialized(const std::string &value) { OS << "\"" << value << "\""; }
+
+  /// \brief Emit a comma if there is a previous element to delimit.
+  void emitComma() {
+    if (State.top() == JsonState::NonEmptyElement) {
+      OS << ",";
+    } else if (State.top() == JsonState::EmptyElement) {
+      State.pop();
+      assert((State.size() >= 1) && "Closed too many JSON elements");
+      State.push(JsonState::NonEmptyElement);
+    }
+  }
+
+  /// \brief Emit a starting dictionary/object character.
+  void emitDictStart() {
+    emitComma();
+    State.push(JsonState::EmptyElement);
+    OS << "{";
+  }
+
+  /// \brief Emit a dictionary/object key but no value.
+  void emitDictKey(const std::string &key) {
+    emitComma();
+    OS << "\"" << key << "\":";
+    State.pop();
+    assert((State.size() >= 1) && "Closed too many JSON elements");
+
+    // We do not want to emit a comma after this key.
+    State.push(JsonState::EmptyElement);
+  }
+
+  /// \brief Emit a dictionary/object key/value pair.
+  template <typename V>
+  void emitDictElement(const std::string &key, const V &Value) {
+    emitComma();
+    emitSerialized(key);
+    OS << ":";
+    emitSerialized(Value);
+  }
+
+  /// \brief Emit a closing dictionary/object character.
+  void emitDictEnd() {
+    State.pop();
+    assert((State.size() >= 1) && "Closed too many JSON elements");
+    OS << "}";
+  }
+
+  /// \brief Emit a starting array character.
+  void emitArrayStart() {
+    emitComma();
+    State.push(JsonState::EmptyElement);
+    OS << "[";
+  }
+
+  /// \brief Emit an array element.
+  template <typename V> void emitArrayElement(const V &Value) {
+    emitComma();
+    emitSerialized(Value);
+  }
+
+  /// \brief emit a closing array character.
+  void emitArrayEnd() {
+    State.pop();
+    assert((State.size() >= 1) && "Closed too many JSON elements");
+    OS << "]";
+  }
+
+  /// \brief Render the CoverageMapping object.
+  void renderRoot() {
+    // Start Root of JSON object.
+    emitDictStart();
+
+    emitDictElement("version", LLVM_COVERAGE_EXPORT_JSON_STR);
+    emitDictElement("type", LLVM_COVERAGE_EXPORT_JSON_TYPE_STR);
+    emitDictKey("data");
+
+    // Start List of Exports.
+    emitArrayStart();
+
+    // Start Export.
+    emitDictStart();
+    emitDictElement("object", getObjectFilename());
+
+    emitDictKey("files");
+    FileCoverageSummary Totals = FileCoverageSummary("Totals");
+    renderFiles(Coverage.getUniqueSourceFiles(), Totals);
+
+    emitDictKey("functions");
+    renderFunctions(Coverage.getCoveredFunctions());
+
+    emitDictKey("totals");
+    renderSummary(Totals);
+
+    // End Export.
+    emitDictEnd();
+
+    // End List of Exports.
+    emitArrayEnd();
+
+    // End Root of JSON Object.
+    emitDictEnd();
+
+    assert((State.top() == JsonState::None) &&
+           "All Elements In JSON were Closed");
+  };
+
+  /// \brief Render an array of all the given functions.
+  void renderFunctions(iterator_range<FunctionRecordIterator>) {
+    // Start List of Functions.
+    emitArrayStart();
+
+    for (const auto &Function : Coverage.getCoveredFunctions()) {
+      // Start Function.
+      emitDictStart();
+
+      emitDictElement("name", Function.Name);
+      emitDictElement("count", Function.ExecutionCount);
+      emitDictKey("regions");
+
+      renderRegions(Function.CountedRegions);
+
+      emitDictKey("filenames");
+
+      // Start Filenames for Function.
+      emitArrayStart();
+
+      for (const auto &FileName : Function.Filenames)
+        emitArrayElement(FileName);
+
+      // End Filenames for Function.
+      emitArrayEnd();
+
+      // End Function.
+      emitDictEnd();
+    }
+
+    // End List of Functions.
+    emitArrayEnd();
+  }
+
+  /// \brief Render an array of all the source files, also pass back a Summary.
+  void renderFiles(ArrayRef<StringRef> SourceFiles,
+                   FileCoverageSummary &Summary) {
+    // Start List of Files.
+    emitArrayStart();
+    for (const auto &SourceFile : SourceFiles) {
+      // Render the file.
+      auto FileCoverage = Coverage.getCoverageForFile(SourceFile);
+      renderFile(std::move(FileCoverage));
+
+      for (const auto &F : Coverage.getCoveredFunctions(SourceFile))
+        Summary.addFunction(FunctionCoverageSummary::get(F));
+    }
+
+    // End List of Files.
+    emitArrayEnd();
+  }
+
+  /// \brief Render a single file.
+  void renderFile(CoverageData FileCoverage) {
+    // Start File.
+    emitDictStart();
+
+    emitDictElement("filename", FileCoverage.getFilename());
+    emitDictKey("segments");
+
+    // Start List of Segments.
+    emitArrayStart();
+
+    for (const auto Segment : FileCoverage) {
+      renderSegment(Segment);
+    }
+
+    // End List of Segments.
+    emitArrayEnd();
+
+    emitDictKey("expansions");
+
+    // Start List of Expansions.
+    emitArrayStart();
+
+    for (const auto &Expansion : FileCoverage.getExpansions())
+      renderExpansion(Expansion);
+
+    // End List of Expansions.
+    emitArrayEnd();
+
+    FileCoverageSummary Summary =
+        FileCoverageSummary(FileCoverage.getFilename());
+    for (const auto &F :
+         Coverage.getCoveredFunctions(FileCoverage.getFilename()))
+      Summary.addFunction(FunctionCoverageSummary::get(F));
+
+    emitDictKey("summary");
+    renderSummary(Summary);
+
+    // End File.
+    emitDictEnd();
+  }
+
+  /// \brief Render a CoverageSegment.
+  void renderSegment(CoverageSegment Segment) {
+    // Start Segment.
+    emitArrayStart();
+
+    emitArrayElement(Segment.Line);
+    emitArrayElement(Segment.Col);
+    emitArrayElement(Segment.Count);
+    emitArrayElement(Segment.HasCount);
+    emitArrayElement(Segment.IsRegionEntry);
+
+    // End Segment.
+    emitArrayEnd();
+  }
+
+  /// \brief Render an ExpansionRecord.
+  void renderExpansion(const ExpansionRecord &Expansion) {
+    // Start Expansion.
+    emitDictStart();
+
+    // Mark the beginning and end of this expansion in the source file.
+    emitDictKey("source_region");
+    renderRegion(Expansion.Region);
+
+    // Enumerate the coverage information for the expansion.
+    emitDictKey("target_regions");
+    renderRegions(Expansion.Function.CountedRegions);
+
+    emitDictKey("filenames");
+    // Start List of Filenames to map the fileIDs.
+    emitArrayStart();
+    for (const auto &Filename : Expansion.Function.Filenames)
+      emitArrayElement(Filename);
+    // End List of Filenames.
+    emitArrayEnd();
+
+    // End Expansion.
+    emitDictEnd();
+  }
+
+  /// \brief Render a list of CountedRegions.
+  void renderRegions(ArrayRef<CountedRegion> Regions) {
+    // Start List of Regions.
+    emitArrayStart();
+
+    for (const auto &Region : Regions)
+      renderRegion(Region);
+
+    // End List of Regions.
+    emitArrayEnd();
+  };
+
+  /// \brief Render a single CountedRegion.
+  void renderRegion(CountedRegion Region) {
+    // Start CountedRegion.
+    emitArrayStart();
+
+    emitArrayElement(Region.LineStart);
+    emitArrayElement(Region.ColumnStart);
+    emitArrayElement(Region.LineEnd);
+    emitArrayElement(Region.ColumnEnd);
+    emitArrayElement(Region.ExecutionCount);
+    emitArrayElement(Region.FileID);
+    emitArrayElement(Region.ExpandedFileID);
+    emitArrayElement(Region.Kind);
+
+    // End CountedRegion.
+    emitArrayEnd();
+  }
+
+  /// \brief Render a FileCoverageSummary.
+  void renderSummary(FileCoverageSummary Summary) {
+    // Start Summary for the file.
+    emitDictStart();
+
+    emitDictKey("lines");
+
+    // Start Line Coverage Summary.
+    emitDictStart();
+    emitDictElement("count", Summary.LineCoverage.NumLines);
+    emitDictElement("covered", Summary.LineCoverage.Covered);
+    emitDictElement("percent", Summary.LineCoverage.getPercentCovered());
+    emitDictElement("noncode", Summary.LineCoverage.NonCodeLines);
+    // End Line Coverage Summary.
+    emitDictEnd();
+
+    emitDictKey("functions");
+
+    // Start Function Coverage Summary.
+    emitDictStart();
+    emitDictElement("count", Summary.FunctionCoverage.NumFunctions);
+    emitDictElement("covered", Summary.FunctionCoverage.Executed);
+    emitDictElement("percent", Summary.FunctionCoverage.getPercentCovered());
+    // End Function Coverage Summary.
+    emitDictEnd();
+
+    emitDictKey("regions");
+
+    // Start Region Coverage Summary.
+    emitDictStart();
+    emitDictElement("count", Summary.RegionCoverage.NumRegions);
+    emitDictElement("covered", Summary.RegionCoverage.Covered);
+    emitDictElement("notcovered", Summary.RegionCoverage.NotCovered);
+    emitDictElement("percent", Summary.RegionCoverage.getPercentCovered());
+    // End Region Coverage Summary.
+    emitDictEnd();
+
+    // End Summary for the file.
+    emitDictEnd();
+  }
+
+public:
+  CoverageExporterJson(StringRef ObjectFilename,
+                       const CoverageViewOptions &Options,
+                       const CoverageMapping &CoverageMapping, raw_ostream &OS)
+      : ObjectFilename(ObjectFilename), Options(Options), OS(OS),
+        Coverage(CoverageMapping) {
+    State.push(JsonState::None);
+  }
+
+  /// \brief Print the CoverageMapping.
+  void print() { renderRoot(); }
+};
+
+/// \brief Export the given CoverageMapping to a JSON Format.
+void exportCoverageDataToJson(StringRef ObjectFilename,
+                              const CoverageViewOptions &Options,
+                              const CoverageMapping &CoverageMapping,
+                              raw_ostream &OS) {
+  auto Exporter =
+      CoverageExporterJson(ObjectFilename, Options, CoverageMapping, OS);
+
+  Exporter.print();
+}

tools/llvm-cov/llvm-cov.cpp

 /// \brief The main entry point for the 'report' subcommand.
 int reportMain(int argc, const char *argv[]);
 
+/// \brief The main entry point for the 'export' subcommand.
+int exportMain(int argc, const char *argv[]);
+
 /// \brief The main entry point for the 'convert-for-testing' subcommand.
 int convertForTestingMain(int argc, const char *argv[]);
 

 
 /// \brief Top level help.
 static int helpMain(int argc, const char *argv[]) {
-  errs() << "Usage: llvm-cov {gcov|report|show} [OPTION]...\n\n"
+  errs() << "Usage: llvm-cov {export|gcov|report|show} [OPTION]...\n\n"
          << "Shows code coverage information.\n\n"
          << "Subcommands:\n"
+         << "  export: Export instrprof file to structured format.\n"
          << "  gcov:   Work with the gcov format.\n"
-         << "  show:   Annotate source files using instrprof style coverage.\n"
-         << "  report: Summarize instrprof style coverage information.\n";
+         << "  report: Summarize instrprof style coverage information.\n"
+         << "  show:   Annotate source files using instrprof style coverage.\n";
+
   return 0;
 }
 

                             .Case("gcov", gcovMain)
                             .Case("report", reportMain)
                             .Case("show", showMain)
+                            .Case("export", exportMain)
                             .Cases("-h", "-help", "--help", helpMain)
                             .Cases("-version", "--version", versionMain)
                             .Default(nullptr);