利用函數(shù)參數(shù)和返回值提高嵌入式軟件質(zhì)量

利用函數(shù)參數(shù)和返回值提高嵌入式軟件質(zhì)量

　引 言

　　提高軟件代碼的質(zhì)量是每一個(gè)軟件設(shè)計(jì)者都必須考慮的問(wèn)題，這涉及軟件的有效性和經(jīng)濟(jì)價(jià)值?；?a href="http://www.ttokpm.com/v/tag/2447/" target="_blank">嵌入式系統(tǒng)的軟件設(shè)計(jì)多數(shù)是以實(shí)時(shí)操作系統(tǒng)為平臺(tái)，這和傳統(tǒng)的以WindOWS操作系統(tǒng)為平臺(tái)的程序設(shè)計(jì)有很大的不同。前者要求對(duì)操作系統(tǒng)有更加深入的了解，要求使用者對(duì)自己的處理器和編譯器工作原理有相當(dāng)?shù)睦斫猓軌蚓帉?xiě)一定量的移植代碼實(shí)現(xiàn)操作系統(tǒng)和底層硬件的連接。μC／OS—II是一種源代碼公開(kāi)的占先式實(shí)時(shí)操作系統(tǒng)內(nèi)核，本文主要結(jié)合μC／OS—II的系統(tǒng)函數(shù)的應(yīng)用，說(shuō)明利用μC／OS—II系統(tǒng)函數(shù)的參數(shù)和返回值來(lái)提高程序設(shè)計(jì)效率和代碼質(zhì)量的方法。

　　1 參數(shù)和返回值分類(lèi)

　　通過(guò)對(duì)μC／0S—II的學(xué)習(xí)和研究，可以發(fā)現(xiàn)它提供的系統(tǒng)函數(shù)大多是用標(biāo)準(zhǔn)C語(yǔ)言寫(xiě)的；受C語(yǔ)言語(yǔ)法規(guī)則的限制，這些函數(shù)只有一個(gè)返回值。為了在使用μC／0SII的系統(tǒng)函數(shù)時(shí)得到更多的狀態(tài)信息，將狀態(tài)信息保存在函數(shù)參數(shù)中。這樣，μC／OS—II系統(tǒng)函數(shù)的參數(shù)可以分為兩類(lèi)：第一類(lèi)是普通的形式參數(shù)，這類(lèi)參數(shù)符合傳統(tǒng)的使用方法，主要傳遞實(shí)際參數(shù)的值，起到數(shù)值傳遞的作用；第二類(lèi)形式參數(shù)在使用時(shí)，不傳遞有效數(shù)值，僅是一個(gè)變量。系統(tǒng)函數(shù)在執(zhí)行時(shí)產(chǎn)生的狀態(tài)信息就保存在第二類(lèi)參數(shù)里，在系統(tǒng)函數(shù)調(diào)用結(jié)束時(shí)通過(guò)這類(lèi)參數(shù)的值來(lái)查看系統(tǒng)函數(shù)執(zhí)行過(guò)程中產(chǎn)生的狀態(tài)信息。

　　本文以函數(shù)0SSemPend()為例來(lái)介紹。這個(gè)函數(shù)沒(méi)有返回值，它每個(gè)形式參數(shù)的具體含義見(jiàn)參考文獻(xiàn)，這里不做具體的描述。其參數(shù)可歸為上述的兩類(lèi)：OS_EVENT*pevent和INTl6U timeout為第一類(lèi)，應(yīng)用程序中的實(shí)際參數(shù)要給予它們具體的數(shù)值；INT8U*err為第二類(lèi)，應(yīng)用程序中的實(shí)際參數(shù)不需要給出具體的數(shù)值，在函數(shù)代碼執(zhí)行時(shí)，會(huì)根據(jù)不同的情況給INT8U*err賦值，這個(gè)值反映了函數(shù)的執(zhí)行情況。如OSSemPend()函數(shù)的應(yīng)用所示。

　　2 函數(shù)參數(shù)和返回值中的狀態(tài)信息

　　μC／OS—II的系統(tǒng)函數(shù)根據(jù)實(shí)際情況可以分為沒(méi)有參數(shù)和返回值的函數(shù)、有參數(shù)沒(méi)有返回值的函數(shù)和既有參數(shù)又有返回值的函數(shù)。在這里不討論第一種情況，本文主要研究的是第二和第三種情況。如前所述，μC／OS—II為了增加系統(tǒng)函數(shù)執(zhí)行產(chǎn)生的狀態(tài)信息和返回值，將狀態(tài)信息放到函數(shù)的參數(shù)中。筆者通過(guò)對(duì)μC／0S—II的系統(tǒng)函數(shù)的研究發(fā)現(xiàn)，這些函數(shù)并不是都將狀態(tài)信息放到函數(shù)的參數(shù)中。有的也放到返回值中，如OSsemQtJery()函數(shù)，就是用返回值傳遞的狀態(tài)信息，而用函數(shù)的參數(shù)傳遞的有效信息。這些狀態(tài)信息反映了在使用μC／OS—II的系統(tǒng)函數(shù)時(shí)出現(xiàn)的問(wèn)題，通過(guò)讀這些狀態(tài)可以知道系統(tǒng)函數(shù)執(zhí)行的情況。因此，從安全的角度來(lái)說(shuō)，在使用這些系統(tǒng)函數(shù)時(shí)應(yīng)該讀出所有狀態(tài)信息，并且根據(jù)狀態(tài)的不同給出相應(yīng)的處理指令。按照這種思路，對(duì)OSSemPend()函數(shù)的應(yīng)用的改進(jìn)如下：

