Skip to content

[BOLT] Never call fixBranches() on non-simple functions #141112

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 22, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions bolt/lib/Core/BinaryContext.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -2425,6 +2425,10 @@ BinaryContext::createInstructionPatch(uint64_t Address,

std::pair<size_t, size_t>
BinaryContext::calculateEmittedSize(BinaryFunction &BF, bool FixBranches) {
// Use the original size for non-simple functions.
if (!BF.isSimple() || BF.isIgnored())
return std::make_pair(BF.getSize(), 0);

// Adjust branch instruction to match the current layout.
if (FixBranches)
BF.fixBranches();
Expand Down
2 changes: 2 additions & 0 deletions bolt/lib/Core/BinaryFunction.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -3579,6 +3579,8 @@ bool BinaryFunction::validateCFG() const {
}

void BinaryFunction::fixBranches() {
assert(isSimple() && "Expected function with valid CFG.");

auto &MIB = BC.MIB;
MCContext *Ctx = BC.Ctx.get();

Expand Down
42 changes: 42 additions & 0 deletions bolt/test/X86/fix-branches-broken-cfg.s
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
## Check that fixBranches() is not invoked on a broken CFG which could lead to
## unintended consequences including a firing assertion.

# RUN: llvm-mc --filetype=obj --triple x86_64-unknown-unknown %s -o %t.o
# RUN: link_fdata %s %t.o %t.fdata
# RUN: llvm-strip --strip-unneeded %t.o
# RUN: %clang %cflags %t.o -o %t.exe -Wl,-q
# RUN: llvm-bolt %t.exe -o %t.bolt --split-functions --split-strategy=cdsplit \
# RUN: --data=%t.fdata --reorder-blocks=ext-tsp 2>&1 | FileCheck %s

# CHECK: internal call detected

.text

.globl foo
.type foo, @function
foo:
ret
.size foo, .-foo

## main contains an internal call. ValidateInternalCalls pass will modify CFG
## (making it invalid) and mark the function as non-simple. After that, we
## cannot make any assumption about the CFG.

.globl main
.type main, @function
main:
call .L1
ret
.L1:
pushq %rbp
movq %rsp, %rbp
movl $1, %edi
LLmain_foo1:
call foo
# FDATA: 1 main #LLmain_foo1# 1 foo 0 0 600
movl $4, %edi
xorl %eax, %eax
popq %rbp
retq
.Lmain_end:
.size main, .Lmain_end-main
Loading