在C語言中用ASSERT調(diào)試的八個技巧

C語言中的ASSERT(斷言)宏是嵌入式軟件開發(fā)人員可以使用的最好的調(diào)試工具之一。雖然ASSERT功能強大，但我很少看到它被實施，并且在一些使用它的案例中，它的實施要么是有瑕疵的要么是不正確的。以下一些技巧將不僅能夠幫助闡明在何時、何地使用ASSERT，而且還能闡明如何開始正確使用它。

技巧1：記住ASSERT的定義

對許多開發(fā)人員來說，斷言是一個令人困惑的話題，因為它們的許多使用方式與其設(shè)計初衷背道而馳。我見到的最清晰的斷言定義是這樣的：

“斷言是在程序某個特定點的一個布爾表達式，除非程序中有缺陷(Bug)，否則它的值將為真。”

想要理解上述斷言定義的開發(fā)人員應(yīng)該留意下面三個要點：

·斷言會評估一個表達式是真還是假

·斷言是在代碼中的某個點對系統(tǒng)狀態(tài)的一種假設(shè)

·斷言會驗證系統(tǒng)假設(shè)，如果不為真，就表明代碼中有一個缺陷

技巧2：使用ASSERT驗證函數(shù)的先決條件

斷言非常適合契約式設(shè)計環(huán)境，在這種環(huán)境中，開發(fā)人員非常清晰地定義了某個函數(shù)的先決條件。斷言可以用來檢查該函數(shù)的輸入是否滿足先決條件。就拿圖1所示的代碼片段為例：

圖1：函數(shù)的先決條件

函數(shù)的STate輸入應(yīng)該在定義的系統(tǒng)狀態(tài)范圍內(nèi)。如果State不是有效的狀態(tài)值，那么它就不是錯誤，而是缺陷!斷言可以用來驗證State是有效的假設(shè)，如圖2所示：

圖2：對函數(shù)先決條件應(yīng)用斷言

在State不小于最大值的事件中，斷言表達式將被評估為假，程序于是將停止執(zhí)行。停止程序執(zhí)行可以讓開發(fā)人員很容易馬上看到哪里的代碼出錯，而不是過段時間以后才知道。

技巧3：使用ASSERT驗證函數(shù)的后置條件

斷言也能用來驗證契約式設(shè)計環(huán)境中對某個函數(shù)輸出的假設(shè)。例如，如果前面定義的System_StateSet函數(shù)返回SystemState變量，開發(fā)人員可以預(yù)計它也在期望的范圍之內(nèi)。斷言可以用來對缺陷進行監(jiān)視，如圖3所示。

圖3：對函數(shù)后置條件應(yīng)用斷言

開發(fā)人員在查看上述代碼后可能會感到這些檢查毫無意義。剛剛才設(shè)置好的SystemState怎么就會出現(xiàn)大于SYSTEM_STATE_MAX的值呢?答案是這確實不應(yīng)該出現(xiàn)，然而有時候會莫名其妙地發(fā)生改變，也許是通過中斷或并行線程，此時斷言可以立即標(biāo)志出這個缺陷。

技巧4：不要把ASSERT用于錯誤處理

在記住斷言定義之后，開發(fā)人員應(yīng)該切記：斷言是用于檢測缺陷的，不能用于錯誤處理。錯誤處理是設(shè)計用于響應(yīng)錯誤的用戶輸入和意外的事件順序的軟件。錯誤在系統(tǒng)中預(yù)料是會發(fā)生的，但僅僅是因為有無效的輸入而并不意味著代碼中有缺陷。錯誤處理應(yīng)該與缺陷尋找分開來。錯誤使用斷言的一個典型例子是，在試圖打開一個文件用于讀取時去檢查文件的指針，如圖4所示。

圖4：ASSERT的不當(dāng)使用

