您现在的位置: IOS教程網 >> IOS系統 >  >> iOS 程式開發 >> iOS 開發基礎

與 LLDB 共舞:把除錯器用在 NSLog 之外的場合

編輯:iOS 開發基礎

你是否做過這些事:為了看一個變量的值而插入一行 NSLog;為了跳過某個函數呼叫而把程式碼註解掉;為了短路一個條件判斷而硬寫 if (1 || theBooleanAtStake);或者乾脆先讓某個函數回傳一個假值,之後再補。而且每做一次,就得重新編譯、重新執行。

NSLog(@"%@", whatIsInsideThisThing);
NSNumber *n = @7;   // 原本應該呼叫 Foo();
if (1 || theBooleanAtStake) { ... }
int calculateTheTrickyValue { return 9; /* 先這樣,之後再想 */ }

軟體開發本來就複雜,Bug 不可能絕跡,而「改碼 → 編譯 → 重跑 → 祈禱」是很多人熟悉的循環。但它並非唯一選項。除錯器能做的,遠比在 Xcode 側邊槽點幾個中斷點多得多。本文希望挑戰一下你對「除錯」的既有認知,從原理談到實戰。

認識 LLDB

LLDB 是開源除錯器,具備 REPL 特性,並支援 C++ 與 Python 外掛。它內建於 Xcode,也就是主視窗底部那塊控制台。除錯器能讓程式在特定時刻暫停,讓你檢視變量、執行自訂指令,並依需要推進或改變執行流程。

GDB to LLDB 參考是命令總覽的好起點;另外也推薦 Chisel,這是一套開源的 LLDB 指令合集,能讓除錯工作更順手。

基礎指令

假設有個會印出字串的小程式,在第 8 行設了中斷點。

程式停在該行,控制台開啟,等著你輸入指令。

help:最基礎的指令,列出所有可用命令。忘記某個指令的用途時,help print、help thread 都能給出細節;忘記 help 自己是幹嘛的,就 help help。

print:印出數值就是這麼簡單。

LLDB 支援前綴比對,所以 prin、pri、p 都行;pr 不行,因為會與 process 產生歧義。輸出中的 $0 可以拿來 reuse,試著執行 print $0 + 7 就會看到 106。凡是以美元符號開頭的名稱,都存在 LLDB 的命名空間裡,是為除錯準備的暫存變數。

expression:想改寫值?用 expression。它不只改變除錯器眼中的值,而是真正改掉了程式執行中的值——繼續執行後,輸出就變成 42 red balloons。以下我們會用 p 和 e 分別簡稱 print 與 expression。

print 其實是什麼:試試 p count = 18,效果等同 expression count = 18。兩者的差異在參數解析——print 不需要標識參數,因為它本質上就是 expression -- 的縮寫。例如 e -h +17 就有歧義:是帶著 -h 標識去算 +17,還是要算 17 減 h?用 -- 標明「標識結束、輸入開始」即可解決:想讓 -h 當標識寫 e -h -- +17,想算差值寫 e -- -h +17。由於不帶標識的情況居多,於是有了 print 這個捷徑。

'print' is an abbreviation for 'expression --'.

印出物件:

(lldb) p objects
(NSString *) $7 = 0x0000000104da4040 @"red balloons"
(lldb) p @[ @"foo", @"bar" ]
(NSArray *) $8 = 0x00007fdb9b71b3e0 @"2 objects"

結構一複雜,輸出就很囉嗦。真正想看的是 description 的結果,這時加上 -O(字母 O,代表 Object)標識:

(lldb) e -O -- $8
( foo, bar )

而 e -O -- 同樣有捷徑,就是 po(print object):

(lldb) po $8
( foo, bar )
(lldb) po @"lunar"
lunar

指定輸出格式:寫成 print/<fmt> 或 p/<fmt>。

(lldb) p 16            // 預設
16
(lldb) p/x 16          // 十六進位
0x10
(lldb) p/t 16          // 二進位,t 代表 two
0b00000000000000000000000000010000
(lldb) p/t (char)16
0b00010000

此外 p/c 可印出字元,p/s 可印出以 null 結尾的字串。

暫存變數:就像 C 語言裡的 int a = 0,在 LLDB 中宣告的變數必須以美元符號開頭才能使用。

(lldb) e int $a = 2
(lldb) p $a * 19
38
(lldb) e NSArray *$array = @[ @"Saturday", @"Sunday", @"Monday" ]
(lldb) p (char)[[$array objectAtIndex:$a] characterAtIndex:0]
'M'
(lldb) p/d (char)[[$array objectAtIndex:$a] characterAtIndex:0]
77

