4#ifdef USE_ESP32_CRASH_HANDLER
13#include <esp_private/panic_internal.h>
16#if CONFIG_IDF_TARGET_ARCH_XTENSA
17#include <esp_cpu_utils.h>
18#include <esp_debug_helpers.h>
19#include <xtensa_context.h>
20#elif CONFIG_IDF_TARGET_ARCH_RISCV
21#include <riscv/rvruntime-frames.h>
24static constexpr uint32_t CRASH_MAGIC = 0xDEADBEEF;
25static constexpr size_t MAX_BACKTRACE = 16;
29static inline bool IRAM_ATTR is_code_addr(
uint32_t addr) {
30 return (addr >= SOC_IROM_LOW && addr < SOC_IROM_HIGH) || (addr >= SOC_IRAM_LOW && addr < SOC_IRAM_HIGH);
33#if CONFIG_IDF_TARGET_ARCH_RISCV
37static inline bool is_return_addr(
uint32_t addr) {
38 if (!is_code_addr(addr) || addr < 4)
46 memcpy(&inst, (
const void *) (addr - 4),
sizeof(inst));
51 if ((opcode == 0x6f || opcode == 0x67) && rd == 0x80)
57 uint16_t c_inst = *(uint16_t *) (addr - 2);
58 if ((c_inst & 0xf07f) == 0x9002 && (c_inst & 0x0f80) != 0)
68#if CONFIG_IDF_TARGET_ARCH_XTENSA
71static uint8_t IRAM_ATTR walk_xtensa_backtrace(XtExcFrame *frame,
uint32_t *
out, uint8_t max) {
72 esp_backtrace_frame_t bt_frame = {
79 uint32_t first_pc = esp_cpu_process_stack_pc(bt_frame.pc);
80 if (is_code_addr(first_pc)) {
83 while (
count < max && bt_frame.next_pc != 0) {
84 if (!esp_backtrace_get_next_frame(&bt_frame))
86 uint32_t pc = esp_cpu_process_stack_pc(bt_frame.pc);
87 if (is_code_addr(pc)) {
95#if CONFIG_IDF_TARGET_ARCH_RISCV
98static uint8_t IRAM_ATTR capture_riscv_backtrace(RvExcFrame *frame,
uint32_t *
out, uint8_t max, uint8_t *reg_count) {
100 if (is_code_addr(frame->mepc)) {
103 if (is_code_addr(frame->ra) && frame->ra != frame->mepc) {
111 if (is_code_addr(
val) &&
val != frame->mepc &&
val != frame->ra) {
126static constexpr uint32_t CRASH_DATA_VERSION = 4;
127#if CONFIG_IDF_TARGET_ARCH_XTENSA
130static constexpr uint32_t XTENSA_EXCCAUSE_COUNT = XCHAL_EXCCAUSE_NUM;
131#elif CONFIG_IDF_TARGET_ARCH_RISCV
134static constexpr uint32_t RISCV_EXCEPTION_CAUSE_COUNT = 32;
140 uint8_t backtrace_count;
141 uint8_t reg_frame_count;
143 uint8_t pseudo_excause;
148 uint8_t crashed_core;
149#if SOC_CPU_CORES_NUM > 1
150 static_assert(SOC_CPU_CORES_NUM == 2,
"Dual-core logic assumes exactly 2 cores");
151 uint8_t other_backtrace_count;
152 uint8_t other_reg_frame_count;
153 uint32_t other_backtrace[MAX_BACKTRACE];
160static
bool s_crash_data_valid = false;
164static const char *
const TAG =
"esp32.crash";
174static uint32_t s_current_build_time =
static_cast<uint32_t>(ESPHOME_BUILD_TIME);
179static void read_crash_data() {
180 if (s_raw_crash_data.magic == CRASH_MAGIC && s_raw_crash_data.version == CRASH_DATA_VERSION) {
181 s_crash_data_valid =
true;
183 if (s_raw_crash_data.backtrace_count > MAX_BACKTRACE)
184 s_raw_crash_data.backtrace_count = MAX_BACKTRACE;
185 if (s_raw_crash_data.reg_frame_count > s_raw_crash_data.backtrace_count)
186 s_raw_crash_data.reg_frame_count = s_raw_crash_data.backtrace_count;
187 if (s_raw_crash_data.exception > 4)
188 s_raw_crash_data.exception = 4;
189 if (s_raw_crash_data.pseudo_excause > 1)
190 s_raw_crash_data.pseudo_excause = 0;
191 if (s_raw_crash_data.crashed_core >= SOC_CPU_CORES_NUM)
192 s_raw_crash_data.crashed_core = 0;
193#if SOC_CPU_CORES_NUM > 1
194 if (s_raw_crash_data.other_backtrace_count > MAX_BACKTRACE)
195 s_raw_crash_data.other_backtrace_count = MAX_BACKTRACE;
196 if (s_raw_crash_data.other_reg_frame_count > s_raw_crash_data.other_backtrace_count)
197 s_raw_crash_data.other_reg_frame_count = s_raw_crash_data.other_backtrace_count;
204 return s_crash_data_valid;
211 s_raw_crash_data.magic = 0;
215static bool cause_slot_was_written() {
216#if CONFIG_IDF_TARGET_ARCH_XTENSA
217 return s_raw_crash_data.cause < XTENSA_EXCCAUSE_COUNT;
219 return s_raw_crash_data.cause < RISCV_EXCEPTION_CAUSE_COUNT;
226static const char *get_exception_reason() {
227 uint8_t exception = s_raw_crash_data.exception;
228 if (exception == PANIC_EXCEPTION_ABORT || exception == PANIC_EXCEPTION_TWDT) {
232 if (!cause_slot_was_written()) {
236#if CONFIG_IDF_TARGET_ARCH_XTENSA
237 if (s_raw_crash_data.pseudo_excause) {
240 static const char *
const PSEUDO_REASON[] = {
242 "Unhandled debug exception",
244 "Unhandled kernel exception",
245 "Coprocessor exception",
246 "Interrupt wdt timeout on CPU0",
247 "Interrupt wdt timeout on CPU1",
250 uint32_t cause = s_raw_crash_data.cause;
251 if (cause <
sizeof(PSEUDO_REASON) /
sizeof(PSEUDO_REASON[0]))
252 return PSEUDO_REASON[cause];
253 return PSEUDO_REASON[0];
256 static const char *
const REASON[] = {
257 "IllegalInstruction",
259 "InstructionFetchError",
263 "IntegerDivideByZero",
266 "LoadStoreAlignment",
270 "LoadStorePIFDataError",
272 "LoadStorePIFAddrError",
275 "InstFetchPrivilege",
277 "InstrFetchProhibited",
282 "LoadStoreTLBMultihit",
283 "LoadStorePrivilege",
298 uint32_t cause = s_raw_crash_data.cause;
299 if (cause <
sizeof(REASON) /
sizeof(REASON[0]) && REASON[cause] !=
nullptr)
300 return REASON[cause];
301#elif CONFIG_IDF_TARGET_ARCH_RISCV
305 if (s_raw_crash_data.pseudo_excause)
307 static const char *
const REASON[] = {
308 "Instruction address misaligned",
309 "Instruction access fault",
310 "Illegal instruction",
312 "Load address misaligned",
314 "Store address misaligned",
315 "Store access fault",
316 "Environment call from U-mode",
317 "Environment call from S-mode",
319 "Environment call from M-mode",
320 "Instruction page fault",
325 uint32_t cause = s_raw_crash_data.cause;
326 if (cause <
sizeof(REASON) /
sizeof(REASON[0]) && REASON[cause] !=
nullptr)
327 return REASON[cause];
333static const char *get_exception_type() {
334 static const char *
const TYPES[] = {
341 uint8_t exc = s_raw_crash_data.exception;
342 if (exc <
sizeof(TYPES) /
sizeof(TYPES[0]))
348static void log_backtrace(
const uint32_t *addrs, uint8_t
count, uint8_t reg_frame_count) {
350 for (uint8_t i = 0; i <
count; i++) {
352#if CONFIG_IDF_TARGET_ARCH_RISCV
353 if (i >= reg_frame_count && !is_return_addr(addr))
355 const char *source = (i < reg_frame_count) ?
"backtrace" :
"stack scan";
357 const char *source =
"backtrace";
359 ESP_LOGE(TAG,
" BT%d: 0x%08" PRIX32
" (%s)", bt_num++, addr, source);
364static int append_addrs_to_hint(
char *buf,
int size,
int pos,
const uint32_t *addrs, uint8_t
count,
365 uint8_t reg_frame_count) {
366 for (uint8_t i = 0; i <
count &&
pos <
size - 12; i++) {
368#if CONFIG_IDF_TARGET_ARCH_RISCV
369 if (i >= reg_frame_count && !is_return_addr(addr))
372 pos += snprintf(buf + pos, size - pos,
" 0x%08" PRIX32, addr);
380#if CONFIG_IDF_TARGET_ARCH_XTENSA
381static const char *
const FAULT_ADDR_REG =
"EXCVADDR";
382static const char *
const FAULT_ADDR_REG_LOWER =
"excvaddr";
383#elif CONFIG_IDF_TARGET_ARCH_RISCV
384static const char *
const FAULT_ADDR_REG =
"MTVAL";
385static const char *
const FAULT_ADDR_REG_LOWER =
"mtval";
390static bool has_fault_addr() {
391 return s_raw_crash_data.exception == PANIC_EXCEPTION_FAULT && !s_raw_crash_data.pseudo_excause &&
392 cause_slot_was_written();
402static uint8_t log_foreign_backtrace(
const uint32_t *addrs, uint8_t
count, uint8_t bt_num) {
403 for (uint8_t i = 0; i <
count; i++) {
404 ESP_LOGE(TAG,
" bt%d: 0x%08" PRIX32, bt_num++, addrs[i]);
409static void log_foreign_addresses() {
410 ESP_LOGE(TAG,
" Captured by a different firmware build; addresses belong to that build's ELF");
411 ESP_LOGE(TAG,
" pc: 0x%08" PRIX32, s_raw_crash_data.pc);
412 if (has_fault_addr()) {
413 ESP_LOGE(TAG,
" %s: 0x%08" PRIX32, FAULT_ADDR_REG_LOWER, s_raw_crash_data.fault_addr);
415 uint8_t bt_num = log_foreign_backtrace(s_raw_crash_data.backtrace, s_raw_crash_data.backtrace_count, 0);
416#if SOC_CPU_CORES_NUM > 1
417 if (s_raw_crash_data.other_backtrace_count > 0) {
419 ESP_LOGE(TAG,
" other core (%d):", 1 - s_raw_crash_data.crashed_core);
420 log_foreign_backtrace(s_raw_crash_data.other_backtrace, s_raw_crash_data.other_backtrace_count, bt_num);
436 ESP_LOGE(TAG,
"*** CRASH DETECTED ON PREVIOUS BOOT ***");
437 const char *reason = get_exception_reason();
438 if (reason !=
nullptr) {
439 ESP_LOGE(TAG,
" Reason: %s - %s (cause %" PRIu32
")", get_exception_type(), reason, s_raw_crash_data.cause);
441 ESP_LOGE(TAG,
" Reason: %s", get_exception_type());
443 ESP_LOGE(TAG,
" Crashed core: %d", s_raw_crash_data.crashed_core);
444 if (s_raw_crash_data.build_time != s_current_build_time) {
447 log_foreign_addresses();
450 ESP_LOGE(TAG,
" PC: 0x%08" PRIX32
" (fault location)", s_raw_crash_data.pc);
453 if (has_fault_addr()) {
454 ESP_LOGE(TAG,
" %s: 0x%08" PRIX32
" (faulting address)", FAULT_ADDR_REG, s_raw_crash_data.fault_addr);
456 log_backtrace(s_raw_crash_data.backtrace, s_raw_crash_data.backtrace_count, s_raw_crash_data.reg_frame_count);
458#if SOC_CPU_CORES_NUM > 1
459 if (s_raw_crash_data.other_backtrace_count > 0) {
460 int other_core = 1 - s_raw_crash_data.crashed_core;
461 ESP_LOGE(TAG,
" Other core (%d) backtrace:", other_core);
462 log_backtrace(s_raw_crash_data.other_backtrace, s_raw_crash_data.other_backtrace_count,
463 s_raw_crash_data.other_reg_frame_count);
470 static const char *
const ADDR2LINE_CMD =
"addr2line -pfiaC -e firmware.elf";
472 int pos = snprintf(hint,
sizeof(hint),
"Use: %s 0x%08" PRIX32, ADDR2LINE_CMD, s_raw_crash_data.pc);
473 append_addrs_to_hint(hint,
sizeof(hint),
pos, s_raw_crash_data.backtrace, s_raw_crash_data.backtrace_count,
474 s_raw_crash_data.reg_frame_count);
475 ESP_LOGE(TAG,
"%s", hint);
476#if SOC_CPU_CORES_NUM > 1
477 if (s_raw_crash_data.other_backtrace_count > 0) {
478 pos = snprintf(hint,
sizeof(hint),
"Other core: %s", ADDR2LINE_CMD);
479 append_addrs_to_hint(hint,
sizeof(hint),
pos, s_raw_crash_data.other_backtrace,
480 s_raw_crash_data.other_backtrace_count, s_raw_crash_data.other_reg_frame_count);
481 ESP_LOGE(TAG,
"%s", hint);
503 s_raw_crash_data.pc = (
uint32_t) info->addr;
504 s_raw_crash_data.backtrace_count = 0;
505 s_raw_crash_data.reg_frame_count = 0;
506 s_raw_crash_data.exception = (uint8_t) info->exception;
507 s_raw_crash_data.pseudo_excause = info->pseudo_excause ? 1 : 0;
508 s_raw_crash_data.crashed_core = (uint8_t) info->core;
514 bool is_twdt = &g_twdt_isr !=
nullptr && g_twdt_isr;
515 s_raw_crash_data.exception = (uint8_t) (is_twdt ? PANIC_EXCEPTION_TWDT : PANIC_EXCEPTION_ABORT);
518 s_raw_crash_data.cause = 0;
519 s_raw_crash_data.fault_addr = 0;
524 s_raw_crash_data.build_time = esphome::esp32::s_current_build_time;
525#if SOC_CPU_CORES_NUM > 1
526 s_raw_crash_data.other_backtrace_count = 0;
527 s_raw_crash_data.other_reg_frame_count = 0;
530#if CONFIG_IDF_TARGET_ARCH_XTENSA
532 if (info->frame !=
nullptr) {
533 auto *xt_frame = (XtExcFrame *) info->frame;
535 if (info->pseudo_excause)
536 s_raw_crash_data.pc = xt_frame->pc;
537 if (!g_panic_abort) {
540 s_raw_crash_data.cause = xt_frame->exccause;
541 s_raw_crash_data.fault_addr = xt_frame->excvaddr;
543 s_raw_crash_data.backtrace_count = walk_xtensa_backtrace(xt_frame, s_raw_crash_data.backtrace, MAX_BACKTRACE);
546#if SOC_CPU_CORES_NUM > 1
550 if (info->core >= 0 && info->core < SOC_CPU_CORES_NUM) {
551 int other_core = 1 - info->core;
552 auto *other_frame = (XtExcFrame *) g_exc_frames[other_core];
553 if (other_frame !=
nullptr) {
554 s_raw_crash_data.other_backtrace_count =
555 walk_xtensa_backtrace(other_frame, s_raw_crash_data.other_backtrace, MAX_BACKTRACE);
560#elif CONFIG_IDF_TARGET_ARCH_RISCV
562 if (info->frame !=
nullptr) {
563 auto *rv_frame = (RvExcFrame *) info->frame;
564 if (!g_panic_abort) {
566 s_raw_crash_data.cause = rv_frame->mcause;
567 s_raw_crash_data.fault_addr = rv_frame->mtval;
569 s_raw_crash_data.backtrace_count =
570 capture_riscv_backtrace(rv_frame, s_raw_crash_data.backtrace, MAX_BACKTRACE, &s_raw_crash_data.reg_frame_count);
573#if SOC_CPU_CORES_NUM > 1
575 if (info->core >= 0 && info->core < SOC_CPU_CORES_NUM) {
576 int other_core = 1 - info->core;
577 auto *other_frame = (RvExcFrame *) g_exc_frames[other_core];
578 if (other_frame !=
nullptr) {
579 s_raw_crash_data.other_backtrace_count = capture_riscv_backtrace(
580 other_frame, s_raw_crash_data.other_backtrace, MAX_BACKTRACE, &s_raw_crash_data.other_reg_frame_count);
587 s_raw_crash_data.version = CRASH_DATA_VERSION;
588 s_raw_crash_data.magic = CRASH_MAGIC;
struct @66::@67 __attribute__
Wake the main loop task from an ISR. ISR-safe.
void __real_esp_panic_handler(panic_info_t *info)
void IRAM_ATTR __wrap_esp_panic_handler(panic_info_t *info)
std::vector< uint8_t > & out
bool crash_handler_has_data()
Returns true if crash data was found this boot, reading it first if needed.
void crash_handler_log()
Log crash data if a crash was detected on previous boot.
void crash_handler_clear()
Clear the magic marker and mark crash data as consumed.