[llvm] [LTO] Include debug options in legacy ThinLTO cache keys (PR #211474)
Xiaoyang Gong via llvm-commits
llvm-commits at lists.llvm.org
Fri Jul 24 00:27:06 PDT 2026
https://github.com/KotoriAster updated https://github.com/llvm/llvm-project/pull/211474
>From eaae6f5154853f034e17fbc9b2c668efaf34a098 Mon Sep 17 00:00:00 2001
From: xiaoyanggong <xiaoyanggong at bytedance.com>
Date: Wed, 22 Jul 2026 19:42:28 +0800
Subject: [PATCH 1/3] [LTO] Include debug options in legacy ThinLTO cache keys
Legacy ThinLTO omits -mllvm options from cache keys, which can cause it to
reuse objects built with different code-generation settings.
Include these options in cache keys, matching modern ThinLTO behavior.
---
.../include/llvm/LTO/legacy/ThinLTOCodeGenerator.h | 8 ++++++++
llvm/lib/LTO/ThinLTOCodeGenerator.cpp | 6 ++++--
llvm/test/tools/lto/print-stats.ll | 11 +++++++++++
llvm/tools/lto/lto.cpp | 14 ++++++++++++--
4 files changed, 35 insertions(+), 4 deletions(-)
diff --git a/llvm/include/llvm/LTO/legacy/ThinLTOCodeGenerator.h b/llvm/include/llvm/LTO/legacy/ThinLTOCodeGenerator.h
index d7e8356fa5f52..ba5bb70db2267 100644
--- a/llvm/include/llvm/LTO/legacy/ThinLTOCodeGenerator.h
+++ b/llvm/include/llvm/LTO/legacy/ThinLTOCodeGenerator.h
@@ -236,6 +236,11 @@ class ThinLTOCodeGenerator {
/// Enable or disable debug output for the new pass manager.
void setDebugPassManager(unsigned Enabled) { DebugPassManager = Enabled; }
+ /// Set the -mllvm arguments to include in the cache key.
+ void setMllvmArgs(ArrayRef<std::string> Args) {
+ MllvmArgs.assign(Args.begin(), Args.end());
+ }
+
/// Disable CodeGen, only run the stages till codegen and stop. The output
/// will be bitcode.
void disableCodeGen(bool Disable) { DisableCodeGen = Disable; }
@@ -356,6 +361,9 @@ class ThinLTOCodeGenerator {
/// Flag to indicate whether debug output should be enabled for the new pass
/// manager.
bool DebugPassManager = false;
+
+ /// -mllvm arguments included in the cache key.
+ std::vector<std::string> MllvmArgs;
};
}
#endif
diff --git a/llvm/lib/LTO/ThinLTOCodeGenerator.cpp b/llvm/lib/LTO/ThinLTOCodeGenerator.cpp
index 2ad2f97bdf48b..78b4208bb796a 100644
--- a/llvm/lib/LTO/ThinLTOCodeGenerator.cpp
+++ b/llvm/lib/LTO/ThinLTOCodeGenerator.cpp
@@ -379,7 +379,8 @@ class ModuleCacheEntry {
const FunctionImporter::ExportSetTy &ExportList,
const std::map<GlobalValue::GUID, GlobalValue::LinkageTypes> &ResolvedODR,
const GVSummaryMapTy &DefinedGVSummaries, unsigned OptLevel,
- bool Freestanding, const TargetMachineBuilder &TMBuilder) {
+ bool Freestanding, const TargetMachineBuilder &TMBuilder,
+ ArrayRef<std::string> MllvmArgs) {
if (CachePath.empty())
return;
@@ -400,6 +401,7 @@ class ModuleCacheEntry {
Conf.RelocModel = TMBuilder.RelocModel;
Conf.CGOptLevel = TMBuilder.CGOptLevel;
Conf.Freestanding = Freestanding;
+ append_range(Conf.MllvmArgs, MllvmArgs);
std::string Key =
computeLTOCacheKey(Conf, Index, ModuleID, ImportList, ExportList,
ResolvedODR, DefinedGVSummaries);
@@ -1152,7 +1154,7 @@ void ThinLTOCodeGenerator::run() {
ImportLists[ModuleIdentifier], ExportList,
ResolvedODR[ModuleIdentifier],
DefinedGVSummaries, OptLevel, Freestanding,
- TMBuilder);
+ TMBuilder, MllvmArgs);
auto CacheEntryPath = CacheEntry.getEntryPath();
{
diff --git a/llvm/test/tools/lto/print-stats.ll b/llvm/test/tools/lto/print-stats.ll
index b9d5809060b37..cc3007a9bca06 100644
--- a/llvm/test/tools/lto/print-stats.ll
+++ b/llvm/test/tools/lto/print-stats.ll
@@ -3,6 +3,17 @@
; RUN: %ld64 -lto_library %llvmshlibdir/libLTO.dylib -arch x86_64 -macosx_version_min 10.8.0 -dylib -o %t.dylib %t.o -lSystem 2>&1 | FileCheck --allow-empty --check-prefix=NO_STATS %s
; REQUIRES: asserts
+; Modern ThinLTO includes -mllvm arguments in its cache keys.
+; Verify that the legacy ThinLTO path does the same.
+; RUN: rm -rf %t.cache && mkdir %t.cache
+; RUN: opt -module-summary -module-hash %s -o %t.o
+; RUN: %ld64 -lto_library %llvmshlibdir/libLTO.dylib -arch x86_64 -macosx_version_min 10.8.0 -dylib -cache_path_lto %t.cache -o %t.dylib %t.o -lSystem 2>&1 -mllvm -stats
+; RUN: ls %t.cache/llvmcache-* | count 1
+; RUN: %ld64 -lto_library %llvmshlibdir/libLTO.dylib -arch x86_64 -macosx_version_min 10.8.0 -dylib -cache_path_lto %t.cache -o %t.dylib %t.o -lSystem 2>&1
+; RUN: ls %t.cache/llvmcache-* | count 2
+; RUN: %ld64 -lto_library %llvmshlibdir/libLTO.dylib -arch x86_64 -macosx_version_min 10.8.0 -dylib -cache_path_lto %t.cache -o %t.dylib %t.o -lSystem 2>&1 -mllvm -stats
+; RUN: ls %t.cache/llvmcache-* | count 2
+
target triple = "x86_64-apple-macosx10.8.0"
define i32 @test(i32 %a) {
diff --git a/llvm/tools/lto/lto.cpp b/llvm/tools/lto/lto.cpp
index 513d0578af24a..20bf0641bd615 100644
--- a/llvm/tools/lto/lto.cpp
+++ b/llvm/tools/lto/lto.cpp
@@ -95,6 +95,9 @@ static enum class OptParsingState {
static LLVMContext *LTOContext = nullptr;
+// Records -mllvm arguments parsed through the legacy debug-option APIs.
+static std::vector<std::string> ThinLTOMllvmArgs;
+
struct LTOToolDiagnosticHandler : public DiagnosticHandler {
bool handleDiagnostics(const DiagnosticInfo &DI) override {
if (DI.getSeverity() != DS_Error) {
@@ -511,6 +514,7 @@ void lto_set_debug_options(const char *const *options, int number) {
llvm::append_range(Options, ArrayRef(options, number));
llvm::parseCommandLineOptions(Options);
+ llvm::append_range(ThinLTOMllvmArgs, Options);
optionParsingState = OptParsingState::Early;
}
@@ -596,7 +600,10 @@ void thinlto_codegen_add_module(thinlto_code_gen_t cg, const char *Identifier,
unwrap(cg)->addModule(Identifier, StringRef(Data, Length));
}
-void thinlto_codegen_process(thinlto_code_gen_t cg) { unwrap(cg)->run(); }
+void thinlto_codegen_process(thinlto_code_gen_t cg) {
+ unwrap(cg)->setMllvmArgs(ThinLTOMllvmArgs);
+ unwrap(cg)->run();
+}
unsigned int thinlto_module_get_num_objects(thinlto_code_gen_t cg) {
return unwrap(cg)->getProducedBinaries().size();
@@ -630,11 +637,14 @@ void thinlto_codegen_set_codegen_only(thinlto_code_gen_t cg,
}
void thinlto_debug_options(const char *const *options, int number) {
- // if options were requested, set them
+ // If options were requested, parse and retain them.
if (number && options) {
std::vector<const char *> CodegenArgv(1, "libLTO");
append_range(CodegenArgv, ArrayRef<const char *>(options, number));
cl::ParseCommandLineOptions(CodegenArgv.size(), CodegenArgv.data());
+ // The parsed options modify process-global state, so retain every argument
+ // cumulatively in parsing order for subsequent ThinLTO cache keys.
+ ThinLTOMllvmArgs.insert(ThinLTOMllvmArgs.end(), options, options + number);
}
}
>From 344b47a58eee1fcab8cbe2a9b9aa413d6f53c05a Mon Sep 17 00:00:00 2001
From: xiaoyanggong <xiaoyanggong at bytedance.com>
Date: Fri, 24 Jul 2026 15:17:17 +0800
Subject: [PATCH 2/3] Create a new regression test
---
.../tools/lto/legacy-thinlto-cache-key.ll | 43 +++++++++++++++++++
llvm/test/tools/lto/print-stats.ll | 11 -----
2 files changed, 43 insertions(+), 11 deletions(-)
create mode 100644 llvm/test/tools/lto/legacy-thinlto-cache-key.ll
diff --git a/llvm/test/tools/lto/legacy-thinlto-cache-key.ll b/llvm/test/tools/lto/legacy-thinlto-cache-key.ll
new file mode 100644
index 0000000000000..fbc9ff42e662e
--- /dev/null
+++ b/llvm/test/tools/lto/legacy-thinlto-cache-key.ll
@@ -0,0 +1,43 @@
+; Verify that legacy ThinLTO includes -mllvm arguments in its cache keys.
+; Cache an unoutlined object, enable outlining, then reuse the first
+; configuration. The products and cache-entry count must match each option set.
+; RUN: opt -module-summary -module-hash %s -o %t.o
+; RUN: rm -rf %t.cache && mkdir %t.cache
+
+; Populate the cache with an unoutlined object.
+; RUN: %ld64 -lto_library %llvmshlibdir/libLTO.dylib -arch x86_64 -macosx_version_min 10.8.0 -dylib -cache_path_lto %t.cache -o %t.not-outlined.dylib %t.o -lSystem
+; RUN: llvm-nm --no-llvm-bc %t.not-outlined.dylib | FileCheck --check-prefix=NO-OUTLINED %s
+; RUN: ls %t.cache/llvmcache-* | count 1
+
+; Enabling the outliner must miss the existing entry and create a distinct one.
+; RUN: %ld64 -lto_library %llvmshlibdir/libLTO.dylib -arch x86_64 -macosx_version_min 10.8.0 -dylib -cache_path_lto %t.cache -o %t.outlined.dylib %t.o -lSystem -mllvm -enable-machine-outliner
+; RUN: llvm-nm --no-llvm-bc %t.outlined.dylib | FileCheck --check-prefix=OUTLINED %s
+; RUN: ls %t.cache/llvmcache-* | count 2
+
+; Omitting the option again must reuse the unoutlined cache entry.
+; RUN: %ld64 -lto_library %llvmshlibdir/libLTO.dylib -arch x86_64 -macosx_version_min 10.8.0 -dylib -cache_path_lto %t.cache -o %t.not-outlined.dylib %t.o -lSystem
+; RUN: llvm-nm --no-llvm-bc %t.not-outlined.dylib | FileCheck --check-prefix=NO-OUTLINED %s
+; RUN: ls %t.cache/llvmcache-* | count 2
+
+; OUTLINED: OUTLINED_FUNCTION_
+; NO-OUTLINED-NOT: OUTLINED_FUNCTION_
+
+target triple = "x86_64-apple-macosx10.8.0"
+
+define void @outline_me() #0 {
+ %slot = alloca i32, align 4
+
+ ; Two copies form a profitable outlining candidate.
+ store i32 1, ptr %slot, align 4
+ store i32 2, ptr %slot, align 4
+ store i32 3, ptr %slot, align 4
+ store i32 4, ptr %slot, align 4
+ store i32 1, ptr %slot, align 4
+ store i32 2, ptr %slot, align 4
+ store i32 3, ptr %slot, align 4
+ store i32 4, ptr %slot, align 4
+ ret void
+}
+
+; Preserve the stores and make outlining profitable.
+attributes #0 = { noinline optnone noredzone "frame-pointer"="all" }
diff --git a/llvm/test/tools/lto/print-stats.ll b/llvm/test/tools/lto/print-stats.ll
index cc3007a9bca06..b9d5809060b37 100644
--- a/llvm/test/tools/lto/print-stats.ll
+++ b/llvm/test/tools/lto/print-stats.ll
@@ -3,17 +3,6 @@
; RUN: %ld64 -lto_library %llvmshlibdir/libLTO.dylib -arch x86_64 -macosx_version_min 10.8.0 -dylib -o %t.dylib %t.o -lSystem 2>&1 | FileCheck --allow-empty --check-prefix=NO_STATS %s
; REQUIRES: asserts
-; Modern ThinLTO includes -mllvm arguments in its cache keys.
-; Verify that the legacy ThinLTO path does the same.
-; RUN: rm -rf %t.cache && mkdir %t.cache
-; RUN: opt -module-summary -module-hash %s -o %t.o
-; RUN: %ld64 -lto_library %llvmshlibdir/libLTO.dylib -arch x86_64 -macosx_version_min 10.8.0 -dylib -cache_path_lto %t.cache -o %t.dylib %t.o -lSystem 2>&1 -mllvm -stats
-; RUN: ls %t.cache/llvmcache-* | count 1
-; RUN: %ld64 -lto_library %llvmshlibdir/libLTO.dylib -arch x86_64 -macosx_version_min 10.8.0 -dylib -cache_path_lto %t.cache -o %t.dylib %t.o -lSystem 2>&1
-; RUN: ls %t.cache/llvmcache-* | count 2
-; RUN: %ld64 -lto_library %llvmshlibdir/libLTO.dylib -arch x86_64 -macosx_version_min 10.8.0 -dylib -cache_path_lto %t.cache -o %t.dylib %t.o -lSystem 2>&1 -mllvm -stats
-; RUN: ls %t.cache/llvmcache-* | count 2
-
target triple = "x86_64-apple-macosx10.8.0"
define i32 @test(i32 %a) {
>From d4755bc2cd4d5c6c54ed2a1d54752226d56854e1 Mon Sep 17 00:00:00 2001
From: xiaoyanggong <xiaoyanggong at bytedance.com>
Date: Fri, 24 Jul 2026 15:19:13 +0800
Subject: [PATCH 3/3] Lighten assignment of MllvmArgs
---
llvm/tools/lto/lto.cpp | 11 +++--------
1 file changed, 3 insertions(+), 8 deletions(-)
diff --git a/llvm/tools/lto/lto.cpp b/llvm/tools/lto/lto.cpp
index 20bf0641bd615..214cf85e432bc 100644
--- a/llvm/tools/lto/lto.cpp
+++ b/llvm/tools/lto/lto.cpp
@@ -514,7 +514,6 @@ void lto_set_debug_options(const char *const *options, int number) {
llvm::append_range(Options, ArrayRef(options, number));
llvm::parseCommandLineOptions(Options);
- llvm::append_range(ThinLTOMllvmArgs, Options);
optionParsingState = OptParsingState::Early;
}
@@ -558,6 +557,7 @@ lto_bool_t lto_module_has_ctor_dtor(lto_module_t mod) {
thinlto_code_gen_t thinlto_create_codegen(void) {
lto_initialize();
ThinLTOCodeGenerator *CodeGen = new ThinLTOCodeGenerator();
+ CodeGen->setMllvmArgs(ThinLTOMllvmArgs);
CodeGen->setTargetOptions(
codegen::InitTargetOptionsFromCodeGenFlags(Triple()));
CodeGen->setFreestanding(EnableFreestanding);
@@ -600,10 +600,7 @@ void thinlto_codegen_add_module(thinlto_code_gen_t cg, const char *Identifier,
unwrap(cg)->addModule(Identifier, StringRef(Data, Length));
}
-void thinlto_codegen_process(thinlto_code_gen_t cg) {
- unwrap(cg)->setMllvmArgs(ThinLTOMllvmArgs);
- unwrap(cg)->run();
-}
+void thinlto_codegen_process(thinlto_code_gen_t cg) { unwrap(cg)->run(); }
unsigned int thinlto_module_get_num_objects(thinlto_code_gen_t cg) {
return unwrap(cg)->getProducedBinaries().size();
@@ -642,9 +639,7 @@ void thinlto_debug_options(const char *const *options, int number) {
std::vector<const char *> CodegenArgv(1, "libLTO");
append_range(CodegenArgv, ArrayRef<const char *>(options, number));
cl::ParseCommandLineOptions(CodegenArgv.size(), CodegenArgv.data());
- // The parsed options modify process-global state, so retain every argument
- // cumulatively in parsing order for subsequent ThinLTO cache keys.
- ThinLTOMllvmArgs.insert(ThinLTOMllvmArgs.end(), options, options + number);
+ ThinLTOMllvmArgs.assign(options, options + number);
}
}
More information about the llvm-commits
mailing list