UI improvements to the current remote-opt-tool

bd1976bris · bd1976bris · commit 0bfafdd4630c · 2025-02-27T23:25:49.000Z
- Replace `thinlto-remote-opt-tool` with `thinlto-remote-compiler`
- Make `thinlto-remote-compiler` a cl::opt
diff --git a/cross-project-tests/dtlto/dtlto-translate-options.ll b/cross-project-tests/dtlto/dtlto-translate-options.ll
@@ -21,25 +21,25 @@
 ; DEFINE: %{triple} = dummy
 ; DEFINE: %{command} = llvm-lto2 run \
 ; DEFINE:   -thinlto-distributor-arg=%llvm_src_root/utils/dtlto/%{distributor} \
-; DEFINE:   -thinlto-remote-opt-tool-arg=-Wunused-command-line-argument \
+; DEFINE:   -thinlto-remote-compiler-arg=-Wunused-command-line-argument \
 ; DEFINE:   @%{triple}.rsp %{extra_flags}
 
 
 ;; Write common arguments to response files.
 
 ; RUN: echo "x86_64-unknown-linux-gnu.bc -o x86_64-unknown-linux-gnu.o \
 ; RUN:       -dtlto \
-; RUN:       -dtlto-remote-opt-tool=%clang \
-; RUN:       -thinlto-remote-opt-tool-arg=-Werror \
 ; RUN:       -dtlto-distributor=%python \
+; RUN:       -thinlto-remote-compiler=%clang \
+; RUN:       -thinlto-remote-compiler-arg=-Werror \
 ; RUN:       -r=x86_64-unknown-linux-gnu.bc,globalfunc1,plx" > x86_64-unknown-linux-gnu.rsp
 
 ; RUN: echo "x86_64-pc-windows-msvc.bc -o x86_64-pc-windows-msvc.o \
 ; RUN:       -dtlto \
-; RUN:       -dtlto-remote-opt-tool=%clang \
-; RUN:       -thinlto-remote-opt-tool-arg=-Werror \
-; RUN:       -thinlto-remote-opt-tool-arg=-Wno-override-module \
 ; RUN:       -dtlto-distributor=%python \
+; RUN:       -thinlto-remote-compiler=%clang \
+; RUN:       -thinlto-remote-compiler-arg=-Werror \
+; RUN:       -thinlto-remote-compiler-arg=-Wno-override-module \
 ; RUN:       -r=x86_64-pc-windows-msvc.bc,globalfunc2,plx" > x86_64-pc-windows-msvc.rsp
 
 
diff --git a/llvm/include/llvm/LTO/LTO.h b/llvm/include/llvm/LTO/LTO.h
@@ -312,17 +312,14 @@ ThinBackend createInProcessThinBackend(ThreadPoolStrategy Parallelism,
 /// LinkerOutputFile is a string that should identify this LTO invocation in
 /// the context of a wider build. It's used for naming to aid the user in
 /// identifying activity related to a specific LTO invocation.
-/// RemoteOptTool specifies the path to a Clang executable to be invoked for the
-/// backend jobs.
 /// Distributor specifies the path to a process to invoke to manage the backend
 /// jobs execution.
 /// SaveTemps is a debugging tool that prevents temporary files created by this
 /// backend from being cleaned up.
 ThinBackend createOutOfProcessThinBackend(
     ThreadPoolStrategy Parallelism, IndexWriteCallback OnWrite,
     bool ShouldEmitIndexFiles, bool ShouldEmitImportsFiles,
-    StringRef LinkerOutputFile, StringRef RemoteOptTool, StringRef Distributor,
-    bool SaveTemps);
+    StringRef LinkerOutputFile, StringRef Distributor, bool SaveTemps);
 
 /// This ThinBackend writes individual module indexes to files, instead of
 /// running the individual backend jobs. This backend is for distributed builds
diff --git a/llvm/lib/LTO/LTO.cpp b/llvm/lib/LTO/LTO.cpp
@@ -99,10 +99,15 @@ cl::list<std::string> AdditionalThinLTODistributorArgs(
     "thinlto-distributor-arg",
     cl::desc("Additional arguments to pass to the ThinLTO distributor"));
 
+cl::opt<std::string>
+    ThinLTORemoteCompiler("thinlto-remote-compiler",
+                          cl::desc("Additional arguments to pass to the "
+                                   "ThinLTO remote optimization tool"));
+
 cl::list<std::string>
-    ThinLTORemoteOptToolArgs("thinlto-remote-opt-tool-arg",
-                             cl::desc("Additional arguments to pass to the "
-                                      "ThinLTO remote optimization tool"));
+    ThinLTORemoteCompilerArgs("thinlto-remote-compiler-arg",
+                              cl::desc("Additional arguments to pass to the "
+                                       "ThinLTO remote compiler"));
 } // namespace llvm
 
 // Computes a unique hash for the Module considering the current list of
