BFLOG

简介

BFLOG 是一个移植简单，功能多样的多线程日志记录库
具有同步异步两种工作模式，异步模式如果缓冲区溢出会将最早的一条记录完整删除
总体三部分、记录器、定向输出、格式化器
一个记录器可多重定向输出,可同时输出到缓冲区、IO外设、文件、文件大小划分、文件时间划分
定向到文件输出，支持设定保留数量，支持按文件大小划分，支持按时间划分
每个定向输出可单独设定格式化器、输出等级、TAG标签过滤、输出方式、颜色
格式化器支持简单格式、用户自定义格式、YAML格式(实现中)、CSV格式(规划中)
六级日志等级控制, FATAL、ERROR、WARNING、INFO、DEBUG、TRACE
支持等级、TAG标签、函数、行数、文件名、TICK数、TIME、线程信息输出
支持等级、TAG标签过滤功能
可对不需要的等级、功能、标签进行裁剪，缩小代码体积

log 样式

配置BFLOG相关功能

如果需要配置BFLOG的相关功能需要在对应的工程目录下 proj.conf 文件中添加对应的代码，举例如下：

以下是一个不支持文件输出的 proj.conf 配置

# 使能 BFLOG
set(CONFIG_BFLOG 1)
# 使能参数检查, 可不开启
set(CONFIG_BFLOG_DEBUG 1)

此外在 proj.conf 配置中添加以下配置可以使用用户的 bflog_user.h 配置文件，配置文件默认为 bflog_default.h

# 使能 BFLOG_USER 配置文件
set(CONFIG_BFLOG_USER 1)

Macros

BFLOG_CSI

Control Sequence Introducer
用于控制终端

 #define BFLOG_CSI_START "\033["
 #define BFLOG_CSI_CUU   "A"
 #define BFLOG_CSI_CUD   "B"
 #define BFLOG_CSI_CUF   "C"
 #define BFLOG_CSI_CUB   "D"
 #define BFLOG_CSI_CNL   "E"
 #define BFLOG_CSI_CPL   "F"
 #define BFLOG_CSI_CHA   "G"
 #define BFLOG_CSI_CUP   "H"
 #define BFLOG_CSI_ED    "J"
 #define BFLOG_CSI_EL    "K"
 #define BFLOG_CSI_SU    "S"
 #define BFLOG_CSI_SD    "T"
 #define BFLOG_CSI_SGR   "m"

BFLOG_SGR

Select Graphic Rendition
用于文字图形

 #define BFLOG_SGR_RESET      "0"
 #define BFLOG_SGR_BOLD       "1"
 #define BFLOG_SGR_FAINT      "2"
 #define BFLOG_SGR_ITALICS    "3"
 #define BFLOG_SGR_UNDERLINE  "4"
 #define BFLOG_SGR_BLINKS     "5"
 #define BFLOG_SGR_BLINKR     "6"
 #define BFLOG_SGR_REVERSE    "7"
 #define BFLOG_SGR_HIDE       "8"
 #define BFLOG_SGR_STRIKE     "9"
 #define BFLOG_SGR_NORMAL     "22"
 #define BFLOG_SGR_FG_BLACK   "30"
 #define BFLOG_SGR_FG_RED     "31"
 #define BFLOG_SGR_FG_GREEN   "32"
 #define BFLOG_SGR_FG_YELLOW  "33"
 #define BFLOG_SGR_FG_BLUE    "34"
 #define BFLOG_SGR_FG_MAGENTA "35"
 #define BFLOG_SGR_FG_CYAN    "36"
 #define BFLOG_SGR_FG_WHITE   "37"
 #define BFLOG_SGR_BG_BLACK   "40"
 #define BFLOG_SGR_BG_RED     "41"
 #define BFLOG_SGR_BG_GREEN   "42"
 #define BFLOG_SGR_BG_YELLOW  "43"
 #define BFLOG_SGR_BG_BLUE    "44"
 #define BFLOG_SGR_BG_MAGENTA "45"
 #define BFLOG_SGR_BG_CYAN    "46"
 #define BFLOG_SGR_BG_WHITE   "47"

BFLOG_COLOR

