SylixOS内核的cdump功能

2023-11-03 06:18
文章标签 功能 内核 sylixos cdump

本文主要是介绍SylixOS内核的cdump功能,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

概念

cdump即CrashDump(奔溃信息转储),就是在紧急情况下存储故障信息,待系统恢复时还能读取或存入文件系统。

来由

当系统奔溃时,一般会通过串口控制台将奔溃信息(如当前寄存器值,线程名称,出错原因等)输出,以供开发人员对故障进行定位和分析。但有时的奔溃情况非常严重,不能或不便于通过串口输出,其他通信方式或磁盘访问也不能正常调用,此时就可以先把奔溃信息记录到指定内存中,等系统恢复或复位后再从指定内存读出或记录。这也是系统尽最大可能去保存奔溃信息的方法了。

大部分情况下cdump还是能起效的,这在于即便是很严重的奔溃,一般不会完全断电,内存一般也还是能正常的可访问的,且访问内存的速度非常快。但也可能达不到效果,比如指定内存在DDR内存空间中,DDR控制器故障或者重启后重新初始化了DDR内存,或则系统完全掉电,都会使得奔溃信息丢失。再有就是奔溃后CPU极快就被复位或停止了,没有足够的时间去进行保存操作。所以配置cdump的存储地址时,最好是选用同在SOC中的紧耦合内存(TCM)来存储,速度快,无需初始化控制器,也不需要太大空间,默认是2KB。

用法

首先在系统编译时,要保证 LW_CFG_CDUMP_ENLW_CFG_DEVICE_EN 配置宏都使能才会启用cdump功能。这两个配置宏位于libsylixos\SylixOS\config\system\system_cfg.h文件中,启停cdump功能只修改 LW_CFG_CDUMP_EN 宏即可。

系统默认的cdump存储空间大小是2KB,位于内核堆的末尾。通过内置的cdump命令即可显示或存储奔溃信息,存储文件名为 /var/log/cdump/ + UTC时间
在这里插入图片描述
以上是系统默认的配置或操作接口,系统同时也提供了3个API接口函数,供开发者编程定制。

  1. 设置存储地址及大小。
/*********************************************************************************************************
** 函数名称: API_CrashDumpBuffer
** 功能描述: 重新定位系统/应用崩溃信息记录位置. (必须是内核能访问的地址)
** 输 入  : pvCdump           缓冲地址
**           stSize            缓冲大小
** 输 出  : ERROR_NONE or PX_ERROR
*********************************************************************************************************/
INT  API_CrashDumpBuffer (PVOID  pvCdump, size_t  stSize);
  1. 保存到指定文件。
/*********************************************************************************************************
** 函数名称: API_CrashDumpSave
** 功能描述: 最近一次系统/应用崩溃信息保存入文件.
** 输 入  : pcLogFile         日志文件名
**           iFlag             open 第二个参数
**           iMode             open 第三个参数
**           bClear            成功保存后是否清空缓冲区
** 输 出  : ERROR_NONE or PX_ERROR
*********************************************************************************************************/
INT  API_CrashDumpSave (CPCHAR  pcLogFile, INT  iFlag, INT  iMode, BOOL  bClear);
  1. 通过指定文件输出显示,一般是标准输出文件。
/*********************************************************************************************************
** 函数名称: API_CrashDumpShow
** 功能描述: 显示最近一次系统/应用崩溃信息.
** 输 入  : iFd               打印文件描述符
**           bClear            是否清空缓冲区
** 输 出  : ERROR_NONE or PX_ERROR
*********************************************************************************************************/ 
INT  API_CrashDumpShow (INT  iFd, BOOL  bClear);

实现

cdump功能的实现代码主要位于 libsylixos\SylixOS\kernel\cdump 文件夹中。

基本配置

#define LW_CFG_CDUMP_EN                         1       /*  是否允许系统/应用崩溃信息暂存               */
#define LW_CFG_CDUMP_BUF_SIZE                   2048    /*  缓存大小                                    */
#define LW_CFG_CDUMP_CALL_STACK_DEPTH           20      /*  调用栈深度                                  */

