LLVM 19.0.0git
Enumerations | Functions
llvm::AArch64PAuth Namespace Reference


enum class  AuthCheckMethod { None , DummyLoad , HighBitsNoTBI , XPACHint }
 Variants of check performed on an authenticated pointer. More...


MachineBasicBlockcheckAuthenticatedRegister (MachineBasicBlock::iterator MBBI, AuthCheckMethod Method, Register AuthenticatedReg, Register TmpReg, bool UseIKey, unsigned BrkImm)
 Explicitly checks that pointer authentication succeeded.
unsigned getCheckerSizeInBytes (AuthCheckMethod Method)
 Returns the number of bytes added by checkAuthenticatedRegister.

Enumeration Type Documentation

◆ AuthCheckMethod

Variants of check performed on an authenticated pointer.

In cases such as authenticating the LR value when performing a tail call or when re-signing a signed pointer with a different signing schema, a failed authentication may not generate an exception on its own and may create an authentication or signing oracle if not checked explicitly.

A number of check methods modify control flow in a similar way by rewriting the code

<authenticate LR>
Select target instructions out of generic instructions

as follows:

<authenticate LR>
<method-specific checker>
<more instructions>
brk <code>

Do not check the value at all.


Perform a load to a temporary register.


Check by comparing bits 62 and 61 of the authenticated address.

This method modifies control flow and inserts the following checker:

eor Xtmp, Xn, Xn, lsl #1
tbnz Xtmp, #62, break_block

Check by comparing the authenticated value with an XPAC-ed one without using PAuth instructions not encoded as HINT.

Can only be applied to LR.

This method modifies control flow and inserts the following checker:

mov Xtmp, LR
xpaclri ; encoded as "hint #7"
; Note: at this point, the LR register contains the address as if
; the authentication succeeded and the temporary register contains the
; *real* result of authentication.
cmp Xtmp, LR
b.ne break_block
static bool contains(SmallPtrSetImpl< ConstantExpr * > &Cache, ConstantExpr *Expr, Constant *C)
Definition: Value.cpp:469

Definition at line 45 of file AArch64PointerAuth.h.

Function Documentation

◆ checkAuthenticatedRegister()

MachineBasicBlock & llvm::AArch64PAuth::checkAuthenticatedRegister ( MachineBasicBlock::iterator  MBBI,
AuthCheckMethod  Method,
Register  AuthenticatedReg,
Register  TmpReg,
bool  UseIKey,
unsigned  BrkImm 

Explicitly checks that pointer authentication succeeded.

Assuming AuthenticatedReg contains a value returned by one of the AUT* instructions, check the value using Method just before the instruction pointed to by MBBI. If the check succeeds, execution proceeds to the instruction pointed to by MBBI, otherwise a CPU exception is generated.

Some of the methods may need to know if the pointer was authenticated using an I-key or D-key and which register can be used as temporary. If an explicit BRK instruction is used to generate an exception, BrkImm specifies its immediate operand.

The machine basic block containing the code that is executed after the check succeeds.

Definition at line 234 of file AArch64PointerAuth.cpp.

References llvm::MachineInstrBuilder::addImm(), llvm::MachineInstrBuilder::addMBB(), llvm::MachineInstrBuilder::addMemOperand(), llvm::MachineInstrBuilder::addReg(), assert(), llvm::MachineBasicBlock::begin(), llvm::BuildMI(), llvm::MachineFunction::CreateMachineBasicBlock(), DL, llvm::MachineBasicBlock::getBasicBlock(), llvm::MachineBasicBlock::getFallThrough(), llvm::AArch64Subtarget::getInstrInfo(), llvm::MachineBasicBlock::getParent(), llvm::MachineFunction::getSubtarget(), llvm::getWRegFromXReg(), llvm_unreachable, MBB, MBBI, llvm::AArch64CC::NE, llvm::MachineFunction::push_back(), llvm::MachineBasicBlock::splitAt(), llvm::MachineBasicBlock::splitSuccessor(), and TII.

◆ getCheckerSizeInBytes()

unsigned llvm::AArch64PAuth::getCheckerSizeInBytes ( AuthCheckMethod  Method)

Returns the number of bytes added by checkAuthenticatedRegister.

Definition at line 312 of file AArch64PointerAuth.cpp.

References llvm_unreachable.