型別推論失敗時,明確加上 cast 就能解決。

流程控制

程式抵達中斷點時會停下,此時調試列上會有四顆按鈕。

由左至右分別是 continue、step over、step into、step out。

continue(process continue/continue/c)讓程式恢復執行,直到下一個中斷點或結束。

step over(thread step-over/next/n)以黑盒方式執行目前這一行,即使它是函數呼叫也不進入。

step into(thread step-in/step/s)會進入函數內部。若目前行不是函數呼叫,next 與 step 效果相同。

step out 是最常被忽略的一顆。誤入函數後,多數人的反應是連按 n 直到函數返回;其實 step out 才是正解——它會一路執行到目前堆疊框的 return,然後停下。

一個示範:

在斷點處依序執行:

p i
n
s
p i
finish
p i
frame info

輸出如下:

(lldb) p i
(int) $0 = 99
(lldb) n
2014-11-22 10:49:26.445 DebuggerDance[60182:4832768] 101 is odd!
(lldb) s
(lldb) p i
(int) $2 = 110
(lldb) finish
2014-11-22 10:49:35.978 DebuggerDance[60182:4832768] 110 is even!
(lldb) p i
(int) $4 = 99
(lldb) frame info
frame #0: 0x000000010a53bcd4 DebuggerDance`main + 68 at main.m:17

frame info 會告訴你目前的行號與原始碼檔案;help frame、help thread、help process 有更多細節。值得注意的是,finish 一路執行到 isEven() 的 return 才停下,所以位置仍在第 17 行,但那行其實已經執行過了。

thread return:另一個強力的流程控制指令,可帶入選用參數寫進返回暫存器,然後立刻跳出目前堆疊框,函數剩餘部分不會執行。這會影響 ARC 的引用計數,也可能讓函數內的清理流程失效,但用在函數開頭做「隔離並偽造回傳值」非常合適。

p i
s
thread return NO
n
p even0
frame info
(lldb) p i
(int) $0 = 99
(lldb) s
(lldb) thread return NO
(lldb) n
(lldb) p even0
(BOOL) $2 = NO
(lldb) frame info
frame #0: 0x00000001009a5cc4 DebuggerDance`main + 52 at main.m:17

中斷點:從被動觀察到主動介入

我們通常把中斷點當成「停下來看看狀態」的工具。但只要改變與它互動的方式,可能性會大幅擴張——中斷點可以決定何時停止,也可以附掛指令自動執行。

想像在中斷點上掛一條 thread return 覆寫函數行為,然後自動繼續;再想像把整個流程自動化。

管理:Xcode 左側面板的斷點導覽可集中管理所有中斷點,對應 LLDB 的 breakpoint list(br li);啟用與停用則是 breakpoint enable <id> 與 breakpoint disable <id>。

(lldb) br li
Current breakpoints:
1: file = '/Users/arig/Desktop/DebuggerDance/DebuggerDance/main.m', line = 16,
   locations = 1, resolved = 1, hit count = 1
  1.1: where = DebuggerDance`main + 27 at main.m:16, address = 0x000000010a3f6cab,
       resolved, hit count = 1
(lldb) br dis 1
1 breakpoints disabled.
(lldb) br del 1
1 breakpoints deleted; 0 breakpoint locations disabled.

建立:在 Xcode 中點擊側邊槽即可,拖出側槽可刪除。在 LLDB 中則用 breakpoint set:

(lldb) breakpoint set -f main.m -l 16
Breakpoint 1: where = DebuggerDance`main + 27 at main.m:16, address = 0x000000010a3f6cab

縮寫 br 同樣可行;b 是另一個指令(_regexp-break 的縮寫),但效果一致:

(lldb) b main.m:17
Breakpoint 2: where = DebuggerDance`main + 52 at main.m:17, address = 0x000000010a3f6cc4

也可以直接對符號(C 語言函數)下斷點,不必指定行號:

(lldb) b isEven
Breakpoint 3: where = DebuggerDance`isEven + 16 at main.m:4, address = 0x000000010a3f6d00

Objective-C 方法完全一樣:

(lldb) breakpoint set -F "-[NSArray objectAtIndex:]"
Breakpoint 5: where = CoreFoundation`-[NSArray objectAtIndex:], address = 0x000000010ac7a950
(lldb) b -[NSArray objectAtIndex:]
Breakpoint 6: where = CoreFoundation`-[NSArray objectAtIndex:], address = 0x000000010ac7a950
(lldb) b +[NSSet setWithObject:]
Breakpoint 8: where = CoreFoundation`+[NSSet setWithObject:], address = 0x000000010abd3820

這類符號中斷點會精準停在函數開頭。在 Xcode 介面上,點斷點欄左側的 + 按鈕,再選第三個選項,即可輸入類似 -[NSArray objectAtIndex:] 的符號——之後不論是你還是系統呼叫這個方法,程式都會停下。

右鍵點擊任一斷點並選擇 Edit Breakpoint,會看到更多好用的選項。

上圖的中斷點被設為「僅當 i 等於 99 時才停止」;另外還有 ignore 選項,可讓前 n 次命中略過不停。

中斷點行為(Action)

想知道每次抵達中斷點時 i 的值是多少?把 p i 設為斷點行為即可,每次命中都會自動執行。

行為可以有多個,除錯器指令、shell 指令,甚至直接朗讀文字都可以。

同樣的事在 LLDB 裡這樣寫:

(lldb) breakpoint set -F isEven
Breakpoint 1: where = DebuggerDance`isEven + 16 at main.m:4, address = 0x00000001083b5d00
(lldb) breakpoint modify -c 'i == 99' 1
(lldb) breakpoint command add 1
Enter your debugger command(s).  Type 'DONE' to end.
> p i
> DONE

評估後自動繼續:編輯中斷點視窗底部有個「Automatically continue after evaluation actions」選項,勾選後除錯器會跑完所有行為再繼續執行,感覺就像沒有中斷點一樣(除非數量太多拖慢了速度)。它的效果等同於讓最後一個行為是 continue。

(lldb) breakpoint command add 1
Enter your debugger command(s).  Type 'DONE' to end.
> continue
> DONE

有了這招,你幾乎可以完全透過中斷點來改寫程式行為:在某行停下、用 expression 改變量、繼續執行。

於是所謂的「print 除錯法」可以這樣升級:別再插入 NSLog(@"%@", whatIsInsideThisThing);,改成掛一個印出變量的中斷點並自動繼續;別再讓 calculateTheTrickyValue 硬回傳 9,改成掛一個 thread return 9 的中斷點。

符號中斷點配上行為,威力相當可觀——甚至在同事的專案裡掛個朗讀文字的行為,看他要花多久才發現(後果自負)。

直接在除錯器中執行程式碼

你可以在 LLDB 裡執行任何 C/Objective-C/C++/Swift 指令,唯一的限制是無法建立新的函數——也就是說不能宣告新類別、block、函數,或帶虛擬函數的 C++ 類別。除此之外幾乎都能做。

(lldb) e char *$str = (char *)malloc(8)
(lldb) e (void)strcpy($str, "munkeys")
(lldb) e $str[1] = 'o'
(char) $0 = 'o'
(lldb) p $str
(char *) $str = 0x00007fd04a900040 "monkeys"

用 x 指令可以檢視記憶體(它需要斜線,因為參數是記憶體位址而非表達式,細節見 help x):

(lldb) x/4c $str
0x7fd04a900040: monk
(lldb) x/1w `$str + 3`
0x7fd04a900043: keys

用完記得釋放,別讓除錯器幫你製造記憶體洩漏:

(lldb) e (void)free($str)

不靠中斷點的除錯

程式執行時,Xcode 調試列上顯示的是暫停按鈕。

按下它會執行 process interrupt,讓你取得除錯器控制權。此時雖然當前作用域沒有變量可看,但若你在跑 iOS App,全域物件是可存取的:

(lldb) po [[[UIApplication sharedApplication] keyWindow] recursiveDescription]

    | 

整棵視圖階層一目了然——Chisel 的 pviews 正是基於此。

更新 UI:

(lldb) e id $myView = (id)0x7f82b1d01fd0
(lldb) e (void)[$myView setBackgroundColor:[UIColor blueColor]]

畫面不會馬上變,因為改動必須送到渲染服務才會生效。而渲染服務是另一個行程(backboardd),即使被除錯的行程是暫停狀態,它仍在運行:

(lldb) e (void)[CATransaction flush]

這樣即使還停在除錯器中,模擬器或真機上的畫面也會即時更新。Chisel 為此提供了 caflush 別名,並衍生出 hide、show 等一眾捷徑指令,安裝後用 help show 即可查閱。

推入一個 View Controller:假設 root 是 UINavigationController:

