Linux用日志打印的方式調(diào)試程序

前言
????? 一般來(lái)說(shuō)，初學(xué)編程者所寫(xiě)的第一個(gè)程序，就是使用printf打印“Hello world”。其實(shí)printf的功效遠(yuǎn)不只這些，在程序調(diào)試方面，printf也有非常大的用處。?
????? “蝸蝸”在接觸Linux driver開(kāi)發(fā)之前，學(xué)習(xí)過(guò)桌面程序開(kāi)發(fā)（如Turbo C、Visual C等），也從事了一段時(shí)間的嵌入式軟件開(kāi)發(fā)。這些開(kāi)發(fā)有一個(gè)共同點(diǎn)，對(duì)調(diào)試工具非常依賴，如桌面程序的Debugger（調(diào)試器）、嵌入式開(kāi)發(fā)的仿真器（JTAG等）。還依稀記得，剛工作時(shí)，為了插空使用仿真器，不得不趁周末別人不工作時(shí)加班使用。直到后來(lái)從事Linux driver開(kāi)發(fā)、見(jiàn)識(shí)到了printk的魅力之后，多年來(lái)，就再也沒(méi)有使用過(guò)仿真器或者調(diào)試器了。?
????? 下面我就總結(jié)一下使用日志打印輔助debug的心得。?
日志打印的注意事項(xiàng)
????? 在編寫(xiě)程序后，我們可以隨手在需要的地方加入打印信息，同時(shí)需要考慮如下事項(xiàng)：
????? 1. 日志輸出是有代價(jià)的，特別是在嵌入式系統(tǒng)，或者對(duì)執(zhí)行時(shí)序要求較高的應(yīng)用場(chǎng)景。因此
????????? a) 只有在需要的地方加入，不能濫用
????????? b) 一定要有一個(gè)全局的開(kāi)關(guān)，在不需要或者產(chǎn)品發(fā)布的時(shí)候，關(guān)閉輸出，或者降低日志輸出的頻率
????? 2. 日志輸出需要有優(yōu)先級(jí)控制，例如：發(fā)生錯(cuò)誤時(shí)的日志優(yōu)先級(jí)最高，一般都要輸出；一些重要的提示，優(yōu)先級(jí)中等，可能會(huì)在debug版的軟件中打開(kāi)；一些不重要的提示，可能只會(huì)在需要的時(shí)候（例如跟蹤bug）打開(kāi)
????? 3. 不要直接使用printf（或者printk）。日志輸出的目標(biāo)是多樣的，例如通過(guò)printf輸出到屏幕、通過(guò)串口輸出到串口調(diào)試助手、通過(guò)文件操作寫(xiě)入到文件等等。要通過(guò)重定義的方式，將所有的日志輸出指令定義到合適的輸出路徑，當(dāng)需要修改輸出路徑的時(shí)候，只要修改重定義的部分即可。否則需要在整個(gè)代碼中修改，就麻煩了
????? 4. 最好為每個(gè)軟件模塊提供單獨(dú)的日志輸出開(kāi)關(guān)，以增加調(diào)試的靈活性
????? 5. 很多時(shí)候，日志輸出語(yǔ)句，可以部分代替代碼注釋的功能
?
日志打印的實(shí)現(xiàn)
????? 結(jié)合上面的注意事項(xiàng)，我們可以按照如下步驟實(shí)現(xiàn)一個(gè)小型的日志輸出系統(tǒng)。
????? Step1. 新建debug.h（如果只是在PC上使用printf，則只需要一個(gè)頭文件即可。如果有需要文件或者串口操作，可以在這個(gè)基礎(chǔ)上增加debug.c，這里暫時(shí)不再描述）
????? Step2. 定義一個(gè)宏開(kāi)關(guān)，用于控制日志輸出的開(kāi)關(guān)

/*

* debug control, you can switch on (delete 'x' suffix)

* to enable log output and assert mechanism

*/

#define CONFIG_ENABLE_DEBUG

????? Step3. 定義ERR、INFO、DEBUG三個(gè)日志級(jí)別

/*

* debug level,

* if is DEBUG_LEVEL_DISABLE, no log is allowed output,

* if is DEBUG_LEVEL_ERR, only ERR is allowed output,

* if is DEBUG_LEVEL_INFO, ERR and INFO are allowed output,

* if is DEBUG_LEVEL_DEBUG, all log are allowed output,

*/

enum debug_level {

DEBUG_LEVEL_DISABLE = 0,

DEBUG_LEVEL_ERR,

DEBUG_LEVEL_INFO,

DEBUG_LEVEL_DEBUG

};

????? Step4. 如果使用系統(tǒng)的printf，需要包含stdio.h，并將printf重定義為PRINT（無(wú)論是Windows還是Linux，皆是如此，如果是嵌入式平臺(tái)，可以自定義PRINT接口）

/* it can be change to others, such as file operations */

#include

#define PRINT printf

????? Step5. 定義一個(gè)宏，用于定義日志輸出級(jí)別

/*

* the macro to set debug level, you should call it

* once in the files you need use debug system

*/

#define DEBUG_SET_LEVEL(x) static int debug = x

需要在每一個(gè)需要日志輸出的C文件中調(diào)用，如下：

/*

* define the debug level of this file,

* please see 'debug.h' for detail info

*/

DEBUG_SET_LEVEL(DEBUG_LEVEL_ERR);

?
????? Step6. 定義ASSERT、ERR、INFO、DEBUG等宏?

#define ASSERT() \

do { \

PRINT("ASSERT: %s %s %d", \

__FILE__, __FUNCTION__, __LINE__); \

while (1); \

} while (0)

#define ERR(...) \

do { \

if (debug >= DEBUG_LEVEL_ERR) { \

PRINT(__VA_ARGS__); \

} \

} while (0)

…

????? Step7. 在需要日志輸出的C文件中，包含debug.h，并定義所需的日志級(jí)別。就可以在需要的時(shí)候輸出日志信息了

debug_test.c

-----------------------------------------------------

#include "debug.h"

/*

* define the debug level of this file,

* please see 'debug.h' for detail info

*/

DEBUG_SET_LEVEL(DEBUG_LEVEL_ERR);

int main(void) {

ERR("This is a error message\n");

INFO("This is a info message\n");

DEBUG("This is a debug message\n");

ASSERT();

return 0;

}

????? Step8. 可以根據(jù)需要，修改容許輸出的日志級(jí)別

?