Add new clang build setting EMIT_SARIF_DIAGNOSTICS_FILE #938
+105
−1
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
passes -fdiagnostic-add-output=sarif:file=<path>. The flag emits a SARIF log during the compilation which contains diagnostic information. The path is currently fixed to <object_file_path>.source-metadata.json
owenv
reviewed
Nov 21, 2025
| let dataCache = cbc.producer.getSpecDataCache(self, cacheType: DataCache.self) | ||
| let constantFlags = dataCache.getStandardFlags(self, producer: cbc.producer, scope: cbc.scope, optionContext: clangInfo, delegate: delegate, inputFileType: resolvedInputFileType) | ||
| let cbcWithOutput = cbc.outputs.isEmpty ? cbc.appendingOutputs([outputNode.path]) : cbc | ||
| let constantFlags = dataCache.getStandardFlags(self, cbc: cbcWithOutput, optionContext: clangInfo, delegate: delegate, inputFileType: resolvedInputFileType) |
Collaborator
There was a problem hiding this comment.
These flags are cached and reused across translation units, so I think this is going to incorrectly inject per-TU flags
usama54321
requested review from
aciidgh,
jakepetroules,
mhrawdon and
neonichu
as code owners
usama54321
changed the title
owenv
approved these changes
Dec 9, 2025
neonichu
approved these changes
Dec 9, 2025
dbartol
reviewed
Dec 10, 2025
dbartol
left a comment
dbartol
left a comment
There was a problem hiding this comment.
Mostly a bunch of naming suggestions.
| public static let EMBEDDED_CONTENT_CONTAINS_SWIFT = BuiltinMacros.declareBooleanMacro("EMBEDDED_CONTENT_CONTAINS_SWIFT") | ||
| public static let EMBEDDED_PROFILE_NAME = BuiltinMacros.declareStringMacro("EMBEDDED_PROFILE_NAME") | ||
| public static let EMBED_PACKAGE_RESOURCE_BUNDLE_NAMES = BuiltinMacros.declareStringListMacro("EMBED_PACKAGE_RESOURCE_BUNDLE_NAMES") | ||
| public static let EMIT_COMPILER_SOURCE_METADATA = BuiltinMacros.declareBooleanMacro("EMIT_COMPILER_SOURCE_METADATA") |
There was a problem hiding this comment.
Suggested name: CLANG_EMIT_SARIF_DIAGNOSTICS_FILE. Unless this macro is reused by the Swift compiler, in which case you should probably drop the CLANG_ prefix.
| } | ||
| } | ||
|
|
||
| commandLine += addCompilerMetadataFlags(cbc, outputFileDir.join(outputNode.path.str + ".source-metadata.json"), delegate, &extraOutputs) |
There was a problem hiding this comment.
Suggested change
| commandLine += addCompilerMetadataFlags(cbc, outputFileDir.join(outputNode.path.str + ".source-metadata.json"), delegate, &extraOutputs) | |
| commandLine += addCompilerSarifFlags(cbc, outputFileDir.join(outputNode.path.str + ".compiled.sarif"), delegate, &extraOutputs) |
| let ftb = FileToBuild(absolutePath: securityMetadataNode.path, fileType: metadatatype) | ||
| taskOutputs.append(securityMetadataNode) | ||
| delegate.declareOutput(ftb) | ||
| return ["-fdiagnostics-add-output=sarif:file=" + securityMetadataNode.path.str] |
There was a problem hiding this comment.
Do you need to add quoting and/or escaping here, since the path has to be part of the same option? Or does the fact the result is an array mean that the build system will property quote each array element?
| UTI = "public.protobuf-source"; | ||
| }, | ||
| { | ||
| Identifier = text.json.compiler-metadata.source; |
There was a problem hiding this comment.
Suggested change
| Identifier = text.json.compiler-metadata.source; | |
| Identifier = text.sarif; |
Unless the hierarchy means something, in which case text.json.sarif is fine.
| { | ||
| Identifier = text.json.compiler-metadata.source; | ||
| Type = FileType; | ||
| Name = "Source metadata emitted from compiler"; |
There was a problem hiding this comment.
Suggested change
| Name = "Source metadata emitted from compiler"; | |
| Name = "Diagnostics log in SARIF format."; |
| Identifier = text.json.compiler-metadata.source; | ||
| Type = FileType; | ||
| Name = "Source metadata emitted from compiler"; | ||
| UTI = "com.apple.compiler-metadata.source"; |
There was a problem hiding this comment.
Suggested change
| UTI = "com.apple.compiler-metadata.source"; | |
| UTI = "com.apple.sarif"; |
jakepetroules
approved these changes
Dec 11, 2025
Contributor
Author
|
@swift-ci test |
usama54321
force-pushed
the
usama54321/fdiagnostics-add-output-clang-flag
branch
from
deb9f17 to
8d321a5
Compare
Contributor
Author
|
@swift-ci test |
usama54321
changed the title
Contributor
Author
|
@swift-ci test windows |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
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.
Add new clang build setting EMIT_SARIF_DIAGNOSTICS_FILE that passes
-fdiagnostic-add-output=sarif:file=. The flag emits a SARIF log during the compilation which contains diagnostic information. The path is currently fixed to <object_file_path>.compiled.sarif