Esp32CoreDumpUtil.hxx

Go to the documentation of this file.

 
#ifndef _FREERTOS_DRIVERS_ESP32_ESP32COREDUMPUTIL_HXX_
#define _FREERTOS_DRIVERS_ESP32_ESP32COREDUMPUTIL_HXX_
 
#include "sdkconfig.h"
#include "os/Gpio.hxx"
#include "utils/FileUtils.hxx"
#include "utils/logging.h"
#include "utils/StringPrintf.hxx"
 
#include <esp_core_dump.h>
#include <esp_log.h>
 
namespace openmrn_arduino
{
 
class Esp32CoreDumpUtil
{
public:
  static bool is_present()
  {
    esp_log_level_set("esp_core_dump_flash", ESP_LOG_NONE);
    esp_err_t res = esp_core_dump_image_check();
    esp_log_level_set("esp_core_dump_flash", ESP_LOG_WARN);
    return res == ESP_OK;
  }
 
  static void display(const char *output_path = nullptr)
  {
    if (is_present())
    {
      esp_core_dump_summary_t details;
      if (esp_core_dump_get_summary(&details) == ESP_OK)
      {
        // Convert the core dump to a text file
        string core_dump_summary =
            StringPrintf("Task:%s (%d) crashed at PC %08x\n",
                         details.exc_task, details.exc_tcb, details.exc_pc);
        core_dump_summary += StringPrintf("Registers:\n");
        for (size_t idx = 0; idx < 16; idx += 4)
        {
          core_dump_summary +=
              StringPrintf(
                  "A%02zu: 0x%08x A%02zu: 0x%08x A%02zu: 0x%08x A%02zu: 0x%08x\n",
                  idx, details.ex_info.exc_a[idx],
                  idx + 1, details.ex_info.exc_a[idx + 1],
                  idx + 2, details.ex_info.exc_a[idx + 2],
                  idx + 3, details.ex_info.exc_a[idx + 3]);
        }
        core_dump_summary +=
            StringPrintf("EXCCAUSE: %08x EXCVADDR: %08x\n",
                         details.ex_info.exc_cause, details.ex_info.exc_vaddr);
        if (details.ex_info.epcx_reg_bits)
        {
          core_dump_summary += "EPCX:";
          for (size_t idx = 0; idx < 8; idx++)
          {
            if (details.ex_info.epcx_reg_bits & BIT(idx))
            {
              core_dump_summary +=
                  StringPrintf("%zu:%08x ", idx, details.ex_info.epcx[idx]);
            }
          }
          core_dump_summary += "\n";
        }
        core_dump_summary += "Backtrace:";
        for (size_t idx = 0; idx < details.exc_bt_info.depth; idx++)
        {
          core_dump_summary +=
              StringPrintf(" 0x%08x", details.exc_bt_info.bt[idx]);
          if (details.exc_bt_info.corrupted)
          {
            core_dump_summary += "(corrupted)";
          }
        }
        core_dump_summary += "\n";
        LOG_ERROR("Core dump:\n%s", core_dump_summary.c_str());
        if (output_path)
        {
          write_string_to_file(output_path, core_dump_summary);
        }
      }
    }
  }
 
  static void cleanup()
  {
    if (is_present())
    {
      ESP_ERROR_CHECK_WITHOUT_ABORT(esp_core_dump_image_erase());
    }
  }
};
 
} // namespace openmrn_arduino
 
using openmrn_arduino::Esp32CoreDumpUtil;
 
#endif // _FREERTOS_DRIVERS_ESP32_ESP32COREDUMPUTIL_HXX_