　　可以看到，在調(diào)用系統(tǒng)服務(wù)函數(shù)OSSemPend()時(shí)，臨時(shí)變量err作為實(shí)際參數(shù)傳遞給OSSemPend()。在執(zhí)行這個(gè)函數(shù)后，err這個(gè)臨時(shí)變量就包含了函數(shù)執(zhí)行時(shí)產(chǎn)生的狀態(tài)信息。這些狀態(tài)信息使用常量而不用一個(gè)常數(shù)，是為了增加軟件的可讀性和通用性。具體的定義和含義如表1所列，其中前兩種返回值是正常的：第一種是有信號(hào)可用時(shí)的情況，進(jìn)行正常的處理；第二種是在規(guī)定的時(shí)間內(nèi)沒(méi)有信號(hào)到來(lái)，要做超時(shí)處理。后面三種情況是人為錯(cuò)誤造成的。在調(diào)用OSSemPend()系統(tǒng)函數(shù)后要對(duì)這個(gè)包含狀態(tài)信息的變量進(jìn)行分析處理，過(guò)程如上述程序所示，由于篇幅關(guān)系，這里只是用簡(jiǎn)單的一句話(huà)來(lái)代表處理過(guò)程。

　　3 狀態(tài)信息的使用

　　在調(diào)用μC／OS—II的每個(gè)系統(tǒng)函數(shù)時(shí)，只要被調(diào)用的函數(shù)提供狀態(tài)信息，都應(yīng)該對(duì)這些狀態(tài)信息進(jìn)行分析和處理。專(zhuān)業(yè)軟件設(shè)計(jì)者信奉這樣一個(gè)道理：“編寫(xiě)無(wú)錯(cuò)代碼的最好方法是把防止錯(cuò)誤放在第一位”。以調(diào)用μC／OS—II的系統(tǒng)函數(shù)OSSemPend()為例，用戶(hù)不需要去改動(dòng)OSSemPend()函數(shù)的代碼，假設(shè)這部分內(nèi)容是沒(méi)有什么問(wèn)題的?，F(xiàn)在我們要做的是檢測(cè)這個(gè)函數(shù)執(zhí)行時(shí)的狀態(tài)，也就是它產(chǎn)生的出錯(cuò)信息。這個(gè)函數(shù)返回三種結(jié)果說(shuō)明用戶(hù)使用的錯(cuò)誤，如表1所列：0S_ERR_EVENT_TYPE表示用戶(hù)在調(diào)用OSSemPend()函數(shù)時(shí)提供的指針數(shù)據(jù)不是指向信號(hào)量的，發(fā)生了類(lèi)型錯(cuò)誤；OS_ERR_PEVENT_NULL表示用戶(hù)提供的用作實(shí)際參數(shù)的指針是一個(gè)空指針；OS_ERR_PEND_ISR表示用戶(hù)在中斷服務(wù)程序中調(diào)用了OSSemPend()函數(shù)；這三種狀態(tài)錯(cuò)誤是在軟件設(shè)計(jì)階段由于用戶(hù)粗心或者對(duì)μC／OS—II系統(tǒng)函數(shù)不了解而導(dǎo)致的。只要用戶(hù)在設(shè)計(jì)過(guò)程中小心謹(jǐn)慎，這類(lèi)錯(cuò)誤可以避免。但是，從防止錯(cuò)誤的角度來(lái)考慮，對(duì)這些錯(cuò)誤的狀態(tài)進(jìn)行檢測(cè)和處理是必要的，這樣在錯(cuò)誤發(fā)生時(shí)錯(cuò)誤處理程序會(huì)給出簡(jiǎn)單的提示甚至對(duì)錯(cuò)誤進(jìn)行修改。錯(cuò)誤處理程序防止在程序調(diào)試過(guò)程中反復(fù)閱讀程序代碼，避免了花費(fèi)很大的精力去查找錯(cuò)誤，提高了軟件設(shè)計(jì)效率。