默认位置及大小
这里决定了cdump的默认存储空间位于内核堆的末尾2KB空间。

/*********************************************************************************************************崩溃信息暂存配置
*********************************************************************************************************/
#if LW_CFG_CDUMP_EN > 0
#define LW_KERNEL_HEAP_START(a)     ((PVOID)a)
#define LW_KERNEL_HEAP_SIZE(s)      ((size_t)s - LW_CFG_CDUMP_BUF_SIZE)
#define LW_KERNEL_CDUMP_START(a, s) ((PVOID)((addr_t)a + LW_KERNEL_HEAP_SIZE(s)))
#define LW_KERNEL_CDUMP_SIZE(s)     LW_CFG_CDUMP_BUF_SIZE
#else
#define LW_KERNEL_HEAP_START(a)     ((PVOID)a)
#define LW_KERNEL_HEAP_SIZE(s)      ((size_t)s)
#endif

魔数头定义
奔溃信息在存储时前4字节是一个特征魔数,用于表征是否已存储及存储收正常。后面这是根据不同奔溃状态的信息字符串。

/*********************************************************************************************************宏定义
*********************************************************************************************************/
#define LW_CDUMP_MAGIC_0    0xab
#define LW_CDUMP_MAGIC_1    0x56
#define LW_CDUMP_MAGIC_2    0xef
#define LW_CDUMP_MAGIC_3    0x33
#define LW_CDUMP_MAGIC_LEN  4

存储区地址及长度全局变量定义及相关基本操作

static PVOID  _K_pvCrashDumpBuffer = (PVOID)PX_ERROR;
static size_t _K_stCrashDumpSize   = LW_CFG_CDUMP_BUF_SIZE;#define LW_CDUMP_BUF_SIZE   (_K_stCrashDumpSize)
#define LW_CDUMP_MAX_LEN    (LW_CDUMP_BUF_SIZE - 1)VOID  _CrashDumpSet (PVOID  pvCdump, size_t  stSize)
{_K_pvCrashDumpBuffer = pvCdump;_K_stCrashDumpSize   = stSize;
}PVOID  _CrashDumpGet (size_t  *pstSize)
{*pstSize = _K_stCrashDumpSize;return  (_K_pvCrashDumpBuffer);
}

奔溃时不同类型的存储信息调用接口,这些接口只会被内核调用。

