错误处理¶
概述¶
在应用程序开发中,及时发现并处理在运行时期的错误,对于保证应用程序的健壮性非常重要。常见的运行时错误有如下几种:
- 可恢复的错误:
- 通过函数的返回值(错误码)表示的错误
- 使用
throw
关键字抛出的 C++ 异常
- 不可恢复(严重)的错误:
- 断言失败(使用
assert
宏或者其它类似方法)或者直接调用abort()
函数造成的错误 - CPU 异常:访问受保护的内存区域、非法指令等
- 系统级检查:看门狗超时、缓存访问错误、堆栈溢出、堆栈粉碎、堆栈损坏等
- 断言失败(使用
本文将介绍 ESP-IDF 中针对可恢复错误的错误处理机制,并提供一些常见错误的处理模式。
关于如何处理不可恢复的错误,请查阅 不可恢复错误。
错误码¶
ESP-IDF 中大多数函数会返回 esp_err_t
类型的错误码, esp_err_t
实质上是带符号的整型,ESP_OK
代表成功(没有错误),具体值定义为 0。
在 ESP-IDF 中,许多头文件都会使用预处理器,定义可能出现的错误代码。这些错误代码通常均以 ESP_ERR_
前缀开头,一些常见错误(比如内存不足、超时、无效参数等)的错误代码则已经在 esp_err.h
文件中定义好了。此外,ESP-IDF 中的各种组件 (component) 也都可以针对具体情况,自行定义更多错误代码。
完整错误代码列表,请见 错误代码参考 中查看完整的错误列表。
错误码到错误消息¶
错误代码并不直观,因此 ESP-IDF 还可以使用 esp_err_to_name()
或者 esp_err_to_name_r()
函数,将错误代码转换为具体的错误消息。例如,我们可以向 esp_err_to_name()
函数传递错误代码 0x101
,可以得到返回字符串 “ESP_ERR_NO_MEM”。这样一来,我们可以在日志中输出更加直观的错误消息,而不是简单的错误码,从而帮助研发人员更快理解发生了何种错误。
此外,如果出现找不到匹配的 ESP_ERR_
值的情况,函数 esp_err_to_name_r()
则会尝试将错误码作为一种 标准 POSIX 错误代码 进行解释。具体过程为:POSIX 错误代码(例如 ENOENT
, ENOMEM
)定义在 errno.h
文件中,可以通过 errno
变量获得,进而调用 strerror_r
函数实现。在 ESP-IDF 中,errno
是一个基于线程的局部变量,即每个 FreeRTOS 任务都有自己的 errno
副本,通过函数修改 errno
也只会作用于当前任务中的 errno
变量值。
该功能(即在无法匹配 ESP_ERR_
值时,尝试用标准 POSIX 解释错误码)默认启用。用户也可以禁用该功能,从而减小应用程序的二进制文件大小,详情可见 CONFIG_ESP_ERR_TO_NAME_LOOKUP。注意,该功能对禁用并不影响 esp_err_to_name()
和 esp_err_to_name_r()
函数的定义,用户仍可调用这两个函数转化错误码。在这种情况下, esp_err_to_name()
函数在遇到无法匹配错误码的情况会返回 UNKNOWN ERROR
,而 esp_err_to_name_r()
函数会返回 Unknown error 0xXXXX(YYYYY)
,其中 0xXXXX
和 YYYYY
分别代表错误代码的十六进制和十进制表示。
ESP_ERROR_CHECK
宏¶
宏 ESP_ERROR_CHECK()
的功能和 assert
类似,不同之处在于:这个宏会检查 esp_err_t
的值,而非判断 bool
条件。如果传给 ESP_ERROR_CHECK()
的参数不等于 ESP_OK
,则会在控制台上打印错误消息,然后调用 abort()
函数。
错误消息通常如下所示:
ESP_ERROR_CHECK failed: esp_err_t 0x107 (ESP_ERR_TIMEOUT) at 0x400d1fdf
file: "/Users/user/esp/example/main/main.c" line 20
func: app_main
expression: sdmmc_card_init(host, &card)
Backtrace: 0x40086e7c:0x3ffb4ff0 0x40087328:0x3ffb5010 0x400d1fdf:0x3ffb5030 0x400d0816:0x3ffb5050
- 第一行打印错误代码的十六进制表示,及该错误在源代码中的标识符。这个标识符取决于 CONFIG_ESP_ERR_TO_NAME_LOOKUP 选项的设定。最后,第一行还会打印程序中该错误发生的具体位置。
- 下面几行显示了程序中调用
ESP_ERROR_CHECK()
宏的具体位置,以及传递给该宏的参数。 - 最后一行打印回溯结果。对于所有不可恢复错误,这里在应急处理程序中打印的内容都是一样的。更多有关回溯结果的详细信息,请参阅 不可恢复错误 。
注解
如果使用 IDF monitor, 则最后一行回溯结果中的地址将会被替换为相应的文件名和行号。
错误处理模式¶
尝试恢复。根据具体情况不同,我们具体可以:
- 在一段时间后,重新调用该函数;
- 尝试删除该驱动,然后重新进行“初始化”;
- 采用其他带外机制,修改导致错误发生的条件(例如,对一直没有响应的外设进行复位等)。
示例:
esp_err_t err; do { err = sdio_slave_send_queue(addr, len, arg, timeout); // 如果发送队列已满就不断重试 } while (err == ESP_ERR_TIMEOUT); if (err != ESP_OK) { // 处理其他错误 }
将错误传递回调用程序。在某些中间件组件中,采用此类处理模式代表函数必须以相同的错误码退出,这样才能确保所有分配的资源都能得到释放。
示例:
sdmmc_card_t* card = calloc(1, sizeof(sdmmc_card_t)); if (card == NULL) { return ESP_ERR_NO_MEM; } esp_err_t err = sdmmc_card_init(host, &card); if (err != ESP_OK) { // 释放内存 free(card); // 将错误码传递给上层(例如通知用户) // 或者,应用程序可以自定义错误代码并返回 return err; }
转为不可恢复错误,比如使用
ESP_ERROR_CHECK
。详情请见 ESP_ERROR_CHECK 宏 章节。对于中间件组件而言,通常并不希望在发生错误时中止应用程序。不过,有时在应用程序级别,这种做法是可以接受的。 在 ESP-IDF 的示例代码中,很多都会使用
ESP_ERROR_CHECK
来处理各种 API 引发的错误,虽然这不是应用程序的最佳做法,但可以让示例代码看起来更加简洁。示例:
ESP_ERROR_CHECK(spi_bus_initialize(host, bus_config, dma_chan));
C++ 异常¶
默认情况下,ESP-IDF 会禁用对 C++ 异常的支持,但是可以通过 CONFIG_COMPILER_CXX_EXCEPTIONS 选项启用。
通常情况下,启用异常处理会让应用程序的二进制文件增加几 kB。此外,启用该功能时还应为异常事故池预留一定内存。当应用程序无法从堆中分配异常对象时,就可以使用这个池中的内存。该内存池的大小可以通过 CONFIG_COMPILER_CXX_EXCEPTIONS_EMG_POOL_SIZE 来设定。
如果 C++ 程序抛出了异常,但是程序中并没有 catch
代码块来捕获该异常,那么程序的运行就会被 abort
函数中止,然后打印回溯信息。有关回溯的更多信息,请参阅 不可恢复错误 。