征程 6｜工具鏈 VP 示例中日志打印解讀
加入技術交流群
1.引言
在上一篇文章中，介紹了 VP 是什么，并以單算子 rotate 為例，介紹了 VP API 使用方法，其中有一些日志打印的代碼顯得特別高大上
LOGE_AND_RETURN_IF(src_mat.empty(), HB_UCP_INVALID_ARGUMENT,
"Read image {} failed", src_img.c_str());
由于本人是屬于對 C++不那么熟悉的同學，下面會從我的視角來介紹這個問題，如果其中有錯誤或表述不當的地方，歡迎評論指正。
其實本文是為了服務于另外一篇文章：
2.log_util.h 代碼解讀
LOGE_AND_RETURN_IF 是在 log_util.h 定義的一個宏，下面來具體看下 log_util.h 中的代碼：
#ifndef VP_CODE_07_ROTATE_INCLUDE_UTIL_LOG_UTIL_H_
#define VP_CODE_07_ROTATE_INCLUDE_UTIL_LOG_UTIL_H_
#include <sstream> //C++中標準頭文件，不做解釋
#include <utility> //C++中標準頭文件，不做解釋
#include "hlog/logging.h" // 地平線提供的頭文件，并不在當前目錄下，為什么能包含？
#define LOGI(err_msg, ...) HFLOGM_I("VP_TRANSFORMATION", err_msg, ##__VA_ARGS__)
#define LOGD(err_msg, ...) HFLOGM_D("VP_TRANSFORMATION", err_msg, ##__VA_ARGS__)
#define LOGE(err_msg, ...) HFLOGM_E("VP_TRANSFORMATION", err_msg, ##__VA_ARGS__)
#define LOGW(err_msg, ...) HFLOGM_W("VP_TRANSFORMATION", err_msg, ##__VA_ARGS__)
#define LOGE_AND_RETURN_IF(condition, code, err_msg, ...) \
do { \
if (condition) { \
LOGE(err_msg, ##__VA_ARGS__); \
return code; \
} \
} while (0)
#define LOGE_AND_RETURN_IF_NULL(ptr, code) \
LOGE_AND_RETURN_IF(ptr == nullptr, code, NULLPTR_ERR(ptr))
#endif // VP_CODE_07_ROTATE_INCLUDE_UTIL_LOG_UTIL_H_
2.1 LOGx
來看一下日志宏定義
#define LOGI(err_msg, ...) HFLOGM_I("VP_TRANSFORMATION", err_msg, ##__VA_ARGS__)
#define LOGD(err_msg, ...) HFLOGM_D("VP_TRANSFORMATION", err_msg, ##__VA_ARGS__)
#define LOGE(err_msg, ...) HFLOGM_E("VP_TRANSFORMATION", err_msg, ##__VA_ARGS__)
#define LOGW(err_msg, ...) HFLOGM_W("VP_TRANSFORMATION", err_msg, ##__VA_ARGS__)
這些宏封裝了 日志打印函數：
LOGI（Info）：信息日志
LOGD（Debug）：調試日志
LOGE（Error）：錯誤日志
LOGW（Warning）：警告日志
具體解釋下其中一行：
#define LOGI(err_msg, ...) HFLOGM_I("VP_TRANSFORMATION", err_msg, ##__VA_ARGS__)LOGI（err_msg， …） 定義了一個宏：
err_msg 是第一個參數
… 表示可以接受變長參數。但… 僅是一個 占位符，它不能直接用于宏的展開。（在下面介紹個展開的例子）
HFLOGM_I(“VP_TRANSFORMATION”, err_msg, ##VA_ARGS):
HFLOGM_I 是 hlog/logging.h 中提供的 具體日志實現
“VP_TRANSFORMATION” 是 日志模塊名稱，用于分類日志來源。
err_msg 就是前面的 LOGI 中的 err_msg
VA_ARGS 是一個 占位符的替代符，用于 填充 … 傳遞的實際參數。
##VA_ARGS 的作用是 在 VA_ARGS 為空時去掉前面的逗號，防止編譯錯誤。
當調用：LOGI（“Error code: %d”， 404）；
它會展開為：HFLOGM_I（“VP_TRANSFORMATION”， “Error code: %d”， 404）；
如果調用：LOGI（“Simple message”）；
它會展開為：HFLOGM_I（“VP_TRANSFORMATION”， “Simple message”）；
其中 ##VA_ARGS 確保了 VA_ARGS 為空時不會出現額外的 ，。（在下面介紹個展開的例子）
2.2 LOGE_AND_RETURN_IF 宏
下面來解讀 LOGE_AND_RETURN_IF 宏的寫法：
#define LOGE_AND_RETURN_IF(condition, code, err_msg, ...) \
do { \
if (condition) { \
LOGE(err_msg, ##__VA_ARGS__); \
return code; \
} \
} while (0)
這個宏 LOGE_AND_RETURN_IF 是一個常見的 防御式編程（Defensive Programming） 宏，如果 condition 為真，則：
記錄錯誤日志 LOGE（err_msg， ##VA_ARGS）
返回 code
定義一個 LOGE_AND_RETURN_IF 宏時，do { … } while （0）起到什么作用？
do { … } while （0） 的作用是讓整個宏塊結構化，使它在語法上表現得像一個普通的語句，這樣：確保 if 語句和 return 被視為一個整體，不會因為 if-else 結構導致錯誤。
條件滿足，觸發錯誤日志并返回；當 … 為空時，去掉前面的 ，，防止編譯錯誤，示例（無可變參數）
LOGE_AND_RETURN_IF(error, -1, "An error occurred");
展開后
do {
if (error) {
LOGE("An error occurred");
return -1;
}
} while (0);
##VA_ARGS 確保了 沒有多余的 ， 影響 LOGE 語法。
（帶可變參數）
LOGE_AND_RETURN_IF(value < 0, -1, "Invalid value: %d", value);
展開后
do {
if (value < 0) {
LOGE("Invalid value: %d", value);
return -1;
}
} while (0);
2.3 do { … } while （0）作用
在前面有說 do { … } while （0） 可以：確保 if 語句和 return 被視為一個整體，不會因為 if-else 結構導致錯誤。
為什么 do { … } while （0） 能避免 if-else 結構導致的錯誤？if-else 結構有什么問題？下面來看一下
do { … } while （0） 的核心作用是讓整個宏塊在語法上表現得像一個單一語句，從而避免 if-else 結構中的 懸空 else（dangling else） 和 單行 if 語句的 bug。
2.3.1 if-else 結構的問題
如果 沒有 do { … } while （0），在 if-else 語句中 直接用 if 語句包裹宏時，可能導致 else 結構錯誤。錯誤示例如下：
未使用 do { … } while （0） 定義宏
#define LOGE_AND_RETURN_IF(condition, code, err_msg, ...) \
if (condition) { \
LOGE(err_msg, ##__VA_ARGS__); \
return code; \
}
代碼中調用宏
if (x < 0)
LOGE_AND_RETURN_IF(x < -10, -1, "x is too small");
else
printf("x is positive\n");
錯誤展開：
if (x < 0)
if (x < -10) {
LOGE("x is too small");
return -1;
} // 這里的 `if` 結束
else // 這個 else 可能會匹配到錯誤的 if！
printf("x is positive\n");
此時就會引入懸空 else 的問題。
2.3.2 懸空 else 問題
錯誤現象：
x = -5:
x is positive // 這個輸出是不應該出現的！
C/C++ 規定：else 總是匹配最近的 if。
上一節中 else 錯誤地匹配了 if （x < -10），而不是 if （x < 0），導致：
x = -5 時，if （x < 0） 為真，但 if （x < -10） 為假，所以 LOGE_AND_RETURN_IF 不執行。
然而 else 仍然執行，最終 printf（“x is positive\n”）； 被錯誤地執行！
解決方案：使用 do { … } while （0）結構。
2.4 NULLPTR_ERR（ptr） 宏
#define NULLPTR_ERR(ptr) #ptr " is null pointer"
#ptr 是 字符串化（stringizing）運算符，它會把 ptr 變成字符串。
示例：
printf("%s\n", NULLPTR_ERR(my_ptr));展開后：
printf("%s\n", "my_ptr is null pointer");輸出：my_ptr is null pointer
2.5 LOGE_AND_RETURN_IF_NULL（ptr， code） 宏
#define LOGE_AND_RETURN_IF_NULL(ptr, code) \
LOGE_AND_RETURN_IF(ptr == nullptr, code, NULLPTR_ERR(ptr))
這個宏會：
檢查 ptr 是否為 nullptr。
如果 ptr == nullptr：
記錄日志，日志信息由 NULLPTR_ERR（ptr） 生成，例如 “ptr is null pointer”。
返回 code 作為錯誤碼。
3.總結
*博客內容為網友個人發布，僅代表博主個人觀點，如有侵權請聯系工作人員刪除。