一系列颜色用于配置使用

 #define BFLOG_COLOR_START BFLOG_CSI_START
 #define BFLOG_COLOR_END   BFLOG_CSI_SGR
 #define BFLOG_CLOLR_SEP   ";"
 #define BFLOG_COLOR_DEFAULT
 #define BFLOG_COLOR_RESET BFLOG_SGR_RESET BFLOG_CLOLR_SEP
 #define BFLOG_COLOR_FG_NONE
 #define BFLOG_COLOR_FG_BLACK   BFLOG_SGR_FG_BLACK BFLOG_CLOLR_SEP
 #define BFLOG_COLOR_FG_RED     BFLOG_SGR_FG_RED BFLOG_CLOLR_SEP
 #define BFLOG_COLOR_FG_GREEN   BFLOG_SGR_FG_GREEN BFLOG_CLOLR_SEP
 #define BFLOG_COLOR_FG_YELLOW  BFLOG_SGR_FG_YELLOW BFLOG_CLOLR_SEP
 #define BFLOG_COLOR_FG_BLUE    BFLOG_SGR_FG_BLUE BFLOG_CLOLR_SEP
 #define BFLOG_COLOR_FG_MAGENTA BFLOG_SGR_FG_MAGENTA BFLOG_CLOLR_SEP
 #define BFLOG_COLOR_FG_CYAN    BFLOG_SGR_FG_CYAN BFLOG_CLOLR_SEP
 #define BFLOG_COLOR_FG_WHITE   BFLOG_SGR_FG_WHITE BFLOG_CLOLR_SEP
 #define BFLOG_COLOR_BG_NONE
 #define BFLOG_COLOR_BG_BLACK   BFLOG_SGR_BG_BLACK BFLOG_CLOLR_SEP
 #define BFLOG_COLOR_BG_RED     BFLOG_SGR_BG_RED BFLOG_CLOLR_SEP
 #define BFLOG_COLOR_BG_GREEN   BFLOG_SGR_BG_GREEN BFLOG_CLOLR_SEP
 #define BFLOG_COLOR_BG_YELLOW  BFLOG_SGR_BG_YELLOW BFLOG_CLOLR_SEP
 #define BFLOG_COLOR_BG_BLUE    BFLOG_SGR_BG_BLUE BFLOG_CLOLR_SEP
 #define BFLOG_COLOR_BG_MAGENTA BFLOG_SGR_BG_MAGENTA BFLOG_CLOLR_SEP
 #define BFLOG_COLOR_BG_CYAN    BFLOG_SGR_BG_CYAN BFLOG_CLOLR_SEP
 #define BFLOG_COLOR_BG_WHITE   BFLOG_SGR_BG_WHITE BFLOG_CLOLR_SEP

BFLOG_COLOR_CONTROL

默认配置的各等级LOG颜色

 #ifndef BFLOG_COLOR_FATAL
 #define BFLOG_COLOR_FATAL BFLOG_COLOR_FG_MAGENTA BFLOG_COLOR_BG_NONE BFLOG_SGR_BLINKS
 #endif

 #ifndef BFLOG_COLOR_ERROR
 #define BFLOG_COLOR_ERROR BFLOG_COLOR_FG_RED BFLOG_COLOR_BG_NONE BFLOG_SGR_NORMAL
 #endif

 #ifndef BFLOG_COLOR_WARN
 #define BFLOG_COLOR_WARN BFLOG_COLOR_FG_YELLOW BFLOG_COLOR_BG_NONE BFLOG_SGR_NORMAL
 #endif

 #ifndef BFLOG_COLOR_INFO
 #define BFLOG_COLOR_INFO BFLOG_COLOR_FG_NONE BFLOG_COLOR_BG_NONE BFLOG_SGR_RESET
 #endif

 #ifndef BFLOG_COLOR_DEBUG
 #define BFLOG_COLOR_DEBUG BFLOG_COLOR_FG_WHITE BFLOG_COLOR_BG_NONE BFLOG_SGR_NORMAL
 #endif

 #ifndef BFLOG_COLOR_TRACE
 #define BFLOG_COLOR_TRACE BFLOG_COLOR_FG_WHITE BFLOG_COLOR_BG_NONE BFLOG_SGR_FAINT
 #endif

BFLOG_LEVEL_STRING

