在主机上运行 ESP-IDF 应用程序

[English]

备注

在主机上运行 ESP-IDF 应用程序的功能仍处于试验阶段,无法保证 API 的稳定性。欢迎用户通过 ESP-IDF GitHub 仓库ESP32 论坛 提供反馈意见,助力未来 ESP-IDF 基于主机的应用程序设计。

本文档概述了在 Linux 上运行 ESP-IDF 应用程序的方法,并介绍了可以在 Linux 上运行的常见 ESP-IDF 应用程序类型。

介绍

ESP-IDF 应用程序通常在主机上进行构建(交叉编译),然后上传(即烧录)到 ESP 芯片上运行,并由主机通过 UART/USB 端口监控。然而,在 ESP 芯片上运行 ESP-IDF 应用程序在各种开发/使用/测试场景下可能存在限制。

因此,ESP-IDF 支持在同一台 Linux 主机上构建和运行其应用程序。在主机上运行 ESP-IDF 应用程序具有以下几个优点:

  • 无需上传到目标芯片。

  • 应用程序在主机上的运行速度比在 ESP 芯片上快。

  • 除主机本身外,无特定硬件要求。

  • 更易进行软件测试的自动化和设置。

  • 提供大量用于代码和运行分析的工具,如 Valgrind。

许多 ESP-IDF 组件依赖支持特定芯片的硬件,因此在主机上运行应用程序时,必须对这些硬件依赖文件进行模拟或仿真。目前,ESP-IDF 支持以下模拟和仿真方法:

  1. 使用 FreeRTOS POSIX/Linux 模拟器 可以模拟 FreeRTOS 调度。在此模拟的基础上,在主机上运行应用程序时也会模拟或使用其他 API。

  2. 使用 CMock 可以模拟所有依赖文件,并在完全独立的情况下运行代码。

原则上,这两种方法(POSIX/Linux 模拟器和使用 CMock 模拟)可以混用,但此功能在 ESP-IDF 中尚未实现。注意,尽管名称中包含 POSIX/Linux,但目前的 FreeRTOS POSIX/Linux 模拟器也支持在 macOS 系统中运行。在主机上运行 ESP-IDF 应用程序通常用于测试,但模拟环境和模拟依赖文件并不能完全代表目标设备。因此,仍然需要在目标设备上测试,此时测试的侧重点通常在集成和系统测试上。

备注

在主机上运行应用程序的另一方法是使用 QEMU 模拟器,但 ESP-IDF 的 QEMU 模拟器仍在开发中,尚未发布相关文档。

基于 CMock 的模拟

该方法使用 CMock 框架解决缺少硬件和软件依赖文件的问题。在主机上运行基于 CMock 的应用程序具备一大优势:在主机上运行的应用程序通常只编译必要代码,即模拟了最主要代码的依赖文件,而非编译整个系统。有关 Mocks 的总体介绍及其在 ESP-IDF 的配置和使用,请参阅 Mocks

POSIX/Linux 模拟器的模拟

ESP-IDF 已支持使用 FreeRTOS POSIX/Linux 模拟器 预览应用程序在目标芯片上的运行效果。使用该模拟器可以在主机上运行 ESP-IDF 组件,并使这类组件可用于在主机上运行的 ESP-IDF 应用程序。目前,只有一部分组件可以在 Linux 上构建。此外,各组件移植到 Linux 上后,其功能可能也会受到限制,或与在芯片目标上构建该组件的功能有所不同。有关所需组件在 Linux 上是否受支持的更多信息,请参阅 组件 Linux/Mock 支持情况概述

备注

FreeRTOS POSIX/Linux 模拟器支持配置 Amazon SMP FreeRTOS 版本,但模拟仍在单核模式下运行。支持 Amazon SMP FreeRTOS 主要是为给 Amazon SMP FreeRTOS 编写的 ESP-IDF 应用程序提供 API 兼容性。

使用模拟器的前提

  • 已安装 ESP-IDF 及使用 ESP-IDF 的所有依赖项

  • 满足系统软件包需求 (libbsdlibbsd-dev)

  • Linux 或 macOS 和 GCC 编译器已更新至足够新的版本

  • 应用程序所依赖的所有组件必须受 Linux 目标(Linux/POSIX 模拟器)支持,或可进行模拟