按照以上方案設(shè)計(jì)出的嵌入式系統(tǒng)軟件可以認(rèn)為是一個(gè)理想的編譯器。現(xiàn)在考慮一下，倘若編譯程序能夠正確地指出代碼中的所有問(wèn)題，那相應(yīng)程序的錯(cuò)誤情況會(huì)怎樣?這不單指語(yǔ)法錯(cuò)誤，還包括程序中的任何問(wèn)題，不管它多么隱蔽。顯然，現(xiàn)在所有的編譯器都無(wú)法實(shí)現(xiàn)這種功能，所以要對(duì)編譯器的功能進(jìn)行擴(kuò)展。這種設(shè)計(jì)思路可以認(rèn)為是：軟件設(shè)計(jì)者要設(shè)計(jì)出編譯器的擴(kuò)展功能，使得在進(jìn)行軟件設(shè)計(jì)時(shí)，編譯器能夠自己檢查錯(cuò)誤。如果能夠做到，軟件設(shè)計(jì)的勞動(dòng)量將大大降低。

　　4 軟件的調(diào)試版與交付版

　　前面的改進(jìn)程序?qū)SSemPend()函數(shù)調(diào)用產(chǎn)生的所有可能狀態(tài)進(jìn)行了處理，而這部分代碼中的大部分都是冗余代碼，為的是便于軟件的設(shè)計(jì)和調(diào)試。使用實(shí)時(shí)操作系統(tǒng)μC／0S—II進(jìn)行嵌入式軟件設(shè)計(jì)，用到的系統(tǒng)函數(shù)當(dāng)然不止OSSemPend()一個(gè)，如果每個(gè)函數(shù)調(diào)用結(jié)束后都像程序中那樣處理，代碼的空間會(huì)迅速增加，程序的效率則會(huì)大大降低。

　　為了解決這個(gè)問(wèn)題，首先考慮，如果非常謹(jǐn)慎小心進(jìn)行程序設(shè)計(jì)，多數(shù)的狀態(tài)檢測(cè)處理過(guò)程就可以省略。之所以對(duì)每個(gè)狀態(tài)信息進(jìn)行檢測(cè)處理是為了提高軟件設(shè)計(jì)調(diào)試的效率。在軟件調(diào)試通過(guò)后，有些狀態(tài)信息的檢測(cè)就沒(méi)有必要了。這就像乘坐飛機(jī)出行前要買(mǎi)保險(xiǎn)，等航班到達(dá)目的地后，保險(xiǎn)就沒(méi)有什么用處了。軟件最終是作為一個(gè)產(chǎn)品提供給客戶(hù)的。這個(gè)產(chǎn)品是最終版本(當(dāng)然還會(huì)不斷升級(jí))。在進(jìn)行產(chǎn)品設(shè)計(jì)時(shí)會(huì)有一個(gè)調(diào)試版本，這個(gè)調(diào)試版要貫穿整個(gè)軟件的生存周期。調(diào)試版是為了軟件的設(shè)計(jì)、調(diào)試和升級(jí)使用，不會(huì)提供給用戶(hù)，更不會(huì)出現(xiàn)在產(chǎn)品中。

　　具體到嵌入式系統(tǒng)軟件設(shè)計(jì)問(wèn)題，仍然以調(diào)用OS—SemPend()函數(shù)的代碼為例來(lái)說(shuō)明問(wèn)題。調(diào)用OSSem—

　　通過(guò)觀察上述程序和前面的改進(jìn)發(fā)現(xiàn)，本段程序中加了幾個(gè)條件編譯指令。如果沒(méi)有定義TEST標(biāo)志，則有一部分代碼將不會(huì)被編譯，這就是交付版軟件。反之，如果定義了TEST標(biāo)志，則表示為調(diào)試版，所有的指令代碼都會(huì)被編譯。通過(guò)比較這兩個(gè)版本看到：交付版的代碼比調(diào)試版的代碼在數(shù)量上大大減少。而且通過(guò)分析知道，在軟件調(diào)試通過(guò)以后，就不存在OS_ERR_EVENT_TYPE、0S_ERR_PEND_ISR和OS_ERR_PEVENT_NULL的錯(cuò)誤了，這兩個(gè)版本實(shí)現(xiàn)的功能完全相同，這部分代碼確實(shí)沒(méi)有編譯的必要了。

　　結(jié) 語(yǔ)

　　嵌入式系統(tǒng)軟件設(shè)計(jì)過(guò)程中，大部分場(chǎng)合會(huì)用到嵌入式實(shí)時(shí)操作系統(tǒng)。用戶(hù)在保證自已設(shè)計(jì)代碼質(zhì)量的前提下，還要充分考慮調(diào)用系統(tǒng)函數(shù)時(shí)產(chǎn)生的狀態(tài)信息，并進(jìn)行適當(dāng)?shù)奶幚?。只有這樣，才能夠提高軟件的設(shè)計(jì)效率，縮短設(shè)計(jì)周期。