默认配置的各等级提示信息

 #ifndef BFLOG_LEVEL_FATAL_STRING
 #define BFLOG_LEVEL_FATAL_STRING "FATL"
 #endif

 #ifndef BFLOG_LEVEL_ERROR_STRING
 #define BFLOG_LEVEL_ERROR_STRING "ERRO"
 #endif

 #ifndef BFLOG_LEVEL_WARN_STRING
 #define BFLOG_LEVEL_WARN_STRING "WARN"
 #endif

 #ifndef BFLOG_LEVEL_INFO_STRING
 #define BFLOG_LEVEL_INFO_STRING "INFO"
 #endif

 #ifndef BFLOG_LEVEL_DEBUG_STRING
 #define BFLOG_LEVEL_DEBUG_STRING "DBUG"
 #endif

 #ifndef BFLOG_LEVEL_TRACE_STRING
 #define BFLOG_LEVEL_TRACE_STRING "TRAC"
 #endif

BFLOG_LEVEL

用于配置 recorder 和 direct 的 LOG等级

 #define BFLOG_LEVEL_FATAL 0x00 /*!< level fatal, create a panic */
 #define BFLOG_LEVEL_ERROR 0x01 /*!< level error                 */
 #define BFLOG_LEVEL_WARN  0x02 /*!< level warning               */
 #define BFLOG_LEVEL_INFO  0x03 /*!< level information           */
 #define BFLOG_LEVEL_DEBUG 0x04 /*!< level debug                 */
 #define BFLOG_LEVEL_TRACE 0x05 /*!< level trace information     */

BFLOG_FLAG

用于配置 recorder 和 direct 的功能

 #define BFLOG_FLAG_LEVEL  ((uint8_t)0x01) /*!< supported print level     */
 #define BFLOG_FLAG_TAG    ((uint8_t)0x02) /*!< supported record tag      */
 #define BFLOG_FLAG_FUNC   ((uint8_t)0x04) /*!< supported record function */
 #define BFLOG_FLAG_LINE   ((uint8_t)0x08) /*!< supported record line     */
 #define BFLOG_FLAG_FILE   ((uint8_t)0x10) /*!< supported record file     */
 #define BFLOG_FLAG_CLK    ((uint8_t)0x20) /*!< supported record clock    */
 #define BFLOG_FLAG_TIME   ((uint8_t)0x40) /*!< supported record time     */
 #define BFLOG_FLAG_THREAD ((uint8_t)0x80) /*!< supported record thread   */

BFLOG_MODE

用于配置 recorder 的模式

 #define BFLOG_MODE_SYNC  ((uint8_t)0x00)
 #define BFLOG_MODE_ASYNC ((uint8_t)0x01)

BFLOG_COMMAND

配置命令,用于 bflog_control 第二个参数

 #define BFLOG_CMD_FLAG           ((uint32_t)0x01)
 #define BFLOG_CMD_LEVEL          ((uint32_t)0x02)
 #define BFLOG_CMD_QUEUE_POOL     ((uint32_t)0x03)
 #define BFLOG_CMD_QUEUE_SIZE     ((uint32_t)0x04)
 #define BFLOG_CMD_QUEUE_RST      ((uint32_t)0x05)
 #define BFLOG_CMD_ENTER_CRITICAL ((uint32_t)0x06)
 #define BFLOG_CMD_EXIT_CRITICAL  ((uint32_t)0x07)
 #define BFLOG_CMD_FLUSH_NOTICE   ((uint32_t)0x08)
 #define BFLOG_CMD_MODE           ((uint32_t)0x09)

BFLOG_DIRECT_COMMAND

配置命令,用于 bflog_direct_control 第二个参数

 #define BFLOG_DIRECT_CMD_ILLEGAL ((uint32_t)0x00)
 #define BFLOG_DIRECT_CMD_LEVEL   ((uint32_t)0x02)
 #define BFLOG_DIRECT_CMD_LOCK    ((uint32_t)0x06)
 #define BFLOG_DIRECT_CMD_UNLOCK  ((uint32_t)0x07)
 #define BFLOG_DIRECT_CMD_COLOR   ((uint32_t)0x0A)

BFLOG_DIRECT_TYPE