/*********************************************************************************************************
** 函数名称: _CrashDumpAbortStkOf
** 功能描述: 堆栈溢出崩溃信息记录.
** 输 入  : ulRetAddr     异常返回 PC 地址
**           ulAbortAddr   异常地址
**           pcInfo        异常信息
**           ptcb          异常任务
** 输 出  : NONE
*********************************************************************************************************/
VOID  _CrashDumpAbortStkOf (addr_t  ulRetAddr, addr_t  ulAbortAddr, CPCHAR  pcInfo, PLW_CLASS_TCB  ptcb)
{PCHAR   pcCdump = (PCHAR)_K_pvCrashDumpBuffer;size_t  stOft   = 4;if (!pcCdump || (pcCdump == (PCHAR)PX_ERROR)) {return;}pcCdump[0] = LW_CDUMP_MAGIC_0;pcCdump[1] = LW_CDUMP_MAGIC_1;pcCdump[2] = LW_CDUMP_MAGIC_2;pcCdump[3] = LW_CDUMP_MAGIC_3;stOft = bnprintf(pcCdump, LW_CDUMP_MAX_LEN, stOft, "FATAL ERROR: thread %lx[%s] stack overflow. ""ret_addr: 0x%08lx abt_addr: 0x%08lx abt_type: %s\n""rebooting...\n",ptcb->TCB_ulId, ptcb->TCB_cThreadName,ulRetAddr, ulAbortAddr, pcInfo);pcCdump[stOft] = PX_EOS;
}
/*********************************************************************************************************
** 函数名称: _CrashDumpAbortFatal
** 功能描述: 崩溃信息记录.
** 输 入  : ulRetAddr     异常返回 PC 地址
**           ulAbortAddr   异常地址
**           pcInfo        异常信息
** 输 出  : NONE
*********************************************************************************************************/
VOID  _CrashDumpAbortFatal (addr_t  ulRetAddr, addr_t  ulAbortAddr, CPCHAR  pcInfo)
{PCHAR   pcCdump = (PCHAR)_K_pvCrashDumpBuffer;size_t  stOft   = 4;if (!pcCdump || (pcCdump == (PCHAR)PX_ERROR)) {return;}pcCdump[0] = LW_CDUMP_MAGIC_0;pcCdump[1] = LW_CDUMP_MAGIC_1;pcCdump[2] = LW_CDUMP_MAGIC_2;pcCdump[3] = LW_CDUMP_MAGIC_3;stOft = bnprintf(pcCdump, LW_CDUMP_MAX_LEN, stOft, "FATAL ERROR: abort occur in exception mode. ""ret_addr: 0x%08lx abt_addr: 0x%08lx abt_type: %s\n""rebooting...\n",ulRetAddr, ulAbortAddr, pcInfo);pcCdump[stOft] = PX_EOS;
}
/*********************************************************************************************************
** 函数名称: _CrashDumpAbortKernel
** 功能描述: 内核崩溃信息记录.
** 输 入  : ulOwner       占用内核的任务
**           pcKernelFunc  进入内核的函数
**           pvCtx         异常信息结构
**           pcInfo        异常信息
**           pcTail        附加信息
** 输 出  : NONE 
*********************************************************************************************************/
VOID  _CrashDumpAbortKernel (LW_OBJECT_HANDLE   ulOwner, CPCHAR             pcKernelFunc, PVOID              pvCtx,CPCHAR             pcInfo, CPCHAR             pcTail)
{PLW_VMM_ABORT_CTX  pabtctx = (PLW_VMM_ABORT_CTX)pvCtx;PCHAR              pcCdump = (PCHAR)_K_pvCrashDumpBuffer;size_t             stOft;if (!pcCdump || (pcCdump == (PCHAR)PX_ERROR)) {return;}lib_bzero(pcCdump, LW_CDUMP_BUF_SIZE);pcCdump[0] = LW_CDUMP_MAGIC_0;pcCdump[1] = LW_CDUMP_MAGIC_1;pcCdump[2] = LW_CDUMP_MAGIC_2;pcCdump[3] = LW_CDUMP_MAGIC_3;archTaskCtxPrint(&pcCdump[4], (LW_CDUMP_MAX_LEN - LW_CDUMP_MAGIC_LEN), &pabtctx->ABTCTX_archRegCtx);stOft = lib_strlen(pcCdump);stOft = bnprintf(pcCdump, LW_CDUMP_MAX_LEN, stOft, "FATAL ERROR: abort in kernel status. ""kowner: 0x%08lx, kfunc: %s, ""ret_addr: 0x%08lx abt_addr: 0x%08lx, abt_type: %s, %s.\n",ulOwner, pcKernelFunc, pabtctx->ABTCTX_ulRetAddr,pabtctx->ABTCTX_ulAbortAddr, pcInfo, pcTail);
}
/*********************************************************************************************************
** 函数名称: _CrashDumpAbortAccess
** 功能描述: 崩溃信息记录.
** 输 入  : pvCtx            异常信息结构
**           pcInfo           异常信息
** 输 出  : NONE
*********************************************************************************************************/
VOID  _CrashDumpAbortAccess (PVOID  pvCtx, CPCHAR  pcInfo)
{PLW_VMM_ABORT_CTX  pabtctx = (PLW_VMM_ABORT_CTX)pvCtx;PCHAR              pcCdump = (PCHAR)_K_pvCrashDumpBuffer;size_t             stOft;if (!pcCdump || (pcCdump == (PCHAR)PX_ERROR)) {return;}lib_bzero(pcCdump, LW_CDUMP_BUF_SIZE);pcCdump[0] = LW_CDUMP_MAGIC_0;pcCdump[1] = LW_CDUMP_MAGIC_1;pcCdump[2] = LW_CDUMP_MAGIC_2;pcCdump[3] = LW_CDUMP_MAGIC_3;archTaskCtxPrint(&pcCdump[4], (LW_CDUMP_MAX_LEN - LW_CDUMP_MAGIC_LEN), &pabtctx->ABTCTX_archRegCtx);stOft = lib_strlen(pcCdump);switch (__ABTCTX_ABORT_TYPE(pabtctx)) {case LW_VMM_ABORT_TYPE_UNDEF:stOft = bnprintf(pcCdump, LW_CDUMP_MAX_LEN, stOft, "UNDEF ERROR: abort in thread %lx[%s]. ""ret_addr: 0x%08lx abt_addr: 0x%08lx, abt_type: %s.\n",pabtctx->ABTCTX_ptcb->TCB_ulId,pabtctx->ABTCTX_ptcb->TCB_cThreadName,pabtctx->ABTCTX_ulRetAddr,pabtctx->ABTCTX_ulAbortAddr, pcInfo);break;case LW_VMM_ABORT_TYPE_FPE:stOft = bnprintf(pcCdump, LW_CDUMP_MAX_LEN, stOft, "FPU ERROR: abort in thread %lx[%s]. ""ret_addr: 0x%08lx abt_addr: 0x%08lx, abt_type: %s.\n",pabtctx->ABTCTX_ptcb->TCB_ulId,pabtctx->ABTCTX_ptcb->TCB_cThreadName,pabtctx->ABTCTX_ulRetAddr,pabtctx->ABTCTX_ulAbortAddr, pcInfo);break;default:stOft = bnprintf(pcCdump, LW_CDUMP_MAX_LEN, stOft, "ACCESS ERROR: abort in thread %lx[%s]. ""ret_addr: 0x%08lx abt_addr: 0x%08lx, abt_type: %s.\n",pabtctx->ABTCTX_ptcb->TCB_ulId,pabtctx->ABTCTX_ptcb->TCB_cThreadName,pabtctx->ABTCTX_ulRetAddr,pabtctx->ABTCTX_ulAbortAddr, pcInfo);break;}API_BacktracePrint(&pcCdump[stOft], (LW_CDUMP_MAX_LEN - stOft), LW_CFG_CDUMP_CALL_STACK_DEPTH);
}

