C語言——設計printf除錯巨集

idenny發表於2019-05-10
C語言除錯

前言

借除錯巨集的設計，梳理下C語言巨集的用法

重定向printf列印

嵌入式裝置基本會配置RS232串列埠作為除錯IO介面，假設底層串列埠單位元組輸出函式為SERIAL_PutChar()，利用fputc()和fputs()重定向printf函式

void fputc(int byte, FILE* stream)
{
    (void)stream;

    SERIAL_PutChar(byte);
}

void fputs(const char *pstr, FILE *stream)
{
    (void)stream;

    while(*pstr)
    {
        SERIAL_PutChar(*pstr++);
    }
}

這樣在程式碼裡面利用printf()函式輸出的字串都老老實實從除錯串列埠出來

除錯巨集使用場景

某個C驅動模組，希望在除錯時列印除錯資訊，而產品程式碼中不顯示除錯資訊。

v1–單引數巨集

#define DRV_DEBUG 1
#if DRV_DEBUG
    #define DRV_PRINT(x) printf(x)
#else
    #define DRV_PRINT(x) 
#endif

這個版本的DRV_PRINT(x)只能輸出單變數——純字串

void foo()
{
    DRV_PRINT("Driver Initialize Success!");
}

不需要列印除錯資訊時，更改DRV_DEBUG巨集定義

#define DRV_DEBUG 0

當然也可以直接這樣定義

#define DRV_PRINT printf

但是如果巨集呼叫了多個引數：

void foo()
{
    DRV_PRINT("Driver Initialize Success: ver %d.%d !", 1, 2);
}

產品程式碼中的#define DRV_PRINT(x)將編譯錯誤！

怎麼辦？一種處女座肯定接受不了的做法，多加對括號

void foo()
{
    DRV_PRINT(("Driver Initialize Success: ver %d.%d !", 1, 2));
}

不管是除錯程式碼還是產品程式碼，編譯都OK

v2–指定引數巨集

#define DRV_DEBUG 1
#if DRV_DEBUG
    #define DRV_PRINT(fmt, val1, val2) printf(fmt, val1, val2)
#else
    #define DRV_PRINT(fmt, val1, val2) 
#endif

如果只需要列印一個變數，第2個引數用隨意值填位，如

void foo()
{
    DRV_PRINT("Driver Initialize Success: ver %d !", val1, 2);
}

類似，如果有4個引數，就：

void foo()
{
    DRV_PRINT("Driver Initialize Success: ver %d !", val1, 2, 3, 4);
}

很傻，但是沒辦法:(，VxWorks 5.5核心程式碼裡就是這樣乾的！

v3–引數數量可變巨集

C90和C++中可將巨集宣告為接受可變數量的自變數，如ARM編譯器是這樣的：

#define DRV_DEBUG 1
#if DRV_DEBUG
    #define DRV_PRINT(fmt, ...) printf(fmt, __VA_ARGS__)
#else
    #define DRV_PRINT(fmt, ...) 
#endif

現在DRV_PRINT用法和printf完全一樣了，這麼爽的功能，C2000編譯器卻不支援！

題外話，注意這個特性C90支援，而C90是C++的一個子集，但是C99和C++卻不相容了

分層次LOG輸出

有時候，某個模組，有輸入跟蹤資訊，輸出資訊，錯誤資訊等，如果我想單獨開啟某部分資訊，可以這樣設計

#define DRV_DEBUG 1
#define DRV_DEBUG_IN 0x0001
#define DRV_DEBUG_OUT 0x0002
#define DRV_DEBUG_ERR 0x0004
#define DRV_DEBUG_ALL 0xFFFF
#if DRV_DEBUG
        unsigned int drv_flags = DRV_DEBUG_ERR | DRV_DEBUG_OUT;
    #define DRV_PRINT(flag, fmt, ...) 
            do{
                if(drv_flags & flag){
                printf(fmt, __VA_ARGS__)}
            }while(0)
#else
    #define DRV_PRINT(fmt, ...) 
#endif

NOTE： 多行巨集，注意換行前加號

這樣，我只列印OUT和ERR：

void drv_write(char* msg_out)
{
    DRV_PRINT(DRV_DEBUG_OUT, "Drivr write %s", msg_out); // 輸出
        DRV_PRINT(DRV_DEBUG_ERR, "Drivr write %s", msg_out); // 輸出
        DRV_PRINT(DRV_DEBUG_IN, "Drivr write %s", msg_out); // 不輸出
}

進一步，可以設計針對整個系統不同模組的LOG輸出控制！TCP/IP協議棧實現Lwip就是這麼幹的！

總結

在嵌入式C語言裡面，運用printf除錯巨集，有助於事後分析，定位BUG，多多益善！

相關文章