要创建的direct类型,用于 bflog_direct_create 第二个参数

 #define BFLOG_DIRECT_TYPE_BUFFER    ((uint8_t)0x01)
 #define BFLOG_DIRECT_TYPE_STREAM    ((uint8_t)0x02)
 #define BFLOG_DIRECT_TYPE_FILE      ((uint8_t)0x03)
 #define BFLOG_DIRECT_TYPE_FILE_TIME ((uint8_t)0x04)
 #define BFLOG_DIRECT_TYPE_FILE_SIZE ((uint8_t)0x05)

BFLOG_DIRECT_COLOR

是否启用颜色输出,用于 bflog_direct_create 第三个参数

 #define BFLOG_DIRECT_COLOR_DISABLE ((uint8_t)0)
 #define BFLOG_DIRECT_COLOR_ENABLE  ((uint8_t)1)

BFLOG_LAYOUT_TYPE

要创建的layout类型,用于 bflog_layout_create 第二个参数

 #define BFLOG_LAYOUT_TYPE_SIMPLE ((uint8_t)0)
 #define BFLOG_LAYOUT_TYPE_FORMAT ((uint8_t)1)
 #define BFLOG_LAYOUT_TYPE_YAML   ((uint8_t)2)

Port Functions

移植要实现的接口函数

bflog_clock

获取当前cpu时钟数

 uint64_t bflog_clock(void);

bflog_time

获取当前UTC时间戳

 uint32_t bflog_time(void);

bflog_thread

获取当前线程名称

 char *bflog_thread(void);

Global Functions

bflog_global_filter

用于对标签过滤器进行全局的开关,会影响所有的recorder和direct

 int bflog_global_filter(void *tag_string, uint8_t enable);

parameter	description
tag_string	标签字符串的指针
enable	是否使能

 bflog_global_filter("YOURTAG", true);
 bflog_global_filter("YOURTAG", false);

Recorder Functions

recorder负责收集日志, 具有illegal、ready、running、suspend四种状态 running状态可以收集日志, ready、suspend状态可以对其进行配置除level配置操作外, 其他配置操作必须在ready、suspend下

bflog_create

创建一个recorder, 需要定义一个bflog_t结构体并将其指针传入,定义一块内存数组用于换冲
成功返回0,失败返回-1

 int bflog_create(bflog_t *log, void *pool, uint16_t size, uint8_t mode);

parameter	description
log	recorder 指针
pool	用于缓冲的数组
size	用户缓冲的数组大小
mode	BFLOG_MODE

 #include "bflog.h"

 #define EXAMPLE_LOG_POOL_SIZE 4096

 bflog_t example_recorder;
 static uint32_t example_pool[EXAMPLE_LOG_POOL_SIZE / 4];

 /*!< 创建一个记录器, 配置内存池, 内存池大小, 模式为同步 */
 if (0 != bflog_create((void *)&example_recorder, example_pool, EXAMPLE_LOG_POOL_SIZE, BFLOG_MODE_SYNC)) {
     printf("bflog_create faild\r\n");
 }

bflog_delete

删除一个recorder
处于ready、suspend状态下
线程安全
成功返回0,失败返回-1

 int bflog_delete(bflog_t *log);

parameter	description
log	recorder 指针

bflog_append

将一个direct添加到此recorder,可以添加多个direct,但一个direct只能被添加到一个recorder
处于ready、suspend状态下
线程安全
成功返回0,失败返回-1

 int bflog_append(bflog_t *log, bflog_direct_t *direct);

parameter	description
log	recorder 指针
direct	direct 指针

bflog_remove

将一个direct从recorder移除
处于ready、suspend状态下
线程安全
成功返回0,失败返回-1

 int bflog_remove(bflog_t *log, bflog_direct_t *direct);

parameter	description
log	recorder 指针
direct	direct 指针

bflog_suspend

将一个recorder挂起
处于ready、running、suspend状态下
线程安全
成功返回0,失败返回-1

 int bflog_suspend(bflog_t *log);

parameter	description
log	recorder 指针

bflog_resume

将一个recorder恢复
处于ready、running、suspend状态下
线程安全
成功返回0,失败返回-1

 int bflog_resume(bflog_t *log);

parameter	description
log	recorder 指针

bflog_control