API接口的实现

/*********************************************************************************************************
** 函数名称: API_CrashDumpBuffer
** 功能描述: 重新定位系统/应用崩溃信息记录位置. (必须是内核能访问的地址)
** 输 入  : pvCdump           缓冲地址
**           stSize            缓冲大小
** 输 出  : ERROR_NONE or PX_ERROR
*********************************************************************************************************/
LW_API  
INT  API_CrashDumpBuffer (PVOID  pvCdump, size_t  stSize)
{if (!pvCdump || (pvCdump == (PVOID)PX_ERROR) || (stSize < 512)) {_ErrorHandle(EINVAL);return  (PX_ERROR);}_CrashDumpSet(pvCdump, stSize);return  (ERROR_NONE);
}
/*********************************************************************************************************
** 函数名称: API_CrashDumpSave
** 功能描述: 最近一次系统/应用崩溃信息保存入文件.
** 输 入  : pcLogFile         日志文件名
**           iFlag             open 第二个参数
**           iMode             open 第三个参数
**           bClear            成功保存后是否清空缓冲区
** 输 出  : ERROR_NONE or PX_ERROR
*********************************************************************************************************/
LW_API  
INT  API_CrashDumpSave (CPCHAR  pcLogFile, INT  iFlag, INT  iMode, BOOL  bClear)
{PCHAR   pcCdump, pcBuffer;size_t  stSize, stLen;INT     iFd;pcCdump = (PCHAR)_CrashDumpGet(&stSize);if (!pcCdump || (pcCdump == (PCHAR)PX_ERROR) || (stSize < 512)) {_ErrorHandle(EINVAL);return  (PX_ERROR);}if (((UINT8)pcCdump[0] != LW_CDUMP_MAGIC_0) ||((UINT8)pcCdump[1] != LW_CDUMP_MAGIC_1) ||((UINT8)pcCdump[2] != LW_CDUMP_MAGIC_2) ||((UINT8)pcCdump[3] != LW_CDUMP_MAGIC_3)) {_ErrorHandle(EMSGSIZE);return  (PX_ERROR);}pcCdump[stSize - 1] = PX_EOS;iFd = open(pcLogFile, iFlag, iMode);if (iFd < 0) {return  (PX_ERROR);}pcBuffer = &pcCdump[4];stLen    = lib_strlen(pcBuffer);if (write(iFd, pcBuffer, stLen) != stLen) {close(iFd);return  (PX_ERROR);}close(iFd);if (bClear) {pcCdump[0] = 0;pcCdump[1] = 0;pcCdump[2] = 0;pcCdump[3] = 0;}return  (ERROR_NONE);
}
/*********************************************************************************************************
** 函数名称: API_CrashDumpShow
** 功能描述: 显示最近一次系统/应用崩溃信息.
** 输 入  : iFd               打印文件描述符
**           bClear            是否清空缓冲区
** 输 出  : ERROR_NONE or PX_ERROR
*********************************************************************************************************/
LW_API  
INT  API_CrashDumpShow (INT  iFd, BOOL  bClear)
{PCHAR   pcCdump, pcBuffer;size_t  stSize;pcCdump = (PCHAR)_CrashDumpGet(&stSize);if (!pcCdump || (pcCdump == (PCHAR)PX_ERROR) || (stSize < 512)) {_ErrorHandle(EINVAL);return  (PX_ERROR);}if (((UINT8)pcCdump[0] != LW_CDUMP_MAGIC_0) ||((UINT8)pcCdump[1] != LW_CDUMP_MAGIC_1) ||((UINT8)pcCdump[2] != LW_CDUMP_MAGIC_2) ||((UINT8)pcCdump[3] != LW_CDUMP_MAGIC_3)) {_ErrorHandle(EMSGSIZE);return  (PX_ERROR);}pcCdump[stSize - 1] = PX_EOS;pcBuffer            = &pcCdump[4];fdprintf(iFd, "%s", pcBuffer);if (bClear) {pcCdump[0] = 0;pcCdump[1] = 0;pcCdump[2] = 0;pcCdump[3] = 0;}return  (ERROR_NONE);
}