讀者可以清楚地看到，試圖打開文件的結(jié)果與文件系統(tǒng)的狀態(tài)和用戶數(shù)據(jù)有關(guān)，而與代碼中的缺陷一點關(guān)系也沒有。開發(fā)人員應(yīng)該編寫錯誤處理程序，而不是用斷言，以便在文件不存在時，錯誤處理程序可以用一些默認可用數(shù)據(jù)來創(chuàng)建它，以便后續(xù)代碼繼續(xù)操作。

技巧5：ASSERT僅對開發(fā)有意義，不能用于生產(chǎn)

開發(fā)ASSERT宏的原始意圖是在開發(fā)過程中啟用它，在后面生產(chǎn)時要禁用。可以用NDEBUG宏激活和禁用ASSERT。正確實施的斷言在被禁用后應(yīng)該對嵌入式系統(tǒng)基本沒有影響。

問題是，如果測試是在斷言啟用的情況下進行的(為了捕捉任何缺陷，應(yīng)該這樣做)，那么現(xiàn)在禁用斷言將導(dǎo)致交付的產(chǎn)品與測試的產(chǎn)品處于不同的狀態(tài)。斷言確實會占用一些代碼空間，但更重要的是，它們需要占用少量的時鐘周期來評估它們的布爾表達式。禁用ASSERT可能對具有有限資源的裸機系統(tǒng)的執(zhí)行時序產(chǎn)生很大影響，從而導(dǎo)致在生產(chǎn)系統(tǒng)中產(chǎn)生新的缺陷。開發(fā)團隊需要判斷是否值得冒關(guān)閉斷言的風(fēng)險。

一種替代方案是保留斷言在激活狀態(tài)，而將它們的輸出重定向到一個系統(tǒng)日志。這樣可以確保任何揮之不去的缺陷很容易被識別，而且能避免中止系統(tǒng)的運行，而中止系統(tǒng)可不是明智之舉。

技巧6：不允許斷言有副作用

ASSERT的默認實現(xiàn)允許開發(fā)人員包含一段可執(zhí)行代碼作為布爾表達式的一部分。舉例來說，一個狀態(tài)變量可以被實現(xiàn)為表達式的一部分并傳遞給ASSERT。但如果傳遞給ASSERT的表達式有副作用，也就是說，它會改變嵌入式系統(tǒng)的狀態(tài)，那么禁用斷言將改變系統(tǒng)的行為。開發(fā)人員應(yīng)該確保他們的表達式?jīng)]有副作用，否則他們需要冒險在系統(tǒng)中增加只針對產(chǎn)品代碼喚醒的休眠時間缺陷。

技巧7：斷言應(yīng)該占代碼的1%至3%

每個開發(fā)人員對于代碼庫(Code Base)中應(yīng)該有多少個斷言都有自己的主見。大家一致同意的一個數(shù)字是，代碼庫中的斷言占比應(yīng)該大于0。斷言為開發(fā)人員提供了一種在代碼庫中發(fā)生缺陷的時刻發(fā)現(xiàn)它的好方法。調(diào)試是在開發(fā)嵌入式系統(tǒng)中最浪費時間并令人沮喪的事情之一。不管開發(fā)人員認可的占比是1%、3%還是5%，使用斷言肯定對你有利，并會使開發(fā)嵌入式軟件變得多少有些趣味。

技巧8：將斷言用作可執(zhí)行代碼注釋

斷言可以生成極好的注釋!編寫出色的表達式可以確切地告訴開發(fā)人員在代碼的某個給定點應(yīng)該預(yù)料發(fā)生什么事情。開發(fā)人員應(yīng)該做好他們斷言的架構(gòu)，幫助人們更清楚地理解系統(tǒng)中發(fā)生的事情，進而幫助減少缺陷。

小結(jié)

斷言是一種出色的工具，但有太多的嵌入式軟件開發(fā)人員忽視了這一工具。本文討論的八個技巧只是如何正確使用斷言的冰山一角。接下來讀者就可以在測試平臺中建立和開始使用斷言，并研究它們在實際的嵌入式系統(tǒng)中是如何工作的。