JSON Reporting #80
Merged
JSON Reporting #80
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
fosterbrereton
commented
May 16, 2024
| assert(globals._odrv_count == violations.size()); | ||
|
|
||
| if (json_mode && globals._fp.is_open()) { | ||
| globals._fp << orc::to_json(violations); |
There was a problem hiding this comment.
This is where the JSON object is serialized to the file.
fosterbrereton
commented
May 16, 2024
| @@ -85,8 +87,10 @@ template <class F> | |||
| void ostream_safe(std::ostream& s, F&& f) { | |||
| std::lock_guard<std::mutex> lock{ostream_safe_mutex()}; | |||
| std::forward<F>(f)(s); | |||
| if (globals::instance()._fp.is_open()) { | |||
| std::forward<F>(f)(globals::instance()._fp); | |||
| if (settings::instance()._output_file_mode == settings::output_file_mode::json) return; | |||
There was a problem hiding this comment.
This circumvents writing anything to the file if we're in json output mode.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds a new flag to ORC's config file,
output_file_mode. Fixes #79.The flag determines what format should be used for content written to external report files defined by either
output_fileorrelative_output_file. The options aretextorjson.textwill mirror all output sent tostdoutandstderrto the file.jsonwill limit output file contents to the ODRV report. This mode enumerates all object files with conflicting symbols, so can be quite verbose. It is intended for programmatic consumption. The default value istext.This PR also removes the
resource_metricscapability of the tool. It's been decided Tracy is a better solution to meet such a need. Therefore the flag and the code associated with supporting it have been pulled out.An example snippet of the JSON output looks something like:
{ "synopsis": { "dies_processed": 163925, "dies_skipped": 122239, "dies_skipped_pct": 74.57007777947231, "object_files_scanned": 92, "unique_symbols": 3435, "violations": 11 }, "violations": { "example_struct": { "attributes": [ "structure:byte_size", "structure:calling_convention" ], "definitions": [ { "attributes": { "byte_size": 624 }, "count": 33, "locations": { "/path/to/library/header.h:430": { "/path/to/library.a": [ "foo.o", "bar.o", "baz.o", ...