cdump命令的实现

/*********************************************************************************************************
** 函数名称: __tshellSysCmdCdump
** 功能描述: 系统命令 "cdump"
** 输 入  : iArgC         参数个数
**           ppcArgV       参数表
** 输 出  : 0
*********************************************************************************************************/
static INT  __tshellSysCmdCdump (INT  iArgC, PCHAR  ppcArgV[])
{INT         iC;BOOL        bSave  = LW_FALSE;BOOL        bClear = LW_FALSE;CHAR        cFile[MAX_FILENAME_LENGTH] = "/var/log/cdump/";time_t      tm;while ((iC = getopt(iArgC, ppcArgV, "sc")) != EOF) {switch (iC) {case 's':bSave = LW_TRUE;break;case 'c':bClear = LW_TRUE;break;}}getopt_free();if (bSave) {lib_time(&tm);snprintf(cFile, MAX_FILENAME_LENGTH, "%s/%lld","/var/log/cdump", tm);if (API_CrashDumpSave(cFile, O_CREAT | O_WRONLY | O_TRUNC, DEFAULT_FILE_PERM, bClear) < ERROR_NONE) {if (errno == EMSGSIZE) {fprintf(stderr, "no message in crash dump buffer.\n");} else {fprintf(stderr, "crash dump save (%s) fail: %s.\n", cFile, lib_strerror(errno));}return  (PX_ERROR);} else {printf("crash dump save (%s) ok.\n", cFile);}} else {if (API_CrashDumpShow(STD_OUT, bClear) < ERROR_NONE) {if (errno == EMSGSIZE) {fprintf(stderr, "no message in crash dump buffer.\n");}return  (PX_ERROR);}}return  (ERROR_NONE);
}

