歡迎來到《用python拓展gdb》的第三篇。上一篇我們談到了pretty printer，一個需要python支持的特性。這一篇我們談論另一個需要python支持的特性，convenience function。

什么是convenience function

所謂的convenience function，正如其名“便利函數”，指gdb會話中，可用于輔助數據處理的一類函數。

舉個例子：

(gdb) print foo() $1 = void (gdb) print $_isvoid(foo()) $2 = 1

上面的$_isvoid就是convenience functions。它們必須以$開頭，以此區別于來自于C/C++上下文的函數。

gdb中內置了一些convenience functions，可惜它們的數量并不多。還好gdb提供了python接口，讓我們能夠添加自定義的convenience functions。

跟自定義命令一樣，該接口也需要用戶繼承特定的類。convenience function提供的基類名為gdb.Function。用戶需要實現其中的__init__和invoke(self, *args)兩個方法，然后通過構造一個對象來向gdb注冊該函數?；旧暇褪亲远x命令的一個翻版。不過有一個區別是，gdb.Function的invoke方法通常會返回一個gdb.Value對象，表示調用該函數后的返回值。如果返回的不是gdb.Value對象，gdb會嘗試把它轉化成對應的gdb.Value對象。比方說，如果invoke方法返回的是一個字符串，那么gdb會把該字符串包裝成表示字符串的gdb.Value。

比起自定義命令，convenience function有一個劣勢。它不能（像通常意義上的函數）獨立使用，只能跟某個命令搭配。舉個例子，(gdb) $aryType()是語法不正確的，你只能(gdb) p $aryType()。即使在調試腳本里這一條也成立，單獨一個$setSize("ary", 20)就不行，需要用p $setSize("ary", 20)繞過。事實上，用自定義命令setSize "ary" 20看上去會更順眼。convenience function能干的事，自定義命令大部分也能干，導致它的存在感一向很稀薄。

當然，它也不全是個雞肋。convenience function有一個優勢，它可以返回值。這是自定義命令做不到的。屬于它的生存空間也就剩下這么一點了。

實現一個convenience function

老規矩，還是用我最愛的教學方式，先上示例代碼。

這次我們嘗試用DSL實現mv命令的第二版。該版本的mv接受兩個參數，一個是待移除斷點的位置，另一個是待設定斷點的位置。

mv具體實現參見《用python拓展gdb》第一篇。由于DSL里面沒有函數，我們會用python代碼實現名為findBreakpoint的convenience function。當然了，如果我們選擇用python實現mv，就沒有這個需求了。還是創造下機會讓convenience function上一會場吧。

findBreakpoint的功能是接受一個位置，返回該位置上首個斷點的編號，這樣就能在delete命令里移除目標斷點。實現代碼如下：

# mv2.gdb # 使用python...end語句塊，使得我們可以在gdb的DSL文件里面編寫python代碼。 python import os # 1. 繼承gdb.Function class FindBreakpoint(gdb.Function):"Find specific breakpoint with location"def __init__(self):# 2. 注冊函數名字'findBreakpoint'super(self.__class__, self).__init__('findBreakpint')def invoke(self, location):# 3. 不要忘了，invoke方法接受的參數是gdb.Value，所以后面我通過# string方法來獲得字符串值。bps = gdb.breakpoints() # 獲取全部斷點if bps is None:raise gdb.GdbError('No breakpoints')for bp in bps:# 由于斷點的location屬性返回的是絕對路徑，把它轉成相對路徑if os.path.relpath(bp.location) == location.string():# 4. convenience function需要返回值，gdb會把它包裝成gdb.Value類型return bp.numberraise gdb.GdbError("Specific breakpoint can't be found.")# 5. 最后一步，向gdb會話注冊該函數 FindBreakpoint() enddefine mvif $argc == 2# 調用它的時候不要忘記'$'前綴set $i = $findBreakpint($arg0)delete $i# 看到我在上面耍的一個trick嗎？# findBreakpint返回的是一個gdb.Value，# 需要把它綁定到DSL變量上，才能在DSL中使用。break $arg1...

使用方式：gdb a.out -x mv2.gdb。

(gdb) help function ... function findBreakpint -- Find specific breakpoint with location ... (gdb) mv "gdb.c:4" 5

注意mv第一個參數需要用雙引號括起來，否則gdb會報錯，說找不到符號gdb.c。

小結

下篇將會是本教程的最后一篇。在這最后一篇里，我們會看到，如何用python在gdb內跟外部程序交互。希望“gdb + X”的想法能讓你腦洞大開，激發出更多的玩法。敬請期待！

總結

以上是生活随笔為你收集整理的用 Python 拓展 GDB（三）的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。