Skip to content

[llvm-cov] Export decision coverage to output json #144335

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
evodius96 merged 2 commits into from
Jun 18, 2025
Merged

[llvm-cov] Export decision coverage to output json #144335

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cb87084
[llvm-cov] Export decision coverage to output json
AndreUthmann Jun 16, 2025
75cef15
Move getDecisions to MCDCRecord
AndreUthmann Jun 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions llvm/include/llvm/ProfileData/Coverage/CoverageMapping.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -494,6 +494,9 @@ struct MCDCRecord {
return TV[TestVectorIndex].first[PosToID[Condition]];
}

/// Return the executed test vectors.
const TestVectors &getTV() const { return TV; }

/// Return the Result evaluation for an executed test vector.
/// See MCDCRecordProcessor::RecordTestVector().
CondState getTVResult(unsigned TestVectorIndex) {
Expand Down
16 changes: 14 additions & 2 deletions llvm/tools/llvm-cov/CoverageExporterJson.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@
#include <utility>

/// The semantic version combined as a string.
#define LLVM_COVERAGE_EXPORT_JSON_STR "2.0.1"
#define LLVM_COVERAGE_EXPORT_JSON_STR "3.0.0"
Copy link
Contributor

@evodius96 evodius96 Jun 16, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for updating this. We have not been good about moving the version forward.

Copy link
Contributor Author

@uthmanna uthmanna Jun 17, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is actually very important to me, as I check this value to see whether the subsequent processing is still correct.


/// Unique type identifier for JSON coverage export.
#define LLVM_COVERAGE_EXPORT_JSON_TYPE_STR "llvm.coverage.json.export"
Expand Down Expand Up @@ -108,10 +108,22 @@ json::Array gatherConditions(const coverage::MCDCRecord &Record) {
return Conditions;
}

std::pair<unsigned, unsigned> getDecisions(const coverage::MCDCRecord &Record) {
Copy link
Contributor

@evodius96 evodius96 Jun 16, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As a design consideration, I'm reluctant to bring knowledge of test vectors into the Exporter and would favor encapsulating the calculation of the number of True and False test vectors within coverage::MCDCRecord. Basically, move getDecisions() into coverage::MCDCRecord. That routine can still return a pair of numbers.

Copy link
Contributor Author

@uthmanna uthmanna Jun 17, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sounds reasonable, I've moved it, hope it's OK.

const coverage::MCDCRecord::TestVectors &TestVectors = Record.getTV();
const unsigned TrueConditions =
std::count_if(TestVectors.begin(), TestVectors.end(), [](const auto &TV) {
return TV.second == coverage::MCDCRecord::CondState::MCDC_True;
});

return {TrueConditions, TestVectors.size() - TrueConditions};
}

json::Array renderMCDCRecord(const coverage::MCDCRecord &Record) {
const llvm::coverage::CounterMappingRegion &CMR = Record.getDecisionRegion();
const auto [TrueConditions, FalseConditions] = getDecisions(Record);
return json::Array({CMR.LineStart, CMR.ColumnStart, CMR.LineEnd,
CMR.ColumnEnd, CMR.ExpandedFileID, int64_t(CMR.Kind),
CMR.ColumnEnd, TrueConditions, FalseConditions,
CMR.ExpandedFileID, int64_t(CMR.Kind),
gatherConditions(Record)});
}

Expand Down