对于在 Linux 目标上运行的应用程序,需要在应用程序根目录的 CMakeLists.txt 文件中,设置 COMPONENTS 变量为 main,具体操作如下:

set(COMPONENTS main)

为方便起见,应用程序会在构建过程中,自动包含 ESP-IDF 的所有组件,执行上述代码则可以防止此类情况。

如果使用了任意模拟器,则应设置变量 Ruby

构建和运行

要在 Linux 上构建并运行应用程序,需要将目标芯片设置为 linux

idf.py --preview set-target linux
idf.py build
idf.py monitor

问题排查

应用程序是为主机编译的,因而可以用主机上的所有工具进行调试。例如,在 Linux 上可以使用 GDBValgrind。在没有连接调试器的情况下,定制了分段错误和中止信号的处理程序,为用户打印出更多信息,并提高与 ESP-IDF 工具的兼容性。

备注

以下功能绝不是应用程序在调试器中运行的替代方案。它们仅用于提供一些补充信息,例如,当在 CI/CD 系统中运行测试时,只收集应用程序日志。在大多数情况下,要追踪实际问题,请使用调试器复现问题。调试器会更加方便,例如,您无需将地址转换为行号。

分段错误

在 Linux 上,应用程序遇到分段错误时,会打印错误信息和基本的回溯。这些信息可以用于查找源代码中发生问题的行号。以下是 Hello-World 应用程序中发生分段错误的示例:

...
Hello world!
ERROR: Segmentation Fault, here's your backtrace:
path/to/esp-idf/examples/get-started/hello_world/build/hello_world.elf(+0x2d1b)[0x55d3f636ad1b]
/lib/x86_64-linux-gnu/libc.so.6(+0x3c050)[0x7f49f0e00050]
path/to/esp-idf/examples/get-started/hello_world/build/hello_world.elf(+0x6198)[0x55d3f636e198]
path/to/esp-idf/examples/get-started/hello_world/build/hello_world.elf(+0x5909)[0x55d3f636d909]
path/to/esp-idf/examples/get-started/hello_world/build/hello_world.elf(+0x2c93)[0x55d3f636ac93]
path/to/esp-idf/examples/get-started/hello_world/build/hello_world.elf(+0x484e)[0x55d3f636c84e]
/lib/x86_64-linux-gnu/libc.so.6(+0x89134)[0x7f49f0e4d134]
/lib/x86_64-linux-gnu/libc.so.6(+0x1097dc)[0x7f49f0ecd7dc]

注意,这些地址 (+0x...) 是相对的二进制地址,仍然需要转换为源代码行号(见下文)。 另外,回溯信息是由信号处理程序生成的,从回溯信息的第三行开始,才是问题发生的的堆栈帧,而最上面的两个堆栈帧不是导致错误的代码部分所以不重要。

path/to/esp-idf/examples/get-started/hello_world/build/hello_world.elf(+0x6198)[0x55d3f636e198]

要检索源代码中的实际行,需要使用文件名和相对地址(如,此例中的 +0x6198)来调用工具 addr2line

$ addr2line -e path/to/esp-idf/examples/get-started/hello_world/build/hello_world.elf +0x6198
path/to/esp-idf/components/esp_hw_support/port/linux/chip_info.c:13

现在,请使用主机上可用的详细调试工具进一步追踪问题。 有关 addr2line 及其调用方法的更多信息,请参见 addr2line 手册页

异常中止

一旦调用了 abort(),将打印以下行:

ERROR: Aborted

组件 Linux/Mock 支持情况概述

注意,下表中的“是”并不代表完全实现或模拟,它也可以表示功能的部分实现或模拟。实现或模拟通常只进行到可以提供足够功能、可以构建和运行测试应用程序的程度。

组件

模拟

仿真

cmock

driver

esp_app_format

esp_common

esp_event

esp_http_client

esp_http_server

esp_https_server

esp_hw_support

esp_netif

esp_netif_stack

esp_partition

esp_rom

esp_system

esp_timer

esp_tls

fatfs

freertos

hal

heap

http_parser

json

linux

log

lwip

mbedtls

mqtt

nvs_flash

partition_table

protobuf-c

pthread

soc

spiffs

spi_flash

tcp_transport

unity