[clang] [clang-tools-extra] [clang-tidy] Add Base URI support to SARIF output (PR #235711)
via cfe-commits
cfe-commits at lists.llvm.org
Fri Oct 30 02:31:12 PDT 2026
https://github.com/matthew-j-code updated https://github.com/llvm/llvm-project/pull/235711
>From e93a861620b2138748952c794390ae251af3ab5d Mon Sep 17 00:00:00 2001
From: "Jones, Matthew (DI SW SIM FRWK PLAT SIMFW HPC)"
<jones.matthew at siemens.com>
Date: Mon, 26 Oct 2026 03:25:15 -0700
Subject: [PATCH 1/3] [clang-tidy] Add SARIF output (squash of #219182)
---
clang-tools-extra/clang-tidy/ClangTidy.cpp | 150 ++++++++-
clang-tools-extra/clang-tidy/ClangTidy.h | 3 +-
.../ClangTidyDiagnosticConsumer.cpp | 38 +--
.../clang-tidy/tool/ClangTidyMain.cpp | 32 +-
clang-tools-extra/docs/ReleaseNotes.md | 4 +
clang-tools-extra/docs/clang-tidy/index.rst | 3 +
.../export-SARIF-conflicting-output.cpp | 8 +
.../export-SARIF-diagnostics-EOF.cpp | 77 +++++
...t-SARIF-diagnostics-macro-thread-flows.cpp | 175 ++++++++++
.../export-SARIF-diagnostics-terminal.cpp | 299 +++++++++++++++++
.../export-SARIF-diagnostics.cpp | 314 ++++++++++++++++++
.../export-SARIF-no-location.cpp | 104 ++++++
clang/include/clang/Basic/Sarif.h | 24 +-
.../include/clang/Frontend/SARIFDiagnostic.h | 16 +-
clang/lib/Basic/Sarif.cpp | 82 +++--
clang/lib/Frontend/SARIFDiagnostic.cpp | 60 ++--
clang/unittests/Basic/SarifTest.cpp | 17 +
17 files changed, 1305 insertions(+), 101 deletions(-)
create mode 100644 clang-tools-extra/test/clang-tidy/infrastructure/export-SARIF-conflicting-output.cpp
create mode 100644 clang-tools-extra/test/clang-tidy/infrastructure/export-SARIF-diagnostics-EOF.cpp
create mode 100644 clang-tools-extra/test/clang-tidy/infrastructure/export-SARIF-diagnostics-macro-thread-flows.cpp
create mode 100644 clang-tools-extra/test/clang-tidy/infrastructure/export-SARIF-diagnostics-terminal.cpp
create mode 100644 clang-tools-extra/test/clang-tidy/infrastructure/export-SARIF-diagnostics.cpp
create mode 100644 clang-tools-extra/test/clang-tidy/infrastructure/export-SARIF-no-location.cpp
diff --git a/clang-tools-extra/clang-tidy/ClangTidy.cpp b/clang-tools-extra/clang-tidy/ClangTidy.cpp
index d065bb2c4bcfcd..272ff73320f5c7 100644
--- a/clang-tools-extra/clang-tidy/ClangTidy.cpp
+++ b/clang-tools-extra/clang-tidy/ClangTidy.cpp
@@ -24,10 +24,12 @@
#include "clang/AST/ASTConsumer.h"
#include "clang/ASTMatchers/ASTMatchFinder.h"
#include "clang/Basic/DiagnosticFrontend.h"
+#include "clang/Basic/Sarif.h"
#include "clang/Format/Format.h"
#include "clang/Frontend/ASTConsumers.h"
#include "clang/Frontend/CompilerInstance.h"
#include "clang/Frontend/MultiplexConsumer.h"
+#include "clang/Frontend/SARIFDiagnostic.h"
#include "clang/Frontend/TextDiagnosticPrinter.h"
#include "clang/Lex/Preprocessor.h"
#include "clang/Lex/PreprocessorOptions.h"
@@ -36,7 +38,11 @@
#include "clang/Tooling/DiagnosticsYaml.h" // IWYU pragma: keep
#include "clang/Tooling/Refactoring.h"
#include "clang/Tooling/Tooling.h"
+#include "llvm/Support/Error.h"
+#include "llvm/Support/FileSystem.h"
+#include "llvm/Support/FormatVariadic.h"
#include "llvm/Support/Process.h"
+#include "llvm/Support/raw_ostream.h"
#include <memory>
#include <utility>
@@ -101,16 +107,28 @@ class AnalyzerDiagnosticConsumer : public ento::PathDiagnosticConsumer {
class ErrorReporter {
public:
ErrorReporter(ClangTidyContext &Context, FixBehaviour ApplyFixes,
- llvm::IntrusiveRefCntPtr<llvm::vfs::FileSystem> BaseFS)
+ llvm::IntrusiveRefCntPtr<llvm::vfs::FileSystem> BaseFS,
+ StringRef SarifExportPath)
: Files(FileSystemOptions(), std::move(BaseFS)),
- DiagPrinter(new TextDiagnosticPrinter(llvm::outs(), DiagOpts)),
+ DiagPrinter(
+ SarifExportPath == "-"
+ ? static_cast<DiagnosticConsumer *>(new IgnoringDiagConsumer())
+ : new TextDiagnosticPrinter(llvm::outs(), DiagOpts)),
Diags(DiagnosticIDs::create(), DiagOpts, DiagPrinter),
- SourceMgr(Diags, Files), Context(Context), ApplyFixes(ApplyFixes) {
+ SourceMgr(Diags, Files), Context(Context), ApplyFixes(ApplyFixes),
+ SarifExportPath(SarifExportPath) {
+ if (!SarifExportPath.empty()) {
+ SarifWriter.emplace(SourceMgr);
+ SarifWriter->createRun("clang-tidy", "clang-tidy", CLANG_VERSION_STRING,
+ "https://clang.llvm.org/extra/clang-tidy/");
+ }
+
DiagOpts.setShowColors(Context.getOptions().UseColor.value_or(
llvm::sys::Process::StandardOutHasColors())
? ShowColorsKind::On
: ShowColorsKind::Off);
- DiagPrinter->BeginSourceFile(LangOpts);
+ if (DiagPrinter)
+ DiagPrinter->BeginSourceFile(LangOpts);
if (DiagOpts.showColors(llvm::sys::Process::StandardOutHasColors()) &&
!llvm::sys::Process::StandardOutIsDisplayed())
llvm::sys::Process::UseANSIEscapeCodes(true);
@@ -195,6 +213,94 @@ class ErrorReporter {
}
for (const auto &Note : Error.Notes)
reportNote(Note);
+
+ if (SarifWriter)
+ exportSarifResult(Error, Loc);
+ }
+
+ CharSourceRange getNoteRange(const tooling::DiagnosticMessage &Note) {
+ const SourceLocation Loc = getLocation(Note.FilePath, Note.FileOffset);
+ return Loc.isValid() ? getOffsetRange(SourceMgr, Loc) : CharSourceRange();
+ }
+
+ SmallVector<ThreadFlow, 8> createThreadFlows(const ClangTidyError &Error) {
+ SmallVector<ThreadFlow, 8> Flows;
+ Flows.reserve(Error.Notes.size());
+ for (const tooling::DiagnosticMessage &Note : Error.Notes) {
+ Flows.push_back(ThreadFlow::create()
+ .setRange(getNoteRange(Note))
+ .setMessage(Note.Message));
+ }
+ return Flows;
+ }
+
+ void exportSarifResult(const ClangTidyError &Error,
+ const SourceLocation Loc) {
+ if (!SarifWriter)
+ return;
+
+ const auto [RuleIndexEntryIt, Inserted] =
+ SarifRuleIdx.try_emplace(Error.DiagnosticName, 0);
+ size_t &RuleIndex = RuleIndexEntryIt->second;
+
+ const DiagnosticsEngine::Level EffectiveLevel =
+ Error.IsWarningAsError
+ ? DiagnosticsEngine::Error
+ : static_cast<DiagnosticsEngine::Level>(Error.DiagLevel);
+
+ if (Inserted) {
+ const StringRef Name = Error.DiagnosticName;
+ SarifRule Rule = SarifRule::create().setRuleId(Name).setName(Name);
+ Rule = addDiagnosticLevelToRule(Rule, EffectiveLevel);
+ RuleIndex = SarifWriter->createRule(Rule);
+ }
+
+ SarifResult Result =
+ SarifResult::create(RuleIndex)
+ .setDiagnosticMessage(Error.Message.Message)
+ .setDiagnosticLevel(getSarifResultLevel(EffectiveLevel));
+ // TODO: Extend SarifDocumentWriter to add an annotations property that can
+ // represent highlight ranges, when both a valid location and highlight
+ // ranges are present.
+ Result =
+ (Loc.isValid() ? Result.addLocations(getOffsetRange(SourceMgr, Loc))
+ : Result.addLocations(getResultRanges(Error)));
+
+ // Same-location, same-message diagnostics from other checks are merged,
+ // with the first alphabetically as the check name, not necessarily the
+ // canon name.
+ if (!Error.EnabledDiagnosticAliases.empty())
+ Result = Result.addProperty(
+ "enabledAliases", llvm::join(Error.EnabledDiagnosticAliases, ","));
+
+ // TODO: CSA stores fullDescription from the HELPTEXT field in Checkers.inc,
+ // strip clang-analyzer- prefix then populate fullDescription with this.
+ // Also, add helpUri with this for in-tree checks, pointing to their
+ // documentation pages.
+ if (StringRef(Error.DiagnosticName).starts_with("clang-analyzer-"))
+ Result = Result.setThreadFlows(createThreadFlows(Error));
+ else
+ for (const tooling::DiagnosticMessage &Note : Error.Notes)
+ Result = Result.addRelatedLocations(getNoteRange(Note), Note.Message);
+ if (SarifWriter)
+ SarifWriter->appendResult(Result);
+ }
+
+ // SARIF regions need a character range: use 1 char at Loc, or 0 at EOF.
+ CharSourceRange getOffsetRange(SourceManager &SM, SourceLocation Loc) {
+ const std::pair<FileID, unsigned> &DecomposedLoc = SM.getDecomposedLoc(Loc);
+ const FileID FileId = DecomposedLoc.first;
+ const unsigned Offset = DecomposedLoc.second;
+ return CharSourceRange::getCharRange(
+ Loc, Loc.getLocWithOffset(Offset < SM.getFileIDSize(FileId) ? 1 : 0));
+ }
+
+ SmallVector<CharSourceRange, 4> getResultRanges(const ClangTidyError &Error) {
+ SmallVector<CharSourceRange, 4> Ranges;
+ Ranges.reserve(Error.Message.Ranges.size());
+ for (const FileByteRange &FBR : Error.Message.Ranges)
+ Ranges.push_back(getRange(FBR));
+ return Ranges;
}
void finish() {
@@ -254,6 +360,8 @@ class ErrorReporter {
if (OriginalCWD)
VFS.setCurrentWorkingDirectory(*OriginalCWD);
}
+ if (SarifWriter)
+ finalizeSarif();
}
unsigned getWarningsAsErrorsCount() const { return WarningsAsErrors; }
@@ -271,6 +379,25 @@ class ErrorReporter {
return SourceMgr.getLocForStartOfFile(ID).getLocWithOffset(Offset);
}
+ void finalizeSarif() {
+ if (!SarifWriter)
+ return;
+ const llvm::json::Value Document = SarifWriter->createDocument();
+ if (SarifExportPath == "-") {
+ llvm::outs() << llvm::formatv("{0:2}", Document);
+ return;
+ }
+ // Reopened here as the file may have changed during the analysis.
+ std::error_code EC;
+ llvm::raw_fd_ostream SarifOS(SarifExportPath, EC, llvm::sys::fs::OF_Text);
+ if (EC) {
+ llvm::errs() << "Error opening SARIF export file '" << SarifExportPath
+ << "': " << EC.message() << "\n";
+ return;
+ }
+ SarifOS << llvm::formatv("{0:2}", Document);
+ }
+
void reportFix(const DiagnosticBuilder &Diag,
const llvm::StringMap<Replacements> &Fix) {
for (const auto &FileAndReplacements : Fix) {
@@ -328,6 +455,13 @@ class ErrorReporter {
unsigned TotalFixes = 0U;
unsigned AppliedFixes = 0U;
unsigned WarningsAsErrors = 0U;
+ std::string SarifExportPath;
+ // ExportSarifResult is called for each SARIF rule that gets created, while a
+ // SarifWriter run is created once at ErrorReporter construction.
+ std::optional<SarifDocumentWriter> SarifWriter;
+ // SarifRuleIdx is used across multiple calls of exportSarifResult as cache to
+ // avoid creating duplicate SARIF rules.
+ llvm::StringMap<size_t> SarifRuleIdx;
};
class ClangTidyASTConsumer : public MultiplexConsumer {
@@ -613,7 +747,8 @@ runClangTidy(ClangTidyContext &Context, const CompilationDatabase &Compilations,
Context.setEnableProfiling(EnableCheckProfile);
Context.setProfileStoragePrefix(StoreCheckProfile);
- ClangTidyDiagnosticConsumer DiagConsumer(Context, nullptr, true, ApplyAnyFix);
+ ClangTidyDiagnosticConsumer DiagConsumer(Context, nullptr, true, ApplyAnyFix,
+ true);
auto DiagOpts = std::make_unique<DiagnosticOptions>();
DiagnosticsEngine DE(DiagnosticIDs::create(), *DiagOpts, &DiagConsumer,
/*ShouldOwnClient=*/false);
@@ -668,8 +803,9 @@ runClangTidy(ClangTidyContext &Context, const CompilationDatabase &Compilations,
void handleErrors(llvm::ArrayRef<ClangTidyError> Errors,
ClangTidyContext &Context, FixBehaviour Fix,
unsigned &WarningsAsErrorsCount,
- llvm::IntrusiveRefCntPtr<llvm::vfs::FileSystem> BaseFS) {
- ErrorReporter Reporter(Context, Fix, std::move(BaseFS));
+ llvm::IntrusiveRefCntPtr<llvm::vfs::FileSystem> BaseFS,
+ StringRef SarifExportPath) {
+ ErrorReporter Reporter(Context, Fix, std::move(BaseFS), SarifExportPath);
llvm::vfs::FileSystem &FileSystem =
Reporter.getSourceManager().getFileManager().getVirtualFileSystem();
auto InitialWorkingDir = FileSystem.getCurrentWorkingDirectory();
diff --git a/clang-tools-extra/clang-tidy/ClangTidy.h b/clang-tools-extra/clang-tidy/ClangTidy.h
index 5fac25bd3bbca3..ee750b2339e626 100644
--- a/clang-tools-extra/clang-tidy/ClangTidy.h
+++ b/clang-tools-extra/clang-tidy/ClangTidy.h
@@ -118,7 +118,8 @@ enum FixBehaviour {
void handleErrors(llvm::ArrayRef<ClangTidyError> Errors,
ClangTidyContext &Context, FixBehaviour Fix,
unsigned &WarningsAsErrorsCount,
- llvm::IntrusiveRefCntPtr<llvm::vfs::FileSystem> BaseFS);
+ llvm::IntrusiveRefCntPtr<llvm::vfs::FileSystem> BaseFS,
+ StringRef SarifExportPath = {});
/// Serializes replacements into YAML and writes them to the specified
/// output stream.
diff --git a/clang-tools-extra/clang-tidy/ClangTidyDiagnosticConsumer.cpp b/clang-tools-extra/clang-tidy/ClangTidyDiagnosticConsumer.cpp
index 61eacd5df6c251..c148056ddc22d2 100644
--- a/clang-tools-extra/clang-tidy/ClangTidyDiagnosticConsumer.cpp
+++ b/clang-tools-extra/clang-tidy/ClangTidyDiagnosticConsumer.cpp
@@ -70,37 +70,29 @@ class ClangTidyDiagnosticRenderer : public DiagnosticRenderer {
? tooling::DiagnosticMessage(Message, Loc.getManager(), Loc)
: tooling::DiagnosticMessage(Message);
- // Make sure that if a TokenRange is received from the check it is unfurled
- // into a real CharRange for the diagnostic printer later.
- // Whatever we store here gets decoupled from the current SourceManager, so
- // we **have to** know the exact position and length of the highlight.
- const auto ToCharRange = [this, &Loc](const CharSourceRange &SourceRange) {
- if (SourceRange.isCharRange())
- return SourceRange;
- assert(SourceRange.isTokenRange());
- const SourceLocation End = Lexer::getLocForEndOfToken(
- SourceRange.getEnd(), 0, Loc.getManager(), LangOpts);
- return CharSourceRange::getCharRange(SourceRange.getBegin(), End);
+ // Whatever we store here gets decoupled from the current Source Manager, so
+ // each range must become a character range in a real file now.
+ // makeFileCharRange maps a range covering a whole macro expansion to the
+ // macro call, and a range inside a macro argument to where the argument is
+ // written. Ranges it cannot map (invalid, or only part of a macro body)
+ // come back invalid and are dropped.
+ const auto StoreRanges = [&](tooling::DiagnosticMessage &Stored) {
+ for (const CharSourceRange &Range : Ranges) {
+ const CharSourceRange FileRange =
+ Lexer::makeFileCharRange(Range, Loc.getManager(), LangOpts);
+ if (FileRange.isValid())
+ Stored.Ranges.emplace_back(Loc.getManager(), FileRange);
+ }
};
- // We are only interested in valid ranges.
- const auto ValidRanges =
- llvm::make_filter_range(Ranges, [](const CharSourceRange &R) {
- return R.getAsRange().isValid();
- });
-
if (Level == DiagnosticsEngine::Note) {
Error.Notes.push_back(TidyMessage);
- for (const CharSourceRange &SourceRange : ValidRanges)
- Error.Notes.back().Ranges.emplace_back(Loc.getManager(),
- ToCharRange(SourceRange));
+ StoreRanges(Error.Notes.back());
return;
}
assert(Error.Message.Message.empty() && "Overwriting a diagnostic message");
Error.Message = TidyMessage;
- for (const CharSourceRange &SourceRange : ValidRanges)
- Error.Message.Ranges.emplace_back(Loc.getManager(),
- ToCharRange(SourceRange));
+ StoreRanges(Error.Message);
}
void emitDiagnosticLoc(FullSourceLoc Loc, PresumedLoc PLoc,
diff --git a/clang-tools-extra/clang-tidy/tool/ClangTidyMain.cpp b/clang-tools-extra/clang-tidy/tool/ClangTidyMain.cpp
index 7ee556fa7c51fa..fa56d969f8db70 100644
--- a/clang-tools-extra/clang-tidy/tool/ClangTidyMain.cpp
+++ b/clang-tools-extra/clang-tidy/tool/ClangTidyMain.cpp
@@ -21,6 +21,7 @@
#include "clang/Tooling/CommonOptionsParser.h"
#include "llvm/ADT/StringSet.h"
#include "llvm/Support/CommandLine.h"
+#include "llvm/Support/FileSystem.h"
#include "llvm/Support/InitLLVM.h"
#include "llvm/Support/PluginLoader.h" // IWYU pragma: keep
#include "llvm/Support/Process.h"
@@ -311,6 +312,14 @@ code with clang-apply-replacements.
cl::value_desc("filename"),
cl::cat(ClangTidyCategory));
+static cl::opt<std::string> SarifExport("sarif-export", desc(R"(
+File in which to store diagnostics in SARIF format.
+Use '-' to write to stdout instead of the
+usual diagnostic output.
+)"),
+ cl::value_desc("filename"),
+ cl::cat(ClangTidyCategory));
+
static cl::opt<bool> Quiet("quiet", desc(R"(
Run clang-tidy in quiet mode. This suppresses
printing statistics about ignored warnings and
@@ -634,6 +643,13 @@ int clangTidyMain(int argc, const char **argv) {
return 1;
}
+ if (!SarifExport.empty() && SarifExport == ExportFixes) {
+ llvm::errs() << "Error: --sarif-export and --export-fixes cannot write to "
+ "the same output '"
+ << SarifExport << "'.\n";
+ return 1;
+ }
+
const llvm::IntrusiveRefCntPtr<vfs::OverlayFileSystem> BaseFS =
createBaseFS();
if (!BaseFS)
@@ -652,6 +668,7 @@ int clangTidyMain(int argc, const char **argv) {
FileName = PathList.front();
const SmallString<256> FilePath = makeAbsolute(FileName);
+
ClangTidyOptions EffectiveOptions = OptionsProvider->getOptions(FilePath);
const std::vector<std::string> EnabledChecks =
@@ -730,6 +747,19 @@ int clangTidyMain(int argc, const char **argv) {
return 1;
}
+ // Checked after the informational modes so they never truncate the file.
+ if (!SarifExport.empty() && SarifExport != "-") {
+ std::error_code EC;
+ {
+ const llvm::raw_fd_ostream OS(SarifExport, EC, llvm::sys::fs::OF_Text);
+ }
+ if (EC) {
+ llvm::errs() << "Error opening SARIF export file '" << SarifExport
+ << "': " << EC.message() << '\n';
+ return 1;
+ }
+ }
+
llvm::InitializeAllTargetInfos();
llvm::InitializeAllTargetMCs();
llvm::InitializeAllAsmParsers();
@@ -754,7 +784,7 @@ int clangTidyMain(int argc, const char **argv) {
unsigned WErrorCount = 0;
handleErrors(Errors, Context, DisableFixes ? FB_NoFix : Behaviour,
- WErrorCount, BaseFS);
+ WErrorCount, BaseFS, SarifExport);
if (!ExportFixes.empty() && !Errors.empty()) {
std::error_code EC;
diff --git a/clang-tools-extra/docs/ReleaseNotes.md b/clang-tools-extra/docs/ReleaseNotes.md
index 93fbe57a583216..e9b5362bf1c2fc 100644
--- a/clang-tools-extra/docs/ReleaseNotes.md
+++ b/clang-tools-extra/docs/ReleaseNotes.md
@@ -105,6 +105,10 @@ infrastructure are described first, followed by tool-specific sections.
piping from {program}`git` to {program}`clang-tidy-diff.py`, where slashes
will now be automatically normalized.
+- Added a new {program}`clang-tidy` command line option `-sarif-export=<file>`
+ in which clang-tidy diagnostics are exported in the [SARIF](https://sarifweb.azurewebsites.net/)
+ format.
+
#### New checks
- New {doc}`llvm-invalid-regex-pattern
diff --git a/clang-tools-extra/docs/clang-tidy/index.rst b/clang-tools-extra/docs/clang-tidy/index.rst
index cfa77eb670ecf4..b619cec35b42f2 100644
--- a/clang-tools-extra/docs/clang-tidy/index.rst
+++ b/clang-tools-extra/docs/clang-tidy/index.rst
@@ -192,6 +192,9 @@ An overview of all the command-line options:
--export-fixes=<filename> - YAML file to store suggested fixes in. The
stored fixes can be applied to the input source
code with clang-apply-replacements.
+ --sarif-export=<filename> - File in which to store diagnostics in SARIF format.
+ Use '-' to write to stdout instead of the usual
+ diagnostic output.
--extra-arg=<string> - Additional argument to append to the compiler command line
--extra-arg-before=<string> - Additional argument to prepend to the compiler command line
--fix - Apply suggested fixes. Without -fix-errors
diff --git a/clang-tools-extra/test/clang-tidy/infrastructure/export-SARIF-conflicting-output.cpp b/clang-tools-extra/test/clang-tidy/infrastructure/export-SARIF-conflicting-output.cpp
new file mode 100644
index 00000000000000..cdcf3c04106132
--- /dev/null
+++ b/clang-tools-extra/test/clang-tidy/infrastructure/export-SARIF-conflicting-output.cpp
@@ -0,0 +1,8 @@
+// RUN: not clang-tidy %s -checks='-*,google-explicit-constructor' -sarif-export=- -export-fixes=- -- 2>&1 | FileCheck %s --check-prefix=CHECK-STDOUT
+// RUN: not clang-tidy %s -checks='-*,google-explicit-constructor' -sarif-export=%t.out -export-fixes=%t.out -- 2>&1 | FileCheck %s --check-prefix=CHECK-FILE
+
+// CHECK-STDOUT: Error: --sarif-export and --export-fixes cannot write to the same output '-'.
+// CHECK-STDOUT-NOT: warning:
+// CHECK-FILE: Error: --sarif-export and --export-fixes cannot write to the same output '{{.*}}.out'.
+
+struct A { A(int) {} };
diff --git a/clang-tools-extra/test/clang-tidy/infrastructure/export-SARIF-diagnostics-EOF.cpp b/clang-tools-extra/test/clang-tidy/infrastructure/export-SARIF-diagnostics-EOF.cpp
new file mode 100644
index 00000000000000..80fe41188bd73a
--- /dev/null
+++ b/clang-tools-extra/test/clang-tidy/infrastructure/export-SARIF-diagnostics-EOF.cpp
@@ -0,0 +1,77 @@
+// RUN: echo -n 'int main() { return 0; }' > %t-input.cpp
+// RUN: clang-tidy %t-input.cpp -checks='-*,clang-diagnostic-newline-eof' --allow-no-checks -sarif-export=%t.sarif -- -Wnewline-eof > %t.msg 2>&1
+// RUN: FileCheck -input-file=%t.msg -check-prefix=CHECK-MESSAGES %s -implicit-check-not='{{warning|error|note}}:'
+// RUN: FileCheck -input-file=%t.sarif -check-prefix=CHECK-SARIF %s
+
+//CHECK-MESSAGES: -input.cpp:1:25: warning: no newline at end of file [clang-diagnostic-newline-eof]
+
+//CHECK-SARIF: {
+//CHECK-SARIF-NEXT: "$schema": "https://docs.oasis-open.org/sarif/sarif/v2.1.0/cos02/schemas/sarif-schema-2.1.0.json",
+//CHECK-SARIF-NEXT: "runs": [
+//CHECK-SARIF-NEXT: {
+//CHECK-SARIF-NEXT: "artifacts": [
+//CHECK-SARIF-NEXT: {
+//CHECK-SARIF-NEXT: "length": {{[0-9]+}},
+//CHECK-SARIF-NEXT: "location": {
+//CHECK-SARIF-NEXT: "index": 0,
+//CHECK-SARIF-NEXT: "uri": "file://{{.*}}-input.cpp"
+//CHECK-SARIF-NEXT: },
+//CHECK-SARIF-NEXT: "mimeType": "text/plain",
+//CHECK-SARIF-NEXT: "roles": [
+//CHECK-SARIF-NEXT: "resultFile"
+//CHECK-SARIF-NEXT: ]
+//CHECK-SARIF-NEXT: }
+//CHECK-SARIF-NEXT: ],
+//CHECK-SARIF-NEXT: "columnKind": "unicodeCodePoints",
+//CHECK-SARIF-NEXT: "results": [
+//CHECK-SARIF-NEXT: {
+//CHECK-SARIF-NEXT: "level": "warning",
+//CHECK-SARIF-NEXT: "locations": [
+//CHECK-SARIF-NEXT: {
+//CHECK-SARIF-NEXT: "physicalLocation": {
+//CHECK-SARIF-NEXT: "artifactLocation": {
+//CHECK-SARIF-NEXT: "index": 0,
+//CHECK-SARIF-NEXT: "uri": "file://{{.*}}-input.cpp"
+//CHECK-SARIF-NEXT: },
+//CHECK-SARIF-NEXT: "region": {
+//CHECK-SARIF-NEXT: "endColumn": 25,
+//CHECK-SARIF-NEXT: "startColumn": 25,
+//CHECK-SARIF-NEXT: "startLine": 1
+//CHECK-SARIF-NEXT: }
+//CHECK-SARIF-NEXT: }
+//CHECK-SARIF-NEXT: }
+//CHECK-SARIF-NEXT: ],
+//CHECK-SARIF-NEXT: "message": {
+//CHECK-SARIF-NEXT: "text": "no newline at end of file"
+//CHECK-SARIF-NEXT: },
+//CHECK-SARIF-NEXT: "ruleId": "clang-diagnostic-newline-eof",
+//CHECK-SARIF-NEXT: "ruleIndex": 0
+//CHECK-SARIF-NEXT: }
+//CHECK-SARIF-NEXT: ],
+//CHECK-SARIF-NEXT: "tool": {
+//CHECK-SARIF-NEXT: "driver": {
+//CHECK-SARIF-NEXT: "fullName": "clang-tidy",
+//CHECK-SARIF-NEXT: "informationUri": "https://clang.llvm.org/extra/clang-tidy/",
+//CHECK-SARIF-NEXT: "language": "en-US",
+//CHECK-SARIF-NEXT: "name": "clang-tidy",
+//CHECK-SARIF-NEXT: "rules": [
+//CHECK-SARIF-NEXT: {
+//CHECK-SARIF-NEXT: "defaultConfiguration": {
+//CHECK-SARIF-NEXT: "enabled": true,
+//CHECK-SARIF-NEXT: "level": "warning",
+//CHECK-SARIF-NEXT: "rank": -1
+//CHECK-SARIF-NEXT: },
+//CHECK-SARIF-NEXT: "fullDescription": {
+//CHECK-SARIF-NEXT: "text": ""
+//CHECK-SARIF-NEXT: },
+//CHECK-SARIF-NEXT: "id": "clang-diagnostic-newline-eof",
+//CHECK-SARIF-NEXT: "name": "clang-diagnostic-newline-eof"
+//CHECK-SARIF-NEXT: }
+//CHECK-SARIF-NEXT: ],
+//CHECK-SARIF-NEXT: "version": "{{.*}}"
+//CHECK-SARIF-NEXT: }
+//CHECK-SARIF-NEXT: }
+//CHECK-SARIF-NEXT: }
+//CHECK-SARIF-NEXT: ],
+//CHECK-SARIF-NEXT: "version": "{{.*}}"
+
diff --git a/clang-tools-extra/test/clang-tidy/infrastructure/export-SARIF-diagnostics-macro-thread-flows.cpp b/clang-tools-extra/test/clang-tidy/infrastructure/export-SARIF-diagnostics-macro-thread-flows.cpp
new file mode 100644
index 00000000000000..f0a90426e04640
--- /dev/null
+++ b/clang-tools-extra/test/clang-tidy/infrastructure/export-SARIF-diagnostics-macro-thread-flows.cpp
@@ -0,0 +1,175 @@
+// RUN: grep -Ev "// *[A-Z-]+:" %s > %t-input.cpp
+// RUN: clang-tidy %t-input.cpp -checks='-*,clang-analyzer-*' -sarif-export=%t.sarif > %t.msg 2>&1
+// RUN: FileCheck -input-file=%t.msg -check-prefix=CHECK-MESSAGES %s -implicit-check-not='{{warning|error|note}}:'
+// RUN: FileCheck -input-file=%t.sarif -check-prefix=CHECK-SARIF %s
+#define DEREF(p) (*(p))
+#define NUL nullptr
+int g() { int *ptr = NUL; return DEREF(ptr); }
+
+//CHECK-MESSAGES: -input.cpp:3:34: warning: Dereference of null pointer (loaded from variable 'ptr') [clang-analyzer-core.NullDereference]
+//CHECK-MESSAGES: -input.cpp:1:18: note: expanded from macro 'DEREF'
+//CHECK-MESSAGES: -input.cpp:3:11: note: 'ptr' initialized to a null pointer value
+//CHECK-MESSAGES: -input.cpp:3:34: note: Dereference of null pointer (loaded from variable 'ptr')
+//CHECK-MESSAGES: -input.cpp:1:18: note: expanded from macro 'DEREF'
+
+//CHECK-SARIF: {
+//CHECK-SARIF-NEXT: "$schema": "https://docs.oasis-open.org/sarif/sarif/v2.1.0/cos02/schemas/sarif-schema-2.1.0.json",
+//CHECK-SARIF-NEXT: "runs": [
+//CHECK-SARIF-NEXT: {
+//CHECK-SARIF-NEXT: "artifacts": [
+//CHECK-SARIF-NEXT: {
+//CHECK-SARIF-NEXT: "length": {{[0-9]+}},
+//CHECK-SARIF-NEXT: "location": {
+//CHECK-SARIF-NEXT: "index": 0,
+//CHECK-SARIF-NEXT: "uri": "file://{{.*}}-input.cpp"
+//CHECK-SARIF-NEXT: },
+//CHECK-SARIF-NEXT: "mimeType": "text/plain",
+//CHECK-SARIF-NEXT: "roles": [
+//CHECK-SARIF-NEXT: "resultFile"
+//CHECK-SARIF-NEXT: ]
+//CHECK-SARIF-NEXT: }
+//CHECK-SARIF-NEXT: ],
+//CHECK-SARIF-NEXT: "columnKind": "unicodeCodePoints",
+//CHECK-SARIF-NEXT: "results": [
+//CHECK-SARIF-NEXT: {
+//CHECK-SARIF-NEXT: "codeFlows": [
+//CHECK-SARIF-NEXT: {
+//CHECK-SARIF-NEXT: "threadFlows": [
+//CHECK-SARIF-NEXT: {
+//CHECK-SARIF-NEXT: "locations": [
+//CHECK-SARIF-NEXT: {
+//CHECK-SARIF-NEXT: "importance": "important",
+//CHECK-SARIF-NEXT: "location": {
+//CHECK-SARIF-NEXT: "message": {
+//CHECK-SARIF-NEXT: "text": "expanded from macro 'DEREF'"
+//CHECK-SARIF-NEXT: },
+//CHECK-SARIF-NEXT: "physicalLocation": {
+//CHECK-SARIF-NEXT: "artifactLocation": {
+//CHECK-SARIF-NEXT: "index": 0,
+//CHECK-SARIF-NEXT: "uri": "file://{{.*}}-input.cpp"
+//CHECK-SARIF-NEXT: },
+//CHECK-SARIF-NEXT: "region": {
+//CHECK-SARIF-NEXT: "endColumn": 19,
+//CHECK-SARIF-NEXT: "endLine": 1,
+//CHECK-SARIF-NEXT: "startColumn": 18,
+//CHECK-SARIF-NEXT: "startLine": 1
+//CHECK-SARIF-NEXT: }
+//CHECK-SARIF-NEXT: }
+//CHECK-SARIF-NEXT: }
+//CHECK-SARIF-NEXT: },
+//CHECK-SARIF-NEXT: {
+//CHECK-SARIF-NEXT: "importance": "important",
+//CHECK-SARIF-NEXT: "location": {
+//CHECK-SARIF-NEXT: "message": {
+//CHECK-SARIF-NEXT: "text": "'ptr' initialized to a null pointer value"
+//CHECK-SARIF-NEXT: },
+//CHECK-SARIF-NEXT: "physicalLocation": {
+//CHECK-SARIF-NEXT: "artifactLocation": {
+//CHECK-SARIF-NEXT: "index": 0,
+//CHECK-SARIF-NEXT: "uri": "file://{{.*}}-input.cpp"
+//CHECK-SARIF-NEXT: },
+//CHECK-SARIF-NEXT: "region": {
+//CHECK-SARIF-NEXT: "endColumn": 12,
+//CHECK-SARIF-NEXT: "endLine": 3,
+//CHECK-SARIF-NEXT: "startColumn": 11,
+//CHECK-SARIF-NEXT: "startLine": 3
+//CHECK-SARIF-NEXT: }
+//CHECK-SARIF-NEXT: }
+//CHECK-SARIF-NEXT: }
+//CHECK-SARIF-NEXT: },
+//CHECK-SARIF-NEXT: {
+//CHECK-SARIF-NEXT: "importance": "important",
+//CHECK-SARIF-NEXT: "location": {
+//CHECK-SARIF-NEXT: "message": {
+//CHECK-SARIF-NEXT: "text": "Dereference of null pointer (loaded from variable 'ptr')"
+//CHECK-SARIF-NEXT: },
+//CHECK-SARIF-NEXT: "physicalLocation": {
+//CHECK-SARIF-NEXT: "artifactLocation": {
+//CHECK-SARIF-NEXT: "index": 0,
+//CHECK-SARIF-NEXT: "uri": "file://{{.*}}-input.cpp"
+//CHECK-SARIF-NEXT: },
+//CHECK-SARIF-NEXT: "region": {
+//CHECK-SARIF-NEXT: "endColumn": 35,
+//CHECK-SARIF-NEXT: "endLine": 3,
+//CHECK-SARIF-NEXT: "startColumn": 34,
+//CHECK-SARIF-NEXT: "startLine": 3
+//CHECK-SARIF-NEXT: }
+//CHECK-SARIF-NEXT: }
+//CHECK-SARIF-NEXT: }
+//CHECK-SARIF-NEXT: },
+//CHECK-SARIF-NEXT: {
+//CHECK-SARIF-NEXT: "importance": "important",
+//CHECK-SARIF-NEXT: "location": {
+//CHECK-SARIF-NEXT: "message": {
+//CHECK-SARIF-NEXT: "text": "expanded from macro 'DEREF'"
+//CHECK-SARIF-NEXT: },
+//CHECK-SARIF-NEXT: "physicalLocation": {
+//CHECK-SARIF-NEXT: "artifactLocation": {
+//CHECK-SARIF-NEXT: "index": 0,
+//CHECK-SARIF-NEXT: "uri": "file://{{.*}}-input.cpp"
+//CHECK-SARIF-NEXT: },
+//CHECK-SARIF-NEXT: "region": {
+//CHECK-SARIF-NEXT: "endColumn": 19,
+//CHECK-SARIF-NEXT: "endLine": 1,
+//CHECK-SARIF-NEXT: "startColumn": 18,
+//CHECK-SARIF-NEXT: "startLine": 1
+//CHECK-SARIF-NEXT: }
+//CHECK-SARIF-NEXT: }
+//CHECK-SARIF-NEXT: }
+//CHECK-SARIF-NEXT: }
+//CHECK-SARIF-NEXT: ]
+//CHECK-SARIF-NEXT: }
+//CHECK-SARIF-NEXT: ]
+//CHECK-SARIF-NEXT: }
+//CHECK-SARIF-NEXT: ],
+//CHECK-SARIF-NEXT: "level": "warning",
+//CHECK-SARIF-NEXT: "locations": [
+//CHECK-SARIF-NEXT: {
+//CHECK-SARIF-NEXT: "physicalLocation": {
+//CHECK-SARIF-NEXT: "artifactLocation": {
+//CHECK-SARIF-NEXT: "index": 0,
+//CHECK-SARIF-NEXT: "uri": "file://{{.*}}-input.cpp"
+//CHECK-SARIF-NEXT: },
+//CHECK-SARIF-NEXT: "region": {
+//CHECK-SARIF-NEXT: "endColumn": 35,
+//CHECK-SARIF-NEXT: "endLine": 3,
+//CHECK-SARIF-NEXT: "startColumn": 34,
+//CHECK-SARIF-NEXT: "startLine": 3
+//CHECK-SARIF-NEXT: }
+//CHECK-SARIF-NEXT: }
+//CHECK-SARIF-NEXT: }
+//CHECK-SARIF-NEXT: ],
+//CHECK-SARIF-NEXT: "message": {
+//CHECK-SARIF-NEXT: "text": "Dereference of null pointer (loaded from variable 'ptr')"
+//CHECK-SARIF-NEXT: },
+//CHECK-SARIF-NEXT: "ruleId": "clang-analyzer-core.NullDereference",
+//CHECK-SARIF-NEXT: "ruleIndex": 0
+//CHECK-SARIF-NEXT: }
+//CHECK-SARIF-NEXT: ],
+//CHECK-SARIF-NEXT: "tool": {
+//CHECK-SARIF-NEXT: "driver": {
+//CHECK-SARIF-NEXT: "fullName": "clang-tidy",
+//CHECK-SARIF-NEXT: "informationUri": "https://clang.llvm.org/extra/clang-tidy/",
+//CHECK-SARIF-NEXT: "language": "en-US",
+//CHECK-SARIF-NEXT: "name": "clang-tidy",
+//CHECK-SARIF-NEXT: "rules": [
+//CHECK-SARIF-NEXT: {
+//CHECK-SARIF-NEXT: "defaultConfiguration": {
+//CHECK-SARIF-NEXT: "enabled": true,
+//CHECK-SARIF-NEXT: "level": "warning",
+//CHECK-SARIF-NEXT: "rank": -1
+//CHECK-SARIF-NEXT: },
+//CHECK-SARIF-NEXT: "fullDescription": {
+//CHECK-SARIF-NEXT: "text": ""
+//CHECK-SARIF-NEXT: },
+//CHECK-SARIF-NEXT: "id": "clang-analyzer-core.NullDereference",
+//CHECK-SARIF-NEXT: "name": "clang-analyzer-core.NullDereference"
+//CHECK-SARIF-NEXT: }
+//CHECK-SARIF-NEXT: ],
+//CHECK-SARIF-NEXT: "version": "{{.*}}"
+//CHECK-SARIF-NEXT: }
+//CHECK-SARIF-NEXT: }
+//CHECK-SARIF-NEXT: }
+//CHECK-SARIF-NEXT: ],
+//CHECK-SARIF-NEXT: "version": "{{.*}}"
+//CHECK-SARIF-NEXT: }
diff --git a/clang-tools-extra/test/clang-tidy/infrastructure/export-SARIF-diagnostics-terminal.cpp b/clang-tools-extra/test/clang-tidy/infrastructure/export-SARIF-diagnostics-terminal.cpp
new file mode 100644
index 00000000000000..5e23318c7d4e21
--- /dev/null
+++ b/clang-tools-extra/test/clang-tidy/infrastructure/export-SARIF-diagnostics-terminal.cpp
@@ -0,0 +1,299 @@
+// RUN: grep -Ev "// *[A-Z-]+:" %s > %t-input.cpp
+// RUN: not clang-tidy %t-input.cpp -checks='-*,google-explicit-constructor,clang-diagnostic-missing-prototypes,clang-diagnostic-zero-length-array' --warnings-as-errors='clang-diagnostic-missing-prototypes,google-explicit-constructor' -sarif-export - -- -Wmissing-prototypes -Wzero-length-array 2>/dev/null | FileCheck %s
+#define X(n) void n ## n() {}
+X(f)
+int a[-1];
+int b[0];
+
+void test(x);
+struct Foo {
+ member;
+ Foo(int) {}
+};
+
+//CHECK: {{^{$}}
+//CHECK-NEXT: "$schema": "https://docs.oasis-open.org/sarif/sarif/v2.1.0/cos02/schemas/sarif-schema-2.1.0.json",
+//CHECK-NEXT: "runs": [
+//CHECK-NEXT: {
+//CHECK-NEXT: "artifacts": [
+//CHECK-NEXT: {
+//CHECK-NEXT: "length": {{[0-9]+}},
+//CHECK-NEXT: "location": {
+//CHECK-NEXT: "index": 0,
+//CHECK-NEXT: "uri": "file://{{.*}}-input.cpp"
+//CHECK-NEXT: },
+//CHECK-NEXT: "mimeType": "text/plain",
+//CHECK-NEXT: "roles": [
+//CHECK-NEXT: "resultFile"
+//CHECK-NEXT: ]
+//CHECK-NEXT: }
+//CHECK-NEXT: ],
+//CHECK-NEXT: "columnKind": "unicodeCodePoints",
+//CHECK-NEXT: "results": [
+//CHECK-NEXT: {
+//CHECK-NEXT: "level": "error",
+//CHECK-NEXT: "locations": [
+//CHECK-NEXT: {
+//CHECK-NEXT: "physicalLocation": {
+//CHECK-NEXT: "artifactLocation": {
+//CHECK-NEXT: "index": 0,
+//CHECK-NEXT: "uri": "file://{{.*}}-input.cpp"
+//CHECK-NEXT: },
+//CHECK-NEXT: "region": {
+//CHECK-NEXT: "endColumn": 2,
+//CHECK-NEXT: "endLine": 2,
+//CHECK-NEXT: "startColumn": 1,
+//CHECK-NEXT: "startLine": 2
+//CHECK-NEXT: }
+//CHECK-NEXT: }
+//CHECK-NEXT: }
+//CHECK-NEXT: ],
+//CHECK-NEXT: "message": {
+//CHECK-NEXT: "text": "no previous prototype for function 'ff'"
+//CHECK-NEXT: },
+//CHECK-NEXT: "relatedLocations": [
+//CHECK-NEXT: {
+//CHECK-NEXT: "message": {
+//CHECK-NEXT: "text": "expanded from macro 'X'"
+//CHECK-NEXT: },
+//CHECK-NEXT: "physicalLocation": {
+//CHECK-NEXT: "artifactLocation": {
+//CHECK-NEXT: "index": 0,
+//CHECK-NEXT: "uri": "file://{{.*}}-input.cpp"
+//CHECK-NEXT: },
+//CHECK-NEXT: "region": {
+//CHECK-NEXT: "endColumn": 20,
+//CHECK-NEXT: "endLine": 1,
+//CHECK-NEXT: "startColumn": 19,
+//CHECK-NEXT: "startLine": 1
+//CHECK-NEXT: }
+//CHECK-NEXT: }
+//CHECK-NEXT: },
+//CHECK-NEXT: {
+//CHECK-NEXT: "message": {
+//CHECK-NEXT: "text": "expanded from here"
+//CHECK-NEXT: }
+//CHECK-NEXT: },
+//CHECK-NEXT: {
+//CHECK-NEXT: "message": {
+//CHECK-NEXT: "text": "declare 'static' if the function is not intended to be used outside of this translation unit"
+//CHECK-NEXT: },
+//CHECK-NEXT: "physicalLocation": {
+//CHECK-NEXT: "artifactLocation": {
+//CHECK-NEXT: "index": 0,
+//CHECK-NEXT: "uri": "file://{{.*}}-input.cpp"
+//CHECK-NEXT: },
+//CHECK-NEXT: "region": {
+//CHECK-NEXT: "endColumn": 2,
+//CHECK-NEXT: "endLine": 2,
+//CHECK-NEXT: "startColumn": 1,
+//CHECK-NEXT: "startLine": 2
+//CHECK-NEXT: }
+//CHECK-NEXT: }
+//CHECK-NEXT: },
+//CHECK-NEXT: {
+//CHECK-NEXT: "message": {
+//CHECK-NEXT: "text": "expanded from macro 'X'"
+//CHECK-NEXT: },
+//CHECK-NEXT: "physicalLocation": {
+//CHECK-NEXT: "artifactLocation": {
+//CHECK-NEXT: "index": 0,
+//CHECK-NEXT: "uri": "file://{{.*}}-input.cpp"
+//CHECK-NEXT: },
+//CHECK-NEXT: "region": {
+//CHECK-NEXT: "endColumn": 15,
+//CHECK-NEXT: "endLine": 1,
+//CHECK-NEXT: "startColumn": 14,
+//CHECK-NEXT: "startLine": 1
+//CHECK-NEXT: }
+//CHECK-NEXT: }
+//CHECK-NEXT: }
+//CHECK-NEXT: ],
+//CHECK-NEXT: "ruleId": "clang-diagnostic-missing-prototypes",
+//CHECK-NEXT: "ruleIndex": 0
+//CHECK-NEXT: },
+//CHECK-NEXT: {
+//CHECK-NEXT: "level": "error",
+//CHECK-NEXT: "locations": [
+//CHECK-NEXT: {
+//CHECK-NEXT: "physicalLocation": {
+//CHECK-NEXT: "artifactLocation": {
+//CHECK-NEXT: "index": 0,
+//CHECK-NEXT: "uri": "file://{{.*}}-input.cpp"
+//CHECK-NEXT: },
+//CHECK-NEXT: "region": {
+//CHECK-NEXT: "endColumn": 8,
+//CHECK-NEXT: "endLine": 3,
+//CHECK-NEXT: "startColumn": 7,
+//CHECK-NEXT: "startLine": 3
+//CHECK-NEXT: }
+//CHECK-NEXT: }
+//CHECK-NEXT: }
+//CHECK-NEXT: ],
+//CHECK-NEXT: "message": {
+//CHECK-NEXT: "text": "'a' declared as an array with a negative size"
+//CHECK-NEXT: },
+//CHECK-NEXT: "ruleId": "clang-diagnostic-error",
+//CHECK-NEXT: "ruleIndex": 1
+//CHECK-NEXT: },
+//CHECK-NEXT: {
+//CHECK-NEXT: "level": "warning",
+//CHECK-NEXT: "locations": [
+//CHECK-NEXT: {
+//CHECK-NEXT: "physicalLocation": {
+//CHECK-NEXT: "artifactLocation": {
+//CHECK-NEXT: "index": 0,
+//CHECK-NEXT: "uri": "file://{{.*}}-input.cpp"
+//CHECK-NEXT: },
+//CHECK-NEXT: "region": {
+//CHECK-NEXT: "endColumn": 8,
+//CHECK-NEXT: "endLine": 4,
+//CHECK-NEXT: "startColumn": 7,
+//CHECK-NEXT: "startLine": 4
+//CHECK-NEXT: }
+//CHECK-NEXT: }
+//CHECK-NEXT: }
+//CHECK-NEXT: ],
+//CHECK-NEXT: "message": {
+//CHECK-NEXT: "text": "zero size arrays are an extension"
+//CHECK-NEXT: },
+//CHECK-NEXT: "ruleId": "clang-diagnostic-zero-length-array",
+//CHECK-NEXT: "ruleIndex": 2
+//CHECK-NEXT: },
+//CHECK-NEXT: {
+//CHECK-NEXT: "level": "error",
+//CHECK-NEXT: "locations": [
+//CHECK-NEXT: {
+//CHECK-NEXT: "physicalLocation": {
+//CHECK-NEXT: "artifactLocation": {
+//CHECK-NEXT: "index": 0,
+//CHECK-NEXT: "uri": "file://{{.*}}-input.cpp"
+//CHECK-NEXT: },
+//CHECK-NEXT: "region": {
+//CHECK-NEXT: "endColumn": 12,
+//CHECK-NEXT: "endLine": 6,
+//CHECK-NEXT: "startColumn": 11,
+//CHECK-NEXT: "startLine": 6
+//CHECK-NEXT: }
+//CHECK-NEXT: }
+//CHECK-NEXT: }
+//CHECK-NEXT: ],
+//CHECK-NEXT: "message": {
+//CHECK-NEXT: "text": "unknown type name 'x'"
+//CHECK-NEXT: },
+//CHECK-NEXT: "ruleId": "clang-diagnostic-error",
+//CHECK-NEXT: "ruleIndex": 1
+//CHECK-NEXT: },
+//CHECK-NEXT: {
+//CHECK-NEXT: "level": "error",
+//CHECK-NEXT: "locations": [
+//CHECK-NEXT: {
+//CHECK-NEXT: "physicalLocation": {
+//CHECK-NEXT: "artifactLocation": {
+//CHECK-NEXT: "index": 0,
+//CHECK-NEXT: "uri": "file://{{.*}}-input.cpp"
+//CHECK-NEXT: },
+//CHECK-NEXT: "region": {
+//CHECK-NEXT: "endColumn": 4,
+//CHECK-NEXT: "endLine": 8,
+//CHECK-NEXT: "startColumn": 3,
+//CHECK-NEXT: "startLine": 8
+//CHECK-NEXT: }
+//CHECK-NEXT: }
+//CHECK-NEXT: }
+//CHECK-NEXT: ],
+//CHECK-NEXT: "message": {
+//CHECK-NEXT: "text": "a type specifier is required for all declarations"
+//CHECK-NEXT: },
+//CHECK-NEXT: "ruleId": "clang-diagnostic-error",
+//CHECK-NEXT: "ruleIndex": 1
+//CHECK-NEXT: },
+//CHECK-NEXT: {
+//CHECK-NEXT: "level": "error",
+//CHECK-NEXT: "locations": [
+//CHECK-NEXT: {
+//CHECK-NEXT: "physicalLocation": {
+//CHECK-NEXT: "artifactLocation": {
+//CHECK-NEXT: "index": 0,
+//CHECK-NEXT: "uri": "file://{{.*}}-input.cpp"
+//CHECK-NEXT: },
+//CHECK-NEXT: "region": {
+//CHECK-NEXT: "endColumn": 4,
+//CHECK-NEXT: "endLine": 9,
+//CHECK-NEXT: "startColumn": 3,
+//CHECK-NEXT: "startLine": 9
+//CHECK-NEXT: }
+//CHECK-NEXT: }
+//CHECK-NEXT: }
+//CHECK-NEXT: ],
+//CHECK-NEXT: "message": {
+//CHECK-NEXT: "text": "single-argument constructors must be marked explicit to avoid unintentional implicit conversions"
+//CHECK-NEXT: },
+//CHECK-NEXT: "ruleId": "google-explicit-constructor",
+//CHECK-NEXT: "ruleIndex": 3
+//CHECK-NEXT: }
+//CHECK-NEXT: ],
+//CHECK-NEXT: "tool": {
+//CHECK-NEXT: "driver": {
+//CHECK-NEXT: "fullName": "clang-tidy",
+//CHECK-NEXT: "informationUri": "https://clang.llvm.org/extra/clang-tidy/",
+//CHECK-NEXT: "language": "en-US",
+//CHECK-NEXT: "name": "clang-tidy",
+//CHECK-NEXT: "rules": [
+//CHECK-NEXT: {
+//CHECK-NEXT: "defaultConfiguration": {
+//CHECK-NEXT: "enabled": true,
+//CHECK-NEXT: "level": "error",
+//CHECK-NEXT: "rank": 50
+//CHECK-NEXT: },
+//CHECK-NEXT: "fullDescription": {
+//CHECK-NEXT: "text": ""
+//CHECK-NEXT: },
+//CHECK-NEXT: "id": "clang-diagnostic-missing-prototypes",
+//CHECK-NEXT: "name": "clang-diagnostic-missing-prototypes"
+//CHECK-NEXT: },
+//CHECK-NEXT: {
+//CHECK-NEXT: "defaultConfiguration": {
+//CHECK-NEXT: "enabled": true,
+//CHECK-NEXT: "level": "error",
+//CHECK-NEXT: "rank": 50
+//CHECK-NEXT: },
+//CHECK-NEXT: "fullDescription": {
+//CHECK-NEXT: "text": ""
+//CHECK-NEXT: },
+//CHECK-NEXT: "id": "clang-diagnostic-error",
+//CHECK-NEXT: "name": "clang-diagnostic-error"
+//CHECK-NEXT: },
+//CHECK-NEXT: {
+//CHECK-NEXT: "defaultConfiguration": {
+//CHECK-NEXT: "enabled": true,
+//CHECK-NEXT: "level": "warning",
+//CHECK-NEXT: "rank": -1
+//CHECK-NEXT: },
+//CHECK-NEXT: "fullDescription": {
+//CHECK-NEXT: "text": ""
+//CHECK-NEXT: },
+//CHECK-NEXT: "id": "clang-diagnostic-zero-length-array",
+//CHECK-NEXT: "name": "clang-diagnostic-zero-length-array"
+//CHECK-NEXT: },
+//CHECK-NEXT: {
+//CHECK-NEXT: "defaultConfiguration": {
+//CHECK-NEXT: "enabled": true,
+//CHECK-NEXT: "level": "error",
+//CHECK-NEXT: "rank": 50
+//CHECK-NEXT: },
+//CHECK-NEXT: "fullDescription": {
+//CHECK-NEXT: "text": ""
+//CHECK-NEXT: },
+//CHECK-NEXT: "id": "google-explicit-constructor",
+//CHECK-NEXT: "name": "google-explicit-constructor"
+//CHECK-NEXT: }
+//CHECK-NEXT: ],
+//CHECK-NEXT: "version": "{{.*}}"
+//CHECK-NEXT: }
+//CHECK-NEXT: }
+//CHECK-NEXT: }
+//CHECK-NEXT: ],
+//CHECK-NEXT: "version": "{{.*}}"
+//CHECK-NEXT: }
+
diff --git a/clang-tools-extra/test/clang-tidy/infrastructure/export-SARIF-diagnostics.cpp b/clang-tools-extra/test/clang-tidy/infrastructure/export-SARIF-diagnostics.cpp
new file mode 100644
index 00000000000000..0fc9429a3aa83c
--- /dev/null
+++ b/clang-tools-extra/test/clang-tidy/infrastructure/export-SARIF-diagnostics.cpp
@@ -0,0 +1,314 @@
+// RUN: grep -Ev "// *[A-Z-]+:" %s > %t-input.cpp
+// RUN: not clang-tidy %t-input.cpp -checks='-*,google-explicit-constructor,cppcoreguidelines-explicit-constructor,clang-diagnostic-missing-prototypes,clang-diagnostic-zero-length-array' --warnings-as-errors='clang-diagnostic-missing-prototypes,google-explicit-constructor' -sarif-export=%t.sarif -- -Wmissing-prototypes -Wzero-length-array > %t.msg 2>&1
+// RUN: FileCheck -input-file=%t.msg -check-prefix=CHECK-MESSAGES %s -implicit-check-not='{{warning|error|note}}:'
+// RUN: FileCheck -input-file=%t.sarif -check-prefix=CHECK-SARIF %s
+#define X(n) void n ## n() {}
+X(f)
+int a[-1];
+int b[0];
+
+void test(x);
+struct Foo {
+ member;
+ Foo(int) {}
+};
+
+//CHECK-MESSAGES: -input.cpp:2:1: error: no previous prototype for function 'ff' [clang-diagnostic-missing-prototypes,-warnings-as-errors]
+//CHECK-MESSAGES: -input.cpp:1:19: note: expanded from macro 'X'
+//CHECK-MESSAGES: {{^}}note: expanded from here{{$}}
+//CHECK-MESSAGES: -input.cpp:2:1: note: declare 'static' if the function is not intended to be used outside of this translation unit
+//CHECK-MESSAGES: -input.cpp:1:14: note: expanded from macro 'X'
+//CHECK-MESSAGES: -input.cpp:3:7: error: 'a' declared as an array with a negative size [clang-diagnostic-error]
+//CHECK-MESSAGES: -input.cpp:4:7: warning: zero size arrays are an extension [clang-diagnostic-zero-length-array]
+//CHECK-MESSAGES: -input.cpp:6:11: error: unknown type name 'x' [clang-diagnostic-error]
+//CHECK-MESSAGES: -input.cpp:8:3: error: a type specifier is required for all declarations [clang-diagnostic-error]
+//CHECK-MESSAGES: -input.cpp:9:3: error: single-argument constructors must be marked explicit to avoid unintentional implicit conversions [cppcoreguidelines-explicit-constructor,google-explicit-constructor,-warnings-as-errors]
+
+//CHECK-SARIF: {
+//CHECK-SARIF-NEXT: "$schema": "https://docs.oasis-open.org/sarif/sarif/v2.1.0/cos02/schemas/sarif-schema-2.1.0.json",
+//CHECK-SARIF-NEXT: "runs": [
+//CHECK-SARIF-NEXT: {
+//CHECK-SARIF-NEXT: "artifacts": [
+//CHECK-SARIF-NEXT: {
+//CHECK-SARIF-NEXT: "length": {{[0-9]+}},
+//CHECK-SARIF-NEXT: "location": {
+//CHECK-SARIF-NEXT: "index": 0,
+//CHECK-SARIF-NEXT: "uri": "file://{{.*}}-input.cpp"
+//CHECK-SARIF-NEXT: },
+//CHECK-SARIF-NEXT: "mimeType": "text/plain",
+//CHECK-SARIF-NEXT: "roles": [
+//CHECK-SARIF-NEXT: "resultFile"
+//CHECK-SARIF-NEXT: ]
+//CHECK-SARIF-NEXT: }
+//CHECK-SARIF-NEXT: ],
+//CHECK-SARIF-NEXT: "columnKind": "unicodeCodePoints",
+//CHECK-SARIF-NEXT: "results": [
+//CHECK-SARIF-NEXT: {
+//CHECK-SARIF-NEXT: "level": "error",
+//CHECK-SARIF-NEXT: "locations": [
+//CHECK-SARIF-NEXT: {
+//CHECK-SARIF-NEXT: "physicalLocation": {
+//CHECK-SARIF-NEXT: "artifactLocation": {
+//CHECK-SARIF-NEXT: "index": 0,
+//CHECK-SARIF-NEXT: "uri": "file://{{.*}}-input.cpp"
+//CHECK-SARIF-NEXT: },
+//CHECK-SARIF-NEXT: "region": {
+//CHECK-SARIF-NEXT: "endColumn": 2,
+//CHECK-SARIF-NEXT: "endLine": 2,
+//CHECK-SARIF-NEXT: "startColumn": 1,
+//CHECK-SARIF-NEXT: "startLine": 2
+//CHECK-SARIF-NEXT: }
+//CHECK-SARIF-NEXT: }
+//CHECK-SARIF-NEXT: }
+//CHECK-SARIF-NEXT: ],
+//CHECK-SARIF-NEXT: "message": {
+//CHECK-SARIF-NEXT: "text": "no previous prototype for function 'ff'"
+//CHECK-SARIF-NEXT: },
+//CHECK-SARIF-NEXT: "relatedLocations": [
+//CHECK-SARIF-NEXT: {
+//CHECK-SARIF-NEXT: "message": {
+//CHECK-SARIF-NEXT: "text": "expanded from macro 'X'"
+//CHECK-SARIF-NEXT: },
+//CHECK-SARIF-NEXT: "physicalLocation": {
+//CHECK-SARIF-NEXT: "artifactLocation": {
+//CHECK-SARIF-NEXT: "index": 0,
+//CHECK-SARIF-NEXT: "uri": "file://{{.*}}-input.cpp"
+//CHECK-SARIF-NEXT: },
+//CHECK-SARIF-NEXT: "region": {
+//CHECK-SARIF-NEXT: "endColumn": 20,
+//CHECK-SARIF-NEXT: "endLine": 1,
+//CHECK-SARIF-NEXT: "startColumn": 19,
+//CHECK-SARIF-NEXT: "startLine": 1
+//CHECK-SARIF-NEXT: }
+//CHECK-SARIF-NEXT: }
+//CHECK-SARIF-NEXT: },
+//CHECK-SARIF-NEXT: {
+//CHECK-SARIF-NEXT: "message": {
+//CHECK-SARIF-NEXT: "text": "expanded from here"
+//CHECK-SARIF-NEXT: }
+//CHECK-SARIF-NEXT: },
+//CHECK-SARIF-NEXT: {
+//CHECK-SARIF-NEXT: "message": {
+//CHECK-SARIF-NEXT: "text": "declare 'static' if the function is not intended to be used outside of this translation unit"
+//CHECK-SARIF-NEXT: },
+//CHECK-SARIF-NEXT: "physicalLocation": {
+//CHECK-SARIF-NEXT: "artifactLocation": {
+//CHECK-SARIF-NEXT: "index": 0,
+//CHECK-SARIF-NEXT: "uri": "file://{{.*}}-input.cpp"
+//CHECK-SARIF-NEXT: },
+//CHECK-SARIF-NEXT: "region": {
+//CHECK-SARIF-NEXT: "endColumn": 2,
+//CHECK-SARIF-NEXT: "endLine": 2,
+//CHECK-SARIF-NEXT: "startColumn": 1,
+//CHECK-SARIF-NEXT: "startLine": 2
+//CHECK-SARIF-NEXT: }
+//CHECK-SARIF-NEXT: }
+//CHECK-SARIF-NEXT: },
+//CHECK-SARIF-NEXT: {
+//CHECK-SARIF-NEXT: "message": {
+//CHECK-SARIF-NEXT: "text": "expanded from macro 'X'"
+//CHECK-SARIF-NEXT: },
+//CHECK-SARIF-NEXT: "physicalLocation": {
+//CHECK-SARIF-NEXT: "artifactLocation": {
+//CHECK-SARIF-NEXT: "index": 0,
+//CHECK-SARIF-NEXT: "uri": "file://{{.*}}-input.cpp"
+//CHECK-SARIF-NEXT: },
+//CHECK-SARIF-NEXT: "region": {
+//CHECK-SARIF-NEXT: "endColumn": 15,
+//CHECK-SARIF-NEXT: "endLine": 1,
+//CHECK-SARIF-NEXT: "startColumn": 14,
+//CHECK-SARIF-NEXT: "startLine": 1
+//CHECK-SARIF-NEXT: }
+//CHECK-SARIF-NEXT: }
+//CHECK-SARIF-NEXT: }
+//CHECK-SARIF-NEXT: ],
+//CHECK-SARIF-NEXT: "ruleId": "clang-diagnostic-missing-prototypes",
+//CHECK-SARIF-NEXT: "ruleIndex": 0
+//CHECK-SARIF-NEXT: },
+//CHECK-SARIF-NEXT: {
+//CHECK-SARIF-NEXT: "level": "error",
+//CHECK-SARIF-NEXT: "locations": [
+//CHECK-SARIF-NEXT: {
+//CHECK-SARIF-NEXT: "physicalLocation": {
+//CHECK-SARIF-NEXT: "artifactLocation": {
+//CHECK-SARIF-NEXT: "index": 0,
+//CHECK-SARIF-NEXT: "uri": "file://{{.*}}-input.cpp"
+//CHECK-SARIF-NEXT: },
+//CHECK-SARIF-NEXT: "region": {
+//CHECK-SARIF-NEXT: "endColumn": 8,
+//CHECK-SARIF-NEXT: "endLine": 3,
+//CHECK-SARIF-NEXT: "startColumn": 7,
+//CHECK-SARIF-NEXT: "startLine": 3
+//CHECK-SARIF-NEXT: }
+//CHECK-SARIF-NEXT: }
+//CHECK-SARIF-NEXT: }
+//CHECK-SARIF-NEXT: ],
+//CHECK-SARIF-NEXT: "message": {
+//CHECK-SARIF-NEXT: "text": "'a' declared as an array with a negative size"
+//CHECK-SARIF-NEXT: },
+//CHECK-SARIF-NEXT: "ruleId": "clang-diagnostic-error",
+//CHECK-SARIF-NEXT: "ruleIndex": 1
+//CHECK-SARIF-NEXT: },
+//CHECK-SARIF-NEXT: {
+//CHECK-SARIF-NEXT: "level": "warning",
+//CHECK-SARIF-NEXT: "locations": [
+//CHECK-SARIF-NEXT: {
+//CHECK-SARIF-NEXT: "physicalLocation": {
+//CHECK-SARIF-NEXT: "artifactLocation": {
+//CHECK-SARIF-NEXT: "index": 0,
+//CHECK-SARIF-NEXT: "uri": "file://{{.*}}-input.cpp"
+//CHECK-SARIF-NEXT: },
+//CHECK-SARIF-NEXT: "region": {
+//CHECK-SARIF-NEXT: "endColumn": 8,
+//CHECK-SARIF-NEXT: "endLine": 4,
+//CHECK-SARIF-NEXT: "startColumn": 7,
+//CHECK-SARIF-NEXT: "startLine": 4
+//CHECK-SARIF-NEXT: }
+//CHECK-SARIF-NEXT: }
+//CHECK-SARIF-NEXT: }
+//CHECK-SARIF-NEXT: ],
+//CHECK-SARIF-NEXT: "message": {
+//CHECK-SARIF-NEXT: "text": "zero size arrays are an extension"
+//CHECK-SARIF-NEXT: },
+//CHECK-SARIF-NEXT: "ruleId": "clang-diagnostic-zero-length-array",
+//CHECK-SARIF-NEXT: "ruleIndex": 2
+//CHECK-SARIF-NEXT: },
+//CHECK-SARIF-NEXT: {
+//CHECK-SARIF-NEXT: "level": "error",
+//CHECK-SARIF-NEXT: "locations": [
+//CHECK-SARIF-NEXT: {
+//CHECK-SARIF-NEXT: "physicalLocation": {
+//CHECK-SARIF-NEXT: "artifactLocation": {
+//CHECK-SARIF-NEXT: "index": 0,
+//CHECK-SARIF-NEXT: "uri": "file://{{.*}}-input.cpp"
+//CHECK-SARIF-NEXT: },
+//CHECK-SARIF-NEXT: "region": {
+//CHECK-SARIF-NEXT: "endColumn": 12,
+//CHECK-SARIF-NEXT: "endLine": 6,
+//CHECK-SARIF-NEXT: "startColumn": 11,
+//CHECK-SARIF-NEXT: "startLine": 6
+//CHECK-SARIF-NEXT: }
+//CHECK-SARIF-NEXT: }
+//CHECK-SARIF-NEXT: }
+//CHECK-SARIF-NEXT: ],
+//CHECK-SARIF-NEXT: "message": {
+//CHECK-SARIF-NEXT: "text": "unknown type name 'x'"
+//CHECK-SARIF-NEXT: },
+//CHECK-SARIF-NEXT: "ruleId": "clang-diagnostic-error",
+//CHECK-SARIF-NEXT: "ruleIndex": 1
+//CHECK-SARIF-NEXT: },
+//CHECK-SARIF-NEXT: {
+//CHECK-SARIF-NEXT: "level": "error",
+//CHECK-SARIF-NEXT: "locations": [
+//CHECK-SARIF-NEXT: {
+//CHECK-SARIF-NEXT: "physicalLocation": {
+//CHECK-SARIF-NEXT: "artifactLocation": {
+//CHECK-SARIF-NEXT: "index": 0,
+//CHECK-SARIF-NEXT: "uri": "file://{{.*}}-input.cpp"
+//CHECK-SARIF-NEXT: },
+//CHECK-SARIF-NEXT: "region": {
+//CHECK-SARIF-NEXT: "endColumn": 4,
+//CHECK-SARIF-NEXT: "endLine": 8,
+//CHECK-SARIF-NEXT: "startColumn": 3,
+//CHECK-SARIF-NEXT: "startLine": 8
+//CHECK-SARIF-NEXT: }
+//CHECK-SARIF-NEXT: }
+//CHECK-SARIF-NEXT: }
+//CHECK-SARIF-NEXT: ],
+//CHECK-SARIF-NEXT: "message": {
+//CHECK-SARIF-NEXT: "text": "a type specifier is required for all declarations"
+//CHECK-SARIF-NEXT: },
+//CHECK-SARIF-NEXT: "ruleId": "clang-diagnostic-error",
+//CHECK-SARIF-NEXT: "ruleIndex": 1
+//CHECK-SARIF-NEXT: },
+//CHECK-SARIF-NEXT: {
+//CHECK-SARIF-NEXT: "level": "error",
+//CHECK-SARIF-NEXT: "locations": [
+//CHECK-SARIF-NEXT: {
+//CHECK-SARIF-NEXT: "physicalLocation": {
+//CHECK-SARIF-NEXT: "artifactLocation": {
+//CHECK-SARIF-NEXT: "index": 0,
+//CHECK-SARIF-NEXT: "uri": "file://{{.*}}-input.cpp"
+//CHECK-SARIF-NEXT: },
+//CHECK-SARIF-NEXT: "region": {
+//CHECK-SARIF-NEXT: "endColumn": 4,
+//CHECK-SARIF-NEXT: "endLine": 9,
+//CHECK-SARIF-NEXT: "startColumn": 3,
+//CHECK-SARIF-NEXT: "startLine": 9
+//CHECK-SARIF-NEXT: }
+//CHECK-SARIF-NEXT: }
+//CHECK-SARIF-NEXT: }
+//CHECK-SARIF-NEXT: ],
+//CHECK-SARIF-NEXT: "message": {
+//CHECK-SARIF-NEXT: "text": "single-argument constructors must be marked explicit to avoid unintentional implicit conversions"
+//CHECK-SARIF-NEXT: },
+//CHECK-SARIF-NEXT: "properties": {
+//CHECK-SARIF-NEXT: "enabledAliases": "google-explicit-constructor"
+//CHECK-SARIF-NEXT: },
+//CHECK-SARIF-NEXT: "ruleId": "cppcoreguidelines-explicit-constructor",
+//CHECK-SARIF-NEXT: "ruleIndex": 3
+//CHECK-SARIF-NEXT: }
+//CHECK-SARIF-NEXT: ],
+//CHECK-SARIF-NEXT: "tool": {
+//CHECK-SARIF-NEXT: "driver": {
+//CHECK-SARIF-NEXT: "fullName": "clang-tidy",
+//CHECK-SARIF-NEXT: "informationUri": "https://clang.llvm.org/extra/clang-tidy/",
+//CHECK-SARIF-NEXT: "language": "en-US",
+//CHECK-SARIF-NEXT: "name": "clang-tidy",
+//CHECK-SARIF-NEXT: "rules": [
+//CHECK-SARIF-NEXT: {
+//CHECK-SARIF-NEXT: "defaultConfiguration": {
+//CHECK-SARIF-NEXT: "enabled": true,
+//CHECK-SARIF-NEXT: "level": "error",
+//CHECK-SARIF-NEXT: "rank": 50
+//CHECK-SARIF-NEXT: },
+//CHECK-SARIF-NEXT: "fullDescription": {
+//CHECK-SARIF-NEXT: "text": ""
+//CHECK-SARIF-NEXT: },
+//CHECK-SARIF-NEXT: "id": "clang-diagnostic-missing-prototypes",
+//CHECK-SARIF-NEXT: "name": "clang-diagnostic-missing-prototypes"
+//CHECK-SARIF-NEXT: },
+//CHECK-SARIF-NEXT: {
+//CHECK-SARIF-NEXT: "defaultConfiguration": {
+//CHECK-SARIF-NEXT: "enabled": true,
+//CHECK-SARIF-NEXT: "level": "error",
+//CHECK-SARIF-NEXT: "rank": 50
+//CHECK-SARIF-NEXT: },
+//CHECK-SARIF-NEXT: "fullDescription": {
+//CHECK-SARIF-NEXT: "text": ""
+//CHECK-SARIF-NEXT: },
+//CHECK-SARIF-NEXT: "id": "clang-diagnostic-error",
+//CHECK-SARIF-NEXT: "name": "clang-diagnostic-error"
+//CHECK-SARIF-NEXT: },
+//CHECK-SARIF-NEXT: {
+//CHECK-SARIF-NEXT: "defaultConfiguration": {
+//CHECK-SARIF-NEXT: "enabled": true,
+//CHECK-SARIF-NEXT: "level": "warning",
+//CHECK-SARIF-NEXT: "rank": -1
+//CHECK-SARIF-NEXT: },
+//CHECK-SARIF-NEXT: "fullDescription": {
+//CHECK-SARIF-NEXT: "text": ""
+//CHECK-SARIF-NEXT: },
+//CHECK-SARIF-NEXT: "id": "clang-diagnostic-zero-length-array",
+//CHECK-SARIF-NEXT: "name": "clang-diagnostic-zero-length-array"
+//CHECK-SARIF-NEXT: },
+//CHECK-SARIF-NEXT: {
+//CHECK-SARIF-NEXT: "defaultConfiguration": {
+//CHECK-SARIF-NEXT: "enabled": true,
+//CHECK-SARIF-NEXT: "level": "error",
+//CHECK-SARIF-NEXT: "rank": 50
+//CHECK-SARIF-NEXT: },
+//CHECK-SARIF-NEXT: "fullDescription": {
+//CHECK-SARIF-NEXT: "text": ""
+//CHECK-SARIF-NEXT: },
+//CHECK-SARIF-NEXT: "id": "cppcoreguidelines-explicit-constructor",
+//CHECK-SARIF-NEXT: "name": "cppcoreguidelines-explicit-constructor"
+//CHECK-SARIF-NEXT: }
+//CHECK-SARIF-NEXT: ],
+//CHECK-SARIF-NEXT: "version": "{{.*}}"
+//CHECK-SARIF-NEXT: }
+//CHECK-SARIF-NEXT: }
+//CHECK-SARIF-NEXT: }
+//CHECK-SARIF-NEXT: ],
+//CHECK-SARIF-NEXT: "version": "{{.*}}"
+//CHECK-SARIF-NEXT: }
diff --git a/clang-tools-extra/test/clang-tidy/infrastructure/export-SARIF-no-location.cpp b/clang-tools-extra/test/clang-tidy/infrastructure/export-SARIF-no-location.cpp
new file mode 100644
index 00000000000000..8e40667f735817
--- /dev/null
+++ b/clang-tools-extra/test/clang-tidy/infrastructure/export-SARIF-no-location.cpp
@@ -0,0 +1,104 @@
+// RUN: grep -Ev "// *[A-Z-]+:" %s > %t-input.cpp
+// RUN: not clang-tidy %t-input.cpp -checks='-*,clang-diagnostic-*,google-explicit-constructor' -sarif-export=%t.sarif -- -fake-command > %t.msg 2>&1
+// RUN: FileCheck -input-file=%t.msg -check-prefix=CHECK-MESSAGES %s -implicit-check-not='{{warning|error|note}}:'
+// RUN: FileCheck -input-file=%t.sarif -check-prefix=CHECK-SARIF %s
+class A { A(int) {} };
+
+//NOTE: "-fake-command" is rejected by the driver before a SourceManager is created,
+//NOTE: so the diagnostic is stored with an empty FilePath and ranges. Therefore, getResultRanges()
+//NOTE: omits locations entirely.
+
+//CHECK-MESSAGES: error: unknown argument: '-fake-command' [clang-diagnostic-error]
+//CHECK-MESSAGES: -input.cpp:1:11: warning: single-argument constructors must be marked explicit to avoid unintentional implicit conversions [google-explicit-constructor]
+
+//CHECK-SARIF: {
+//CHECK-SARIF-NEXT: "$schema": "https://docs.oasis-open.org/sarif/sarif/v2.1.0/cos02/schemas/sarif-schema-2.1.0.json",
+//CHECK-SARIF-NEXT: "runs": [
+//CHECK-SARIF-NEXT: {
+//CHECK-SARIF-NEXT: "artifacts": [
+//CHECK-SARIF-NEXT: {
+//CHECK-SARIF-NEXT: "length": {{[0-9]+}},
+//CHECK-SARIF-NEXT: "location": {
+//CHECK-SARIF-NEXT: "index": 0,
+//CHECK-SARIF-NEXT: "uri": "file://{{.*}}-input.cpp"
+//CHECK-SARIF-NEXT: },
+//CHECK-SARIF-NEXT: "mimeType": "text/plain",
+//CHECK-SARIF-NEXT: "roles": [
+//CHECK-SARIF-NEXT: "resultFile"
+//CHECK-SARIF-NEXT: ]
+//CHECK-SARIF-NEXT: }
+//CHECK-SARIF-NEXT: ],
+//CHECK-SARIF-NEXT: "columnKind": "unicodeCodePoints",
+//CHECK-SARIF-NEXT: "results": [
+//CHECK-SARIF-NEXT: {
+//CHECK-SARIF-NEXT: "level": "error",
+//CHECK-SARIF-NEXT: "message": {
+//CHECK-SARIF-NEXT: "text": "unknown argument: '-fake-command'"
+//CHECK-SARIF-NEXT: },
+//CHECK-SARIF-NEXT: "ruleId": "clang-diagnostic-error",
+//CHECK-SARIF-NEXT: "ruleIndex": 0
+//CHECK-SARIF-NEXT: },
+//CHECK-SARIF-NEXT: {
+//CHECK-SARIF-NEXT: "level": "warning",
+//CHECK-SARIF-NEXT: "locations": [
+//CHECK-SARIF-NEXT: {
+//CHECK-SARIF-NEXT: "physicalLocation": {
+//CHECK-SARIF-NEXT: "artifactLocation": {
+//CHECK-SARIF-NEXT: "index": 0,
+//CHECK-SARIF-NEXT: "uri": "file://{{.*}}-input.cpp"
+//CHECK-SARIF-NEXT: },
+//CHECK-SARIF-NEXT: "region": {
+//CHECK-SARIF-NEXT: "endColumn": 12,
+//CHECK-SARIF-NEXT: "endLine": 1,
+//CHECK-SARIF-NEXT: "startColumn": 11,
+//CHECK-SARIF-NEXT: "startLine": 1
+//CHECK-SARIF-NEXT: }
+//CHECK-SARIF-NEXT: }
+//CHECK-SARIF-NEXT: }
+//CHECK-SARIF-NEXT: ],
+//CHECK-SARIF-NEXT: "message": {
+//CHECK-SARIF-NEXT: "text": "single-argument constructors must be marked explicit to avoid unintentional implicit conversions"
+//CHECK-SARIF-NEXT: },
+//CHECK-SARIF-NEXT: "ruleId": "google-explicit-constructor",
+//CHECK-SARIF-NEXT: "ruleIndex": 1
+//CHECK-SARIF-NEXT: }
+//CHECK-SARIF-NEXT: ],
+//CHECK-SARIF-NEXT: "tool": {
+//CHECK-SARIF-NEXT: "driver": {
+//CHECK-SARIF-NEXT: "fullName": "clang-tidy",
+//CHECK-SARIF-NEXT: "informationUri": "https://clang.llvm.org/extra/clang-tidy/",
+//CHECK-SARIF-NEXT: "language": "en-US",
+//CHECK-SARIF-NEXT: "name": "clang-tidy",
+//CHECK-SARIF-NEXT: "rules": [
+//CHECK-SARIF-NEXT: {
+//CHECK-SARIF-NEXT: "defaultConfiguration": {
+//CHECK-SARIF-NEXT: "enabled": true,
+//CHECK-SARIF-NEXT: "level": "error",
+//CHECK-SARIF-NEXT: "rank": 50
+//CHECK-SARIF-NEXT: },
+//CHECK-SARIF-NEXT: "fullDescription": {
+//CHECK-SARIF-NEXT: "text": ""
+//CHECK-SARIF-NEXT: },
+//CHECK-SARIF-NEXT: "id": "clang-diagnostic-error",
+//CHECK-SARIF-NEXT: "name": "clang-diagnostic-error"
+//CHECK-SARIF-NEXT: },
+//CHECK-SARIF-NEXT: {
+//CHECK-SARIF-NEXT: "defaultConfiguration": {
+//CHECK-SARIF-NEXT: "enabled": true,
+//CHECK-SARIF-NEXT: "level": "warning",
+//CHECK-SARIF-NEXT: "rank": -1
+//CHECK-SARIF-NEXT: },
+//CHECK-SARIF-NEXT: "fullDescription": {
+//CHECK-SARIF-NEXT: "text": ""
+//CHECK-SARIF-NEXT: },
+//CHECK-SARIF-NEXT: "id": "google-explicit-constructor",
+//CHECK-SARIF-NEXT: "name": "google-explicit-constructor"
+//CHECK-SARIF-NEXT: }
+//CHECK-SARIF-NEXT: ],
+//CHECK-SARIF-NEXT: "version": "{{.*}}"
+//CHECK-SARIF-NEXT: }
+//CHECK-SARIF-NEXT: }
+//CHECK-SARIF-NEXT: }
+//CHECK-SARIF-NEXT: ],
+//CHECK-SARIF-NEXT: "version": "{{.*}}"
+//CHECK-SARIF-NEXT: }
diff --git a/clang/include/clang/Basic/Sarif.h b/clang/include/clang/Basic/Sarif.h
index 7651d2ac7a7681..5edee63233e9c9 100644
--- a/clang/include/clang/Basic/Sarif.h
+++ b/clang/include/clang/Basic/Sarif.h
@@ -332,9 +332,11 @@ class SarifResult {
std::string HostedViewerURI;
llvm::SmallDenseMap<StringRef, std::string, 4> PartialFingerprints;
llvm::SmallVector<CharSourceRange, 8> Locations;
- llvm::SmallVector<CharSourceRange, 8> RelatedLocations;
+ llvm::SmallVector<std::pair<CharSourceRange, std::string>, 8>
+ RelatedLocations;
llvm::SmallVector<ThreadFlow, 8> ThreadFlows;
std::optional<SarifResultLevel> LevelOverride;
+ llvm::StringMap<std::string> Properties;
SarifResult() = delete;
explicit SarifResult(uint32_t RuleIdx) : RuleIdx(RuleIdx) {}
@@ -373,7 +375,8 @@ class SarifResult {
return *this;
}
- SarifResult addRelatedLocations(llvm::ArrayRef<CharSourceRange> DiagLocs) {
+ SarifResult addRelatedLocations(llvm::ArrayRef<CharSourceRange> DiagLocs,
+ llvm::StringRef Message = "") {
#ifndef NDEBUG
for (const auto &Loc : DiagLocs) {
assert(
@@ -381,7 +384,8 @@ class SarifResult {
"SARIF RelatedLocations require character granular source ranges!");
}
#endif
- RelatedLocations.append(DiagLocs.begin(), DiagLocs.end());
+ for (const CharSourceRange &Loc : DiagLocs)
+ RelatedLocations.emplace_back(Loc, Message.str());
return *this;
}
@@ -395,6 +399,11 @@ class SarifResult {
return *this;
}
+ SarifResult addProperty(llvm::StringRef Key, llvm::StringRef Value) {
+ Properties[Key] = Value.str();
+ return *this;
+ }
+
SarifResult addPartialFingerprint(llvm::StringRef key,
llvm::StringRef value) {
PartialFingerprints[key] = value;
@@ -453,8 +462,10 @@ class SarifDocumentWriter {
createThreadFlows(const llvm::ArrayRef<ThreadFlow> ThreadFlows);
/// Add the given \ref CharSourceRange to the SARIF document as a physical
- /// location, with its corresponding artifact.
- llvm::json::Object createPhysicalLocation(const CharSourceRange &R);
+ /// location, with its corresponding artifact. Returns std::nullopt if \p R
+ /// is invalid or does not map to a file.
+ std::optional<llvm::json::Object>
+ createPhysicalLocation(const CharSourceRange &R);
public:
SarifDocumentWriter() = delete;
@@ -469,7 +480,8 @@ class SarifDocumentWriter {
/// Each run requires specifying the tool that is generating reporting items.
void createRun(const llvm::StringRef ShortToolName,
const llvm::StringRef LongToolName,
- const llvm::StringRef ToolVersion = CLANG_VERSION_STRING);
+ const llvm::StringRef ToolVersion = CLANG_VERSION_STRING,
+ const llvm::StringRef InformationUri = "");
/// If there is a current run, end it.
///
diff --git a/clang/include/clang/Frontend/SARIFDiagnostic.h b/clang/include/clang/Frontend/SARIFDiagnostic.h
index 7a6f27eb3b9fab..cef565db1686a5 100644
--- a/clang/include/clang/Frontend/SARIFDiagnostic.h
+++ b/clang/include/clang/Frontend/SARIFDiagnostic.h
@@ -6,8 +6,9 @@
//
//===----------------------------------------------------------------------===//
//
-// This is a utility class that provides support for constructing a SARIF object
-// containing diagnostics.
+// This file implements SARIF diagnostic emission, including the SARIFDiagnostic
+// renderer and helper utilities for mapping diagnostic levels and annotating
+// SARIF rules.
//
//===----------------------------------------------------------------------===//
@@ -20,6 +21,14 @@
namespace clang {
+// Maps clang DiagnosticsEngine level to SARIF result levels.
+SarifResultLevel getSarifResultLevel(DiagnosticsEngine::Level level);
+
+// Creates configuration for a SARIF rule based on the diagnostic level and sets
+// the rank.
+SarifRule addDiagnosticLevelToRule(SarifRule Rule,
+ DiagnosticsEngine::Level Level);
+
class SARIFDiagnostic : public DiagnosticRenderer {
public:
SARIFDiagnostic(raw_ostream &OS, const LangOptions &LangOpts,
@@ -70,9 +79,6 @@ class SARIFDiagnostic : public DiagnosticRenderer {
getSarifLocation(FullSourceLoc Loc, PresumedLoc PLoc,
ArrayRef<CharSourceRange> Ranges);
- SarifRule addDiagnosticLevelToRule(SarifRule Rule,
- DiagnosticsEngine::Level Level);
-
llvm::StringRef emitFilename(StringRef Filename, const SourceManager &SM);
llvm::SmallVector<std::pair<FullSourceLoc, PresumedLoc>>
diff --git a/clang/lib/Basic/Sarif.cpp b/clang/lib/Basic/Sarif.cpp
index e829b9bb47ad94..c72e7478f01d3c 100644
--- a/clang/lib/Basic/Sarif.cpp
+++ b/clang/lib/Basic/Sarif.cpp
@@ -162,11 +162,16 @@ static json::Object createTextRegion(const SourceManager &SM,
return Region;
}
-static json::Object createLocation(json::Object &&PhysicalLocation,
- StringRef Message = "") {
- json::Object Ret{{"physicalLocation", std::move(PhysicalLocation)}};
+/// \internal
+/// SARIF allows a location with only a message and no physicalLocation.
+static json::Object
+createLocation(std::optional<json::Object> &&PhysicalLocation,
+ StringRef Message = "") {
+ json::Object Ret;
+ if (PhysicalLocation)
+ Ret["physicalLocation"] = std::move(*PhysicalLocation);
if (!Message.empty())
- Ret.insert({"message", createMessage(Message)});
+ Ret["message"] = createMessage(Message);
return Ret;
}
@@ -205,15 +210,16 @@ createThreadFlowLocation(json::Object &&Location,
}
/// @}
-json::Object
+std::optional<json::Object>
SarifDocumentWriter::createPhysicalLocation(const CharSourceRange &R) {
- assert(R.isValid() &&
- "Cannot create a physicalLocation from invalid SourceRange!");
+ if (R.isInvalid())
+ return std::nullopt;
assert(R.isCharRange() &&
"Cannot create a physicalLocation from a token range!");
FullSourceLoc Start{R.getBegin(), SourceMgr};
OptionalFileEntryRef FE = Start.getExpansionLoc().getFileEntryRef();
- assert(FE && "Diagnostic does not exist within a valid file!");
+ if (!FE)
+ return std::nullopt;
const std::string &FileURI = fileNameToURI(getFileName(*FE));
auto I = CurrentArtifacts.find(FileURI);
@@ -297,7 +303,11 @@ void SarifDocumentWriter::endRun() {
SmallVector<std::pair<StringRef, SarifArtifact>, 0> Vec;
for (const auto &[K, V] : CurrentArtifacts)
Vec.emplace_back(K, V);
- llvm::sort(Vec, llvm::less_first());
+ // artifactLocation.index refers to the position in this array.
+ llvm::sort(Vec, [](const std::pair<StringRef, SarifArtifact> &L,
+ const std::pair<StringRef, SarifArtifact> &R) {
+ return L.second.Location.Index < R.second.Location.Index;
+ });
for (const auto &[_, A] : Vec) {
json::Object Loc{{"uri", A.Location.URI}};
if (A.Location.Index.has_value()) {
@@ -328,8 +338,8 @@ SarifDocumentWriter::createThreadFlows(ArrayRef<ThreadFlow> ThreadFlows) {
json::Object Ret{{"locations", json::Array{}}};
json::Array Locs;
for (const auto &ThreadFlow : ThreadFlows) {
- json::Object PLoc = createPhysicalLocation(ThreadFlow.Range);
- json::Object Loc = createLocation(std::move(PLoc), ThreadFlow.Message);
+ json::Object Loc = createLocation(createPhysicalLocation(ThreadFlow.Range),
+ ThreadFlow.Message);
Locs.emplace_back(
createThreadFlowLocation(std::move(Loc), ThreadFlow.Importance));
}
@@ -344,21 +354,24 @@ SarifDocumentWriter::createCodeFlow(ArrayRef<ThreadFlow> ThreadFlows) {
void SarifDocumentWriter::createRun(StringRef ShortToolName,
StringRef LongToolName,
- StringRef ToolVersion) {
+ StringRef ToolVersion,
+ StringRef InformationUri) {
// Clear resources associated with a previous run.
endRun();
// Signify a new run has begun.
Closed = false;
+ StringRef EffectiveInformationUri =
+ InformationUri.empty() ? "https://clang.llvm.org/docs/UsersManual.html"
+ : InformationUri;
json::Object Tool{
- {"driver",
- json::Object{{"name", ShortToolName},
- {"fullName", LongToolName},
- {"language", "en-US"},
- {"version", ToolVersion},
- {"informationUri",
- "https://clang.llvm.org/docs/UsersManual.html"}}}};
+ {"driver", json::Object{{"name", ShortToolName},
+ {"fullName", LongToolName},
+ {"language", "en-US"},
+ {"version", ToolVersion},
+ {"informationUri", EffectiveInformationUri},
+ {"rules", json::Array{}}}}};
json::Object TheRun{{"tool", std::move(Tool)},
{"results", {}},
{"artifacts", {}},
@@ -399,21 +412,30 @@ void SarifDocumentWriter::appendResult(const SarifResult &Result) {
Ret["hostedViewerUri"] = Result.HostedViewerURI;
}
- if (!Result.Locations.empty()) {
- json::Array Locs;
- for (auto &Range : Result.Locations) {
- Locs.emplace_back(createLocation(createPhysicalLocation(Range)));
- }
+ if (!Result.Properties.empty()) {
+ json::Object Properties;
+ for (const auto &[Key, Value] : Result.Properties)
+ Properties[Key.str()] = Value;
+ Ret["properties"] = std::move(Properties);
+ }
+
+ json::Array Locs;
+ for (const auto &Range : Result.Locations)
+ if (std::optional<json::Object> PL = createPhysicalLocation(Range))
+ Locs.emplace_back(createLocation(std::move(PL)));
+ if (!Locs.empty())
Ret["locations"] = std::move(Locs);
+
+ // The schema requires relatedLocations items to be unique.
+ json::Array ReLocs;
+ for (const auto &[Range, Message] : Result.RelatedLocations) {
+ json::Value Loc = createLocation(createPhysicalLocation(Range), Message);
+ if (!Loc.getAsObject()->empty() && !llvm::is_contained(ReLocs, Loc))
+ ReLocs.emplace_back(std::move(Loc));
}
- if (!Result.RelatedLocations.empty()) {
- json::Array ReLocs;
- for (auto &Range : Result.RelatedLocations) {
- ReLocs.emplace_back(createLocation(createPhysicalLocation(Range)));
- }
+ if (!ReLocs.empty())
Ret["relatedLocations"] = std::move(ReLocs);
- }
if (!Result.PartialFingerprints.empty()) {
json::Object fingerprints = {};
diff --git a/clang/lib/Frontend/SARIFDiagnostic.cpp b/clang/lib/Frontend/SARIFDiagnostic.cpp
index 5183462b76f413..b2df1772e4ee5a 100644
--- a/clang/lib/Frontend/SARIFDiagnostic.cpp
+++ b/clang/lib/Frontend/SARIFDiagnostic.cpp
@@ -30,6 +30,38 @@
namespace clang {
+SarifResultLevel getSarifResultLevel(DiagnosticsEngine::Level level) {
+ switch (level) {
+ case DiagnosticsEngine::Ignored:
+ llvm_unreachable("Invalid diagnostic type");
+ case DiagnosticsEngine::Note:
+ return SarifResultLevel::Note;
+ case DiagnosticsEngine::Remark:
+ return SarifResultLevel::None;
+ case DiagnosticsEngine::Warning:
+ return SarifResultLevel::Warning;
+ case DiagnosticsEngine::Error:
+ case DiagnosticsEngine::Fatal:
+ return SarifResultLevel::Error;
+ }
+ llvm_unreachable("Potentially un-handled DiagnosticsEngine::Level. "
+ "Is the switch not fully covered?");
+}
+
+SarifRule addDiagnosticLevelToRule(SarifRule Rule,
+ DiagnosticsEngine::Level Level) {
+ SarifReportingConfiguration Config =
+ SarifReportingConfiguration::create().setLevel(
+ getSarifResultLevel(Level));
+
+ if (Level == DiagnosticsEngine::Error)
+ Config = Config.setRank(50);
+ else if (Level == DiagnosticsEngine::Fatal)
+ Config = Config.setRank(100);
+
+ return Rule.setDefaultConfiguration(Config);
+}
+
SARIFDiagnostic::SARIFDiagnostic(raw_ostream &OS, const LangOptions &LangOpts,
DiagnosticOptions &DiagOpts,
SarifDocumentWriter *Writer)
@@ -164,34 +196,6 @@ SARIFDiagnostic::getSarifLocation(FullSourceLoc Loc, PresumedLoc PLoc,
return Locations;
}
-SarifRule
-SARIFDiagnostic::addDiagnosticLevelToRule(SarifRule Rule,
- DiagnosticsEngine::Level Level) {
- auto Config = SarifReportingConfiguration::create();
-
- switch (Level) {
- case DiagnosticsEngine::Note:
- Config = Config.setLevel(SarifResultLevel::Note);
- break;
- case DiagnosticsEngine::Remark:
- Config = Config.setLevel(SarifResultLevel::None);
- break;
- case DiagnosticsEngine::Warning:
- Config = Config.setLevel(SarifResultLevel::Warning);
- break;
- case DiagnosticsEngine::Error:
- Config = Config.setLevel(SarifResultLevel::Error).setRank(50);
- break;
- case DiagnosticsEngine::Fatal:
- Config = Config.setLevel(SarifResultLevel::Error).setRank(100);
- break;
- case DiagnosticsEngine::Ignored:
- assert(false && "Invalid diagnostic type");
- }
-
- return Rule.setDefaultConfiguration(Config);
-}
-
llvm::StringRef SARIFDiagnostic::emitFilename(StringRef Filename,
const SourceManager &SM) {
if (DiagOpts.AbsolutePath) {
diff --git a/clang/unittests/Basic/SarifTest.cpp b/clang/unittests/Basic/SarifTest.cpp
index 42e85085d646eb..5e214d52de57a5 100644
--- a/clang/unittests/Basic/SarifTest.cpp
+++ b/clang/unittests/Basic/SarifTest.cpp
@@ -388,4 +388,21 @@ TEST_F(SarifDocumentWriterTest, checkSerializingCodeflows) {
ASSERT_THAT(Output, ::testing::StrEq(ExpectedOutput));
}
+TEST_F(SarifDocumentWriterTest, artifactIndexMatchesArrayPosition) {
+ SarifDocumentWriter Writer{SourceMgr};
+ Writer.createRun("sarif test", "sarif test runner");
+ unsigned RuleIdx = Writer.createRule(SarifRule::create());
+
+ // "/z.cpp" is seen first (index 0) but sorts after "/a.h" by name.
+ FileID ZFile = registerSource("/z.cpp", "int z;\n");
+ FileID AFile = registerSource("/a.h", "int a;\n");
+ Writer.appendResult(SarifResult::create(RuleIdx).addLocations(
+ {getFakeCharSourceRange(ZFile, {1, 1}, {1, 2}),
+ getFakeCharSourceRange(AFile, {1, 1}, {1, 2})}));
+
+ std::string Output = serializeSarifDocument(Writer.createDocument());
+ EXPECT_THAT(Output, ::testing::HasSubstr(
+ R"("location":{"index":0,"uri":"file:///z.cpp"})"));
+}
+
} // namespace
>From 0ee62893636900a5c505cc06a76dc2847de6d471 Mon Sep 17 00:00:00 2001
From: "Jones, Matthew (DI SW SIM FRWK PLAT SIMFW HPC)"
<jones.matthew at siemens.com>
Date: Mon, 26 Oct 2026 03:26:02 -0700
Subject: [PATCH 2/3] [clang-tidy] implemented base-uri support for clang-tidy
SARIF
---
clang-tools-extra/clang-tidy/ClangTidy.cpp | 10 +-
clang-tools-extra/clang-tidy/ClangTidy.h | 5 +-
.../clang-tidy/tool/ClangTidyMain.cpp | 58 ++-
clang-tools-extra/docs/ReleaseNotes.md | 6 +-
clang-tools-extra/docs/clang-tidy/index.rst | 5 +
.../infrastructure/export-SARIF-baseURI.cpp | 338 ++++++++++++++++++
clang/include/clang/Basic/Sarif.h | 43 +++
clang/lib/Basic/Sarif.cpp | 74 +++-
clang/unittests/Basic/SarifTest.cpp | 12 +
9 files changed, 540 insertions(+), 11 deletions(-)
create mode 100644 clang-tools-extra/test/clang-tidy/infrastructure/export-SARIF-baseURI.cpp
diff --git a/clang-tools-extra/clang-tidy/ClangTidy.cpp b/clang-tools-extra/clang-tidy/ClangTidy.cpp
index 272ff73320f5c7..34810becd84ac7 100644
--- a/clang-tools-extra/clang-tidy/ClangTidy.cpp
+++ b/clang-tools-extra/clang-tidy/ClangTidy.cpp
@@ -108,7 +108,8 @@ class ErrorReporter {
public:
ErrorReporter(ClangTidyContext &Context, FixBehaviour ApplyFixes,
llvm::IntrusiveRefCntPtr<llvm::vfs::FileSystem> BaseFS,
- StringRef SarifExportPath)
+ StringRef SarifExportPath,
+ const llvm::StringMap<SarifUriBase> &SarifBaseUri)
: Files(FileSystemOptions(), std::move(BaseFS)),
DiagPrinter(
SarifExportPath == "-"
@@ -119,6 +120,7 @@ class ErrorReporter {
SarifExportPath(SarifExportPath) {
if (!SarifExportPath.empty()) {
SarifWriter.emplace(SourceMgr);
+ SarifWriter->setOriginalUriBaseIds(SarifBaseUri);
SarifWriter->createRun("clang-tidy", "clang-tidy", CLANG_VERSION_STRING,
"https://clang.llvm.org/extra/clang-tidy/");
}
@@ -804,8 +806,10 @@ void handleErrors(llvm::ArrayRef<ClangTidyError> Errors,
ClangTidyContext &Context, FixBehaviour Fix,
unsigned &WarningsAsErrorsCount,
llvm::IntrusiveRefCntPtr<llvm::vfs::FileSystem> BaseFS,
- StringRef SarifExportPath) {
- ErrorReporter Reporter(Context, Fix, std::move(BaseFS), SarifExportPath);
+ StringRef SarifExportPath,
+ const llvm::StringMap<SarifUriBase> &SarifBaseUri) {
+ ErrorReporter Reporter(Context, Fix, std::move(BaseFS), SarifExportPath,
+ SarifBaseUri);
llvm::vfs::FileSystem &FileSystem =
Reporter.getSourceManager().getFileManager().getVirtualFileSystem();
auto InitialWorkingDir = FileSystem.getCurrentWorkingDirectory();
diff --git a/clang-tools-extra/clang-tidy/ClangTidy.h b/clang-tools-extra/clang-tidy/ClangTidy.h
index ee750b2339e626..75c8de6389f329 100644
--- a/clang-tools-extra/clang-tidy/ClangTidy.h
+++ b/clang-tools-extra/clang-tidy/ClangTidy.h
@@ -8,9 +8,9 @@
#ifndef LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_CLANGTIDY_H
#define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_CLANGTIDY_H
-
#include "ClangTidyDiagnosticConsumer.h"
#include "ClangTidyOptions.h"
+#include "clang/Basic/Sarif.h"
#include "llvm/ADT/StringSet.h"
#include <memory>
#include <vector>
@@ -119,7 +119,8 @@ void handleErrors(llvm::ArrayRef<ClangTidyError> Errors,
ClangTidyContext &Context, FixBehaviour Fix,
unsigned &WarningsAsErrorsCount,
llvm::IntrusiveRefCntPtr<llvm::vfs::FileSystem> BaseFS,
- StringRef SarifExportPath = {});
+ StringRef SarifExport = {},
+ const llvm::StringMap<SarifUriBase> &SarifBaseUri = {});
/// Serializes replacements into YAML and writes them to the specified
/// output stream.
diff --git a/clang-tools-extra/clang-tidy/tool/ClangTidyMain.cpp b/clang-tools-extra/clang-tidy/tool/ClangTidyMain.cpp
index fa56d969f8db70..34fb9af1282ca2 100644
--- a/clang-tools-extra/clang-tidy/tool/ClangTidyMain.cpp
+++ b/clang-tools-extra/clang-tidy/tool/ClangTidyMain.cpp
@@ -19,15 +19,19 @@
#include "../ClangTidyForceLinker.h" // IWYU pragma: keep
#include "../GlobList.h"
#include "clang/Tooling/CommonOptionsParser.h"
+#include "llvm/ADT/StringExtras.h"
#include "llvm/ADT/StringSet.h"
#include "llvm/Support/CommandLine.h"
#include "llvm/Support/FileSystem.h"
#include "llvm/Support/InitLLVM.h"
+#include "llvm/Support/JSON.h"
+#include "llvm/Support/Path.h"
#include "llvm/Support/PluginLoader.h" // IWYU pragma: keep
#include "llvm/Support/Process.h"
#include "llvm/Support/Signals.h"
#include "llvm/Support/TargetSelect.h"
#include "llvm/Support/WithColor.h"
+#include "llvm/Support/raw_ostream.h"
#include "llvm/TargetParser/Host.h"
#include <optional>
@@ -320,6 +324,15 @@ usual diagnostic output.
cl::value_desc("filename"),
cl::cat(ClangTidyCategory));
+static cl::list<std::string> SarifBaseUri("sarif-base-uri", desc(R"(
+Defines a SARIF base URI as <id>=<path|uri>.
+Paths are converted to file URIs. Values with
+'://' are used verbatim. Artifact locations
+under a base are written relative to it, all
+others keep their absolute URI. Can be repeated.)"),
+ cl::value_desc("name=path"),
+ cl::cat(ClangTidyCategory));
+
static cl::opt<bool> Quiet("quiet", desc(R"(
Run clang-tidy in quiet mode. This suppresses
printing statistics about ignored warnings and
@@ -613,6 +626,44 @@ static llvm::IntrusiveRefCntPtr<vfs::OverlayFileSystem> createBaseFS() {
return BaseFS;
}
+static std::optional<std::string> parseBaseUri(StringRef Value) {
+ if (Value.contains("://")) {
+ if (Value.find_first_of("?#") != StringRef::npos)
+ return std::nullopt;
+ return (Value + (Value.ends_with("/") ? "" : "/")).str();
+ }
+ // Artifact URIs use real paths, so resolve symlinks when the path exists.
+ SmallString<256> Path;
+ if (sys::fs::real_path(Value, Path, /*expand_tilde=*/true)) {
+ sys::fs::expand_tilde(Value, Path);
+ if (sys::fs::make_absolute(Path))
+ return std::nullopt;
+ sys::path::remove_dots(Path, true);
+ }
+ return SarifDocumentWriter::fileNameToURI(Path) + "/";
+}
+
+// Paths go through fileNameToURI so they prefix-match artifact URIs; URIs are
+// kept verbatim.
+static std::optional<llvm::StringMap<SarifUriBase>>
+parseBaseUris(const cl::list<std::string> &SarifBaseUri) {
+ llvm::StringMap<SarifUriBase> Result;
+ for (StringRef BaseUri : SarifBaseUri) {
+ auto [Name, Value] = BaseUri.split('=');
+ std::optional<std::string> URI;
+ if (!Name.empty() && !Value.empty() && !Result.contains(Name) &&
+ json::isUTF8(BaseUri))
+ URI = parseBaseUri(Value);
+ if (!URI) {
+ llvm::errs() << "Invalid or duplicate SARIF base URI: " << BaseUri
+ << "\n";
+ return std::nullopt;
+ }
+ Result[Name] = SarifUriBase().setURI(*URI);
+ }
+ return Result;
+}
+
int clangTidyMain(int argc, const char **argv) {
const llvm::InitLLVM X(argc, argv);
SmallVector<const char *> Args{argv, argv + argc};
@@ -760,6 +811,11 @@ int clangTidyMain(int argc, const char **argv) {
}
}
+ const std::optional<llvm::StringMap<SarifUriBase>> BaseUris =
+ parseBaseUris(SarifBaseUri);
+ if (!BaseUris)
+ return 1;
+
llvm::InitializeAllTargetInfos();
llvm::InitializeAllTargetMCs();
llvm::InitializeAllAsmParsers();
@@ -784,7 +840,7 @@ int clangTidyMain(int argc, const char **argv) {
unsigned WErrorCount = 0;
handleErrors(Errors, Context, DisableFixes ? FB_NoFix : Behaviour,
- WErrorCount, BaseFS, SarifExport);
+ WErrorCount, BaseFS, SarifExport, *BaseUris);
if (!ExportFixes.empty() && !Errors.empty()) {
std::error_code EC;
diff --git a/clang-tools-extra/docs/ReleaseNotes.md b/clang-tools-extra/docs/ReleaseNotes.md
index e9b5362bf1c2fc..feea6255f8f5ae 100644
--- a/clang-tools-extra/docs/ReleaseNotes.md
+++ b/clang-tools-extra/docs/ReleaseNotes.md
@@ -108,7 +108,11 @@ infrastructure are described first, followed by tool-specific sections.
- Added a new {program}`clang-tidy` command line option `-sarif-export=<file>`
in which clang-tidy diagnostics are exported in the [SARIF](https://sarifweb.azurewebsites.net/)
format.
-
+
+- Added a new {program}`clang-tidy` command line option
+ `-sarif-base-uri=<id>=<path|uri>` to define base URIs, so that SARIF
+ artifact locations are written relative to them.
+
#### New checks
- New {doc}`llvm-invalid-regex-pattern
diff --git a/clang-tools-extra/docs/clang-tidy/index.rst b/clang-tools-extra/docs/clang-tidy/index.rst
index b619cec35b42f2..c5703d4b5a32d4 100644
--- a/clang-tools-extra/docs/clang-tidy/index.rst
+++ b/clang-tools-extra/docs/clang-tidy/index.rst
@@ -195,6 +195,11 @@ An overview of all the command-line options:
--sarif-export=<filename> - File in which to store diagnostics in SARIF format.
Use '-' to write to stdout instead of the usual
diagnostic output.
+ --sarif-base-uri=<id>=<path|uri> - Defines a SARIF base URI as <id>=<path|uri>.
+ Paths are converted to file URIs. Values with
+ '://' are used verbatim. Artifact locations
+ under a base are written relative to it, all
+ others keep their absolute URI. Can be repeated.
--extra-arg=<string> - Additional argument to append to the compiler command line
--extra-arg-before=<string> - Additional argument to prepend to the compiler command line
--fix - Apply suggested fixes. Without -fix-errors
diff --git a/clang-tools-extra/test/clang-tidy/infrastructure/export-SARIF-baseURI.cpp b/clang-tools-extra/test/clang-tidy/infrastructure/export-SARIF-baseURI.cpp
new file mode 100644
index 00000000000000..366ad3a1fda567
--- /dev/null
+++ b/clang-tools-extra/test/clang-tidy/infrastructure/export-SARIF-baseURI.cpp
@@ -0,0 +1,338 @@
+// RUN: rm -rf %t && mkdir -p %t/project/src/testing
+// RUN: grep -Ev "// *[A-Z-]+:" %s > %t/project/src/testing/export-SARIF-baseURI-input.cpp
+// RUN: not clang-tidy %t/project/src/testing/export-SARIF-baseURI-input.cpp -checks="-*,google-explicit-constructor,clang-diagnostic-missing-prototypes,clang-diagnostic-zero-length-array" --warnings-as-errors="clang-diagnostic-missing-prototypes,google-explicit-constructor" -sarif-export=%t.sarif -sarif-base-uri=PROJROOT=%t/././project -sarif-base-uri=SRCROOT=%t/project/src/../src/../src -sarif-base-uri=TESTDIR=file://%if system-windows %{/%}%/t/project/src/testing -sarif-base-uri=%EXAMPLE%=%t/example/ -- -Wmissing-prototypes -Wzero-length-array > %t.msg 2>&1
+// RUN: FileCheck -input-file=%t.msg -check-prefix=CHECK-MESSAGES %s -implicit-check-not='{{warning|error|note}}:'
+// RUN: FileCheck -input-file=%t.sarif -check-prefix=CHECK-SARIF %s
+#define X(n) void n ## n() {}
+X(f)
+int a[-1];
+int b[0];
+
+void test(x);
+struct Foo {
+ member;
+ Foo(int) {}
+};
+
+//CHECK-MESSAGES: -input.cpp:2:1: error: no previous prototype for function 'ff' [clang-diagnostic-missing-prototypes,-warnings-as-errors]
+//CHECK-MESSAGES: -input.cpp:1:19: note: expanded from macro 'X'
+//CHECK-MESSAGES: {{^}}note: expanded from here{{$}}
+//CHECK-MESSAGES: -input.cpp:2:1: note: declare 'static' if the function is not intended to be used outside of this translation unit
+//CHECK-MESSAGES: -input.cpp:1:14: note: expanded from macro 'X'
+//CHECK-MESSAGES: -input.cpp:3:7: error: 'a' declared as an array with a negative size [clang-diagnostic-error]
+//CHECK-MESSAGES: -input.cpp:4:7: warning: zero size arrays are an extension [clang-diagnostic-zero-length-array]
+//CHECK-MESSAGES: -input.cpp:6:11: error: unknown type name 'x' [clang-diagnostic-error]
+//CHECK-MESSAGES: -input.cpp:8:3: error: a type specifier is required for all declarations [clang-diagnostic-error]
+//CHECK-MESSAGES: -input.cpp:9:3: error: single-argument constructors must be marked explicit to avoid unintentional implicit conversions [google-explicit-constructor,-warnings-as-errors]
+
+//CHECK-SARIF: {
+//CHECK-SARIF-NEXT: "$schema": "https://docs.oasis-open.org/sarif/sarif/v2.1.0/cos02/schemas/sarif-schema-2.1.0.json",
+//CHECK-SARIF-NEXT: "runs": [
+//CHECK-SARIF-NEXT: {
+//CHECK-SARIF-NEXT: "artifacts": [
+//CHECK-SARIF-NEXT: {
+//CHECK-SARIF-NEXT: "length": {{[0-9]+}},
+//CHECK-SARIF-NEXT: "location": {
+//CHECK-SARIF-NEXT: "index": 0,
+//CHECK-SARIF-NEXT: "uri": "export-SARIF-baseURI-input.cpp",
+//CHECK-SARIF-NEXT: "uriBaseId": "TESTDIR"
+//CHECK-SARIF-NEXT: },
+//CHECK-SARIF-NEXT: "mimeType": "text/plain",
+//CHECK-SARIF-NEXT: "roles": [
+//CHECK-SARIF-NEXT: "resultFile"
+//CHECK-SARIF-NEXT: ]
+//CHECK-SARIF-NEXT: }
+//CHECK-SARIF-NEXT: ],
+//CHECK-SARIF-NEXT: "columnKind": "unicodeCodePoints",
+//CHECK-SARIF-NEXT: "originalUriBaseIds": {
+//CHECK-SARIF-NEXT: "%EXAMPLE%": {
+//CHECK-SARIF-NEXT: "uri": "file:///{{.*}}/example/"
+//CHECK-SARIF-NEXT: },
+//CHECK-SARIF-NEXT: "PROJROOT": {
+//CHECK-SARIF-NEXT: "uri": "file:///{{.*}}/project/"
+//CHECK-SARIF-NEXT: },
+//CHECK-SARIF-NEXT: "SRCROOT": {
+//CHECK-SARIF-NEXT: "uri": "src/",
+//CHECK-SARIF-NEXT: "uriBaseId": "PROJROOT"
+//CHECK-SARIF-NEXT: },
+//CHECK-SARIF-NEXT: "TESTDIR": {
+//CHECK-SARIF-NEXT: "uri": "testing/",
+//CHECK-SARIF-NEXT: "uriBaseId": "SRCROOT"
+//CHECK-SARIF-NEXT: }
+//CHECK-SARIF-NEXT: },
+//CHECK-SARIF-NEXT: "results": [
+//CHECK-SARIF-NEXT: {
+//CHECK-SARIF-NEXT: "level": "error",
+//CHECK-SARIF-NEXT: "locations": [
+//CHECK-SARIF-NEXT: {
+//CHECK-SARIF-NEXT: "physicalLocation": {
+//CHECK-SARIF-NEXT: "artifactLocation": {
+//CHECK-SARIF-NEXT: "index": 0,
+//CHECK-SARIF-NEXT: "uri": "export-SARIF-baseURI-input.cpp",
+//CHECK-SARIF-NEXT: "uriBaseId": "TESTDIR"
+//CHECK-SARIF-NEXT: },
+//CHECK-SARIF-NEXT: "region": {
+//CHECK-SARIF-NEXT: "endColumn": 2,
+//CHECK-SARIF-NEXT: "endLine": 2,
+//CHECK-SARIF-NEXT: "startColumn": 1,
+//CHECK-SARIF-NEXT: "startLine": 2
+//CHECK-SARIF-NEXT: }
+//CHECK-SARIF-NEXT: }
+//CHECK-SARIF-NEXT: }
+//CHECK-SARIF-NEXT: ],
+//CHECK-SARIF-NEXT: "message": {
+//CHECK-SARIF-NEXT: "text": "no previous prototype for function 'ff'"
+//CHECK-SARIF-NEXT: },
+//CHECK-SARIF-NEXT: "relatedLocations": [
+//CHECK-SARIF-NEXT: {
+//CHECK-SARIF-NEXT: "message": {
+//CHECK-SARIF-NEXT: "text": "expanded from macro 'X'"
+//CHECK-SARIF-NEXT: },
+//CHECK-SARIF-NEXT: "physicalLocation": {
+//CHECK-SARIF-NEXT: "artifactLocation": {
+//CHECK-SARIF-NEXT: "index": 0,
+//CHECK-SARIF-NEXT: "uri": "export-SARIF-baseURI-input.cpp",
+//CHECK-SARIF-NEXT: "uriBaseId": "TESTDIR"
+//CHECK-SARIF-NEXT: },
+//CHECK-SARIF-NEXT: "region": {
+//CHECK-SARIF-NEXT: "endColumn": 20,
+//CHECK-SARIF-NEXT: "endLine": 1,
+//CHECK-SARIF-NEXT: "startColumn": 19,
+//CHECK-SARIF-NEXT: "startLine": 1
+//CHECK-SARIF-NEXT: }
+//CHECK-SARIF-NEXT: }
+//CHECK-SARIF-NEXT: },
+//CHECK-SARIF-NEXT: {
+//CHECK-SARIF-NEXT: "message": {
+//CHECK-SARIF-NEXT: "text": "expanded from here"
+//CHECK-SARIF-NEXT: }
+//CHECK-SARIF-NEXT: },
+//CHECK-SARIF-NEXT: {
+//CHECK-SARIF-NEXT: "message": {
+//CHECK-SARIF-NEXT: "text": "declare 'static' if the function is not intended to be used outside of this translation unit"
+//CHECK-SARIF-NEXT: },
+//CHECK-SARIF-NEXT: "physicalLocation": {
+//CHECK-SARIF-NEXT: "artifactLocation": {
+//CHECK-SARIF-NEXT: "index": 0,
+//CHECK-SARIF-NEXT: "uri": "export-SARIF-baseURI-input.cpp",
+//CHECK-SARIF-NEXT: "uriBaseId": "TESTDIR"
+//CHECK-SARIF-NEXT: },
+//CHECK-SARIF-NEXT: "region": {
+//CHECK-SARIF-NEXT: "endColumn": 2,
+//CHECK-SARIF-NEXT: "endLine": 2,
+//CHECK-SARIF-NEXT: "startColumn": 1,
+//CHECK-SARIF-NEXT: "startLine": 2
+//CHECK-SARIF-NEXT: }
+//CHECK-SARIF-NEXT: }
+//CHECK-SARIF-NEXT: },
+//CHECK-SARIF-NEXT: {
+//CHECK-SARIF-NEXT: "message": {
+//CHECK-SARIF-NEXT: "text": "expanded from macro 'X'"
+//CHECK-SARIF-NEXT: },
+//CHECK-SARIF-NEXT: "physicalLocation": {
+//CHECK-SARIF-NEXT: "artifactLocation": {
+//CHECK-SARIF-NEXT: "index": 0,
+//CHECK-SARIF-NEXT: "uri": "export-SARIF-baseURI-input.cpp",
+//CHECK-SARIF-NEXT: "uriBaseId": "TESTDIR"
+//CHECK-SARIF-NEXT: },
+//CHECK-SARIF-NEXT: "region": {
+//CHECK-SARIF-NEXT: "endColumn": 15,
+//CHECK-SARIF-NEXT: "endLine": 1,
+//CHECK-SARIF-NEXT: "startColumn": 14,
+//CHECK-SARIF-NEXT: "startLine": 1
+//CHECK-SARIF-NEXT: }
+//CHECK-SARIF-NEXT: }
+//CHECK-SARIF-NEXT: }
+//CHECK-SARIF-NEXT: ],
+//CHECK-SARIF-NEXT: "ruleId": "clang-diagnostic-missing-prototypes",
+//CHECK-SARIF-NEXT: "ruleIndex": 0
+//CHECK-SARIF-NEXT: },
+//CHECK-SARIF-NEXT: {
+//CHECK-SARIF-NEXT: "level": "error",
+//CHECK-SARIF-NEXT: "locations": [
+//CHECK-SARIF-NEXT: {
+//CHECK-SARIF-NEXT: "physicalLocation": {
+//CHECK-SARIF-NEXT: "artifactLocation": {
+//CHECK-SARIF-NEXT: "index": 0,
+//CHECK-SARIF-NEXT: "uri": "export-SARIF-baseURI-input.cpp",
+//CHECK-SARIF-NEXT: "uriBaseId": "TESTDIR"
+//CHECK-SARIF-NEXT: },
+//CHECK-SARIF-NEXT: "region": {
+//CHECK-SARIF-NEXT: "endColumn": 8,
+//CHECK-SARIF-NEXT: "endLine": 3,
+//CHECK-SARIF-NEXT: "startColumn": 7,
+//CHECK-SARIF-NEXT: "startLine": 3
+//CHECK-SARIF-NEXT: }
+//CHECK-SARIF-NEXT: }
+//CHECK-SARIF-NEXT: }
+//CHECK-SARIF-NEXT: ],
+//CHECK-SARIF-NEXT: "message": {
+//CHECK-SARIF-NEXT: "text": "'a' declared as an array with a negative size"
+//CHECK-SARIF-NEXT: },
+//CHECK-SARIF-NEXT: "ruleId": "clang-diagnostic-error",
+//CHECK-SARIF-NEXT: "ruleIndex": 1
+//CHECK-SARIF-NEXT: },
+//CHECK-SARIF-NEXT: {
+//CHECK-SARIF-NEXT: "level": "warning",
+//CHECK-SARIF-NEXT: "locations": [
+//CHECK-SARIF-NEXT: {
+//CHECK-SARIF-NEXT: "physicalLocation": {
+//CHECK-SARIF-NEXT: "artifactLocation": {
+//CHECK-SARIF-NEXT: "index": 0,
+//CHECK-SARIF-NEXT: "uri": "export-SARIF-baseURI-input.cpp",
+//CHECK-SARIF-NEXT: "uriBaseId": "TESTDIR"
+//CHECK-SARIF-NEXT: },
+//CHECK-SARIF-NEXT: "region": {
+//CHECK-SARIF-NEXT: "endColumn": 8,
+//CHECK-SARIF-NEXT: "endLine": 4,
+//CHECK-SARIF-NEXT: "startColumn": 7,
+//CHECK-SARIF-NEXT: "startLine": 4
+//CHECK-SARIF-NEXT: }
+//CHECK-SARIF-NEXT: }
+//CHECK-SARIF-NEXT: }
+//CHECK-SARIF-NEXT: ],
+//CHECK-SARIF-NEXT: "message": {
+//CHECK-SARIF-NEXT: "text": "zero size arrays are an extension"
+//CHECK-SARIF-NEXT: },
+//CHECK-SARIF-NEXT: "ruleId": "clang-diagnostic-zero-length-array",
+//CHECK-SARIF-NEXT: "ruleIndex": 2
+//CHECK-SARIF-NEXT: },
+//CHECK-SARIF-NEXT: {
+//CHECK-SARIF-NEXT: "level": "error",
+//CHECK-SARIF-NEXT: "locations": [
+//CHECK-SARIF-NEXT: {
+//CHECK-SARIF-NEXT: "physicalLocation": {
+//CHECK-SARIF-NEXT: "artifactLocation": {
+//CHECK-SARIF-NEXT: "index": 0,
+//CHECK-SARIF-NEXT: "uri": "export-SARIF-baseURI-input.cpp",
+//CHECK-SARIF-NEXT: "uriBaseId": "TESTDIR"
+//CHECK-SARIF-NEXT: },
+//CHECK-SARIF-NEXT: "region": {
+//CHECK-SARIF-NEXT: "endColumn": 12,
+//CHECK-SARIF-NEXT: "endLine": 6,
+//CHECK-SARIF-NEXT: "startColumn": 11,
+//CHECK-SARIF-NEXT: "startLine": 6
+//CHECK-SARIF-NEXT: }
+//CHECK-SARIF-NEXT: }
+//CHECK-SARIF-NEXT: }
+//CHECK-SARIF-NEXT: ],
+//CHECK-SARIF-NEXT: "message": {
+//CHECK-SARIF-NEXT: "text": "unknown type name 'x'"
+//CHECK-SARIF-NEXT: },
+//CHECK-SARIF-NEXT: "ruleId": "clang-diagnostic-error",
+//CHECK-SARIF-NEXT: "ruleIndex": 1
+//CHECK-SARIF-NEXT: },
+//CHECK-SARIF-NEXT: {
+//CHECK-SARIF-NEXT: "level": "error",
+//CHECK-SARIF-NEXT: "locations": [
+//CHECK-SARIF-NEXT: {
+//CHECK-SARIF-NEXT: "physicalLocation": {
+//CHECK-SARIF-NEXT: "artifactLocation": {
+//CHECK-SARIF-NEXT: "index": 0,
+//CHECK-SARIF-NEXT: "uri": "export-SARIF-baseURI-input.cpp",
+//CHECK-SARIF-NEXT: "uriBaseId": "TESTDIR"
+//CHECK-SARIF-NEXT: },
+//CHECK-SARIF-NEXT: "region": {
+//CHECK-SARIF-NEXT: "endColumn": 4,
+//CHECK-SARIF-NEXT: "endLine": 8,
+//CHECK-SARIF-NEXT: "startColumn": 3,
+//CHECK-SARIF-NEXT: "startLine": 8
+//CHECK-SARIF-NEXT: }
+//CHECK-SARIF-NEXT: }
+//CHECK-SARIF-NEXT: }
+//CHECK-SARIF-NEXT: ],
+//CHECK-SARIF-NEXT: "message": {
+//CHECK-SARIF-NEXT: "text": "a type specifier is required for all declarations"
+//CHECK-SARIF-NEXT: },
+//CHECK-SARIF-NEXT: "ruleId": "clang-diagnostic-error",
+//CHECK-SARIF-NEXT: "ruleIndex": 1
+//CHECK-SARIF-NEXT: },
+//CHECK-SARIF-NEXT: {
+//CHECK-SARIF-NEXT: "level": "error",
+//CHECK-SARIF-NEXT: "locations": [
+//CHECK-SARIF-NEXT: {
+//CHECK-SARIF-NEXT: "physicalLocation": {
+//CHECK-SARIF-NEXT: "artifactLocation": {
+//CHECK-SARIF-NEXT: "index": 0,
+//CHECK-SARIF-NEXT: "uri": "export-SARIF-baseURI-input.cpp",
+//CHECK-SARIF-NEXT: "uriBaseId": "TESTDIR"
+//CHECK-SARIF-NEXT: },
+//CHECK-SARIF-NEXT: "region": {
+//CHECK-SARIF-NEXT: "endColumn": 4,
+//CHECK-SARIF-NEXT: "endLine": 9,
+//CHECK-SARIF-NEXT: "startColumn": 3,
+//CHECK-SARIF-NEXT: "startLine": 9
+//CHECK-SARIF-NEXT: }
+//CHECK-SARIF-NEXT: }
+//CHECK-SARIF-NEXT: }
+//CHECK-SARIF-NEXT: ],
+//CHECK-SARIF-NEXT: "message": {
+//CHECK-SARIF-NEXT: "text": "single-argument constructors must be marked explicit to avoid unintentional implicit conversions"
+//CHECK-SARIF-NEXT: },
+//CHECK-SARIF-NEXT: "ruleId": "google-explicit-constructor",
+//CHECK-SARIF-NEXT: "ruleIndex": 3
+//CHECK-SARIF-NEXT: }
+//CHECK-SARIF-NEXT: ],
+//CHECK-SARIF-NEXT: "tool": {
+//CHECK-SARIF-NEXT: "driver": {
+//CHECK-SARIF-NEXT: "fullName": "clang-tidy",
+//CHECK-SARIF-NEXT: "informationUri": "https://clang.llvm.org/extra/clang-tidy/",
+//CHECK-SARIF-NEXT: "language": "en-US",
+//CHECK-SARIF-NEXT: "name": "clang-tidy",
+//CHECK-SARIF-NEXT: "rules": [
+//CHECK-SARIF-NEXT: {
+//CHECK-SARIF-NEXT: "defaultConfiguration": {
+//CHECK-SARIF-NEXT: "enabled": true,
+//CHECK-SARIF-NEXT: "level": "error",
+//CHECK-SARIF-NEXT: "rank": 50
+//CHECK-SARIF-NEXT: },
+//CHECK-SARIF-NEXT: "fullDescription": {
+//CHECK-SARIF-NEXT: "text": ""
+//CHECK-SARIF-NEXT: },
+//CHECK-SARIF-NEXT: "id": "clang-diagnostic-missing-prototypes",
+//CHECK-SARIF-NEXT: "name": "clang-diagnostic-missing-prototypes"
+//CHECK-SARIF-NEXT: },
+//CHECK-SARIF-NEXT: {
+//CHECK-SARIF-NEXT: "defaultConfiguration": {
+//CHECK-SARIF-NEXT: "enabled": true,
+//CHECK-SARIF-NEXT: "level": "error",
+//CHECK-SARIF-NEXT: "rank": 50
+//CHECK-SARIF-NEXT: },
+//CHECK-SARIF-NEXT: "fullDescription": {
+//CHECK-SARIF-NEXT: "text": ""
+//CHECK-SARIF-NEXT: },
+//CHECK-SARIF-NEXT: "id": "clang-diagnostic-error",
+//CHECK-SARIF-NEXT: "name": "clang-diagnostic-error"
+//CHECK-SARIF-NEXT: },
+//CHECK-SARIF-NEXT: {
+//CHECK-SARIF-NEXT: "defaultConfiguration": {
+//CHECK-SARIF-NEXT: "enabled": true,
+//CHECK-SARIF-NEXT: "level": "warning",
+//CHECK-SARIF-NEXT: "rank": -1
+//CHECK-SARIF-NEXT: },
+//CHECK-SARIF-NEXT: "fullDescription": {
+//CHECK-SARIF-NEXT: "text": ""
+//CHECK-SARIF-NEXT: },
+//CHECK-SARIF-NEXT: "id": "clang-diagnostic-zero-length-array",
+//CHECK-SARIF-NEXT: "name": "clang-diagnostic-zero-length-array"
+//CHECK-SARIF-NEXT: },
+//CHECK-SARIF-NEXT: {
+//CHECK-SARIF-NEXT: "defaultConfiguration": {
+//CHECK-SARIF-NEXT: "enabled": true,
+//CHECK-SARIF-NEXT: "level": "error",
+//CHECK-SARIF-NEXT: "rank": 50
+//CHECK-SARIF-NEXT: },
+//CHECK-SARIF-NEXT: "fullDescription": {
+//CHECK-SARIF-NEXT: "text": ""
+//CHECK-SARIF-NEXT: },
+//CHECK-SARIF-NEXT: "id": "google-explicit-constructor",
+//CHECK-SARIF-NEXT: "name": "google-explicit-constructor"
+//CHECK-SARIF-NEXT: }
+//CHECK-SARIF-NEXT: ],
+//CHECK-SARIF-NEXT: "version": "{{.*}}"
+//CHECK-SARIF-NEXT: }
+//CHECK-SARIF-NEXT: }
+//CHECK-SARIF-NEXT: }
+//CHECK-SARIF-NEXT: ],
+//CHECK-SARIF-NEXT: "version": "{{.*}}"
+//CHECK-SARIF-NEXT: }
diff --git a/clang/include/clang/Basic/Sarif.h b/clang/include/clang/Basic/Sarif.h
index 5edee63233e9c9..05321bec1de254 100644
--- a/clang/include/clang/Basic/Sarif.h
+++ b/clang/include/clang/Basic/Sarif.h
@@ -74,6 +74,7 @@ class SarifArtifactLocation {
std::optional<uint32_t> Index;
std::string URI;
+ std::optional<std::string> UriBaseId;
SarifArtifactLocation() = delete;
explicit SarifArtifactLocation(const std::string &URI) : URI(URI) {}
@@ -87,6 +88,11 @@ class SarifArtifactLocation {
Index = Idx;
return *this;
}
+
+ SarifArtifactLocation setUriBaseId(llvm::StringRef BaseId) {
+ UriBaseId = BaseId.str();
+ return *this;
+ }
};
/// \internal
@@ -411,6 +417,32 @@ class SarifResult {
}
};
+/// A SARIF uriBaseId object that defines a base URI for relative path
+/// resolution. It enables expressing file URIs relative to known locations
+/// (e.g., "PROJROOT", "SRCROOT") to reduce redundancy and improve portability
+/// of SARIF documents.
+///
+/// Reference: <a href="https://docs.oasis-open.org/sarif/sarif/v2.1.0/os/sarif-v2.1.0-os.html#_Toc34317431">SARIF<pre>uriBaseId</pre></a>
+class SarifUriBase {
+ friend class clang::SarifDocumentWriter;
+
+ // Absolute; parent chains are derived when emitted.
+ std::string URI;
+
+public:
+ SarifUriBase setURI(llvm::StringRef BaseURI) {
+ URI = BaseURI.str();
+ return *this;
+ }
+
+ /// Finds longest matching base URI and returns the relative portion.
+ /// Sets ParentId to matched base identifier.
+ static StringRef
+ remapUriToBaseUri(StringRef FileURI,
+ const llvm::StringMap<SarifUriBase> &OriginalUriBaseIds,
+ StringRef &ParentId);
+};
+
/// This class handles creating a valid SARIF document given various input
/// attributes. However, it requires an ordering among certain method calls:
///
@@ -467,6 +499,9 @@ class SarifDocumentWriter {
std::optional<llvm::json::Object>
createPhysicalLocation(const CharSourceRange &R);
+ llvm::json::Object createOriginalUriBaseIds(
+ const llvm::StringMap<SarifUriBase> &OriginalUriBaseIds) const;
+
public:
SarifDocumentWriter() = delete;
@@ -523,6 +558,10 @@ class SarifDocumentWriter {
static std::string fileNameToURI(llvm::StringRef Filename);
+ void setOriginalUriBaseIds(llvm::StringMap<SarifUriBase> BaseURIs) {
+ OriginalUriBaseIds = std::move(BaseURIs);
+ }
+
private:
/// Source Manager to use for the current SARIF document.
const SourceManager &SourceMgr;
@@ -555,6 +594,10 @@ class SarifDocumentWriter {
/// by a URI. A common example for clang's case would be files named by
/// filesystem paths.
llvm::StringMap<detail::SarifArtifact> CurrentArtifacts;
+
+ /// Map of uriBaseId -> SarifUriBase for relative path computation. This is
+ /// used to express artifact URIs relative to known project locations.
+ llvm::StringMap<SarifUriBase> OriginalUriBaseIds;
};
} // namespace clang
diff --git a/clang/lib/Basic/Sarif.cpp b/clang/lib/Basic/Sarif.cpp
index c72e7478f01d3c..b616d0cf6698f4 100644
--- a/clang/lib/Basic/Sarif.cpp
+++ b/clang/lib/Basic/Sarif.cpp
@@ -21,6 +21,7 @@
#include "llvm/ADT/StringExtras.h"
#include "llvm/ADT/StringRef.h"
#include "llvm/Support/ConvertUTF.h"
+#include "llvm/Support/ErrorHandling.h"
#include "llvm/Support/JSON.h"
#include "llvm/Support/Path.h"
@@ -210,6 +211,38 @@ createThreadFlowLocation(json::Object &&Location,
}
/// @}
+StringRef SarifUriBase::remapUriToBaseUri(
+ StringRef FileURI,
+ const llvm::StringMap<SarifUriBase> &OriginalUriBaseIds,
+ StringRef &ParentId) {
+ // Iterate through the map of original URI bases to find the longest matching
+ // prefix for the given FileURI. If a match is found, remap the FileURI to the
+ // corresponding base URI and set the ParentId.
+ size_t BestMatchLength = 0;
+ llvm::StringRef BestMatchKey;
+ std::for_each(OriginalUriBaseIds.begin(), OriginalUriBaseIds.end(),
+ [&](const auto &Entry) {
+ const std::string &BaseURI = Entry.second.URI;
+ // Prevents base URI matching with itself
+ if (BaseURI.size() < FileURI.size() &&
+ FileURI.starts_with(BaseURI)) {
+ const size_t MatchLength = BaseURI.size();
+ // Equal bases: the smallest id wins, independent of map order.
+ if (MatchLength > BestMatchLength ||
+ (MatchLength == BestMatchLength &&
+ Entry.getKey() < BestMatchKey)) {
+ BestMatchLength = MatchLength;
+ BestMatchKey = Entry.getKey();
+ }
+ }
+ });
+ if (BestMatchLength > 0) {
+ ParentId = BestMatchKey;
+ return FileURI.substr(BestMatchLength);
+ }
+ return FileURI;
+}
+
std::optional<json::Object>
SarifDocumentWriter::createPhysicalLocation(const CharSourceRange &R) {
if (R.isInvalid())
@@ -221,13 +254,17 @@ SarifDocumentWriter::createPhysicalLocation(const CharSourceRange &R) {
if (!FE)
return std::nullopt;
- const std::string &FileURI = fileNameToURI(getFileName(*FE));
+ std::string FileURI = fileNameToURI(getFileName(*FE));
auto I = CurrentArtifacts.find(FileURI);
-
if (I == CurrentArtifacts.end()) {
uint32_t Idx = static_cast<uint32_t>(CurrentArtifacts.size());
- const SarifArtifactLocation &Location =
- SarifArtifactLocation::create(FileURI).setIndex(Idx);
+ StringRef ParentId;
+ StringRef RelativeURI =
+ SarifUriBase::remapUriToBaseUri(FileURI, OriginalUriBaseIds, ParentId);
+ SarifArtifactLocation Location =
+ SarifArtifactLocation::create(RelativeURI).setIndex(Idx);
+ if (!ParentId.empty())
+ Location.setUriBaseId(ParentId);
const SarifArtifact &Artifact = SarifArtifact::create(Location)
.setRoles({"resultFile"})
.setLength(FE->getSize())
@@ -243,6 +280,8 @@ SarifDocumentWriter::createPhysicalLocation(const CharSourceRange &R) {
json::Object ArtifactLocationObject{{"uri", Location.URI}};
if (Location.Index.has_value())
ArtifactLocationObject["index"] = *Location.Index;
+ if (Location.UriBaseId)
+ ArtifactLocationObject["uriBaseId"] = *Location.UriBaseId;
return json::Object{{{"artifactLocation", std::move(ArtifactLocationObject)},
{"region", createTextRegion(SourceMgr, R)}}};
}
@@ -313,6 +352,8 @@ void SarifDocumentWriter::endRun() {
if (A.Location.Index.has_value()) {
Loc["index"] = static_cast<int64_t>(*A.Location.Index);
}
+ if (A.Location.UriBaseId)
+ Loc["uriBaseId"] = *A.Location.UriBaseId;
json::Object Artifact;
Artifact["location"] = std::move(Loc);
if (A.Length.has_value())
@@ -352,6 +393,27 @@ SarifDocumentWriter::createCodeFlow(ArrayRef<ThreadFlow> ThreadFlows) {
return json::Object{{"threadFlows", createThreadFlows(ThreadFlows)}};
}
+json::Object SarifDocumentWriter::createOriginalUriBaseIds(
+ const llvm::StringMap<SarifUriBase> &OriginalUriBaseIds) const {
+ json::Object BaseIds;
+ for (const llvm::StringMapEntry<clang::SarifUriBase> &Entry :
+ OriginalUriBaseIds) {
+ StringRef Id = Entry.getKey();
+ const SarifUriBase &Base = Entry.second;
+ json::Object Loc;
+ if (!Base.URI.empty()) {
+ StringRef ParentId;
+ Loc["uri"] = SarifUriBase::remapUriToBaseUri(Base.URI, OriginalUriBaseIds,
+ ParentId)
+ .str();
+ if (!ParentId.empty())
+ Loc["uriBaseId"] = ParentId.str();
+ }
+ BaseIds[Id.str()] = std::move(Loc);
+ }
+ return BaseIds;
+}
+
void SarifDocumentWriter::createRun(StringRef ShortToolName,
StringRef LongToolName,
StringRef ToolVersion,
@@ -376,6 +438,10 @@ void SarifDocumentWriter::createRun(StringRef ShortToolName,
{"results", {}},
{"artifacts", {}},
{"columnKind", "unicodeCodePoints"}};
+
+ if (!OriginalUriBaseIds.empty())
+ TheRun["originalUriBaseIds"] = createOriginalUriBaseIds(OriginalUriBaseIds);
+
Runs.emplace_back(std::move(TheRun));
}
diff --git a/clang/unittests/Basic/SarifTest.cpp b/clang/unittests/Basic/SarifTest.cpp
index 5e214d52de57a5..9ee828aa11e3b9 100644
--- a/clang/unittests/Basic/SarifTest.cpp
+++ b/clang/unittests/Basic/SarifTest.cpp
@@ -405,4 +405,16 @@ TEST_F(SarifDocumentWriterTest, artifactIndexMatchesArrayPosition) {
R"("location":{"index":0,"uri":"file:///z.cpp"})"));
}
+TEST(SarifUriBaseTest, remapsToLongestMatchingBase) {
+ llvm::StringMap<SarifUriBase> Bases;
+ Bases["ROOT"] = SarifUriBase().setURI("file:///root/");
+ Bases["SRC"] = SarifUriBase().setURI("file:///root/src/");
+
+ StringRef Id;
+ EXPECT_EQ(
+ SarifUriBase::remapUriToBaseUri("file:///root/src/a.cpp", Bases, Id),
+ "a.cpp");
+ EXPECT_EQ(Id, "SRC");
+}
+
} // namespace
>From 7c7b0049027d771982a51b6de08afd604d2bd64d Mon Sep 17 00:00:00 2001
From: Matthew <matthew.arda at gmail.com>
Date: Fri, 30 Oct 2026 09:31:00 +0000
Subject: [PATCH 3/3] Update clang/lib/Basic/Sarif.cpp
Co-authored-by: Kazu Hirata <kazu at google.com>
---
clang/lib/Basic/Sarif.cpp | 5 +----
1 file changed, 1 insertion(+), 4 deletions(-)
diff --git a/clang/lib/Basic/Sarif.cpp b/clang/lib/Basic/Sarif.cpp
index b616d0cf6698f4..41e44e4709e907 100644
--- a/clang/lib/Basic/Sarif.cpp
+++ b/clang/lib/Basic/Sarif.cpp
@@ -396,10 +396,7 @@ SarifDocumentWriter::createCodeFlow(ArrayRef<ThreadFlow> ThreadFlows) {
json::Object SarifDocumentWriter::createOriginalUriBaseIds(
const llvm::StringMap<SarifUriBase> &OriginalUriBaseIds) const {
json::Object BaseIds;
- for (const llvm::StringMapEntry<clang::SarifUriBase> &Entry :
- OriginalUriBaseIds) {
- StringRef Id = Entry.getKey();
- const SarifUriBase &Base = Entry.second;
+ for (const auto &[Id, Base] : OriginalUriBaseIds) {
json::Object Loc;
if (!Base.URI.empty()) {
StringRef ParentId;
More information about the cfe-commits
mailing list