要追查非同步執行程式碼中的錯誤,往往非常棘手。原因是堆疊追蹤(stack trace)只能涵蓋當初崩潰的那條執行緒,你無從取得完整的上下文;與此同時,寫非同步程式碼卻因為 libdispatch、Operation Queue 與 XPC 提供的 API 而變得越來越輕鬆。
Activity Tracing 是 iOS 8 與 OS X 10.10 才引入的新技術,正是為了解決這個落差。今年的 WWDC 有一場講這個主題的精彩 session,不過懂的人還不多,所以我們決定另外寫一篇簡介。
Activity Tracing 最核心的想法是:用一個「活動」把回應某次使用者互動(或其他事件)所涉及的全部工作聚合起來,無論這些工作是同步執行,還是被分配到其他佇列甚至其他行程。舉例來說,如果使用者在你的 App 裡觸發了刷新然後崩潰,即使崩潰發生在別的佇列、或有其他程式碼路徑也能走到那段程式碼,你依然能確定是「刷新」這個特定行為造成了後續的崩潰。
這套技術由三部分組成:活動(Activity)、麵包屑(Breadcrumb)與追蹤資訊(Trace Message)。活動能跨佇列、跨行程地追出導致崩潰的事件;麵包屑能跨多個活動描繪出事件軌跡;追蹤資訊則為當前活動補充更細節的說明。一旦出問題,這三種資訊都會出現在最終的崩潰報告裡。
進入細節之前,先提醒一個可能的坑:如果活動資訊沒顯示出來,請檢查 system.log 裡 diagnosticd 這個守護行程是否給出了類似 "Signature Validation Failed" 的訊息,你可能遇到了程式碼簽章的問題。另外,在 iOS 上 Activity Tracing 只能在真機運作,模擬器不行。
活動(Activity)
活動是這項技術的核心。一個活動聚合了回應單一事件所需的全部程式碼執行過程,不管這些程式碼跑在哪個佇列、哪個行程。這樣一來,過程中出任何問題,都能回溯到造成崩潰的源頭事件。
Activity Tracing 已整合進 AppKit 與 UIKit,所以當一個使用者介面事件透過 target-action 機制傳遞時,系統會自動開啟一個活動。但對於不會向回應鏈送出事件的使用者互動(例如點擊 table view cell),你就得自己手動建立活動。
啟動一個活動很簡單:
#import <os/activity.h>
os_activity_initiate("activity name", OS_ACTIVITY_FLAG_DEFAULT, ^{
// do some work...
});這個 API 會同步執行 block,block 內的任何程式碼——包括你派到別的佇列去跑的工作,或進行 XPC 呼叫的部分——都會被歸到這個活動裡。第一個參數是活動標記,必須是字串常數(這套 API 的其他字串參數也一樣)。
第二個參數 OS_ACTIVITY_FLAG_DEFAULT 表示你要建立一個全新的活動。如果想在既有活動之內再開一個,就必須改用 OS_ACTIVITY_FLAG_DETACHED。舉例:當回應使用者互動控制項送出的行為訊息時,AppKit 已經幫你開好一個活動;若你想在這個互動回應尚未結束時另外開一個活動,就需要一個分離(detached)的活動。
這個 API 還有幾個功能相同的變體,一個是函式形式(os_activity_initiate_f),另一個是一對巨集:
os_activity_t activity = os_activity_start("label", OS_ACTIVITY_FLAG_DEFAULT);
// do some work...
os_activity_end(activity);注意:你至少要設定一則追蹤資訊,否則這個活動不會出現在崩潰報告或任何查看方式中。後面會再談追蹤資訊的細節。
麵包屑(Breadcrumbs)
麵包屑的作用正如其名:當程式碼崩潰時,它留下一串能說明上下文的跨活動事件標記軌跡。使用方式非常簡單:
os_activity_set_breadcrumb("event description");這些事件被存放在一個環形緩衝區中,只保留最近 50 個。因此這個 API 只適合用來標記「宏觀」事件,例如特定的使用者互流行為。
另外要注意:這個 API 只在活動進行中有效——它的作用是「把當前活動標記為一個麵包屑」。也就是說每個活動只能標記一次,後續呼叫會被系統忽略。
追蹤資訊(Trace Messages)
追蹤資訊用來為活動補充說明,用途和你平時寫 log 差不多,只是它能直接進到崩潰報告裡,幫助你理解問題根源。在一個活動中,最簡單的用法是:
#import <os/trace.h>
os_trace("my message");除此之外,它還能發揮更大作用。os_trace 的第一個參數是格式化字串,用法和 printf 或 NSLog 相同,但有兩個限制:格式化字串最長只能有 100 個字元,最多 7 個純量值的占位符。這意味著你不能輸出字串——若嘗試輸出字串,它會被一個占位符取代。
兩個使用格式化字串的範例:
os_trace("Received %d creates, %d updates, %d deletes", created, updated, deleted);
os_trace("Processed %d records in %g seconds", count, time);我在試用時還發現一個坑:如果沒有從「發生崩潰的那條執行緒」送出追蹤資訊,那麼所有追蹤資訊都不會出現在崩潰報告中。
追蹤資訊的變體
在 os_trace 之上還有好幾個功能相近的 API。首先是 os_trace_debug,只在除錯模式下輸出追蹤資訊。這在正式環境很有幫助,能減少環形緩衝區被無用資訊佔滿,讓你留下最有價值的部分。要開啟除錯模式,需把環境變數 OS_ACTIVITY_MODE 設為 debug。
此外還有兩個語義相近的巨集:os_trace_error 用來表示出現了未預期的錯誤,os_trace_fault 則用來表示致命錯誤,例如即將崩潰。
前面提到,標準的 os_trace 只接受「長度受限、僅純量型別」的格式化字串。這樣的設計是基於隱私、安全性與執行效率的考量。但除錯時總有幾個情境是你希望拿到更多資料的,這時候「帶有負載(payload)的追蹤資訊」就派上用場了。
對應的 API 是 os_trace_with_payload,第一眼有點奇怪:它除了接受格式化字串與可變數量參數之外,還多收一個帶 xpc_object_t 參數的 block。這個 block 在正式環境不會被呼叫,因此不產生額外開銷;而在除錯過程中,你可以在 block 唯一的字典參數裡塞任何你想看的資料。
os_trace_with_payload("logged in: %d", guid, ^(xpc_object_t xdict) {
xpc_dictionary_set_string(xdict, "name", username);
});這個 block 的參數型別之所以是 XPC 物件,是因為 Activity Tracing 底層靠 diagnosticd 守護行程收集資料。透過 xpc_dictionary_set_* 系列 API 設定這個字典的值,就是在與那個行程溝通。你可以用命令列工具 ostraceutil 來查看負載資料,後面會深入說明。
前面提到的所有 os_trace 變體巨集,都有對應的負載版本。除了 os_trace_with_payload,還有 os_trace_debug_with_payload、os_trace_error_with_payload 與 os_trace_fault_with_payload。
查看活動追蹤的輸出
除了崩潰報告,你還有兩種方式檢視輸出。第一,Activity Tracing 整合在除錯器中。在 LLDB 主控台輸入 thread info,就能取得當前執行緒正在進行的活動與追蹤資訊。
(lldb) thread info
thread #1: tid = 0x19514a, 0x000000010000125b ActivityTracing2`__24-[ViewController crash:]_block_invoke_4(.block_descriptor=) + 27 at ViewController.m:26, queue = 'com.apple.main-thread', activity = 'crash button pressed', 1 messages, stop reason = EXC_BAD_ACCESS (code=1, address=0x0)
Activity 'crash button pressed', 0x8e700000005
Current Breadcrumb: button pressed
1 trace messages:
message1第二種方式是命令列工具 ostraceutil,在終端機執行:
sudo ostraceutil -diagnostic -process <pid> -quiet
(把 <pid> 換成行程 id)會輸出類似下面的內容(已精簡):
Process: ================== PID: 16992 Image_uuid: FE5A6C31-8710-330A-9203-CA56366876E6 Image_path: [...] Application Breadcrumbs: ================== Timestamp: 59740.861604, Breadcrumb ID = 6768, Name = 'Opened theme picker', Activity ID: 0x000008e700000001 Timestamp: 59742.202451, Breadcrumb ID = 6788, Name = 'button pressed', Activity ID: 0x000008e700000005 Activity: ================== Activity ID: 0x000008e700000005 Activity Name: crash button pressed Image Path: [...] Image UUID: FE5A6C31-8710-330A-9203-CA56366876E6 Offset: 0x1031 Timestamp: 59742.202350 Reason: none detected Messages: ================== Timestamp: 59742.202508 FAULT Activity ID: 0x000008e700000005 Trace ID: 0x0000c10000001ac0 Thread: 0x1951a8 Image UUID: FE5A6C31-8710-330A-9203-CA56366876E6 Image Path: [...] Offset: 0x118d Message: 'payload message' ---------------------- Timestamp: 59742.202508 RELEASE Trace ID: 0x0000010000001aad Offset: 0x114c Message: 'message2' ---------------------- Timestamp: 59742.202350 RELEASE Trace ID: 0x0000010000001aa4 Thread: 0x19514a Offset: 0x10b2 Message: 'message1'
真正的輸出會比 LLDB 主控台多得多,因為還包含麵包屑軌跡與所有執行緒的追蹤資訊。
除了 -diagnostic,還可以用 -watch 參數動態觀察追蹤資訊與麵包屑的輸出。這種模式下連負載資料也會一併印出:
[...]
----------------------
Timestamp: 60059.327207
FAULT
Trace ID: 0x0000c10000001ac0
Offset: 0x118d
Message: 'payload message'
Payload: '{
count = 1,
contents =
"test-key" => {
length = 10,
contents = "test-value";
}
}'
----------------------
[...]Activity Tracing 與 Swift
寫這篇文章時,Swift 還不能直接呼叫 Activity Tracing API。
如果你想在 Swift 專案中使用它,就得寫一層 Objective-C 封裝,讓 Swift 透過橋接標頭檔(bridging header)來呼叫。特別注意:這套 API 的巨集要求字串必須是常數,也就是說你不能直接把封裝函式的參數傳進去。以下寫法是不會動的:
void sendTraceMessage(const char *msg) {
os_trace(msg); // this doesn't work!
}可行的做法是針對每個情境定義專用的輔助函式,例如:
void traceLogin(int guid) {
os_trace("Login: %d", guid);
}總結
Activity Tracing 是個很受歡迎的新除錯工具,讓診斷非同步程式碼的錯誤變得容易許多。我們都應該養成標記活動、麵包屑與追蹤資訊的習慣。
對已經在正式環境使用 Swift 的人來說,目前最大的遺憾就是 Swift 無法直接呼叫。希望這只是時間問題,不會太久。