对一个recorder进行配置
处于ready、suspend状态下;当command为BFLOG_CMD_LEVEL可以处于running状态下
线程安全
成功返回0,失败返回-1

 int bflog_control(bflog_t *log, uint32_t command, uint32_t param);

parameter	description
log	recorder 指针
command	配置命令
param	配置参数

command param 可以填入以下参数:

command	param	description
BFLOG_CMD_FLAG	BFLOG_FLAG	配置recorder记录功能
BFLOG_CMD_LEVEL	BFLOG_LEVEL	配置recorder记录的等级
BFLOG_CMD_QUEUE_POOL	内存池地址	配置用于缓冲的内存池地址
BFLOG_CMD_QUEUE_SIZE	内存池大小(byte)	配置用于缓冲的内存池大小
BFLOG_CMD_QUEUE_RST	NULL	复位缓冲区,清除缓冲区的所有内容
BFLOG_CMD_ENTER_CRITICAL	int (* enter_critical)(void) 函数指针	配置进入临界区的函数
BFLOG_CMD_EXIT_CRITICAL	int (* exit_critical)(void) 函数指针	配置退出临界区的函数
BFLOG_CMD_FLUSH_NOTICE	int (* flush_notice)(void) 函数指针	配置清除缓冲区提示函数,用于多线程flush线程工作
BFLOG_CMD_MODE	BFLOG_MODE	配置recorder工作模式

bflog_filter

配置recorder的tag filter, 配置是否启用对应tag_string的log输出
处于ready、suspend、running状态下
线程安全
成功返回0,失败返回-1

 int bflog_filter(bflog_t *log, void *tag_string, uint8_t enable);

parameter	description
log	recorder 指针
tag_string	tag 字符串
enable	是否使能

bflog

将log信息添加到recorder, sync模式会直接调用bflog_flush, async模式调用配置的flush_notice函数
处于running状态下
线程安全
成功返回0,失败返回-1

 int bflog(void *log, uint8_t level, void *tag, const char *const file, const char *const func, const long line, const char *format, ...);

parameter	description
log	recorder 指针
level	此条log的等级
tag	此条log的tag结构体指针
file	此条log的文件名字符串指针
func	此条log的函数名字符串指针
line	此条log的行号
format	此条log的格式化字符串
...	此条log的变长参数列表

bflog_flush

将队列中存储的所有log信息全部输出到recorder配置的所有的direct
处于running状态下
线程安全
成功返回0,失败返回-1

 int bflog_flush(void *log);

parameter	description
log	recorder 指针

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

bflog.rst

bflog.rst

BFLOG

简介

配置BFLOG相关功能

Macros

BFLOG_CSI

BFLOG_SGR

BFLOG_COLOR

BFLOG_COLOR_CONTROL

BFLOG_LEVEL_STRING

BFLOG_LEVEL

BFLOG_FLAG

BFLOG_MODE

BFLOG_COMMAND

BFLOG_DIRECT_COMMAND

BFLOG_DIRECT_TYPE

BFLOG_DIRECT_COLOR

BFLOG_LAYOUT_TYPE

Port Functions

bflog_clock

bflog_time

bflog_thread

Global Functions

bflog_global_filter

Recorder Functions

bflog_create

bflog_delete

bflog_append

bflog_remove

bflog_suspend

bflog_resume

bflog_control

bflog_filter

bflog

bflog_flush

Files

bflog.rst

Latest commit

History

bflog.rst

File metadata and controls

BFLOG

简介

配置BFLOG相关功能

Macros

BFLOG_CSI

BFLOG_SGR

BFLOG_COLOR

BFLOG_COLOR_CONTROL

BFLOG_LEVEL_STRING

BFLOG_LEVEL

BFLOG_FLAG

BFLOG_MODE

BFLOG_COMMAND

BFLOG_DIRECT_COMMAND

BFLOG_DIRECT_TYPE

BFLOG_DIRECT_COLOR

BFLOG_LAYOUT_TYPE

Port Functions

bflog_clock

bflog_time

bflog_thread

Global Functions

bflog_global_filter

Recorder Functions

bflog_create

bflog_delete

bflog_append

bflog_remove

bflog_suspend

bflog_resume

bflog_control

bflog_filter

bflog

bflog_flush