歡迎來到《用python拓展gdb》的第三篇。上一篇我們談到了pretty printer，一個(gè)需要python支持的特性。這一篇我們談?wù)摿硪粋€(gè)需要python支持的特性，convenience function。

什么是convenience function

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

舉個(gè)例子：

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

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

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

跟自定義命令一樣，該接口也需要用戶繼承特定的類。convenience function提供的基類名為gdb.Function。用戶需要實(shí)現(xiàn)其中的__init__和invoke(self, *args)兩個(gè)方法，然后通過構(gòu)造一個(gè)對(duì)象來向gdb注冊(cè)該函數(shù)。基本上就是自定義命令的一個(gè)翻版。不過有一個(gè)區(qū)別是，gdb.Function的invoke方法通常會(huì)返回一個(gè)gdb.Value對(duì)象，表示調(diào)用該函數(shù)后的返回值。如果返回的不是gdb.Value對(duì)象，gdb會(huì)嘗試把它轉(zhuǎn)化成對(duì)應(yīng)的gdb.Value對(duì)象。比方說，如果invoke方法返回的是一個(gè)字符串，那么gdb會(huì)把該字符串包裝成表示字符串的gdb.Value。

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

當(dāng)然，它也不全是個(gè)雞肋。convenience function有一個(gè)優(yōu)勢(shì)，它可以返回值。這是自定義命令做不到的。屬于它的生存空間也就剩下這么一點(diǎn)了。

實(shí)現(xiàn)一個(gè)convenience function

老規(guī)矩，還是用我最愛的教學(xué)方式，先上示例代碼。

這次我們嘗試用DSL實(shí)現(xiàn)mv命令的第二版。該版本的mv接受兩個(gè)參數(shù)，一個(gè)是待移除斷點(diǎn)的位置，另一個(gè)是待設(shè)定斷點(diǎn)的位置。

mv具體實(shí)現(xiàn)參見《用python拓展gdb》第一篇。由于DSL里面沒有函數(shù)，我們會(huì)用python代碼實(shí)現(xiàn)名為findBreakpoint的convenience function。當(dāng)然了，如果我們選擇用python實(shí)現(xiàn)mv，就沒有這個(gè)需求了。還是創(chuàng)造下機(jī)會(huì)讓convenience function上一會(huì)場(chǎng)吧。

findBreakpoint的功能是接受一個(gè)位置，返回該位置上首個(gè)斷點(diǎn)的編號(hào)，這樣就能在delete命令里移除目標(biāo)斷點(diǎn)。實(shí)現(xiàn)代碼如下：

# mv2.gdb # 使用python...end語句塊，使得我們可以在gdb的DSL文件里面編寫python代碼。 python import os # 1. 繼承g(shù)db.Function class FindBreakpoint(gdb.Function):"Find specific breakpoint with location"def __init__(self):# 2. 注冊(cè)函數(shù)名字'findBreakpoint'super(self.__class__, self).__init__('findBreakpint')def invoke(self, location):# 3. 不要忘了，invoke方法接受的參數(shù)是gdb.Value，所以后面我通過# string方法來獲得字符串值。bps = gdb.breakpoints() # 獲取全部斷點(diǎn)if bps is None:raise gdb.GdbError('No breakpoints')for bp in bps:# 由于斷點(diǎn)的location屬性返回的是絕對(duì)路徑，把它轉(zhuǎn)成相對(duì)路徑if os.path.relpath(bp.location) == location.string():# 4. convenience function需要返回值，gdb會(huì)把它包裝成gdb.Value類型return bp.numberraise gdb.GdbError("Specific breakpoint can't be found.")# 5. 最后一步，向gdb會(huì)話注冊(cè)該函數(shù) FindBreakpoint() enddefine mvif $argc == 2# 調(diào)用它的時(shí)候不要忘記'$'前綴set $i = $findBreakpint($arg0)delete $i# 看到我在上面耍的一個(gè)trick嗎？# findBreakpint返回的是一個(gè)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第一個(gè)參數(shù)需要用雙引號(hào)括起來，否則gdb會(huì)報(bào)錯(cuò)，說找不到符號(hào)gdb.c。

小結(jié)

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

總結(jié)

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

如果覺得生活随笔網(wǎng)站內(nèi)容還不錯(cuò)，歡迎將生活随笔推薦給好友。