@@ -2207,7 +2212,6 @@ class OutOfProcessThinBackend : public CGThinBackend {
   StringSaver Saver{Alloc};
 
   SString LinkerOutputFile;
-  SString RemoteOptTool;
   SString DistributorPath;
   bool SaveTemps;
 
@@ -2240,13 +2244,12 @@ class OutOfProcessThinBackend : public CGThinBackend {
       AddStreamFn AddStream, AddBufferFn AddBuffer,
       lto::IndexWriteCallback OnWrite, bool ShouldEmitIndexFiles,
       bool ShouldEmitImportsFiles, StringRef LinkerOutputFile,
-      StringRef RemoteOptTool, StringRef Distributor, bool SaveTemps)
+      StringRef Distributor, bool SaveTemps)
       : CGThinBackend(Conf, CombinedIndex, ModuleToDefinedGVSummaries, OnWrite,
                       ShouldEmitIndexFiles, ShouldEmitImportsFiles,
                       ThinLTOParallelism),
         AddBuffer(std::move(AddBuffer)), LinkerOutputFile(LinkerOutputFile),
-        RemoteOptTool(RemoteOptTool), DistributorPath(Distributor),
-        SaveTemps(SaveTemps) {}
+        DistributorPath(Distributor), SaveTemps(SaveTemps) {}
 
   virtual void setup(unsigned MaxTasks, unsigned ReservedTasks) override {
     UID = itostr(sys::Process::getProcessId());
@@ -2311,7 +2314,7 @@ class OutOfProcessThinBackend : public CGThinBackend {
   // approaches should be considered, such as:
   //   - A serialization/deserialization format for LTO configuration.
   //   - Modifying LLD to be the tool that performs the backend compilations.
-  void buildCommonRemoteOptToolOptions() {
+  void buildCommonRemoteCompilerOptions() {
     const lto::Config &C = Conf;
     auto &Ops = CodegenOptions;
     llvm::Triple TT{Jobs.front().Triple};
@@ -2349,8 +2352,8 @@ class OutOfProcessThinBackend : public CGThinBackend {
     Ops.push_back("-Wno-unused-command-line-argument");
 
     // Forward any supplied options.
-    if (!ThinLTORemoteOptToolArgs.empty())
-      for (auto &a : ThinLTORemoteOptToolArgs)
+    if (!ThinLTORemoteCompilerArgs.empty())
+      for (auto &a : ThinLTORemoteCompilerArgs)
         Ops.push_back(a);
   }
 
@@ -2372,7 +2375,7 @@ class OutOfProcessThinBackend : public CGThinBackend {
 
         // Common command line template.
         JOS.attributeArray("args", [&]() {
-          JOS.value(RemoteOptTool);
+          JOS.value(ThinLTORemoteCompiler);
 
           // Reference to Job::NativeObjectPath.
           JOS.value("-o");
@@ -2454,7 +2457,7 @@ class OutOfProcessThinBackend : public CGThinBackend {
       return make_error<StringError>(BCError + "all triples must be consistent",
                                      inconvertibleErrorCode());
 
-    buildCommonRemoteOptToolOptions();
+    buildCommonRemoteCompilerOptions();
 
     SString JsonFile = sys::path::parent_path(LinkerOutputFile);
     sys::path::append(JsonFile, sys::path::stem(LinkerOutputFile) + "." + UID +
@@ -2502,17 +2505,15 @@ class OutOfProcessThinBackend : public CGThinBackend {
 ThinBackend lto::createOutOfProcessThinBackend(
     ThreadPoolStrategy Parallelism, lto::IndexWriteCallback OnWrite,
     bool ShouldEmitIndexFiles, bool ShouldEmitImportsFiles,
-    StringRef LinkerOutputFile, StringRef RemoteOptTool, StringRef Distributor,
-    bool SaveTemps) {
+    StringRef LinkerOutputFile, StringRef Distributor, bool SaveTemps) {
   auto Func =
       [=](const Config &Conf, ModuleSummaryIndex &CombinedIndex,
           const DenseMap<StringRef, GVSummaryMapTy> &ModuleToDefinedGVSummaries,
           AddStreamFn AddStream, AddBufferFn AddBuffer, FileCache /*Cache*/) {
         return std::make_unique<OutOfProcessThinBackend>(
             Conf, CombinedIndex, Parallelism, ModuleToDefinedGVSummaries,
             AddStream, AddBuffer, OnWrite, ShouldEmitIndexFiles,
-            ShouldEmitImportsFiles, LinkerOutputFile, RemoteOptTool,
-            Distributor, SaveTemps);
+            ShouldEmitImportsFiles, LinkerOutputFile, Distributor, SaveTemps);
       };
   return ThinBackend(Func, Parallelism);
 }
diff --git a/llvm/test/ThinLTO/X86/dtlto/dtlto.test b/llvm/test/ThinLTO/X86/dtlto/dtlto.test
@@ -16,7 +16,6 @@ RUN: mkdir %t/out && cd %t/out
 # Define a substitution to share the common DTLTO arguments.
 DEFINE: %{command} = llvm-lto2 run ../t1.bc ../t2.bc -o t.o \
 DEFINE:   -dtlto \
-DEFINE:   -dtlto-remote-opt-tool=dummy \
 DEFINE:   -dtlto-distributor=%python \
 DEFINE:   -thinlto-distributor-arg=%llvm_src_root/utils/dtlto/mock.py \
 DEFINE:   -thinlto-distributor-arg=../t1.o \
diff --git a/llvm/test/ThinLTO/X86/dtlto/imports.test b/llvm/test/ThinLTO/X86/dtlto/imports.test
@@ -10,7 +10,6 @@ RUN: opt -thinlto-bc 1.ll -o 1.bc -O2
 # of validate.py will cause a failure as it does not create output files.
 DEFINE: %{command} = llvm-lto2 run 0.bc 1.bc -o t.o \
 DEFINE:    -dtlto \
-DEFINE:    -dtlto-remote-opt-tool=dummy \
 DEFINE:    -dtlto-distributor=%python \
 DEFINE:    -thinlto-distributor-arg=%llvm_src_root/utils/dtlto/validate.py \
 DEFINE:    -thinlto-distributor-arg=0.bc \
diff --git a/llvm/test/ThinLTO/X86/dtlto/json.test b/llvm/test/ThinLTO/X86/dtlto/json.test
@@ -11,11 +11,11 @@ RUN: opt -thinlto-bc t2.ll -o t2.bc
 RUN: not llvm-lto2 run t1.bc t2.bc -o my.output \
 RUN:     -r=t1.bc,t1,px -r=t2.bc,t2,px \
 RUN:     -dtlto \
-RUN:     -dtlto-remote-opt-tool=my_clang.exe \
 RUN:     -dtlto-distributor=%python \
 RUN:     -thinlto-distributor-arg=%llvm_src_root/utils/dtlto/validate.py \
-RUN:     -thinlto-remote-opt-tool-arg=--rota1=10 \
-RUN:     -thinlto-remote-opt-tool-arg=--rota2=20 \
+RUN:     -thinlto-remote-compiler=my_clang.exe \
+RUN:     -thinlto-remote-compiler-arg=--rota1=10 \
+RUN:     -thinlto-remote-compiler-arg=--rota2=20 \
 RUN:     -thinlto-distributor-arg=--da1=10 \
 RUN:     -thinlto-distributor-arg=--da2=10 \
 RUN:   2>&1 | FileCheck %s
diff --git a/llvm/test/ThinLTO/X86/dtlto/summary.test b/llvm/test/ThinLTO/X86/dtlto/summary.test
@@ -20,7 +20,6 @@ DEFINE:     -thinlto-emit-indexes
 
 # Perform DTLTO.
 RUN: %{command} -dtlto \
-RUN:     -dtlto-remote-opt-tool=dummy \
 RUN:     -dtlto-distributor=%python \
 RUN:     -thinlto-distributor-arg=%llvm_src_root/utils/dtlto/mock.py \
 RUN:     -thinlto-distributor-arg=t1.o \
diff --git a/llvm/test/ThinLTO/X86/dtlto/triple.test b/llvm/test/ThinLTO/X86/dtlto/triple.test
@@ -14,7 +14,6 @@ RUN: opt t2.ll -o t2.o
 # object files supplied using -thinlto-distributor-arg in job order.
 RUN: not llvm-lto2 run t1.bc t2.bc -o t.o -save-temps \
 RUN:   -dtlto \
-RUN:   -dtlto-remote-opt-tool=dummy \
 RUN:   -dtlto-distributor=%python \
 RUN:   -thinlto-distributor-arg=%llvm_src_root/utils/dtlto/mock.py \
 RUN:   -thinlto-distributor-arg=t1.o \
diff --git a/llvm/tools/llvm-lto2/llvm-lto2.cpp b/llvm/tools/llvm-lto2/llvm-lto2.cpp
@@ -99,10 +99,6 @@ static cl::opt<bool>
 
 static cl::opt<bool> DTLTO("dtlto", cl::desc("Perform DTLTO"));
 
-static cl::opt<std::string>
-    DTLTORemoteOptTool("dtlto-remote-opt-tool",
-                       cl::desc("Specify the remote opt tool for DTLTO"));
-
 static cl::opt<std::string>
     DTLTODistributor("dtlto-distributor",
                      cl::desc("Specify the distributor for DTLTO"));
@@ -372,7 +368,7 @@ static int run(int argc, char **argv) {
     Backend = createOutOfProcessThinBackend(
         llvm::heavyweight_hardware_concurrency(Threads),
         /*OnWrite=*/{}, ThinLTOEmitIndexes, ThinLTOEmitImports, OutputFilename,
-        DTLTORemoteOptTool, DTLTODistributor, SaveTemps);
+        DTLTODistributor, SaveTemps);
   } else
     Backend = createInProcessThinBackend(
         llvm::heavyweight_hardware_concurrency(Threads),
