Skip to content

Commit 2f7b4d9

Browse files
committed
Don't internalize __llvm_profile_counter_bias
Currently, LLVM profiling runtime counter relocation cannot be used by rust during LTO because symbols are being internalized before all symbol information is known. This mode makes LLVM emit a __llvm_profile_counter_bias symbol which is referenced by the profiling initialization, which itself is pulled in by the rust driver here [1]. It is enabled with -Cllvm-args=-runtime-counter-relocation for platforms which are opt-in to this mode like Linux. On these platforms there will be no link error, rather just surprising behavior for a user which request runtime counter relocation. The profiling runtime will not see that symbol go on as if it were never there. On Fuchsia, the profiling runtime must have this symbol which will cause a hard link error. As an aside, I don't have enough context as to why rust's LTO model is how it is. AFAICT, the internalize pass is only safe to run at link time when all symbol information is actually known, this being an example as to why. I think special casing this symbol as a known one that LLVM can emit which should not have it's visbility de-escalated should be fine given how seldom this pattern of defining an undefined symbol to get initilization code pulled in is. From a quick grep, __llvm_profile_runtime is the only symbol that rustc does this for. [1] https://github.com/rust-lang/rust/blob/0265a3e93bf1b89d97cae113ed214954d5c35e22/compiler/rustc_codegen_ssa/src/back/linker.rs#L598
1 parent 0265a3e commit 2f7b4d9

File tree

2 files changed

+20
-4
lines changed

2 files changed

+20
-4
lines changed

compiler/rustc_codegen_ssa/src/back/symbol_export.rs

+11-4
Original file line numberDiff line numberDiff line change
@@ -212,10 +212,17 @@ fn exported_symbols_provider_local<'tcx>(
212212
// These are weak symbols that point to the profile version and the
213213
// profile name, which need to be treated as exported so LTO doesn't nix
214214
// them.
215-
const PROFILER_WEAK_SYMBOLS: [&str; 2] =
216-
["__llvm_profile_raw_version", "__llvm_profile_filename"];
217-
218-
symbols.extend(PROFILER_WEAK_SYMBOLS.iter().map(|sym| {
215+
// __llvm_profile_counter_bias is not weak, but is only referenced by the
216+
// profiling initialization runtime, which is itself pulled in by an
217+
// undefined reference to __llvm_profile_runtime. This happens at link time
218+
// and thus this symbol cannot be internalized until then.
219+
const PROFILER_DEFAULT_VIS_SYMBOLS: [&str; 3] = [
220+
"__llvm_profile_raw_version",
221+
"__llvm_profile_filename",
222+
"__llvm_profile_counter_bias",
223+
];
224+
225+
symbols.extend(PROFILER_DEFAULT_VIS_SYMBOLS.iter().map(|sym| {
219226
let exported_symbol = ExportedSymbol::NoDefId(SymbolName::new(tcx, sym));
220227
(
221228
exported_symbol,

src/test/codegen/pgo-counter-bias.rs

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
// Test that __llvm_profile_counter_bias does not get internalized by lto.
2+
3+
// compile-flags: -Cprofile-generate -Cllvm-args=-runtime-counter-relocation -Clto=fat
4+
// needs-profiler-support
5+
// no-prefer-dynamic
6+
7+
// CHECK: @__llvm_profile_counter_bias = {{.*}}global
8+
9+
pub fn main() {}

0 commit comments

Comments
 (0)