(lldb) e id $nvc = [[[UIApplication sharedApplication] keyWindow] rootViewController]
(lldb) e id $vc = [UIViewController new]
(lldb) e (void)[[$vc view] setBackgroundColor:[UIColor yellowColor]]
(lldb) e (void)[$vc setTitle:@"Yay!"]
(lldb) e (void)[$nvc pushViewController:$vc animated:YES]
(lldb) caflush

頁面立刻推送到眼前。

追查按鈕的 target:

(lldb) po [$myButton allTargets]
{
}
(lldb) po [$myButton actionsForTarget:(id)0x7fb58bd2e240 forControlEvent:0]
( _handleTap: )

接著在 -[MyEventListener _handleTap:] 上設一個符號中斷點,點擊按鈕就會停在你想看的位置。

監看實例變量的寫入:若某個 UIView 的 _layer 被神不知鬼不覺地覆寫,而流程中沒有經過任何方法,符號中斷點就無效了——這時該監看的是「記憶體位址何時被寫入」。

(lldb) p (ptrdiff_t)ivar_getOffset((struct Ivar *)class_getInstanceVariable([MyView class], "_layer"))
(ptrdiff_t) $0 = 8
(lldb) watchpoint set expression -- (int *)$myView + 8
Watchpoint created: Watchpoint 3: addr = 0x7fa554231340 size = 8 state = enabled type = w
    new value: 0x0000000000000000

Chisel 把這整個流程包成了 wivar $myView _layer。

未被覆寫的方法:想知道 -[MyViewController viewDidAppear:] 何時被呼叫,但該方法其實實作在父類,直接下斷點會這樣:

(lldb) b -[MyViewController viewDidAppear:]
Breakpoint 1: no locations (pending).
WARNING:  Unable to resolve breakpoint to any actual locations.

因為 LLDB 找不到該類別上的符號,斷點永遠不會觸發。直覺做法是改在 UIViewController 上設斷點並加上 [self isKindOfClass:[MyViewController class]] 條件,但這裡行不通:viewDidAppear: 由蘋果實作,沒有符號,函數內拿不到 self。要在符號斷點上取用 self,你得知道它當時在哪裡(暫存器或堆疊;x86 上可從 $esp+4 找到),而這意味著必須同時掌握 x86、x86-64、armv7、armv64 四套體系結構的指令集與呼叫約定。Chisel 的 bmessage 把這件事解決了:

(lldb) bmessage -[MyViewController viewDidAppear:]
Setting a breakpoint at -[UIViewController viewDidAppear:] with condition
(void*)object_getClass((id)$rdi) == 0x000000010e2f4d28
Breakpoint 1: where = UIKit`-[UIViewController viewDidAppear:], address = 0x000000010e11533c

LLDB 與 Python

LLDB 內建完整的 Python 支援。輸入 script 會進入 Python REPL,也可以把單行語句當作參數直接執行:

(lldb) script import os
(lldb) script os.system("open https://www.objc.io/")

這讓自訂指令變得容易。把下面的內容存進 ~/myCommands.py:

def caflushCommand(debugger, command, result, internal_dict):
    debugger.HandleCommand("e (void)[CATransaction flush]")

然後在 LLDB 中載入:

command script import ~/myCommands.py

把這行放進 ~/.lldbinit,每次啟動就會自動載入。Chisel 本質上就是一堆 Python 腳本,負責拼出指令字串再交給 LLDB 執行——原理單純得令人愉悅。

把除錯器當成主要工具

多數人習慣用 p、po、n、s、c 就停下腳步,但 LLDB 能做的還有很多,而這些指令的總量其實並不多。熟練之後,你在觀察程式運行狀態、定位 Bug、強制走特定分支時會靈活得多,甚至能直接在執行中的 App 裡做互動原型:如果現在用 modal 方式彈出一個 View Controller 會是什麼感覺?試一下就知道。

這篇文章的目的,是讓你看見 LLDB 的能力邊界,並鼓勵你多練習在控制台裡下指令。打開 LLDB,輸入 help,看看那些列出來的指令,你試過幾個?

希望下一次,當你想插入 NSLog 時會先遲疑一下——毕竟每次改碼再重跑,既无趣又费时。

除錯愉快。

  1. 上一篇文章:
  2. 下一篇文章:
蘋果刷機越獄教程| IOS教程問題解答| IOS技巧綜合| IOS7技巧| IOS8教程
Copyright © IOS教程網 All Rights Reserved