[BOLT] Extend Inliner to work on functions with Pointer Authentication (#162458)

The inliner uses DirectSP to check if a function has instructions that
modify the SP. Exceptions are stack Push and Pop instructions.

We can also allow pointer signing and authenticating instructions.

The inliner removes the Return instructions from the inlined functions.
If it is a fused pointer-authentication-and-return (e.g. RETAA), we have
to generate a new authentication instruction.
This commit is contained in:
Gergely Bálint 2025-11-24 18:00:58 +01:00 committed by GitHub
parent 78d8298576
commit bab1c2971a
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
6 changed files with 204 additions and 0 deletions

View File

@ -632,6 +632,12 @@ public:
return false;
}
/// Generate the matching pointer authentication instruction from a fused
/// pauth-and-return instruction.
virtual void createMatchingAuth(const MCInst &AuthAndRet, MCInst &Auth) {
llvm_unreachable("not implemented");
}
/// Returns the register used as a return address. Returns std::nullopt if
/// not applicable, such as reading the return address from a system register
/// or from the stack.

View File

@ -195,6 +195,13 @@ InliningInfo getInliningInfo(const BinaryFunction &BF) {
if (BC.MIB->isPush(Inst) || BC.MIB->isPop(Inst))
continue;
// Pointer signing and authenticatin instructions are used around
// Push and Pop. These are also straightforward to handle.
if (BC.isAArch64() &&
(BC.MIB->isPSignOnLR(Inst) || BC.MIB->isPAuthOnLR(Inst) ||
BC.MIB->isPAuthAndRet(Inst)))
continue;
DirectSP |= BC.MIB->hasDefOfPhysReg(Inst, SPReg) ||
BC.MIB->hasUseOfPhysReg(Inst, SPReg);
}
@ -338,6 +345,18 @@ Inliner::inlineCall(BinaryBasicBlock &CallerBB,
BC.Ctx.get());
}
// Handling fused authentication and return instructions (Armv8.3-A):
// if the Callee does not end in a tailcall, the return will be removed
// from the inlined block. If that return is RETA(A|B), we have to keep
// the authentication part.
// RETAA -> AUTIASP
// RETAB -> AUTIBSP
if (!CSIsTailCall && BC.isAArch64() && BC.MIB->isPAuthAndRet(Inst)) {
MCInst Auth;
BC.MIB->createMatchingAuth(Inst, Auth);
InsertII =
std::next(InlinedBB->insertInstruction(InsertII, std::move(Auth)));
}
if (CSIsTailCall || (!MIB.isCall(Inst) && !MIB.isReturn(Inst))) {
InsertII =
std::next(InlinedBB->insertInstruction(InsertII, std::move(Inst)));

View File

@ -313,6 +313,33 @@ public:
Inst.getOpcode() == AArch64::RETABSPPCr;
}
void createMatchingAuth(const MCInst &AuthAndRet, MCInst &Auth) override {
Auth.clear();
Auth.setOperands(AuthAndRet.getOperands());
switch (AuthAndRet.getOpcode()) {
case AArch64::RETAA:
Auth.setOpcode(AArch64::AUTIASP);
break;
case AArch64::RETAB:
Auth.setOpcode(AArch64::AUTIBSP);
break;
case AArch64::RETAASPPCi:
Auth.setOpcode(AArch64::AUTIASPPCi);
break;
case AArch64::RETABSPPCi:
Auth.setOpcode(AArch64::AUTIBSPPCi);
break;
case AArch64::RETAASPPCr:
Auth.setOpcode(AArch64::AUTIASPPCr);
break;
case AArch64::RETABSPPCr:
Auth.setOpcode(AArch64::AUTIBSPPCr);
break;
default:
llvm_unreachable("Unhandled fused pauth-and-return instruction");
}
}
std::optional<MCPhysReg> getSignedReg(const MCInst &Inst) const override {
switch (Inst.getOpcode()) {
case AArch64::PACIA:

View File

@ -0,0 +1,45 @@
# This test checks that inlining functions with fused pointer-auth-and-return
# instructions is properly handled by BOLT.
# REQUIRES: system-linux
# RUN: llvm-mc -filetype=obj -triple aarch64-unknown-unknown -mattr=+v8.3a %s -o %t.o
# RUN: %clang %cflags -O0 %t.o -o %t.exe -Wl,-q
# RUN: llvm-bolt --inline-all --print-inline --print-only=_Z3barP1A \
# RUN: %t.exe -o %t.bolt | FileCheck %s
# CHECK: BOLT-INFO: inlined 0 calls at 1 call sites in 2 iteration(s). Change in binary size: 8 bytes.
# CHECK: Binary Function "_Z3barP1A" after inlining {
# CHECK-NOT: bl _Z3fooP1A
# CHECK: ldr x8, [x0]
# CHECK-NEXT: ldr w0, [x8]
# CHECK-NEXT: autiasp
.text
.globl _Z3fooP1A
.type _Z3fooP1A,@function
_Z3fooP1A:
paciasp
ldr x8, [x0]
ldr w0, [x8]
retaa
.size _Z3fooP1A, .-_Z3fooP1A
.globl _Z3barP1A
.type _Z3barP1A,@function
_Z3barP1A:
stp x29, x30, [sp, #-16]!
mov x29, sp
bl _Z3fooP1A
mul w0, w0, w0
ldp x29, x30, [sp], #16
ret
.size _Z3barP1A, .-_Z3barP1A
.globl main
.p2align 2
.type main,@function
main:
mov w0, wzr
ret
.size main, .-main

View File

@ -0,0 +1,46 @@
# This test checks that inlining functions with fused pointer-auth-and-return
# instructions into a location with a tailcall is properly handled by BOLT.
# Because _Z3barP1A ends in a tailcall, we don't remove the return instruction
# from the inlined block. Therefore, we should see a retaa, and not an autiasp.
# REQUIRES: system-linux
# RUN: llvm-mc -filetype=obj -triple aarch64-unknown-unknown -mattr=+v8.3a %s -o %t.o
# RUN: %clang %cflags -O0 %t.o -o %t.exe -Wl,-q
# RUN: llvm-bolt --inline-all --print-inline --print-only=_Z3barP1A \
# RUN: %t.exe -o %t.bolt | FileCheck %s
# CHECK: BOLT-INFO: inlined 0 calls at 1 call sites in 2 iteration(s). Change in binary size: 12 bytes.
# CHECK: Binary Function "_Z3barP1A" after inlining {
# CHECK-NOT: bl _Z3fooP1A
# CHECK: mov x29, sp
# CHECK-NEXT: paciasp
# CHECK-NEXT: ldr x8, [x0]
# CHECK-NEXT: ldr w0, [x8]
# CHECK-NEXT: retaa
.text
.globl _Z3fooP1A
.type _Z3fooP1A,@function
_Z3fooP1A:
paciasp
ldr x8, [x0]
ldr w0, [x8]
retaa
.size _Z3fooP1A, .-_Z3fooP1A
.globl _Z3barP1A
.type _Z3barP1A,@function
_Z3barP1A:
stp x29, x30, [sp, #-16]!
mov x29, sp
b _Z3fooP1A // tailcall
.size _Z3barP1A, .-_Z3barP1A
.globl main
.p2align 2
.type main,@function
main:
mov w0, wzr
ret
.size main, .-main

View File

@ -0,0 +1,61 @@
# This test checks that inlining functions with the pauth-lr variants of
# fused pointer-auth-and-return instructions is properly handled by BOLT.
# REQUIRES: system-linux
# RUN: %clang %cflags -march=armv9.5-a+pauth-lr -O0 %s -o %t.exe -Wl,-q
# RUN: llvm-bolt --inline-all --print-inline --print-only=_Z3barP1A \
# RUN: %t.exe -o %t.bolt | FileCheck %s
# CHECK: BOLT-INFO: inlined 0 calls at 2 call sites in 2 iteration(s). Change in binary size: 16 bytes.
# CHECK: Binary Function "_Z3barP1A" after inlining {
# CHECK-NOT: bl _Z3fooP1A
# CHECK: paciasppc
# CHECK-NEXT: ldr x8, [x0]
# CHECK-NEXT: ldr w0, [x8]
# CHECK-NEXT: autiasppcr x28
# CHECK-NEXT: paciasppc
# CHECK-NEXT: ldr x7, [x0]
# CHECK-NEXT: ldr w0, [x7]
# CHECK-NEXT: autiasppc _Z3bazP1A
.text
.globl _Z3fooP1A
.type _Z3fooP1A,@function
_Z3fooP1A:
paciasppc
ldr x8, [x0]
ldr w0, [x8]
retaasppcr x28
.size _Z3fooP1A, .-_Z3fooP1A
.text
.globl _Z3bazP1A
.type _Z3bazP1A,@function
_Z3bazP1A:
0:
paciasppc
ldr x7, [x0]
ldr w0, [x7]
retaasppc 0b
.size _Z3bazP1A, .-_Z3bazP1A
.globl _Z3barP1A
.type _Z3barP1A,@function
_Z3barP1A:
stp x29, x30, [sp, #-16]!
mov x29, sp
bl _Z3fooP1A
bl _Z3bazP1A
mul w0, w0, w0
ldp x29, x30, [sp], #16
ret
.size _Z3barP1A, .-_Z3barP1A
.globl main
.p2align 2
.type main,@function
main:
mov w0, wzr
ret
.size main, .-main