[libclang] Allow to put a reproducer into a custom location. (#10577)

Tools using the reproducers can specify a custom location to support
scenarios similar to those covered by `-fcrash-diagnostics-dir` and
`CLANG_CRASH_DIAGNOSTICS_DIR`.

Author: vsapsai

clang/include/clang-c/Dependencies.h

@@ -608,11 +608,16 @@ typedef struct CXOpaqueDependencyScannerReproducerOptions
  *                   the intermediate modules. Otherwise, reproduce building
  *                   the whole translation unit.
  * \param WorkingDirectory the directory in which the invocation runs.
+ * \param ReproducerLocation the directory where to store the reproducer files.
+ *                           If NULL, use a temporary location.
+ * \param UseUniqueReproducerName if reproducer files should have unique names
+ *                                to avoid collisions with existing files.
  */
 CINDEX_LINKAGE CXDependencyScannerReproducerOptions
 clang_experimental_DependencyScannerReproducerOptions_create(
     int argc, const char *const *argv, const char *ModuleName,
-    const char *WorkingDirectory);
+    const char *WorkingDirectory, const char *ReproducerLocation,
+    bool UseUniqueReproducerName);
 
 CINDEX_LINKAGE void
     clang_experimental_DependencyScannerReproducerOptions_dispose(

clang/test/Modules/reproducer-with-module-dependencies.c

@@ -13,6 +13,12 @@
 // RUN:   -- clang-executable -c %t/failed-reproducer.c -o %t/reproducer.o \
 // RUN:      -fmodules -fmodules-cache-path=%t 2>&1 | FileCheck %t/failed-reproducer.c
 
+// Test the content of a reproducer script.
+// RUN: c-index-test core -gen-deps-reproducer -working-dir %t -o %t/repro-content \
+// RUN:   -- clang-executable -c %t/reproducer.c -o %t/reproducer.o \
+// RUN:      -fmodules -fmodules-cache-path=%t
+// RUN: FileCheck %t/script-expectations.txt --input-file %t/repro-content/reproducer.sh
+
 //--- modular-header.h
 void fn_in_modular_header(void);
 
@@ -30,3 +36,7 @@ void test(void) {
 //--- failed-reproducer.c
 // CHECK: fatal error: 'non-existing-header.h' file not found
 #include "non-existing-header.h"
+
+//--- script-expectations.txt
+CHECK: clang-executable
+CHECK: -fmodule-file=Test=reproducer.cache/explicitly-built-modules/Test-{{.*}}.pcm

clang/tools/c-index-test/core_main.cpp

@@ -927,11 +927,14 @@ static int scanDeps(ArrayRef<const char *> Args, std::string WorkingDirectory,
 }
 
 static int generateDepsReproducer(ArrayRef<const char *> Args,
-                                  std::string WorkingDirectory) {
+                                  std::string WorkingDirectory,
+                                  std::string ReproLocation) {
   CXDependencyScannerReproducerOptions Opts =
       clang_experimental_DependencyScannerReproducerOptions_create(
           Args.size(), Args.data(), /*ModuleName=*/nullptr,
-          WorkingDirectory.c_str());
+          WorkingDirectory.c_str(),
+          ReproLocation.empty() ? nullptr : ReproLocation.c_str(),
+          /*UseUniqueReproducerName=*/ReproLocation.empty());
   auto DisposeOpts = llvm::make_scope_exit([&] {
     clang_experimental_DependencyScannerReproducerOptions_dispose(Opts);
   });
@@ -1580,7 +1583,8 @@ int indextest_core_main(int argc, const char **argv) {
       errs() << "error: missing -working-dir\n";
       return 1;
     }
-    return generateDepsReproducer(CompArgs, options::WorkingDir);
+    return generateDepsReproducer(CompArgs, options::WorkingDir,
+                                  options::OutputFile);
   }
 
   if (options::Action == ActionType::UploadCachedJob) {

clang/tools/libclang/CDependencies.cpp

@@ -646,16 +646,23 @@ struct DependencyScannerReproducerOptions {
   std::vector<std::string> BuildArgs;
   std::optional<std::string> ModuleName;
   std::optional<std::string> WorkingDirectory;
+  std::optional<std::string> ReproducerLocation;
+  bool UseUniqueReproducerName;
 
   DependencyScannerReproducerOptions(int argc, const char *const *argv,
                                      const char *ModuleName,
-                                     const char *WorkingDirectory) {
+                                     const char *WorkingDirectory,
+                                     const char *ReproducerLocation,
+                                     bool UseUniqueReproducerName)
+      : UseUniqueReproducerName(UseUniqueReproducerName) {
     if (argv)
       BuildArgs.assign(argv, argv + argc);
     if (ModuleName)
       this->ModuleName = ModuleName;
     if (WorkingDirectory)
       this->WorkingDirectory = WorkingDirectory;
+    if (ReproducerLocation)
+      this->ReproducerLocation = ReproducerLocation;
   }
 };
 
@@ -690,9 +697,11 @@ DEFINE_SIMPLE_CONVERSION_FUNCTIONS(DependencyScannerReproducerOptions,
 CXDependencyScannerReproducerOptions
 clang_experimental_DependencyScannerReproducerOptions_create(
     int argc, const char *const *argv, const char *ModuleName,
-    const char *WorkingDirectory) {
-  return wrap(new DependencyScannerReproducerOptions{argc, argv, ModuleName,
-                                                     WorkingDirectory});
+    const char *WorkingDirectory, const char *ReproducerLocation,
+    bool UseUniqueReproducerName) {
+  return wrap(new DependencyScannerReproducerOptions{
+      argc, argv, ModuleName, WorkingDirectory, ReproducerLocation,
+      UseUniqueReproducerName});
 }
 
 void clang_experimental_DependencyScannerReproducerOptions_dispose(
@@ -714,6 +723,9 @@ enum CXErrorCode clang_experimental_DependencyScanner_generateReproducer(
     return Report(CXError_InvalidArguments) << "missing compilation command";
   if (!Opts.WorkingDirectory)
     return Report(CXError_InvalidArguments) << "missing working directory";
+  if (!Opts.UseUniqueReproducerName && !Opts.ReproducerLocation)
+    return Report(CXError_InvalidArguments)
+           << "non-unique reproducer is allowed only in a custom location";
 
   CASOptions CASOpts;
   IntrusiveRefCntPtr<llvm::cas::CachingOnDiskFileSystem> FS;
@@ -724,9 +736,24 @@ enum CXErrorCode clang_experimental_DependencyScanner_generateReproducer(
 
   llvm::SmallString<128> ReproScriptPath;
   int ScriptFD;
-  if (auto EC = llvm::sys::fs::createTemporaryFile("reproducer", "sh", ScriptFD,
-                                                   ReproScriptPath)) {
-    return ReportFailure() << "failed to create a reproducer script file";
+  if (Opts.ReproducerLocation) {
+    if (auto EC = llvm::sys::fs::create_directories(*Opts.ReproducerLocation))
+      return ReportFailure() << "failed to create a reproducer location '"
+                             << *Opts.ReproducerLocation << "'\n"
+                             << EC.message();
+    SmallString<128> Path(*Opts.ReproducerLocation);
+    llvm::sys::path::append(Path, "reproducer");
+    const char *UniqueSuffix = Opts.UseUniqueReproducerName ? "-%%%%%%" : "";
+    if (auto EC = llvm::sys::fs::createUniqueFile(Path + UniqueSuffix + ".sh",
+                                                  ScriptFD, ReproScriptPath))
+      return ReportFailure() << "failed to create a reproducer script file\n"
+                             << EC.message();
+  } else {
+    if (auto EC = llvm::sys::fs::createTemporaryFile(
+            "reproducer", "sh", ScriptFD, ReproScriptPath)) {
+      return ReportFailure() << "failed to create a reproducer script file\n"
+                             << EC.message();
+    }
   }
   SmallString<128> FileCachePath = ReproScriptPath;
   llvm::sys::path::replace_extension(FileCachePath, ".cache");