这篇关于SylixOS内核的cdump功能的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/336174

相关文章

mysql表操作与查询功能详解

《mysql表操作与查询功能详解》本文系统讲解MySQL表操作与查询,涵盖创建、修改、复制表语法,基本查询结构及WHERE、GROUPBY等子句,本文结合实例代码给大家介绍的非常详细,感兴趣的朋友跟随... 目录01.表的操作1.1表操作概览1.2创建表1.3修改表1.4复制表02.基本查询操作2.1 SE

Golang如何用gorm实现分页的功能

《Golang如何用gorm实现分页的功能》:本文主要介绍Golang如何用gorm实现分页的功能方式,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录背景go库下载初始化数据【1】建表【2】插入数据【3】查看数据4、代码示例【1】gorm结构体定义【2】分页结构体

Java Web实现类似Excel表格锁定功能实战教程

《JavaWeb实现类似Excel表格锁定功能实战教程》本文将详细介绍通过创建特定div元素并利用CSS布局和JavaScript事件监听来实现类似Excel的锁定行和列效果的方法,感兴趣的朋友跟随... 目录1. 模拟Excel表格锁定功能2. 创建3个div元素实现表格锁定2.1 div元素布局设计2.

HTML5实现的移动端购物车自动结算功能示例代码

《HTML5实现的移动端购物车自动结算功能示例代码》本文介绍HTML5实现移动端购物车自动结算,通过WebStorage、事件监听、DOM操作等技术,确保实时更新与数据同步,优化性能及无障碍性,提升用... 目录1. 移动端购物车自动结算概述2. 数据存储与状态保存机制2.1 浏览器端的数据存储方式2.1.

基于 HTML5 Canvas 实现图片旋转与下载功能(完整代码展示)

《基于HTML5Canvas实现图片旋转与下载功能(完整代码展示)》本文将深入剖析一段基于HTML5Canvas的代码,该代码实现了图片的旋转(90度和180度)以及旋转后图片的下载... 目录一、引言二、html 结构分析三、css 样式分析四、JavaScript 功能实现一、引言在 Web 开发中,

springboot下载接口限速功能实现

《springboot下载接口限速功能实现》通过Redis统计并发数动态调整每个用户带宽,核心逻辑为每秒读取并发送限定数据量,防止单用户占用过多资源,确保整体下载均衡且高效,本文给大家介绍spring... 目录 一、整体目标 二、涉及的主要类/方法✅ 三、核心流程图解(简化) 四、关键代码详解1️⃣ 设置

苹果macOS 26 Tahoe主题功能大升级:可定制图标/高亮文本/文件夹颜色

《苹果macOS26Tahoe主题功能大升级:可定制图标/高亮文本/文件夹颜色》在整体系统设计方面,macOS26采用了全新的玻璃质感视觉风格,应用于Dock栏、应用图标以及桌面小部件等多个界面... 科技媒体 MACRumors 昨日(6 月 13 日)发布博文,报道称在 macOS 26 Tahoe 中

Java使用HttpClient实现图片下载与本地保存功能

《Java使用HttpClient实现图片下载与本地保存功能》在当今数字化时代,网络资源的获取与处理已成为软件开发中的常见需求,其中,图片作为网络上最常见的资源之一,其下载与保存功能在许多应用场景中都... 目录引言一、Apache HttpClient简介二、技术栈与环境准备三、实现图片下载与保存功能1.

MybatisPlus service接口功能介绍

《MybatisPlusservice接口功能介绍》:本文主要介绍MybatisPlusservice接口功能介绍,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友... 目录Service接口基本用法进阶用法总结:Lambda方法Service接口基本用法MyBATisP

Java反射实现多属性去重与分组功能

《Java反射实现多属性去重与分组功能》在Java开发中,​​List是一种非常常用的数据结构,通常我们会遇到这样的问题:如何处理​​List​​​中的相同字段?无论是去重还是分组,合理的操作可以提高... 目录一、开发环境与基础组件准备1.环境配置:2. 代码结构说明:二、基础反射工具:BeanUtils