在 iOS 開發與問題排查中,取得執行緒的呼叫堆疊(Call Stack)是一項非常實用的能力。本文將一步步說明如何獲取「任意一個」執行緒的呼叫棧。
如果要取得「當前」執行緒的呼叫棧,可以直接使用現成的 API:[NSThread callStackSymbols]。但苹果並未提供取得「任意」執行緒呼叫棧的介面,因此只能自行編碼實現。
一個執行緒的呼叫棧是什麼樣子?我的理解是:它應該包含當前執行緒的執行位址,並且能從這個位址一級一級回溯到執行緒的入口位址,反向構成一條鏈——執行緒入口執行某方法,再逐級嵌套呼叫到當前現場。
(圖片來源於維基百科)
如圖所示,每一級方法呼叫都對應一張活動記錄,也稱活動幀(棧幀)。也就是說,呼叫棧是由一張張幀結構組成的。而每張棧幀中都包含一個 Return Address(返回位址),也就是當前活動記錄執行完畢後要返回的位址。因此,只要取得棧幀,就能透過返回位址進行回溯。
我們明確了兩個目標:(1) 當前執行的指令;(2) 當前棧幀結構。以 x86 為例,相關寄存器用途如下:
SP/ESP/RSP: 棧頂位址(Stack pointer) BP/EBP/RBP: 當前棧幀的基址(Stack base pointer) IP/EIP/RIP: 指令指針(Instruction pointer),保存程式計數器,即當前指令位址
也就是說,我們能透過指令指針取得當前指令位址,並透過棧基址指針取得當前棧幀位址。問題在於:如何取得這些寄存器?
考慮到一個執行緒被掛起時,後續恢復執行需要還原現場(例如當前執行到哪條指令),因此掛起時相關狀態必須被保存起來。這就需要一個結構體來記錄執行緒的運行狀態。查閱資料後可得知:thread_get_state 函數能回傳指定執行緒的執行狀態(如機器寄存器)。
kern_return_t thread_get_state(
thread_act_t target_thread,
thread_state_flavor_t flavor,
thread_state_t old_state,
mach_msg_type_number_t old_state_count);
因此,我們可以搭配相關參數取得想要的寄存器資訊:
bool jdy_fillThreadStateIntoMachineContext(thread_t thread, _STRUCT_MCONTEXT *machineContext) {
mach_msg_type_number_t state_count = x86_THREAD_STATE64_COUNT;
kern_return_t kr = thread_get_state(thread, x86_THREAD_STATE64,
(thread_state_t)&machineContext->__ss, &state_count);
return (kr == KERN_SUCCESS);
}
這裡引入了一個結構體 _STRUCT_MCONTEXT。
_STRUCT_MCONTEXT 在不同平台上的結構並不相同:
x86_64(如 iPhone 6 模擬器):包含 __rax ~ __r15、__rip(指令指針)、__rbp(基址指針)、__rsp(棧指針)等。
x86_32(如 iPhone 4s 模擬器):包含 __eax ~ __esi、__ebp、__esp、__eip 等 32 位寄存器。
ARM64(如 iPhone 5s):包含 x0-x28 通用寄存器、__fp(frame pointer x29)、__lr(link register x30)、__sp(stack pointer x31)、__pc(program counter)等。
ARMv7/v6(如 iPhone 4s):包含 r0-r12 通用寄存器、__sp、__lr、__pc 等。
對照《iOS ABI Function Call Guide》,其中 ARM64 章節描述到:frame pointer 寄存器(x29)必須始終指向一個有效的幀記錄,因此即使沒有除錯資訊,堆疊追蹤也始終有意義。而在 ARMv7/v6 上,則約定 R7 作為 frame pointer、R9 有特殊用途。
了解這些不同平台的寄存器結構後,我們就能編寫出較為通用的回溯功能。
/**
* 棧幀布局可參考:
* https://en.wikipedia.org/wiki/Call_stack
* https://eli.thegreenplace.net/2011/09/06/stack-frame-layout-on-x86-64/
*/
typedef struct JDYStackFrame {
const struct JDYStackFrame* const previous;
const uintptr_t returnAddress;
} JDYStackFrame;
int jdy_backtraceThread(thread_t thread, uintptr_t *backtraceBuffer, int limit) {
if (limit <= 0) return 0;
_STRUCT_MCONTEXT mcontext;
if (!jdy_fillThreadStateIntoMachineContext(thread, &mcontext)) {
return 0;
}
int i = 0;
uintptr_t pc = jdy_programCounterOfMachineContext(&mcontext);
backtraceBuffer[i++] = pc;
if (i == limit) return i;
uintptr_t lr = jdy_linkRegisterOfMachineContext(&mcontext);
if (lr != 0) {
/* lr 保存的也是返回位址,有效時可能產生重複項 */
backtraceBuffer[i++] = lr;
if (i == limit) return i;
}
JDYStackFrame frame = {0};
uintptr_t fp = jdy_framePointerOfMachineContext(&mcontext);
if (fp == 0 || jdy_copyMemory((void *)fp, &frame, sizeof(frame)) != KERN_SUCCESS) {
return i;
}
while (i < limit) {
backtraceBuffer[i++] = frame.returnAddress;
if (frame.returnAddress == 0 || frame.previous == NULL ||
jdy_copyMemory((void *)frame.previous, &frame, sizeof(frame)) != KERN_SUCCESS) {
break;
}
}
return i;
}
整體思路是:先透過 thread_get_state 取得寄存器現場,讀出程式計數器(pc)與連結寄存器(lr)作為起點,再沿著 frame pointer 指向的棧幀鏈,透過每張幀的 previous 指標與 returnAddress 一路回溯,直到遇到 termination 或達到上限。理解了棧幀的布局原理,這個回溯過程就不再神秘。