[Driver] Use the output filename as the base name in getStatsFileName when -save-stats=obj

[dtcxzyw]

Summary

When linking a multi-file program with -save-stats=obj, clang will save internal statistics during the link-time code generation to <obj_dir>/xxx.stats where xxx is the first filename of inputs. This behavior is strange. Additionally, naming conflicts will occur when multiple binaries placed in the same directory depend on the same input (e.g., https://github.com/martinus/map_benchmark).
This patch uses the output filename as the base name instead of the first input when -save-stats=obj.

[dtcxzyw]

Fix test errors.

[dtcxzyw]

Add tests

[MaskRay]

-save-stats=obj behavior seems strange. I think we should port https://maskray.me/blog/2023-04-25-compiler-output-files to -save-stats and deprecated -save-stats=obj.

[MaskRay]

In D146364#4496131, @MaskRay wrote:

-save-stats=obj behavior seems strange. I think we should port https://maskray.me/blog/2023-04-25-compiler-output-files to -save-stats and deprecated -save-stats=obj.

I've added "fix -save-stats=obj" to my todo list for the https://maskray.me/blog/2023-04-25-compiler-output-files work I have been doing.

clang/lib/Driver/ToolChains/CommonArgs.cpp

SmallString<128> tools::getStatsFileName(const llvm::opt::ArgList &Args,
   if (!A && !D.CCPrintInternalStats)
     return {};
 
   SmallString<128> StatsFile;
   if (A) {
     StringRef SaveStats = A->getValue();
     if (SaveStats == "obj" && Output.isFilename()) {
       StatsFile.assign(Output.getFilename());
-      llvm::sys::path::remove_filename(StatsFile);
-    } else if (SaveStats != "cwd") {
+    } else if (SaveStats == "cwd") {
+      StatsFile.assign(llvm::sys::path::filename(Input.getBaseInput()));
+    } else {
       D.Diag(diag::err_drv_invalid_value) << A->getAsString(Args) << SaveStats;
       return {};
     }
 
-    StringRef BaseName = llvm::sys::path::filename(Input.getBaseInput());
-    llvm::sys::path::append(StatsFile, BaseName);
     llvm::sys::path::replace_extension(StatsFile, "stats");
   } else {
     assert(D.CCPrintInternalStats);
     StatsFile.assign(D.CCPrintInternalStatReportFilename.empty()
                          ? "-"
                          : D.CCPrintInternalStatReportFilename);
   }
   return StatsFile;

clang/test/Driver/save-stats.c

 // RUN: %clang -target x86_64-apple-darwin -save-stats=bla -c %s -### 2>&1 | FileCheck %s -check-prefix=CHECK-INVALID
 // CHECK-INVALID: invalid value 'bla' in '-save-stats=bla'
 
 // RUN: %clang -target x86_64-linux-unknown -save-stats -flto -o obj/dir/save-stats.exe %s -### 2>&1 | FileCheck %s -check-prefix=CHECK-LTO
 // CHECK-LTO: "-stats-file=save-stats.stats"
 // CHECK-LTO: "-o" "obj/dir{{/|\\\\}}save-stats.exe"
 // CHECK-LTO: "-plugin-opt=stats-file=save-stats.stats"
 
-// RUN: %clang -target x86_64-linux-unknown -save-stats=obj -flto -o obj/dir/save-stats.exe %s -### 2>&1 | FileCheck %s -check-prefix=CHECK-LTO-OBJ
-// CHECK-LTO-OBJ: "-plugin-opt=stats-file=obj/dir{{/|\\\\}}save-stats.stats"
+// RUN: %clang -target x86_64-linux-unknown -save-stats=obj -flto -o obj/dir/save-stats-output.exe %s -### 2>&1 | FileCheck %s -check-prefix=CHECK-LTO-OBJ
+// CHECK-LTO-OBJ: "-plugin-opt=stats-file=obj/dir{{/|\\\\}}save-stats-output.stats"
 
 // RUN: env CC_PRINT_INTERNAL_STAT=1 \
 // RUN: %clang -target x86_64-apple-darwin %s -### 2>&1 | FileCheck %s -check-prefix=CHECK-ENV
 // CHECK-ENV: "-stats-file=-"
 // CHECK-ENV-NO: "stats-file-append"
 
 // RUN: env CC_PRINT_INTERNAL_STAT=1 \
 // RUN:     CC_PRINT_INTERNAL_STAT_FILE=/tmp/stats.json \
 // RUN: %clang -target x86_64-apple-darwin %s -### 2>&1 | FileCheck %s -check-prefix=CHECK-ENV-FILE
 // CHECK-ENV-FILE: "-stats-file=/tmp/stats.json"
 // CHECK-ENV-FILE: "-stats-file-append"