【干貨分享】嵌入式C編程之錯(cuò)誤處理(附代碼例子)
前言
本文主要總結(jié)嵌入式系統(tǒng)C語言編程中,主要的錯(cuò)誤處理方式。文中涉及的代碼運(yùn)行環(huán)境如下:一、錯(cuò)誤概念
1.1 錯(cuò)誤分類
從嚴(yán)重性而言,程序錯(cuò)誤可分為致命性和非致命性兩類。對(duì)于致命性錯(cuò)誤,無法執(zhí)行恢復(fù)動(dòng)作,最多只能在用戶屏幕上打印出錯(cuò)消息或?qū)⑵鋵懭肴罩疚募缓蠼K止程序;而對(duì)于非致命性錯(cuò)誤,多數(shù)本質(zhì)上是暫時(shí)的(如資源短缺),一般恢復(fù)動(dòng)作是延遲一些時(shí)間后再次嘗試。從交互性而言,程序錯(cuò)誤可分為用戶錯(cuò)誤和內(nèi)部錯(cuò)誤兩類。用戶錯(cuò)誤呈現(xiàn)給用戶,通常指明用戶操作上的錯(cuò)誤;而程序內(nèi)部錯(cuò)誤呈現(xiàn)給程序員(可能攜帶用戶不可接觸的數(shù)據(jù)細(xì)節(jié)),用于查錯(cuò)和排障。
應(yīng)用程序開發(fā)者可決定恢復(fù)哪些錯(cuò)誤以及如何恢復(fù)。例如,若磁盤已滿,可考慮刪除非必需或已過期的數(shù)據(jù);若網(wǎng)絡(luò)連接失敗,可考慮短時(shí)間延遲后重建連接。選擇合理的錯(cuò)誤恢復(fù)策略,可避免應(yīng)用程序的異常終止,從而改善其健壯性。
1.2 處理步驟
錯(cuò)誤處理即處理程序運(yùn)行時(shí)出現(xiàn)的任何意外或異常情況。典型的錯(cuò)誤處理包含五個(gè)步驟:
-
程序執(zhí)行時(shí)發(fā)生軟件錯(cuò)誤。該錯(cuò)誤可能產(chǎn)生于被底層驅(qū)動(dòng)或內(nèi)核映射為軟件錯(cuò)誤的硬件響應(yīng)事件(如除零)。
-
以一個(gè)錯(cuò)誤指示符(如整數(shù)或結(jié)構(gòu)體)記錄錯(cuò)誤的原因及相關(guān)信息。
-
程序檢測(cè)該錯(cuò)誤(讀取錯(cuò)誤指示符,或由其主動(dòng)上報(bào));
-
程序決定如何處理錯(cuò)誤(忽略、部分處理或完全處理);
-
恢復(fù)或終止程序的執(zhí)行。
int func()
{
int bIsErrOccur = 0;
//do something that might invoke errors
if(bIsErrOccur) //Stage 1: error occurred
return -1; //Stage 2: generate error indicator
//...
return 0;
}
int main(void)
{
if(func() != 0) //Stage 3: detect error
{
//Stage 4: handle error
}
//Stage 5: recover or abort
return 0;
}
調(diào)用者可能希望函數(shù)返回成功時(shí)表示完全成功,失敗時(shí)程序恢復(fù)到調(diào)用前的狀態(tài)(但被調(diào)函數(shù)很難保證這點(diǎn))。
二 、錯(cuò)誤傳遞
2.1 返回值和回傳參數(shù)
C語言通常使用返回值來標(biāo)志函數(shù)是否執(zhí)行成功,調(diào)用者通過if等語句檢查該返回值以判斷函數(shù)執(zhí)行情況。常見的幾種調(diào)用形式如下:
if((p = malloc(100)) == NULL)//...
if((c = getchar()) == EOF)
//...
if((ticks = clock()) < 0)
//...
Unix系統(tǒng)調(diào)用級(jí)函數(shù)(和一些老的Posix函數(shù))的返回值有時(shí)既包括錯(cuò)誤代碼也包括有用結(jié)果。因此,上述調(diào)用形式可在同一條語句中接收返回值并檢查錯(cuò)誤(當(dāng)執(zhí)行成功時(shí)返回合法的數(shù)據(jù)值)。
返回值方式的好處是簡便和高效,但仍存在較多問題:
- 代碼可讀性降低
- 質(zhì)量降級(jí)
- 信息有限
char *IntToAscii(int dwVal, char *pszRes, int dwRadix)
{
if(NULL == pszRes)
return "Arg2Null";
if((dwRadix < 2) || (dwRadix > 36))
return "Arg3OutOfRange";
//...
return pszRes;
}
- 定義沖突
- 無約束性
新的Posix函數(shù)返回值只攜帶狀態(tài)和異常信息,并通過參數(shù)列表中的指針回傳有用的結(jié)果?;貍鲄?shù)綁定到相應(yīng)的實(shí)參上,因此調(diào)用者不可能完全忽略它們。通過回傳參數(shù)(如結(jié)構(gòu)體指針)可返回多個(gè)值,也可攜帶更多的信息。
綜合返回值和回傳參數(shù)的優(yōu)點(diǎn),可對(duì)Get類函數(shù)采用返回值(含有用結(jié)果)方式,而對(duì)Set類函數(shù)采用返回值 回傳參數(shù)方式。對(duì)于純粹的返回值,可按需提供如下解析接口:
typedef enum{
S_OK, //成功
S_ERROR, //失敗(原因未明確),通用狀態(tài)
S_NULL_POINTER, //入?yún)⒅羔槥镹ULL
S_ILLEGAL_PARAM, //參數(shù)值非法,通用
S_OUT_OF_RANGE, //參數(shù)值越限
S_MAX_STATUS //不可作為返回值狀態(tài),僅作枚舉最值使用
}FUNC_STATUS;
#define RC_NAME(eRetCode) \
((eRetCode) == S_OK ? "Success" : \
((eRetCode) == S_ERROR ? "Failure" : \
((eRetCode) == S_NULL_POINTER ? "NullPointer" : \
((eRetCode) == S_ILLEGAL_PARAM ? "IllegalParas" : \
((eRetCode) == S_OUT_OF_RANGE ? "OutOfRange" : \
"Unknown")))))
當(dāng)返回值錯(cuò)誤碼來自下游模塊時(shí),可能與本模塊錯(cuò)誤碼沖突。此時(shí),建議不要將下游錯(cuò)誤碼直接向上傳遞,以免引起混亂。若允許向終端或文件輸出錯(cuò)誤信息,則可詳細(xì)記錄出錯(cuò)現(xiàn)場(chǎng)(如函數(shù)名、錯(cuò)誤描述、參數(shù)取值等),并轉(zhuǎn)換為本模塊定義的錯(cuò)誤碼再向上傳遞。
2.2 全局狀態(tài)標(biāo)志(errno)
Unix系統(tǒng)調(diào)用或某些C標(biāo)準(zhǔn)庫函數(shù)出錯(cuò)時(shí),通常返回一個(gè)負(fù)值,并設(shè)置全局整型變量errno為一個(gè)含有錯(cuò)誤信息的值。例如,open函數(shù)出錯(cuò)時(shí)返回-1,并設(shè)置errno為EACESS(權(quán)限不足)等值。
C標(biāo)準(zhǔn)庫頭文件Linux系統(tǒng)中,出錯(cuò)常量在errno(3)手冊(cè)頁中列出,可通過man 3 errno命令查看。除EAGAIN和EWOULDBLOCK取值相同外,POSIX.1指定的所有出錯(cuò)編號(hào)取值均不同。
Posix和ISO C將errno定義為一個(gè)可修改的整型左值(lvalue),可以是包含出錯(cuò)編號(hào)的一個(gè)整數(shù),或是一個(gè)返回出錯(cuò)編號(hào)指針的函數(shù)。以前使用的定義為:
extern int errno;
但在多線程環(huán)境中,多個(gè)線程共享進(jìn)程地址空間,每個(gè)線程都有屬于自己的局部errno(thread-local)以避免一個(gè)線程干擾另一個(gè)線程。例如,Linux支持多線程存取errno,將其定義為:
extern int *__errno_location(void);
#define errno (*__errno_location())
函數(shù)__errno_location在不同的庫版本下有不同的定義,在單線程版本中,直接返回全局變量errno的地址;而在多線程版本中,不同線程調(diào)用__errno_location返回的地址則各不相同。
C運(yùn)行庫中主要在math.h(數(shù)學(xué)運(yùn)算)和stdio.h(I/O操作)頭文件聲明的函數(shù)中使用errno。
使用errno時(shí)應(yīng)注意以下幾點(diǎn):
- 函數(shù)返回成功時(shí),允許其修改errno。
因此,調(diào)用庫函數(shù)時(shí)應(yīng)先檢測(cè)作為錯(cuò)誤指示的返回值。僅當(dāng)函數(shù)返回值指明出錯(cuò)時(shí),才檢查errno值:
//調(diào)用庫函數(shù)
if(返回錯(cuò)誤值)
//檢查errno
-
庫函數(shù)返回失敗時(shí),不一定會(huì)設(shè)置errno,取決于具體的庫函數(shù)。
-
errno在程序開始時(shí)設(shè)置為0,任何庫函數(shù)都不會(huì)將errno再次清零。
- 使用errno前,應(yīng)避免調(diào)用其他可能設(shè)置errno的庫函數(shù)。如:
{
printf("somecall() failed\n");
if(errno == ...) { ... }
}
somecall()函數(shù)出錯(cuò)返回時(shí)設(shè)置errno。但當(dāng)檢查errno時(shí),其值可能已被printf()函數(shù)改變。若要正確使用somecall()函數(shù)設(shè)置的errno,須在調(diào)用printf()函數(shù)前保存其值:
if (somecall() == -1)
{
int dwErrSaved = errno;
printf("somecall() failed\n");
if(dwErrSaved == ...) { ... }
}
類似地,當(dāng)在信號(hào)處理程序中調(diào)用可重入函數(shù)時(shí),應(yīng)在其前保存其后恢復(fù)errno值。
-
使用現(xiàn)代版本的C庫時(shí),應(yīng)包含使用
頭文件;在非常老的Unix 系統(tǒng)中,可能沒有該頭文件,此時(shí)可手工聲明errno(如extern int errno)。
#include
char *strerror(int errnum);
該函數(shù)將errnum(即errno值)映射為一個(gè)出錯(cuò)信息字符串,并返回指向該字符串的指針。可將出錯(cuò)字符串和其它信息組合輸出到用戶界面,或保存到日志文件中,如通過fprintf(fp, "somecall failed(%s)", strerror(errno))將錯(cuò)誤消息打印到fp指向的文件中。
perror函數(shù)將當(dāng)前errno對(duì)應(yīng)的錯(cuò)誤消息的字符串輸出到標(biāo)準(zhǔn)錯(cuò)誤(即stderr或2)上。
#include
void perror(const char *msg);
該函數(shù)首先輸出由msg指向的字符串(用戶自己定義的信息),后面緊跟一個(gè)冒號(hào)和空格,然后是當(dāng)前errno值對(duì)應(yīng)的錯(cuò)誤類型描述,最后是一個(gè)換行符。未使用重定向時(shí),該函數(shù)輸出到控制臺(tái)上;若將標(biāo)準(zhǔn)錯(cuò)誤輸出重定向到/dev/null,則看不到任何輸出。
注意,perror()函數(shù)中errno對(duì)應(yīng)的錯(cuò)誤消息集合與strerror()相同。但后者可提供更多定位信息和輸出方式。
兩個(gè)函數(shù)的用法示例如下:
int main(int argc, char** argv)
{
errno = 0;
FILE *pFile = fopen(argv[1], "r");
if(NULL == pFile)
{
printf("Cannot open file '%s'(%s)!\n", argv[1], strerror(errno));
perror("Open file failed");
}
else
{
printf("Open file '%s'(%s)!\n", argv[1], strerror(errno));
perror("Open file");
fclose(pFile);
}
return 0;
}
執(zhí)行結(jié)果為:
[wangxiaoyuan_@localhost test1]$ ./GlbErr /sdb1/wangxiaoyuan/linux_test/test1/test.c
Open file '/sdb1/wangxiaoyuan/linux_test/test1/test.c'(Success)!
Open file: Success
[wangxiaoyuan_@localhost test1]$ ./GlbErr NonexistentFile.h
Cannot open file 'NonexistentFile.h'(No such file or directory)!
Open file failed: No such file or directory
[wangxiaoyuan_@localhost test1]$ ./GlbErr NonexistentFile.h > test
Open file failed: No such file or directory
[wangxiaoyuan_@localhost test1]$ ./GlbErr NonexistentFile.h 2> test
Cannot open file 'NonexistentFile.h'(No such file or directory)!
也可仿照errno的定義和處理,定制自己的錯(cuò)誤代碼:
int *_fpErrNo(void)
{
static int dwLocalErrNo = 0;
return