【实践】日志调试法

在我们嵌入式开发中，调试代码的方法有很多。比如使用调试器在线调试、借助一些测量仪器、输出调试日志等方式。没有哪种方法是最好的调试方法，实际开发中需要根据实际情况借助不同的方法进行调试。但是，在一些稍微大点的项目中，输出调试日志却是比较好的调试方法。

输出日志可以比较随意，想输出什么就输出什么，但是也得注意两个点：一是输出的日志尽量整洁明了，因为如果日志稍微多一点，看起来就会很乱，很扰心；二是方便打开/关闭日志相关代码，程序调试阶段打开，方便定位问题，程序发布阶段关闭，可节省不必要地资源开销。

最近在做Linux方面的开发，整天分析日志，有点体会。顺便也写点日志笔记分享给大家：

站在巨人的肩膀上

网络上有很多现成的日志库，简单移植一下就可以使用。这里分享一个常用的日志库—— EasyLogger。

码云仓库及介绍地址：

https://gitee.com/Armink/EasyLogger?_from=gitee_search#easylogger

1、EasyLogger介绍

EasyLogger是一款超轻量级(ROM<1.6K, RAM<0.3K)、高性能的C/C++日志库，非常适合对资源敏感的软件项目，例如： IoT产品、可穿戴设备、智能家居等等。相比log4c、zlog这些知名的C/C++日志库， EasyLogger的功能更加简单，提供给用户的接口更少，但上手会很快，更多实用功能支持以插件形式进行动态扩展。

2、EasyLogger特性

• 支持用户自定义输出方式（例如：终端、文件、数据库、串口、485、Flash…）；
• 日志内容可包含级别、时间戳、线程信息、进程信息等；
• 日志输出被设计为线程安全的方式，并支持异步输出及缓冲输出模式；
• 支持多种操作系统（RT-Thread、UCOS、Linux、Windows…），也支持裸机平台；
• 日志支持RAW格式，支持hexdump；
• 支持按标签 、级别、关键词进行动态过滤；
• 各级别日志支持不同颜色显示；
• 扩展性强，支持以插件形式扩展新功能。

3、EasyLogger的尝试

该开源项目提供了丰富的demo，有stm32裸机的demo，有RT-Thread的demo、有Windows下的demo、有Linux下的demo。这里我们跑一下stm32裸机的demo。

进行初始化及一些设置之后就可以调用其给我们用户提供的日志打印接口log_a、log_e、log_w等来输出日志信息，我们使用日志库也主要使用的是这几个接口，其它辅助功能有兴趣的朋友可自行学习使用。

4、EasyLogger的移植、剖析

想要对EasyLogger进行深入学习可查阅项目的readme文件、源码阅读及如下两篇文章：

【开源解读】一款轻量级C日志库-EasyLogger

EasyLogger，一款轻量级且高性能的日志库

自己动手，丰衣足食

网络上的一些日志库的功能过于强大，有时候我们用不上一些高级的功能，没必要大动干戈移植一个日志库，这时候我们可以通过简单的几行代码实现我们自己的日志打印格式。其实之前也有简单分享过打印相关的技术笔记：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、分模块打印

给各个模块加上宏打印开关。在调试时可以通过宏开关先屏蔽掉没有问题的模块的日志信息，减少日志地输出，方便专注于有问题的模块分析。

直接上代码吧。。。

（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

/* 日志统一输出的格式 */
#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日志库的分级打印实现方式：

这也是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)
	
/* 调试(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__ */

编译、运行：

以上就是本次的分享，欢迎转发！

---