@page debug debug [更正文档](https://gitee.com/alios-things/debug/edit/master/README.md)      [贡献说明](https://help.aliyun.com/document_detail/302301.html) # 概述 AliOS Things 调试诊断（debug）组件支持以下功能： - 异常管理，在系统异常后接管异常，并输出系统快照coredump信息 - 提供常见的系统调试诊断接口； - 提供常见的CLI调试命令(可输入help查看)，如： - cpuusage： 查询cpu利用率 - tasklist： 查询系统任务状态 - dumpsys mm: 查询系统内存使用状态 - debug： 查询系统内存/任务/队列/信号量/互斥锁等使用状态 - p: 查询内存值 - m: 改写内存值 ## 版权信息 > Apache license v2.0 ## 目录结构 ```tree ├── include │ └── aos │ └── debug.h #维测组件对外头接口 ├── package.yaml ├── README.md └── src ├── debug_api.h #维测组件内部头文件 ├── debug_backtrace.c #栈回溯 ├── debug_backtrace.h ├── debug.c #维测组件对外接口实现 ├── debug_cli_cmd.c #调试命令 ├── debug_cli_cmd.h ├── debug_cpuusage.c #cpu利用率 ├── debug_cpuusage.h ├── debug_dumpsys.c #内存信息查询 ├── debug_dumpsys.h ├── debug_infoget.c #组件内部接口实现 ├── debug_infoget.h ├── debug_lastword.c #临终遗言管理 ├── debug_lastword.h ├── debug_overview.c #系统调试信息查询 ├── debug_overview.h ├── debug_panic.c #系统异常coredump ├── debug_panic.h ├── debug_print.c #printk调试打印 ├── debug_print.h ├── debug_test.c #一些测试命令 └── debug_test.h ``` ## 依赖组件 * rhino * vfs(lastword功能依赖) * littlefs(lastword功能依赖) # 常用配置 系统中相关配置已有默认值，如需修改配置，统一在yaml中**def_config**节点修改，具体如下： > 系统异常后进入调试模式，可继续执行cli命令，系统不会自动复位（默认模式），可修改yaml配置如下，修改为0后，系统异常则会自动复位。 ```yaml def_config: DEBUG_PANIC_CLI: 1 ``` > 系统异常后，默认不会将ulog缓存里的log输出，可修改yaml配置如下，修改为1后，会输出ulog缓存里的log ```yaml def_config: DEBUG_ULOG_FLUSH: 0 ``` > cpuusage统计结果默认输出到串口终端，可修改yaml配置如下，修改为1后，会将cpuusage统计结果写入文件，不在终端输出 ```yaml def_config: DEBUG_CPUUSAGE_RECODE_TO_FILE_ENABLE: 0 #可配置写入文件的cpuusage的统计任务的最大数量 DEBUG_CPUUSAGE_MAX_TASK: 80 #可配置写入文件的路径 DEBUG_CPUUSAGE_FILE_NAME: "/data/cpuusage" ``` # API说明 - 参考 [debug_aos_api](https://dev.g.alicdn.com/alios-things-3.3/doc/group__debug__aos__api.html) # 使用示例 组件使用示例相关的代码下载、编译和固件烧录均依赖AliOS Things配套的开发工具，所以首先需要参考[《AliOS Things集成开发环境使用说明之搭建开发环境》](https://help.aliyun.com/document_detail/302378.html)，下载安装。 待开发环境搭建完成后，可以按照以下步骤进行示例的测试。 ## 步骤1 创建或打开工程 **打开已有工程** 如果用于测试的案例工程已存在，可参考[《AliOS Things集成开发环境使用说明之打开工程》](https://help.aliyun.com/document_detail/302381.html)打开已有工程。 **创建新的工程** 组件的示例代码可以通过编译链接到AliOS Things的任意案例（solution）来运行，这里选择helloworld_demo案例。helloworld_demo案例相关的源代码下载可参考[《AliOS Things集成开发环境使用说明之创建工程》](https://help.aliyun.com/document_detail/302379.html)。 ## 步骤2 添加组件 案例下载完成后，以运行helloworld_demo为例，需要在helloworld_demo组件的package.yaml中添加对组件的依赖： ```yaml depends: - debug: master # helloworld_demo中引入debug组件 ``` ## 步骤3 下载组件 在已安装了 的开发环境工具栏中，选择Terminal -> New Terminal启动终端，并且默认工作路径为当前工程的workspace，此时在终端命令行中输入： ```shell aos install debug ``` 上述命令执行成功后，组件源码则被下载到了./components/debug路径中。 ## 步骤4 添加示例 在debug组件的package.yaml中添加[example示例代码](https://gitee.com/alios-things/debug/tree/master/example)： ```yaml source_file: - example/debug_example.c ``` ## 步骤5 编译固件 在示例代码已经添加至组件的配置文件，并且helloworld_demo已添加了对该组件的依赖后，就可以编译helloworld_demo案例来生成固件了，具体编译方法可参考[《AliOS Things集成开发环境使用说明之编译固件》](https://help.aliyun.com/document_detail/302384.html)。 ## 步骤6 烧录固件 helloworld_demo案例的固件生成后，可参考[《AliOS Things集成开发环境使用说明之烧录固件》](https://help.aliyun.com/document_detail/302383.html)来烧录固件。 ## 步骤7 打开串口 固件烧录完成后，可以通过串口查看示例的运行结果，打开串口的具体方法可参考[《AliOS Things集成开发环境使用说明之查看日志》](https://help.aliyun.com/document_detail/302382.html)。 当串口终端打开成功后，可在串口中输入help来查看已添加的测试命令。 ## 步骤8 测试示例 **CLI命令行输入：** ```shell debug_api help # debug接口测试 ``` > 关键日志： ```shell You can use debug cmd to show api test: debug_api help --- show this debug_api 1 --- show memory info debug_api 2 --- show task info debug_api 3 --- show bufqueue info debug_api 4 --- show queue info debug_api 5 --- show sem info debug_api 6 --- show mutex info debug_api 7 --- show backtrace now debug_api 8 --- show backtrace task debug_api all --- show all above ``` 接着可根据提示使用debug_api n 进行相应的接口演示,如 **CLI命令行输入：** ```shell debug_api 1 # show memory info ``` > 关键日志： ```shell ========== Heap Info ========== --------------------------------------------------------------------------- [HEAP]| TotalSz | FreeSz | UsedSz | MinFreeSz | MaxFreeBlkSz | | 0x0067FFF8 | 0x0064D530 | 0x00032AC8 | 0x0064D120 | 0x0064D530 | --------------------------------------------------------------------------- ``` # FAQ Q1： cpuusage命令的使用说明是什么？ 答： cpuusage [-d n] [-t m] 命令启动CPU利用率统计，结果输出到串口终端 其中：-d 选项用于指定统计周期，单位为ms，默认为1 s； -t 选项用于指定统计时长，单位为ms，默认为连续运行。 举例说明： (1) cpuusage -- 启动一个cpuusage任务，该任务默认每隔1s执行一次统计; (2) cpuusage -d 3000 -- 启动一个cpuusage任务，该任务默认每隔3s（3000ms）执行一次统计; (3) cpuusage -d 2000 -t 10000 -- 启动一个cpuusage任务，该任务默认每隔2s（2000ms）执行一次统计，统计到10s（10000ms）后停止； (4) cpuusage -e -- 停止统计 Q2： 查看修改内存p/m命令的使用说明是什么？ 答： 查看内存 p addr [数量：默认为16个] [字节宽度显示,可选1/2/4，默认为4字节] 举例说明： p 0x80000000 -- 查看0x80000000处的内存值，默认输出16个地址，以4字节数据宽度显示 0x80000000: 80020000 60012ee1 60012f81 60012f87 0x80000010: 60012fa9 60012fb5 60012fc1 00000000 0x80000020: 00000000 00000000 00000000 60013005 0x80000030: 60013005 00000000 60013005 60013005 p 0x80000000 32 -- 查看0x80000000处的内存值，输出32个地址，以4字节数据宽度显示 0x80000000: 80020000 60012ee1 60012f81 60012f87 0x80000010: 60012fa9 60012fb5 60012fc1 00000000 0x80000020: 00000000 00000000 00000000 60013005 0x80000030: 60013005 00000000 60013005 60013005 0x80000040: 60008919 600076f1 60008919 600145cd 0x80000050: 60008919 60008919 60008919 60014e65 0x80000060: 60008389 60008919 60014939 60008919 0x80000070: 60008919 60008919 600147fb 60008919 p 0x80000000 32 2 -- 查看0x80000000处的内存值，输出32个地址，以2字节数据宽度显示 0x80000000: 0000 8002 2ee1 6001 2f81 6001 2f87 6001 0x80000010: 2fa9 6001 2fb5 6001 2fc1 6001 0000 0000 0x80000020: 0000 0000 0000 0000 0000 0000 3005 6001 0x80000030: 3005 6001 0000 0000 3005 6001 3005 6001 p 0x80000000 32 1 -- 查看0x80000000处的内存值，输出32个地址，以1字节数据宽度显示 0x80000000: 00 00 02 80 e1 2e 01 60 81 2f 01 60 87 2f 01 60 0x80000010: a9 2f 01 60 b5 2f 01 60 c1 2f 01 60 00 00 00 00 修改内存 m addr new_value 将addr处的内存值修改为new_value 举例说明： m 0x80000000 0x12345678 -- 将0x80000000处的内存值修改为0x12345678 value on 0x80000000 change from 0x80020000 to 0x12345678. 验证: p 0x80000000 0x80000000: 12345678 60012ee1 60012f81 60012f87 0x80000010: 60012fa9 60012fb5 60012fc1 00000000 0x80000020: 00000000 00000000 00000000 60013005 0x80000030: 60013005 00000000 60013005 60013005