若要獲取當前線程的呼叫堆疊,可以直接使用現成 API:[NSThread callStackSymbols]。但官方並未提供取得「任意」線程呼叫堆疊的接口,因此只能自行編碼實作。
一個線程的呼叫堆疊是什麼樣子?我的理解是:它應包含當前線程的執行地址,並能從這個地址一級一級回溯到線程的入口地址,反向構成一條鏈——線程入口執行某個方法,再逐級嵌套呼叫到當前現場。
(圖片來源於維基百科)
如圖所示,每一級的方法呼叫都對應一張活動記錄,也稱為活動幀,因此呼叫堆疊是由一張張幀結構(棧幀)所組成。每張棧幀中都包含 Return Address,也就是當前活動記錄執行完畢後要返回的地址。
我們明確了兩個目標:當前執行的指令,以及當前棧幀結構。以 x86 為例,相關寄存器用途如下:
SP/ESP/RSP: Stack pointer for top address of the stack. BP/EBP/RBP: Stack base pointer for holding the address of the current stack frame. IP/EIP/RIP: Instruction pointer. Holds the program counter, the current instruction address.
也就是說,我們可以透過指令指針取得當前指令地址,透過棧基址指針取得當前棧幀地址。問題在於:如何讀取到這些寄存器?
考慮到線程被掛起時,為了後續能恢復現場,相關狀態(如當前執行到哪條指令)必須被保存起來。查閱資料後可知,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);
搭配適當的 flavor 參數(如 x86_THREAD_STATE64),我們便能取得想要的寄存器資訊:
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 在不同平台上的定義各異:
__rbp、__rsp、__rip 等。__ebp、__esp、__eip 等。__fp(x29)、__lr(x30)、__sp、__pc 等。__sp、__lr、__pc 等。對照《iOS ABI Function Call Guide》,ARM64 章節提到 frame pointer(x29)必須始終指向一個有效的幀記錄,因此即使沒有除錯資訊,堆疊追蹤仍有意義;ARMv7/v6 則沿用 ARM 架構的呼叫約定,並以 R7 作為 frame pointer。了解這些差異後,我們便能編寫出相對通用的回溯功能。
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) {
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;
}
關於地址符號化的解析實作,請參閱續篇〈iOS 中線程 Call Stack 的捕獲與解析(二)〉。