一個簡單debug資訊輸出方法

在軟體開發時，經常要在程式碼關鍵地方新增必要除錯資訊跟蹤程式碼執行分支或者引數值，為了除錯和軟體釋出方便，除錯程式碼往往要求做到：
1）在debug時生效，而在釋出時為了控制編譯產物的大小，往往需要去掉debug程式碼；
2）可用通過引數控制debug資訊的輸出等級（型別）；
下面通過一個例子，介紹如何在程式碼中新增debug資訊的方法。
首先，先在公共的標頭檔案中定義一個巨集，比如：

#ifdef DBG
#define DBG_PRINT(Level, Fmt)           \
{                                       \
    if
 
 (Level <= DebugLevel)            \
    {                                   \
        printf Fmt;                     \
    }                                   \
}
#else
    /* no debug information */
    #define DBG_PRINT(Level, Fmt)
#endif

可以看到，這個巨集通過條件編譯#ifdef DBG … #else … #endif控制；另外，巨集通過引數level，對列印內容進行控制；
然後，在外部的Makefile中，通過Makefile引數CFLAGS 進行控制

EXEC = helloworld
OBJS = helloworld.o

\# If you want to debug app, add following line
CFLAGS += -DDBG
CFLAGS += -I./

all: $(EXEC)

$(EXEC): $(OBJS)
    $(CC) $(CFLAGS) $(LDFLAGS) -o [email protected] $(OBJS) $(LDLIBS)

romfs:
    $(ROMFSINST) /sbin/$(EXEC)

install:
    cp -f $(EXEC) $(INSTALL_DIR
 
)/bin

clean:
    rm -f core *~ *.o helloworld*.d

OK，這個debug介面就可以使用了，呼叫這個介面函式的app中，app的程式碼中可以增加引數-d，如下：

while(argc > 0)
if (...)
{
...
}
else if (strncmp(argv[0], "-d", 2) == 0)
        {
            { argc--; argv++; }
            DebugLevel= atoi(argv[0]);
        }

然後在命令呼叫時通過引數-d控制除錯資訊的型別（等級），比如：
#helloworld -d 2
一般的除錯資訊等級可以分為:

\#define DEBUG_OFF                  0
\#define DEBUG_ERROR                1
\#define DEBUG_WARN                 2
\#define DEBUG_TRACE                3
\#define DEBUG_INFO                 4

Linux kernel中提供8種列印資訊，設計錯誤資訊型別時可以參考，

#define KERN_EMERG      "<0>"    /* system is unusable */   
#define KERN_ALERT      "<1>"    /* action must be taken immediately */   
#define KERN_CRIT       "<2>"    /* critical conditions */   
#define KERN_ERR        "<3>"    /* error conditions */   
#define KERN_WARNING    "<4>"    /* warning conditions */   
#define KERN_NOTICE     "<5>"    /* normal but significant */   
#define KERN_INFO       "<6>"    /* informational */   
#define KERN_DEBUG      "<7>"    /* debug-level messages */  
#define KERN_EMERG      "<0>"    /* system is unusable */
#define KERN_ALERT      "<1>"    /* action must be taken immediately */
#define KERN_CRIT       "<2>"    /* critical conditions */
#define KERN_ERR        "<3>"    /* error conditions */
#define KERN_WARNING    "<4>"    /* warning conditions */
#define KERN_NOTICE     "<5>"    /* normal but significant */
#define KERN_INFO       "<6>"    /* informational */
#define KERN_DEBUG      "<7>"    /* debug-level messages */

另外，對於一些系統呼叫函式失敗，錯誤碼記錄在errno中，使用該變數需要包含標頭檔案errno.h，然後通過函式介面：

char *strerror(int errnum);

返回該錯誤碼對應的字元資訊。比如，socket程式設計中使用bind繫結伺服器IP和埠，返回出錯，程式碼：

DBG_PRINT(DEBUG_ERROR, ("bind rcv tcp failed, msg = %s!\n", strerror(errno)));

輸出結果：

bind rcv tcp failed, msg = Address already in use!