ESP-IDF 中使用 esp-iot-solution GProf 组件做 GNU Profiler 性能分析【免费下载链接】esp-iot-solutionEspressif IoT Library. IoT Device Drivers, Documentations and Solutions.项目地址: https://gitcode.com/GitHub_Trending/es/esp-iot-solution导读本文介绍 Espressif IoT Solutionesp-iot-solution仓库中 components/gprof 组件的完整使用方法与底层原理。GProfEspressif GNU Profiler用于统计程序运行过程中各函数及代码段消耗的时间与占比帮助开发者定位热点、指导软件优化。读完本文你将掌握如何在 ESP-IDF 工程中集成该组件、如何配置目标组件与自定义分区、如何调用esp_gprof_init/esp_gprof_save采集数据以及如何用idf.py gprof/idf.py gprof-graphic生成文本分析与 PNG 调用图。GProf 是什么面向 ESP-IDF 的 GNU Profiler根据 components/gprof/README.md 的描述Espressif GNU Profiler 用于评估运行程序中各部分的耗时与占比开发者可据此进行软件优化。它实现了 GNU Profiler 的主要功能并在标准 gprof 基础上针对嵌入式场景做了三点增强统计 OS API 调用信息可采集调用系统接口如sleep、read等的信息该能力针对 Xtensa CPU 提供。按组件粒度选择可只对用户指定的 ESP-IDF 组件进行插桩无需对全部组件生效从而显著减小侵入范围与开销。独立分区存储数据存放在一个类型为data、子类型为0x3a的分区中随固件持久化方便事后导出分析。从源码结构看组件核心实现位于 src/esp_gprof.c对外 API 定义在 include/gprof.h数据格式定义在 private_include/gprof_types.h构建期插桩逻辑位于 gprof.cmake 与 scripts/gprof.py。使用限制原文档明确列出了以下限制使用前务必评估是否符合你的场景不能作用于内核组件如 FreeRTOS、libc、硬件驱动等这类组件的代码结构或链接方式不支持插桩。不能采集 IRAM 中的函数位于 IRAM 的代码段不在 gprof 统计范围内。不支持多线程只能采集调用esp_gprof_init的那个线程的数据_mcount中会通过任务句柄比对过滤其他线程。工作原理速览结合源码可以勾勒出 GProf 的两条数据通路时间直方图time histogramesp_gprof_init内部调用 esp_register_freertos_tick_hook 注册采样回调hist_sample_cbIRAM_ATTR见 esp_gprof.c。每个 tick 回调中读取当前 PCXtensa 下还支持通过栈回溯hist_bt_pc还原调用 PC按下标(pc - low_pc) / HISTFRACTION / sizeof(histcnt_t)累加直方图计数采样率即CONFIG_FREERTOS_HZ。调用关系图call graph构建期通过-pg编译选项在函数入口插入对_mcount的调用gprof.cmake 对选中组件目标添加target_compile_options(... -pg)。_mcountesp_gprof.c用哈希表记录 callerfrom与 calleeto之间的调用弧及次数缓冲区按ARCDENSITY、MINARCS、MAXARCS等参数动态分配见 gprof_types.h。esp_gprof_save会按 gmon 格式依次写入 headermagic 为gmon、时间直方图与调用图数据最后在分区头部写回总大小esp_gprof.c并打印esp_gprof: GProf data is saved successfully。集成步骤四步走1. 添加组件依赖在组件或项目的idf_component.yml中加入依赖dependencies: espressif/gprof: 0.*组件清单 idf_component.yml 显示该组件要求idf 5.1并依赖espressif/cmake_utilities构建期重链接脚本依赖。也可以使用组件管理器命令一键添加idf.py add-dependency espressif/gprof*CMake 阶段组件会被自动下载。2. 在工程 CMakeLists.txt 中包含 gprof 模块在你的工程CMakeLists.txt中、project(XXXX)之后添加project(XXXX) include(gprof)该文件由 project_include.cmake 把gprof.cmake所在的目录加入CMAKE_MODULE_PATH从而让include(gprof)生效。gprof.cmake在CONFIG_GPROF_ENABLE开启时会给选中的组件目标追加-pg编译选项并通过gprof.py relink对链接脚本做二次处理把选中组件的代码段集中到可供 gprof 统计的地址区间详见 gprof.cmake。3. menuconfig 启用并选择目标组件执行idf.py menuconfig按下述路径配置Component config --- Espressif GNU Profiler(GProf) --- [*] Enable Espressif GNU Profiler(GProf) (component_a;component_b) Select components for GProf对应 Kconfig 定义在 components/gprof/KconfigCONFIG_GPROF_ENABLE为总开关默认nCONFIG_GPROF_COMPONENTS为待插桩组件列表。注意多个组件必须以;分隔字符串中不能包含空格等无关符号组件名需与 ESP-IDF 组件目录/管理器命名一致例如示例中用了test_func;espressif__cjson。4. 配置 gprof 数据分区在工程分区表如partitions.csv中加入以下分区类型为data子类型为0x3a# Name, Type, SubType, Offset, Size, Flags gprof, data, 0x3a, , 0x1000,Offset留空表示自动分配。若选中的组件较多或较大可相应增大Size。存储侧实现见 gprof_storage_init它通过esp_partition_find_first(ESP_PARTITION_TYPE_DATA, 0x3a, NULL)查找分区并在保存前整片擦除。构建时 gprof.cmake 会读取该分区的 offset 与 size若找不到会直接FATAL_ERROR报错。API 调用在代码中埋点在工程代码中包含头文件并调用#include gprof.h ESP_ERROR_CHECK(esp_gprof_init()); // Your Code ESP_ERROR_CHECK(esp_gprof_save()); esp_gprof_deinit();四个 API 均在 include/gprof.h 声明API功能说明esp_err_t esp_gprof_init(void)初始化并开始采样分配直方图/调用图缓冲区、擦除分区、注册 tick 钩子并记录当前任务句柄esp_gprof.cesp_err_t esp_gprof_save(void)停止采样并保存数据到分区注销 tick 钩子按 gmon 格式写入 header/直方图/调用图及总大小esp_gprof.cesp_err_t esp_gprof_dump(void)从分区读出并以日志打印使用esp_partition_mmap映射分区后逐条解析打印esp_gprof.c便于在设备端直接观察esp_err_t esp_gprof_deinit(void)反初始化释放缓冲区并复位状态esp_gprof.c内部状态机定义在 gprof_types.hNONE - START - SAVED非法状态下调用对应 API 会返回ESP_ERR_INVALID_STATE。构建、运行与日志确认正常构建并烧录运行等待终端打印esp_gprof: GProf data is saved successfully该日志来自 esp_gprof.c同时ESP_LOGD级别还会打印实际写入的字节数与分区地址。随后即可导出分析。数据分析文本与 PNG 调用图生成文本分析结果idf.py gprof该自定义 target 由 gprof.cmake 定义它读取分区 offset/size、工程 ELF 与编译器调用scripts/gprof.py dump生成build/{PROJECT_NAME}.gprof.out供 gprof 工具链解析。生成 PNG 可视化调用图PNG 输出目前仅支持 Ubuntu 与 MacOS需先安装依赖工具Ubuntusudo apt install graphviz pip3 install gprof2dotMacOSbrew install graphviz pip3 install gprof2dot然后执行idf.py gprof-graphic生成图片位于build/{PROJECT_NAME}.gprof.png。该 target 在 gprof.cmake 中定义等价于gprof.py dump ... --graphic内部借助gprof2dotgraphviz将调用图渲染为图片便于快速识别热点调用路径。示例工程gprof_simple可通过组件管理器从示例模板创建工程idf.py create-project-from-example espressif/gprof*:gprof_simple该命令会把示例gprof_simple下载到当前目录进入后即可构建烧录。示例源码同时存放在本仓库 examples/gprof/gprof_simple其主程序非常简洁#include gprof.h #include test_func.h void app_main(void) { ESP_ERROR_CHECK(esp_gprof_init()); test_func(); ESP_ERROR_CHECK(esp_gprof_save()); esp_gprof_deinit(); }对应的 CMakeLists.txt 中project(gprof_simple)之后紧跟include(gprof)partitions.csv 展示了gprof, data, 0x3a, , 0x1000,的实际写法sdkconfig.defaults 给出了最小可用的配置组合CONFIG_GPROF_ENABLEy CONFIG_GPROF_COMPONENTStest_func;espressif__cjson CONFIG_PARTITION_TABLE_CUSTOMy CONFIG_PARTITION_TABLE_CUSTOM_FILENAMEpartitions.csv CONFIG_PARTITION_TABLE_FILENAMEpartitions.csv示例把test_func组件与第三方组件espressif__cjson作为插桩对象并切换到自定义分区表以容纳 gprof 数据分区是理解整套配置如何落地的直接参考。小结快速上手idf_component.yml加依赖 →CMakeLists.txt加include(gprof)→ menuconfig 开启并填组件列表 → 分区表加data/0x3a分区 → 代码中esp_gprof_init/esp_gprof_save→idf.py gprof分析。适用范围面向用户应用组件示例中为test_func、espressif__cjson这类业务组件不适用于内核、libc、驱动等底层组件不支持 IRAM 代码与多线程采样。可选增强esp_gprof_dump可在设备端直接打印原始数据idf.py gprof-graphic可生成 PNG 调用图帮助直观定位热点路径。如需进一步深入可阅读 components/gprof 目录下的 gprof.cmake、scripts/gprof.py 与 src/esp_gprof.c 源码并结合 examples/gprof/gprof_simple 示例工程实际运行验证。【免费下载链接】esp-iot-solutionEspressif IoT Library. IoT Device Drivers, Documentations and Solutions.项目地址: https://gitcode.com/GitHub_Trending/es/esp-iot-solution创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考
ESP-IDF 中使用 esp-iot-solution GProf 组件做 GNU Profiler 性能分析【免费下载链接】esp-iot-solutionEspressif IoT Library. IoT Device Drivers, Documentations and Solutions.项目地址: https://gitcode.com/GitHub_Trending/es/esp-iot-solution导读本文介绍 Espressif IoT Solutionesp-iot-solution仓库中 components/gprof 组件的完整使用方法与底层原理。GProfEspressif GNU Profiler用于统计程序运行过程中各函数及代码段消耗的时间与占比帮助开发者定位热点、指导软件优化。读完本文你将掌握如何在 ESP-IDF 工程中集成该组件、如何配置目标组件与自定义分区、如何调用esp_gprof_init/esp_gprof_save采集数据以及如何用idf.py gprof/idf.py gprof-graphic生成文本分析与 PNG 调用图。GProf 是什么面向 ESP-IDF 的 GNU Profiler根据 components/gprof/README.md 的描述Espressif GNU Profiler 用于评估运行程序中各部分的耗时与占比开发者可据此进行软件优化。它实现了 GNU Profiler 的主要功能并在标准 gprof 基础上针对嵌入式场景做了三点增强统计 OS API 调用信息可采集调用系统接口如sleep、read等的信息该能力针对 Xtensa CPU 提供。按组件粒度选择可只对用户指定的 ESP-IDF 组件进行插桩无需对全部组件生效从而显著减小侵入范围与开销。独立分区存储数据存放在一个类型为data、子类型为0x3a的分区中随固件持久化方便事后导出分析。从源码结构看组件核心实现位于 src/esp_gprof.c对外 API 定义在 include/gprof.h数据格式定义在 private_include/gprof_types.h构建期插桩逻辑位于 gprof.cmake 与 scripts/gprof.py。使用限制原文档明确列出了以下限制使用前务必评估是否符合你的场景不能作用于内核组件如 FreeRTOS、libc、硬件驱动等这类组件的代码结构或链接方式不支持插桩。不能采集 IRAM 中的函数位于 IRAM 的代码段不在 gprof 统计范围内。不支持多线程只能采集调用esp_gprof_init的那个线程的数据_mcount中会通过任务句柄比对过滤其他线程。工作原理速览结合源码可以勾勒出 GProf 的两条数据通路时间直方图time histogramesp_gprof_init内部调用 esp_register_freertos_tick_hook 注册采样回调hist_sample_cbIRAM_ATTR见 esp_gprof.c。每个 tick 回调中读取当前 PCXtensa 下还支持通过栈回溯hist_bt_pc还原调用 PC按下标(pc - low_pc) / HISTFRACTION / sizeof(histcnt_t)累加直方图计数采样率即CONFIG_FREERTOS_HZ。调用关系图call graph构建期通过-pg编译选项在函数入口插入对_mcount的调用gprof.cmake 对选中组件目标添加target_compile_options(... -pg)。_mcountesp_gprof.c用哈希表记录 callerfrom与 calleeto之间的调用弧及次数缓冲区按ARCDENSITY、MINARCS、MAXARCS等参数动态分配见 gprof_types.h。esp_gprof_save会按 gmon 格式依次写入 headermagic 为gmon、时间直方图与调用图数据最后在分区头部写回总大小esp_gprof.c并打印esp_gprof: GProf data is saved successfully。集成步骤四步走1. 添加组件依赖在组件或项目的idf_component.yml中加入依赖dependencies: espressif/gprof: 0.*组件清单 idf_component.yml 显示该组件要求idf 5.1并依赖espressif/cmake_utilities构建期重链接脚本依赖。也可以使用组件管理器命令一键添加idf.py add-dependency espressif/gprof*CMake 阶段组件会被自动下载。2. 在工程 CMakeLists.txt 中包含 gprof 模块在你的工程CMakeLists.txt中、project(XXXX)之后添加project(XXXX) include(gprof)该文件由 project_include.cmake 把gprof.cmake所在的目录加入CMAKE_MODULE_PATH从而让include(gprof)生效。gprof.cmake在CONFIG_GPROF_ENABLE开启时会给选中的组件目标追加-pg编译选项并通过gprof.py relink对链接脚本做二次处理把选中组件的代码段集中到可供 gprof 统计的地址区间详见 gprof.cmake。3. menuconfig 启用并选择目标组件执行idf.py menuconfig按下述路径配置Component config --- Espressif GNU Profiler(GProf) --- [*] Enable Espressif GNU Profiler(GProf) (component_a;component_b) Select components for GProf对应 Kconfig 定义在 components/gprof/KconfigCONFIG_GPROF_ENABLE为总开关默认nCONFIG_GPROF_COMPONENTS为待插桩组件列表。注意多个组件必须以;分隔字符串中不能包含空格等无关符号组件名需与 ESP-IDF 组件目录/管理器命名一致例如示例中用了test_func;espressif__cjson。4. 配置 gprof 数据分区在工程分区表如partitions.csv中加入以下分区类型为data子类型为0x3a# Name, Type, SubType, Offset, Size, Flags gprof, data, 0x3a, , 0x1000,Offset留空表示自动分配。若选中的组件较多或较大可相应增大Size。存储侧实现见 gprof_storage_init它通过esp_partition_find_first(ESP_PARTITION_TYPE_DATA, 0x3a, NULL)查找分区并在保存前整片擦除。构建时 gprof.cmake 会读取该分区的 offset 与 size若找不到会直接FATAL_ERROR报错。API 调用在代码中埋点在工程代码中包含头文件并调用#include gprof.h ESP_ERROR_CHECK(esp_gprof_init()); // Your Code ESP_ERROR_CHECK(esp_gprof_save()); esp_gprof_deinit();四个 API 均在 include/gprof.h 声明API功能说明esp_err_t esp_gprof_init(void)初始化并开始采样分配直方图/调用图缓冲区、擦除分区、注册 tick 钩子并记录当前任务句柄esp_gprof.cesp_err_t esp_gprof_save(void)停止采样并保存数据到分区注销 tick 钩子按 gmon 格式写入 header/直方图/调用图及总大小esp_gprof.cesp_err_t esp_gprof_dump(void)从分区读出并以日志打印使用esp_partition_mmap映射分区后逐条解析打印esp_gprof.c便于在设备端直接观察esp_err_t esp_gprof_deinit(void)反初始化释放缓冲区并复位状态esp_gprof.c内部状态机定义在 gprof_types.hNONE - START - SAVED非法状态下调用对应 API 会返回ESP_ERR_INVALID_STATE。构建、运行与日志确认正常构建并烧录运行等待终端打印esp_gprof: GProf data is saved successfully该日志来自 esp_gprof.c同时ESP_LOGD级别还会打印实际写入的字节数与分区地址。随后即可导出分析。数据分析文本与 PNG 调用图生成文本分析结果idf.py gprof该自定义 target 由 gprof.cmake 定义它读取分区 offset/size、工程 ELF 与编译器调用scripts/gprof.py dump生成build/{PROJECT_NAME}.gprof.out供 gprof 工具链解析。生成 PNG 可视化调用图PNG 输出目前仅支持 Ubuntu 与 MacOS需先安装依赖工具Ubuntusudo apt install graphviz pip3 install gprof2dotMacOSbrew install graphviz pip3 install gprof2dot然后执行idf.py gprof-graphic生成图片位于build/{PROJECT_NAME}.gprof.png。该 target 在 gprof.cmake 中定义等价于gprof.py dump ... --graphic内部借助gprof2dotgraphviz将调用图渲染为图片便于快速识别热点调用路径。示例工程gprof_simple可通过组件管理器从示例模板创建工程idf.py create-project-from-example espressif/gprof*:gprof_simple该命令会把示例gprof_simple下载到当前目录进入后即可构建烧录。示例源码同时存放在本仓库 examples/gprof/gprof_simple其主程序非常简洁#include gprof.h #include test_func.h void app_main(void) { ESP_ERROR_CHECK(esp_gprof_init()); test_func(); ESP_ERROR_CHECK(esp_gprof_save()); esp_gprof_deinit(); }对应的 CMakeLists.txt 中project(gprof_simple)之后紧跟include(gprof)partitions.csv 展示了gprof, data, 0x3a, , 0x1000,的实际写法sdkconfig.defaults 给出了最小可用的配置组合CONFIG_GPROF_ENABLEy CONFIG_GPROF_COMPONENTStest_func;espressif__cjson CONFIG_PARTITION_TABLE_CUSTOMy CONFIG_PARTITION_TABLE_CUSTOM_FILENAMEpartitions.csv CONFIG_PARTITION_TABLE_FILENAMEpartitions.csv示例把test_func组件与第三方组件espressif__cjson作为插桩对象并切换到自定义分区表以容纳 gprof 数据分区是理解整套配置如何落地的直接参考。小结快速上手idf_component.yml加依赖 →CMakeLists.txt加include(gprof)→ menuconfig 开启并填组件列表 → 分区表加data/0x3a分区 → 代码中esp_gprof_init/esp_gprof_save→idf.py gprof分析。适用范围面向用户应用组件示例中为test_func、espressif__cjson这类业务组件不适用于内核、libc、驱动等底层组件不支持 IRAM 代码与多线程采样。可选增强esp_gprof_dump可在设备端直接打印原始数据idf.py gprof-graphic可生成 PNG 调用图帮助直观定位热点路径。如需进一步深入可阅读 components/gprof 目录下的 gprof.cmake、scripts/gprof.py 与 src/esp_gprof.c 源码并结合 examples/gprof/gprof_simple 示例工程实际运行验证。【免费下载链接】esp-iot-solutionEspressif IoT Library. IoT Device Drivers, Documentations and Solutions.项目地址: https://gitcode.com/GitHub_Trending/es/esp-iot-solution创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考
