嵌入式系统日志存储方案设计与Flash优化

嵌入式设备系统日志记录方案设计与实现1. 项目概述1.1 系统日志的重要性在嵌入式设备开发中系统日志是监控设备运行状态、记录关键信息和定位问题的重要工具。一个完善的日志系统能够帮助开发人员快速诊断系统异常分析设备行为提高问题解决效率。1.2 设计目标本文介绍一种基于外部Flash的嵌入式系统日志记录方案主要实现以下功能按日期分类存储系统日志支持日志目录查询和特定日志检索实现环形存储以延长Flash寿命提供调试等级控制机制2. 系统架构设计2.1 存储区域划分系统将外部Flash划分为三个主要区域区域名称功能描述特点目录区存储日志目录信息按日期分类记录日志地址和大小参数区存储系统参数记录当前写位置、目录项个数等日志区存储实际日志内容支持环形写入延长Flash寿命2.2 关键数据结构2.2.1 时间结构体typedef struct { uint16_t Year; /* 年份:YYYY */ uint8_t Month; /* 月份:MM */ uint8_t Day; /* 日:DD */ uint8_t Hour; /* 小时:HH */ uint8_t Minute; /* 分钟:MM */ uint8_t Second; /* 秒:SS */ } time_t;2.2.2 系统日志参数结构体typedef struct { uint32_t write_pos; /* 写位置 */ uint32_t catalog_num; /* 目录项个数 */ uint8_t log_cyclic_status; /* 系统日志环形写状态 */ uint8_t catalog_cyclic_status; /* 日志目录环形写状态 */ time_t log_latest_time; /* 存储最新时间 */ } system_log_t;2.2.3 目录项结构体typedef struct { uint32_t log_id; /* 日志索引 */ uint32_t log_addr; /* 日志地址 */ uint32_t log_offset; /* 日志偏移大小单位字节 */ time_t log_time; /* 日志存储时间 */ } system_catalog_t;3. 硬件设计3.1 Flash存储规划系统使用外部SPI Flash作为日志存储介质根据Flash特性进行合理分区#define FLASH_SECTOR_SIZE ((uint32_t)0x001000) /* 4KB扇区 */ #define FLASH_BLOCK_32K_SIZE ((uint32_t)0x008000) /* 32KB块 */ #define FLASH_BLOCK_64K_SIZE ((uint32_t)0x010000) /* 64KB块 */ typedef enum { FLASH_CATALOG_ZONE 0, /* 目录区 */ FLASH_SYSLOG_PARA_ZONE, /* 参数区 */ FLASH_SYSLOG_ZONE, /* 日志区 */ FLASH_ZONEX, } flash_zone_e; typedef struct { flash_zone_e zone; uint32_t start_address; uint32_t end_address; } flash_table_t; static const flash_table_t flash_table[] { { .zone FLASH_CATALOG_ZONE, .start_address 0x03200000, .end_address 0x032FFFFF }, { .zone FLASH_SYSLOG_PARA_ZONE, .start_address 0x03300000, .end_address 0x033FFFFF }, { .zone FLASH_SYSLOG_ZONE, .start_address 0x03400000, .end_address 0x03FFFFFF }, };3.2 Flash操作接口系统提供基本的Flash操作接口包括擦除、读写等功能int flash_erase(flash_zone_e zone, uint32_t address, flash_block_t block_type) { flash_table_t *flash_table_tmp get_flash_table(zone); if(flash_table_tmp NULL) return -1; if(address flash_table_tmp-start_address || address flash_table_tmp-end_address) return -1; return bsp_spi_flash_erase(address, block_type); } int flash_write(flash_zone_e zone, uint32_t address, const uint8_t *data, uint32_t length) { flash_table_t *flash_table_tmp get_flash_table(zone); if(flash_table_tmp NULL) return -1; if((address flash_table_tmp-start_address) || ((address length) flash_table_tmp-end_address)) return -1; return bsp_spi_flash_buffer_write(address, (uint8_t*)data, length); } int flash_read(flash_zone_e zone, uint32_t address, uint8_t *buffer, uint32_t length) { flash_table_t *flash_table_tmp get_flash_table(zone); if(flash_table_tmp NULL) return -1; if((address flash_table_tmp-start_address) || ((address length) flash_table_tmp-end_address)) return -1; bsp_spi_flash_buffer_read(buffer, address, length); return 0; }4. 软件实现4.1 参数管理4.1.1 参数保存系统采用CRC校验确保参数存储的可靠性void save_system_log_param(void) { uint32_t i 0; uint32_t addr 0; uint32_t remainbyte 0; uint32_t start_addr; int len sizeof(sys_log_param_t); uint8_t *pdata (uint8_t*)SysLogParam; flash_table_t *flash_tmp get_flash_table(FLASH_SYSLOG_PARA_ZONE); /* 校验参数 */ gp_sys_log-crc_val.magic SYSTEM_LOG_MAGIC_PARAM; gp_sys_log-crc_val.len sizeof(sys_log_param_t) - sizeof(single_sav_t); gp_sys_log-crc_val.crc CRC16(pdata[sizeof(single_sav_t)], gp_sys_log-crc_val.len); start_addr gp_sys_ram-system_log_param_addr; /* 剩余内存不够写则重新从起始地址开始写实现环形存储功能 */ if((start_addr len) flash_tmp-end_address) { start_addr flash_tmp-start_address; } gp_sys_ram-system_log_param_addr start_addr len; /* 首地址存储擦除整个系统日志参数存储区 */ if(flash_tmp-start_address start_addr) { addr flash_tmp-start_address; do { if((addr FLASH_BLOCK_64K_SIZE) flash_tmp-end_address) { flash_erase(FLASH_SYSLOG_PARA_ZONE, BLOCK_64K_BASE(i), FLASH_BLOCK_64K); addr FLASH_BLOCK_64K_SIZE; } else if((addr FLASH_BLOCK_32K_SIZE) flash_tmp-end_address) { flash_erase(FLASH_SYSLOG_PARA_ZONE, BLOCK_32K_BASE(i), FLASH_BLOCK_32K); addr FLASH_BLOCK_32K_SIZE; } else if((addr FLASH_SECTOR_SIZE) flash_tmp-end_address) { flash_erase(FLASH_SYSLOG_PARA_ZONE, SECTOR_BASE(i), FLASH_BLOCK_4K); addr FLASH_SECTOR_SIZE; } else { break; } } while(addr flash_tmp-end_address); } remainbyte FLASH_SECTOR_SIZE - (start_addr % FLASH_SECTOR_SIZE); if(remainbyte len) { remainbyte len; } while(1) { flash_write(FLASH_SYSLOG_PARA_ZONE, start_addr, pdata, remainbyte); if(remainbyte len) { break; } else { pdata remainbyte; start_addr remainbyte; len - remainbyte; remainbyte (len FLASH_SECTOR_SIZE) ? FLASH_SECTOR_SIZE : len; } } }4.1.2 参数加载系统启动时从Flash加载日志参数int load_system_log_param(void) { uint32_t i 0; single_sav_t psav; uint32_t end_addr; uint32_t interal sizeof(sys_log_param_t); int data_len sizeof(sys_log_param_t) - sizeof(single_sav_t); uint8_t *pram (uint8_t*)SysLogParam; flash_table_t *flash_tmp get_flash_table(FLASH_SYSLOG_PARA_ZONE); end_addr flash_tmp-end_address - (flash_tmp-end_address - flash_tmp-start_address) % interal; for(i end_addr - interal; i flash_tmp-start_address; i - interal) { flash_read(FLASH_SYSLOG_PARA_ZONE, i, (uint8_t*)psav, sizeof(single_sav_t)); if((psav.magic SYSTEM_LOG_MAGIC_PARAM) (psav.len data_len)) { flash_read(FLASH_SYSLOG_PARA_ZONE, i sizeof(single_sav_t), pram[sizeof(single_sav_t)], data_len); if(psav.crc ! CRC16(pram[sizeof(single_sav_t)], data_len)) continue; gp_sys_ram-system_log_param_addr i; log_info(Load System Log Param Addr[0x%08x]!, gp_sys_ram-system_log_param_addr); return 0; } } /* 扫描不到合法的参数导入默认系统日志参数 */ load_system_log_default_param(); gp_sys_ram-system_log_param_addr flash_tmp-start_address; log_info(Load System Log Param Addr(Default)[0x%08x]!, gp_sys_ram-system_log_param_addr); return 1; }4.2 日志存储管理4.2.1 日志写入系统采用环形缓冲区方式存储日志延长Flash寿命int system_log_write(uint8_t *wbuf, int wlen) { uint32_t start_addr; uint8_t *pdata wbuf; uint32_t remainbyte; int system_catalog_max_id; flash_table_t *flash_tmp get_flash_table(FLASH_SYSLOG_ZONE); system_catalog_max_id ((flash_tmp-end_address - flash_tmp-start_address) / sizeof(system_catalog_t)); start_addr flash_tmp-start_address gp_sys_log-system_log.write_pos; /* 存储数据地址大于规划内存地址范围处理 */ if((start_addr wlen) flash_tmp-end_address) { start_addr flash_tmp-start_address; gp_sys_log-system_log.write_pos 0; gp_sys_log-system_log.log_cyclic_status 0x01; } gp_sys_log-system_log.write_pos wlen; if((gp_sys_log-system_log.log_latest_time.Year ! gp_sys_log-system_catalog.log_time.Year) || (gp_sys_log-system_log.log_latest_time.Month ! gp_sys_log-system_catalog.log_time.Month) || (gp_sys_log-system_log.log_latest_time.Day ! gp_sys_log-system_catalog.log_time.Day)) { /* 日期改变记录目录信息 */ system_catalog_write(gp_sys_log-system_catalog, gp_sys_log-system_catalog.log_id); gp_sys_log-system_catalog.log_time gp_sys_log-system_log.log_latest_time; if((gp_sys_log-system_catalog.log_id 1) system_catalog_max_id) { gp_sys_log-system_log.catalog_num system_catalog_max_id; gp_sys_log-system_log.catalog_cyclic_status 1; } else { if(0 gp_sys_log-system_log.catalog_cyclic_status) { gp_sys_log-system_log.catalog_num gp_sys_log-system_catalog.log_id 1; } } gp_sys_log-system_catalog.log_id (gp_sys_log-system_catalog.log_id 1) % system_catalog_max_id; gp_sys_log-system_catalog.log_addr start_addr; gp_sys_log-system_catalog.log_offset wlen; } else { gp_sys_log-system_catalog.log_offset wlen; } /* 写位置为存储起始地址并且不为扇区首地址 */ if((flash_tmp-start_address start_addr) (SECTOR_OFFSET(flash_tmp-start_address))) { flash_read(FLASH_SYSLOG_ZONE, SECTOR_BASE(start_addr), sector_buf, FLASH_SECTOR_SIZE); flash_erase(FLASH_SYSLOG_ZONE, SECTOR_BASE(start_addr), FLASH_BLOCK_4K); flash_write(FLASH_SYSLOG_ZONE, SECTOR_BASE(start_addr), sector_buf[0], SECTOR_OFFSET(start_addr)); } /* 写位置为扇区首地址则擦除一个扇区的存储区 */ if(0 SECTOR_OFFSET(start_addr)) { flash_erase(FLASH_SYSLOG_ZONE, SECTOR_BASE(start_addr), FLASH_BLOCK_4K); } remainbyte FLASH_SECTOR_SIZE - (start_addr % FLASH_SECTOR_SIZE); if(remainbyte wlen) { remainbyte wlen; } while(1) { flash_write(FLASH_SYSLOG_ZONE, start_addr, pdata, remainbyte); if(remainbyte wlen) { break; } else { pdata remainbyte; start_addr remainbyte; wlen - remainbyte; remainbyte (wlen FLASH_SECTOR_SIZE) ? FLASH_SECTOR_SIZE : wlen; if(0 SECTOR_OFFSET(start_addr)) { flash_erase(FLASH_SYSLOG_ZONE, SECTOR_BASE(start_addr), FLASH_BLOCK_4K); } } } save_system_log_param(); return 0; }4.2.2 日志查询系统提供日志查询功能支持按日期查询和全部查询int system_catalog_all_print(void) { int i 0; system_catalog_t catalog; printf(System Log Command Information:\r\n); printf(Query Specifies Log : ATCATALOGLOG_IDCRLF\r\n); printf(Query All Log : ATCATALOG0CRLF\r\n\r\n); printf(Query All System Catalog:\r\n); printf(LOG_ID LOG_DATE LOG_ADDR LOG_OFFSET \r\n); for(i 0; i gp_sys_log-system_log.catalog_num; i) { if(i (gp_sys_log-system_catalog.log_id - 1)) { catalog gp_sys_log-system_catalog; } else { system_catalog_read(catalog, i 1); } printf(%d %04d-%02d-%02d 0x%08X %d \r\n, catalog.log_id, catalog.log_time.Year, catalog.log_time.Month, catalog.log_time.Day, catalog.log_addr, catalog.log_offset); memset((char*)catalog, 0, sizeof(system_catalog_t)); } return 0; }4.3 调试接口系统提供多级调试接口方便开发人员控制日志输出#define LOG_CLOSE_LEVEL 0x00 /* 关闭调试信息 */ #define LOG_ERROR_LEVEL 0x01 /* 错误调试信息 */ #define LOG_WARN_LEVEL 0x02 /* 警告调试信息 */ #define LOG_INFO_LEVEL 0x03 /* 关键调试信息 */ #define LOG_DEBUG_LEVEL 0x04 /* debug调试信息 */ #define LOG_RECORD_LEVEL 0x10 /* 保存日志并输出信息 */ #define LOG_PRINT_LEVEL 0xff #define SET_LOG_LEVEL(LEVEL) (gp_sys_param-system_print_level LEVEL) #define GET_LOG_LEVEL() (gp_sys_param-system_print_level) #define log_debug(fmt, args...) log_format(LOG_DEBUG_LEVEL, fmt, ##args) #define log_info(fmt, args...) log_format(LOG_INFO_LEVEL, fmt, ##args) #define log_warn(fmt, args...) log_format(LOG_WARN_LEVEL, fmt, ##args) #define log_error(fmt, args...) log_format(LOG_ERROR_LEVEL, fmt, ##args) #define log_record(fmt, args...) log_format(LOG_RECORD_LEVEL, fmt, ##args) #define printf(fmt, args...) log_format(LOG_PRINT_LEVEL, fmt, ##args) int log_format(uint8_t level, const char *fmt, ...) { #define TIME_PREFIX_SIZE (21) #define PRINT_MAX_SIZE (1024 TIME_PREFIX_SIZE) va_list args; int num 0, i 0, fmt_index 0; int fmt_str_len 0, ret -1; char buf[PRINT_MAX_SIZE]; static QueueHandle_t sem NULL; time_t time {0}; if(NULL sem) { sem xSemaphoreCreateCounting(1,1); } xSemaphoreTake(sem, portMAX_DELAY); ret -1; fmt_str_len 0; if(level ! LOG_PRINT_LEVEL) { if((GET_LOG_LEVEL() level) (level ! LOG_RECORD_LEVEL) (level ! LOG_ERROR_LEVEL)) goto exit_end; for(i 0; i SYSTEM_PRINT_FMT_LIST_MAX; i) { if(level system_print_fmt_list[i].level) { fmt_index i; break; } } if(i SYSTEM_PRINT_FMT_LIST_MAX) { goto exit_end; } fmt_str_len strlen(system_print_fmt_list[fmt_index].fmt_str); strncpy((char*)buf[TIME_PREFIX_SIZE], system_print_fmt_list[fmt_index].fmt_str, fmt_str_len); } va_start(args, fmt); num vsnprintf((char*)buf[fmt_str_len TIME_PREFIX_SIZE], PRINT_MAX_SIZE - fmt_str_len - TIME_PREFIX_SIZE - 2, fmt, args); va_end(args); if(num 0) { goto exit_end; } if(level ! LOG_PRINT_LEVEL) { num fmt_str_len; buf[num TIME_PREFIX_SIZE] \r; buf[num TIME_PREFIX_SIZE 1] \n; num 2; } if((GET_LOG_LEVEL() level) (level LOG_ERROR_LEVEL)) { //do nothing } else { ret bsp_debug_send((uint8_t*)buf[TIME_PREFIX_SIZE], num); } if((LOG_ERROR_LEVEL level) || (LOG_RECORD_LEVEL level)) { bsp_rtc_get_time(time); sprintf(buf[0], [%04d-%02d-%02d %02d:%02d:%02d, time.Year, time.Month, time.Day, time.Hour, time.Minute, time.Second); buf[TIME_PREFIX_SIZE - 1] ]; gp_sys_log-system_log.log_latest_time time; system_log_write((uint8_t*)buf, num TIME_PREFIX_SIZE); } exit_end: xSemaphoreGive(sem); return ret; }5. 系统优化与注意事项5.1 Flash寿命优化采用环形缓冲区设计均衡Flash磨损合理划分存储区域减少不必要的擦除操作根据Flash特性选择适当的擦除块大小5.2 性能优化批量写入数据减少Flash操作次数使用缓冲区减少小数据量的直接写入合理设置日志级别避免不必要的日志记录5.3 可靠性保障采用CRC校验确保参数完整性实现原子操作保护关键数据提供默认参数恢复机制5.4 实际应用建议根据设备Flash容量合理调整区域大小考虑日志压缩算法减少存储空间占用实现日志导出功能方便离线分析定期清理过期日志释放存储空间