PLEASE DO NOT COMMENT ON THIS PATCH

[cjdb]

Summary

This is one of two alternative designs that Clang can adopt when writing
SARIF to file. In this design, the Clang driver will bundle all of the
individual SARIF files into a directory called <target>_sarif, with
the files being enumerated in order of compilation.

Please discuss the design of this patch over at
https://discourse.llvm.org/t/adding-options-for-clang-to-write-diagnostics-to-file/67762/,
alongside <OTHER CL>, so that we can incorporate one of them into D145284.
I ask that commentary regarding the implementation be held off until
either this patch or <OTHER CL> is integrated into D145284.

Depends on D145284.

[cjdb]

D145438 was merged into D145284.

clang/test/Frontend/sarif-diagnostics.cpp

 
 struct t1 { };
 void f1(t1 x, t1 y) {
     x + y;
 }
 
 #include "sarif-diagnostics.hpp"
 
-// RUN: %clang -fsyntax-only -Wall -Wextra -fdiagnostics-format=sarif %s > %t.txt 2>&1 || true
+// RUN: %clang -fsyntax-only -Wall -Wextra -fdiagnostics-format=sarif-stderr %s > %t.txt 2>&1 || true
 // RUN: FileCheck -dump-input=always %s --input-file=%t.txt --check-prefixes=STDERR,SARIF
 
+// RUN: %clang -fsyntax-only -Wall -Wextra -fdiagnostics-format=sarif-file %s > %t.txt 2>&1 || true
+// RUN: FileCheck -dump-input=always --check-prefix=STDERR %s --input-file=%t.txt
+// RUN: FileCheck -dump-input=always --check-prefix=SARIF  %s --input-file=sarif-diagnostics.cpp.sarif
+
+// RUN: rm -rf %t
+// RUN: mkdir %t
+// RUN: %clang -Wall -Wextra -fdiagnostics-format=sarif-file %s -o %t/sarif-output > %t.txt 2>&1 || true
+// RUN: FileCheck -dump-input=always --check-prefix=STDERR %s --input-file=%t.txt
+// RUN: FileCheck -dump-input=always --check-prefix=SARIF  %s --input-file=%t/sarif-output_sarif/0.sarif
+
+// RUN: rm -rf %t
+// RUN: mkdir %t
+// RUN: %clang -Wall -Wextra -fdiagnostics-format=sarif-file %s %s -o %t/sarif-output > %t.txt 2>&1 || true
+// RUN: FileCheck -dump-input=always --check-prefix=STDERR %s --input-file=%t.txt
+// RUN: FileCheck -dump-input=always --check-prefix=SARIF  %s --input-file=%t/sarif-output_sarif/0.sarif
+// RUN: FileCheck -dump-input=always --check-prefix=SARIF  %s --input-file=%t/sarif-output_sarif/1.sarif
+
 // STDERR: warning: diagnostic formatting in SARIF mode is currently unstable [-Wsarif-format-unstable]
 // SARIF: {
 // SARIF:   "$schema":"https://docs.oasis-open.org/sarif/sarif/v2.1.0/cos02/schemas/sarif-schema-2.1.0.json",
 // SARIF:   "runs":[
 // SARIF:     {
 // SARIF:       "artifacts":[
 // SARIF:         {
 // SARIF:           "length":{{[0-9]+}},

clang/tools/driver/driver.cpp

if (Tool == "-cc1gen-reproducer")
     return cc1gen_reproducer_main(ArrayRef(ArgV).slice(2), ArgV[0],
                                   GetExecutablePathVP, ToolContext);
   // Reject unknown tools.
   llvm::errs() << "error: unknown integrated tool '" << Tool << "'. "
                << "Valid tools include '-cc1' and '-cc1as'.\n";
   return 1;
 }
 
+static std::error_code MoveSarifDiagnostics(ArrayRef<const char*> InputPaths, std::string OutputPath)
+{
+  if (InputPaths.size() == 0)
+    return std::error_code();
+
+  std::vector<std::string> SarifDiagnosticPaths;
+  llvm::copy_if(InputPaths, std::back_inserter(SarifDiagnosticPaths), [](StringRef File) {
+    return File.ends_with(".o");
+  });
+  llvm::transform(SarifDiagnosticPaths, SarifDiagnosticPaths.begin(), [](StringRef Temp) {
+    return (Temp + ".sarif").str();
+  });
+
+  namespace fs = llvm::sys::fs;
+  OutputPath += "_sarif/";
+  if (std::error_code EC = fs::remove_directories(OutputPath))
+    return EC;
+
+  if (std::error_code EC = fs::create_directories(OutputPath))
+    return EC;
+
+  std::size_t i = 0;
+  for (StringRef Path : SarifDiagnosticPaths)
+    if (std::error_code EC = fs::rename(Path, OutputPath + std::to_string(i++) + ".sarif"))
+      return EC;
+
+  return std::error_code();
+}
+
 int clang_main(int Argc, char **Argv, const llvm::ToolContext &ToolContext) {
   noteBottomOfStack();
   llvm::InitLLVM X(Argc, Argv);
   llvm::setBugReportMsg("PLEASE submit a bug report to " BUG_REPORT_URL
                         " and include the crash backtrace, preprocessed "
                         "source, and associated run script.\n");
   SmallVector<const char *, 256> Args(Argv, Argv + Argc);
 

 #ifdef _WIN32
   // Exit status should not be negative on Win32, unless abnormal termination.
   // Once abnormal termination was caught, negative status should not be
   // propagated.
   if (Res < 0)
     Res = 1;
 #endif
 
+  // Finally, we need to move any SARIF diagnostics into the build directory.
+  const DerivedArgList& ArgList = C->getArgs();
+  if (Arg* DF = ArgList.getLastArg(options::OPT_fdiagnostics_format_EQ); DF && DF->containsValue("sarif-file")) {
+    Arg* o = ArgList.getLastArg(options::OPT_o);
+    const char* Out = o ? o->getValue(0) : TheDriver.getDefaultImageName();
+    if (std::error_code EC = MoveSarifDiagnostics(C->getTempFiles(), Out)) {
+      llvm::errs() << EC.message() << '\n';
+      return EC.value();
+    }
+  }
+
   // If we have multiple failing commands, we return the result of the first
   // failing command.
   return Res;
 }