bug解決不了?使用日志法
掃描二維碼
隨時隨地手機看文章
交心
在我們嵌入式開發(fā)中,調(diào)試代碼的方法有很多。比如使用調(diào)試器在線調(diào)試、借助一些測量儀器、輸出調(diào)試日志等方式。
沒有哪種方法是最好的調(diào)試方法,實際開發(fā)中需要根據(jù)實際情況借助不同的方法進行調(diào)試。但是,在一些稍微大點的項目中,輸出調(diào)試日志卻是比較好的調(diào)試方法。
輸出日志可以比較隨意,想輸出什么就輸出什么,但是也得注意兩個點:
一是輸出的日志盡量整潔明了,因為如果日志稍微多一點,看起來就會很亂,很擾心;
二是方便打開/關閉日志相關代碼,程序調(diào)試階段打開,方便定位問題,程序發(fā)布階段關閉,可節(jié)省不必要地資源開銷。
最近在做Linux方面的開發(fā),整天分析日志,有點體會。順便也寫點日志筆記分享給大家:
站在巨人的肩膀上
網(wǎng)絡上有很多現(xiàn)成的日志庫,簡單移植一下就可以使用。這里分享一個常用的日志庫—— EasyLogger
。
碼云倉庫及介紹地址:
https://gitee.com/Armink/EasyLogger?_from=gitee_search#easylogger
1、EasyLogger介紹
EasyLogger是一款超輕量級(ROM<1.6K, RAM<0.3K)、高性能的C/C++日志庫,非常適合對資源敏感的軟件項目,例如:IoT產(chǎn)品、可穿戴設備、智能家居等等。
2、EasyLogger特性
-
支持用戶自定義輸出方式(例如:終端、文件、數(shù)據(jù)庫、串口、485、Flash...); -
日志內(nèi)容可包含級別、時間戳、線程信息、進程信息等; -
日志輸出被設計為線程安全的方式,并支持 異步輸出及 緩沖輸出模式; -
支持多種操作系統(tǒng)(RT-Thread、UCOS、Linux、Windows...),也支持裸機平臺; -
日志支持 RAW格式,支持 hexdump; -
支持按 標簽 、 級別、 關鍵詞進行動態(tài)過濾; -
各級別日志支持不同顏色顯示; -
擴展性強,支持以插件形式擴展新功能。
3、EasyLogger的嘗試
該開源項目提供了豐富的demo,有stm32裸機的demo,有RT-Thread的demo、有Windows下的demo、有Linux下的demo。這里我們跑一下stm32裸機的demo。
進行初始化及一些設置之后就可以調(diào)用其給我們用戶提供的日志打印接口log_a、log_e、log_w等來輸出日志信息,我們使用日志庫也主要使用的是這幾個接口,其它輔助功能有興趣的朋友可自行學習使用。
4、EasyLogger的移植、剖析
想要對EasyLogger進行深入學習可查閱項目的readme文件、源碼閱讀及如下兩篇文章:
【開源解讀】一款輕量級C日志庫-EasyLogger
第3期 | EasyLogger,一款輕量級且高性能的日志庫
自己動手,豐衣足食
網(wǎng)絡上的一些日志庫的功能過于強大,有時候我們用不上一些高級的功能,沒必要大動干戈移植一個日志庫。
這時候我們可以通過簡單的幾行代碼實現(xiàn)我們自己的日志打印格式。其實之前也有簡單分享過打印相關的技術筆記:C語言、嵌入式中幾個非常實用的宏技巧
摘選那篇筆記的代碼:
左右滑動查看全部代碼>>>
#define DEBUG 1
#if DEBUG
#define DBG_PRINTF(fmt, args...) \
do\
{\
printf("<<File:%s Line:%d Function:%s>> ", __FILE__, __LINE__, __FUNCTION__);\
printf(fmt, ##args);\
}while(0)
#else
#define DBG_PRINTF(fmt, args...)
#endif
我們拿來修改一下,下面分享兩種簡單的日志輸出方式:
1、分模塊打印
給各個模塊加上宏打印開關。在調(diào)試時可以通過宏開關先屏蔽掉沒有問題的模塊的日志信息,減少日志地輸出,方便專注于有問題的模塊分析。
直接上代碼吧。。。
(1)main.c
左右滑動查看全部代碼>>>
/*
demo: 分模塊打印日志
公眾號:嵌入式大雜燴
*/
#include <stdio.h>
#include "module1.h"
#include "module2.h"
int main(void)
{
module1_print();
module2_print();
return 0;
}
(2)mylog.h
左右滑動查看全部代碼>>>
#define __MYLOG_H__
#ifdef __cplusplus
extern "C" {
#endif
#include <stdio.h>
/* 各模塊日志開關 */
#define MODULE1_LOG_SWITCH 1
#define MODULE2_LOG_SWITCH 1
/* 日志統(tǒng)一輸出的格式 */
#define DBG_PRINTF(fmt, args...) \
do\
{\
printf("<<File:%s Line:%d Function:%s>> ", __FILE__, __LINE__, __FUNCTION__);\
printf(fmt, ##args);\
}while(0)
#ifdef __cplusplus
}
#endif
#endif /* __MYLOG_H__ */
(3)module1.c
左右滑動查看全部代碼>>>
#include "module1.h"
#if MODULE1_LOG_SWITCH
#define LOG_MODULE1(fmt, args...) DBG_PRINTF(fmt, ##args)
#else
#define LOG_MODULE1(fmt, args...)
#endif
void module1_print(void)
{
LOG_MODULE1("hello module1\n");
}
(4)module1.h
左右滑動查看全部代碼>>>
#ifndef __MODEL1_H__
#define __MODEL1_H__
#ifdef __cplusplus
extern "C" {
#endif
#include "mylog.h"
void module1_print(void);
#ifdef __cplusplus
}
#endif
#endif /* __MODEL1_H__ */
(5)module2.c
左右滑動查看全部代碼>>>
#include "module2.h"
#if MODULE2_LOG_SWITCH
#define LOG_MODULE2(fmt, args...) DBG_PRINTF(fmt, ##args)
#else
#define LOG_MODULE2(fmt, args...)
#endif
void module2_print(void)
{
LOG_MODULE2("hello module2\n");
}
(6)module2.h
左右滑動查看全部代碼>>>
#ifndef __MODEL2_H__
#define __MODEL2_H__
#ifdef __cplusplus
extern "C" {
#endif
#include "mylog.h"
void module2_print(void);
#ifdef __cplusplus
}
#endif
#endif /* __MODEL2_H__ */
通過模塊日志開關可以打開/關閉各模塊日志打印接口。這里的demo只拿兩個模塊作為例子,可模仿這兩個模塊拓展其它模塊。
編譯、運行:
2、分級打印
分級打印是日志庫里常用的方式,比如上面的EasyLogger日志庫的分級打印實現(xiàn)方式:
這也是EasyLogger的核心部分。
我們可以把這一部分抽出來修改一下:
(1)main.c
左右滑動查看全部代碼>>>
/*
demo:分級打印日志
公眾號:嵌入式大雜燴
*/
#include "mylog.h"
int main(void)
{
LOG_A("Hello world");
LOG_E("Hello world");
LOG_W("Hello world");
LOG_I("Hello world");
LOG_D("Hello world");
LOG_V("Hello world");
return 0;
}
(2)mylog.h
左右滑動查看全部代碼>>>
#ifndef __MYLOG_H__
#define __MYLOG_H__
#ifdef __cplusplus
extern "C" {
#endif
#include <stdio.h>
/* 日志級別 */
#define ELOG_LVL_ASSERT 0
#define ELOG_LVL_ERROR 1
#define ELOG_LVL_WARN 2
#define ELOG_LVL_INFO 3
#define ELOG_LVL_DEBUG 4
#define ELOG_LVL_VERBOSE 5
/* 設置日志級別 */
#define ELOG_OUTPUT_LVL ELOG_LVL_VERBOSE
/* 斷言(Assert) */
#define LOG_A(args,...)\
do{\
if (ELOG_OUTPUT_LVL >= ELOG_LVL_ASSERT)\
{\
printf("[A/%s Line:%.4d] " args "\n", __FILE__, __LINE__, ##__VA_ARGS__);\
}\
}while(0)
/* 錯誤(Error) */
#define LOG_E(args,...)\
do{\
if (ELOG_OUTPUT_LVL >= ELOG_LVL_ASSERT)\
{\
printf("[E/%s Line:%.4d] " args "\n", __FILE__, __LINE__, ##__VA_ARGS__);\
}\
}while(0)
/* 警告(Warn) */
#define LOG_W(args,...)\
do{\
if (ELOG_OUTPUT_LVL >= ELOG_LVL_WARN)\
{\
printf("[W/%s Line:%.4d] " args "\n", __FILE__, __LINE__, ##__VA_ARGS__);\
}\
}while(0)
/* 信息(Info) */
#define LOG_I(args,...)\
do{\
if (ELOG_OUTPUT_LVL >= ELOG_LVL_INFO)\
{\
printf("[I/%s Line:%.4d] " args "\n", __FILE__, __LINE__, ##__VA_ARGS__);\
}\
}while(0)
/* 調(diào)試(Debug) */
#define LOG_D(args,...)\
do{\
if (ELOG_OUTPUT_LVL >= ELOG_LVL_DEBUG)\
{\
printf("[D/%s Line:%.4d] " args "\n", __FILE__, __LINE__, ##__VA_ARGS__);\
}\
}while(0)
/* 詳細(Verbose) */
#define LOG_V(args,...)\
do{\
if (ELOG_OUTPUT_LVL >= ELOG_LVL_VERBOSE)\
{\
printf("[V/%s Line:%.4d] " args "\n", __FILE__, __LINE__, ##__VA_ARGS__);\
}\
}while(0)
#ifdef __cplusplus
}
#endif
#endif /* __MYLOG_H__ */
編譯、運行:
以上就是本次的筆記分享,如有錯誤,歡迎指出,感謝閱讀!期待大家的轉(zhuǎn)發(fā),大家的轉(zhuǎn)發(fā)也是我持續(xù)更新的動力。
猜你喜歡
OpenBLT Bootloader的使用分享
C語言對象編程第一彈:封裝與抽象
為了便于公眾號讀者交流學習,小編創(chuàng)建了相關相關交流群。坑位有限,感興趣的朋友可以掃碼下方二維碼加我微信,由我邀請入群:
歡迎大家進群交流、共同進步。同時,我也會關注一些大家問的一些問題,從中挑選一些具有代表性的、并且在我知識范圍內(nèi)的問題寫出相關文章做分享。
免責聲明:本文內(nèi)容由21ic獲得授權后發(fā)布,版權歸原作者所有,本平臺僅提供信息存儲服務。文章僅代表作者個人觀點,不代表本平臺立場,如有問題,請聯(lián)系我們,謝謝!