在上一篇文章中,關于斷言的簡介,我們討論了如何使用斷言來捕獲錯誤,并且不應將斷言用于錯誤處理。
請記住,斷言是:
“除非程序中有一個錯誤,否則在程序中的特定點上的布爾表達式將是真實的?!?
在今天的帖子中,我們將研究您通常如何設置并使用斷言來捕獲錯誤。
設置并使用斷言
建立基本斷言是相對瑣碎的,但是即使essert.h是C標準的一部分,它也可能會因一個開發(fā)環(huán)境而異。如果您要檢查不同工具鏈中的斷言,您會注意到斷言的實現(xiàn)可能會大不相同。這使我們進入了使用主張的第一步,該斷言是檢查您的essert.h模塊。例如,讓我們看看Arm的Keil MDK中的sustert.h模塊的樣子?;ㄒ稽c時間檢查下面的圖1中的代碼。
圖1:keil MDK的sustert.h頭文件
所有這些代碼都控制可用于主張宏的不同定義!我們應該在這里注意到幾件重要的事情。
首先,我們可以控制斷言宏是否沒有替換,基本上是從代碼庫中編譯的,或者我們可以定義一個版本,如果斷言失敗,該版本將調用函數。如果我們想禁用主張,我們需要創(chuàng)建符號ndebug。這通常是通過編譯器設置完成的。
接下來,如果我們使用的是keil,我們還必須確保定義__do_not_link_promise_with_assert。同樣,這通常是在編譯器設置符號表中完成的。最后,在這一點上,我們可以提出將用于我們主張的定義:
定義斷言(e)(e?(void)0:__clibns __aeabi_assert(“ e”,__file__,__line__))
與您在STM32Cubeide等海灣合作委員會工具中發(fā)現(xiàn)的東西相比,這一切都非常復雜。您可以看到圖2中的區(qū)別。
圖2:STM32Cubeide的essert.h標題定義
請注意,如果斷言失敗相似但截然不同,則調用的功能。這就是為什么我們需要花一些時間來回顧我們的工具鏈的期望。這很重要,因為我們必須定義我們的assert_failed函數,我們需要知道該稱呼它,以便將其正確鏈接到項目。
實施主張
一旦我們找到了斷言的實現(xiàn),我們就需要為函數創(chuàng)建定義。 assert.h創(chuàng)建聲明,但沒有定義該函數的作用,就不會有任何有用。我們需要做四件事,其中包括:
· 復制聲明并將聲明粘貼到源模塊中
· 將新聲明變成函數定義
· 輸出一些東西,以便開發(fā)人員知道斷言失敗
· 阻止程序執(zhí)行
對于使用KEIL的開發(fā)人員,他們的斷言失敗的功能將看起來像圖3中的代碼。
圖3:keil“ assert_failed”功能定義
您可以看到紅色,我從essert.h復制并粘貼了聲明,并將其變成函數定義。在藍色中,我正在通過微控制器的UARTS打印一條消息,以通知開發(fā)人員斷言失敗。打印出來的典型消息是通知開發(fā)人員的聲明失敗和行號。這告訴開發(fā)人員的問題在哪里。
這使我們變得有趣。您可以創(chuàng)建非常復雜的斷言,以測試單個斷言中的多個條件,但是您必須做更多的工作來確定出了什么問題。通常,我的斷言很簡單,最多可以在一個斷言中檢查一個和三個條件。在大多數情況下,我將只檢查一個條件,如有必要,我將使用多個斷言。它節(jié)省了試圖解碼條件的哪一部分失敗的時間和麻煩。
最后,一旦我們通知了開發(fā)人員出現(xiàn)問題,我們想以相同的方式停止程序執(zhí)行。綠色突出顯示了上面的循環(huán)是一種做到這一點的方法。此時,系統(tǒng)“停止”執(zhí)行任何新代碼,只是坐在循環(huán)中。這是可以做到的,但是從IDE的角度來看,這并沒有表明開發(fā)人員出現(xiàn)了問題。如果我的調試器可以處理閃存斷點,或者我將使用匯編指令__bkpt停止處理器,我更喜歡在此功能中放置斷點。那時,IDE將停止并突出顯示代碼線,告訴我我有問題。
觸發(fā)斷言
一旦實現(xiàn)了斷言功能,我將始終進行測試,以確保它以我期望的方式工作。最好的方法是簡單地創(chuàng)建一個在應用程序中某個地方失敗的斷言。一個很好的例子是將以下斷言放在某個地方:
斷言(1> 2);
此斷言永遠不會是真實的,一旦編譯和執(zhí)行代碼,我們可能會從應用程序中看到串行輸出,看起來像圖4。
圖4:顯示已觸發(fā)斷言的應用程序輸出日志
如您所見,當我們遇到斷言時,我們的新斷言失敗的功能會告訴我們斷言失敗了。在這種情況下,在第17行中的文件中,它是在文件tsk_100ms.c中。您無法對缺陷隱藏在代碼中的位置比這更具體!
采取您的下一步
現(xiàn)在您知道了如何實施基本斷言,必須通過使用它們來建立自己的專業(yè)知識。
繼續(xù)在有效地使用主張方面建立您的專業(yè)知識:
· 查看您的essert.h頭文件,以查看工具鏈中的斷言是如何實現(xiàn)的。
· 創(chuàng)建您的斷言實現(xiàn)。首先保持簡單。
· 使用一些基本測試用例測試您的斷言實現(xiàn)。
當您深入了解斷言時,您會發(fā)現(xiàn)它可以幫助您快速捕獲錯誤,從而產生更強大的固件。不過,要警告,您可以提出更多的主張。例如,有實時斷言和靜態(tài)斷言。
在下一篇文章中,我將向您展示我認為是實時斷言的內容,以及如果您在應用程序中具有實時組件(例如電動機),它們如何幫助您找到錯誤而不會引起安全問題。