Merge branch 'coredump_breaking_changes' into 'master'

change(coredump): drop binary format and crc checksum

Closes IDF-9020 and IDFGH-14364

See merge request espressif/esp-idf!40324

Author: erhankur

components/espcoredump/CMakeLists.txt

@@ -9,9 +9,7 @@ set(srcs "src/core_dump_init.c"
          "src/core_dump_flash.c"
          "src/core_dump_uart.c"
          "src/core_dump_elf.c"
-         "src/core_dump_binary.c"
-         "src/core_dump_sha.c"
-         "src/core_dump_crc.c")
+         "src/core_dump_sha.c")
 
 set(includes "include")
 set(priv_includes "include_core_dump")
@@ -38,7 +36,4 @@ idf_component_register(SRCS ${srcs}
 
 # make sure 'core_dump_init' object file is considered by the linker
 target_link_libraries(${COMPONENT_LIB} INTERFACE "-u esp_system_include_coredump_init")
-
-if(CONFIG_ESP_COREDUMP_DATA_FORMAT_ELF)
-  target_link_libraries(${COMPONENT_LIB} PRIVATE idf::esp_app_format)
-endif()
+target_link_libraries(${COMPONENT_LIB} PRIVATE idf::esp_app_format)

components/espcoredump/Kconfig

@@ -22,35 +22,10 @@ menu "Core dump"
             bool "None"
     endchoice
 
-    choice ESP_COREDUMP_DATA_FORMAT
-        prompt "Core dump data format"
-        default ESP_COREDUMP_DATA_FORMAT_ELF
-        depends on !ESP_COREDUMP_ENABLE_TO_NONE
-        help
-            Select the data format for core dump.
-        config ESP_COREDUMP_DATA_FORMAT_BIN
-            bool "Binary format"
-        config ESP_COREDUMP_DATA_FORMAT_ELF
-            bool "ELF format"
-    endchoice
-
-    choice ESP_COREDUMP_CHECKSUM
-        prompt "Core dump data integrity check"
-        default ESP_COREDUMP_CHECKSUM_CRC32
-        depends on !ESP_COREDUMP_ENABLE_TO_NONE
-        help
-            Select the integrity check for the core dump.
-        config ESP_COREDUMP_CHECKSUM_CRC32
-            bool "Use CRC32 for integrity verification"
-        config ESP_COREDUMP_CHECKSUM_SHA256
-            bool "Use SHA256 for integrity verification"
-            depends on ESP_COREDUMP_DATA_FORMAT_ELF
-    endchoice
-
     config ESP_COREDUMP_CAPTURE_DRAM
         bool "Include whole .bss and .data sections and heap data into core dump file"
         default n
-        depends on ESP_COREDUMP_DATA_FORMAT_ELF
+        depends on ESP_COREDUMP_ENABLE
         help
             Storing these sections can help with easier debugging and troubleshooting.
             However, additional storage space will be required in the core dump partition.
@@ -69,6 +44,8 @@ menu "Core dump"
     config ESP_COREDUMP_ENABLE
         bool
         default F
+        select ESP_COREDUMP_DATA_FORMAT_ELF
+        select ESP_COREDUMP_CHECKSUM_SHA256
         help
             Enables/disable core dump module.
 
@@ -129,7 +106,7 @@ menu "Core dump"
 
     config ESP_COREDUMP_SUMMARY_STACKDUMP_SIZE
         int "Size of the stack dump buffer"
-        depends on ESP_COREDUMP_DATA_FORMAT_ELF && ESP_COREDUMP_ENABLE_TO_FLASH && IDF_TARGET_ARCH_RISCV
+        depends on ESP_COREDUMP_ENABLE_TO_FLASH && IDF_TARGET_ARCH_RISCV
         range 512 4096
         default 1024
         help

components/espcoredump/include/esp_core_dump.h

@@ -1,5 +1,5 @@
 /*
- * SPDX-FileCopyrightText: 2015-2024 Espressif Systems (Shanghai) CO LTD
+ * SPDX-FileCopyrightText: 2015-2025 Espressif Systems (Shanghai) CO LTD
  *
  * SPDX-License-Identifier: Apache-2.0
  */
@@ -18,7 +18,7 @@ extern "C" {
 
 #define APP_ELF_SHA256_SZ (CONFIG_APP_RETRIEVE_LEN_ELF_SHA + 1)
 
-#if CONFIG_ESP_COREDUMP_ENABLE_TO_FLASH && CONFIG_ESP_COREDUMP_DATA_FORMAT_ELF
+#if CONFIG_ESP_COREDUMP_ENABLE_TO_FLASH
 
 /**
  * @brief Core dump summary, Most meaningful contents of the core dump
@@ -34,7 +34,7 @@ typedef struct {
     esp_core_dump_summary_extra_info_t ex_info; /*!< Architecture specific extra data */
 } esp_core_dump_summary_t;
 
-#endif /* CONFIG_ESP_COREDUMP_ENABLE_TO_FLASH && CONFIG_ESP_COREDUMP_DATA_FORMAT_ELF */
+#endif /* CONFIG_ESP_COREDUMP_ENABLE_TO_FLASH */
 
 /**************************************************************************************/
 /******************************** EXCEPTION MODE API **********************************/
@@ -52,27 +52,17 @@ void esp_core_dump_init(void);
 /**************************************************************************************/
 
 /**
- * Core dump file consists of header and data (in binary or ELF format) for every task in the system at the moment of crash.
+ * Core dump file consists of header and data (in ELF format) for every task in the system at the moment of crash.
  * For the data integrity, a checksum is used at the end of core the dump data.
  * The structure of core dump file is described below in details.
  * 1) Core dump starts with header:
  * 1.1) TOTAL_LEN is total length of core dump data in flash including the checksum. Size is 4 bytes.
  * 1.2) VERSION field keeps 4 byte version of core dump.
- * 1.2) TASKS_NUM is the number of tasks for which data are stored. Size is 4 bytes. Unused in ELF format
- * 1.3) TCB_SIZE is the size of task's TCB structure. Size is 4 bytes. Unused in ELF format
- * 1.4) MEM_SEG_NUM is the number of memory segment. Size is 4 bytes. Unused in ELF format
- * 1.5) CHIP_REV is the revision of the chip. Size is 4 bytes.
- * 2) Core dump header is followed by the data for every task in the system. Data part is differs for the binary
- *  and elf formats.
+ * 1.3) CHIP_REV is the revision of the chip. Size is 4 bytes.
+ * 2) Core dump header is followed by the data for every task in the system.
  * 2.1) The core dump file uses a subset of the ELF structures to store the crash information.
  *  Loadable ELF segments and ELF notes (ELF.PT_NOTE) used with a special name and type (CORE, NT_PRSTATUS type)
- * 2.2) In Binary format task data are started with the task header:
- * 2.2.1) TCB_ADDR is the address of TCB in memory. Size is 4 bytes.
- * 2.2.2) STACK_TOP is the top of task's stack (address of the topmost stack item). Size is 4 bytes.
- * 2.2.3) STACK_END is the end of task's stack (address from which task's stack starts). Size is 4 bytes.
- * 2.2.4) Task header is followed by TCB data. Size is TCB_SIZE bytes.
- * 2.2.5) Task's stack is placed after TCB data. Size is (STACK_END - STACK_TOP) bytes.
- * 2.3) The checksum is placed at the end of the data.
+ * 2.2) The checksum is placed at the end of the data.
  * 3) The structure of the uart data is the same as the data stored in flash
  * 3.1) Uart data is printed in base64 format surrounded with special messages to help user recognize the start and
  * end of actual data.
@@ -123,7 +113,7 @@ esp_err_t esp_core_dump_image_get(size_t* out_addr, size_t *out_size);
  */
 esp_err_t esp_core_dump_image_erase(void);
 
-#if CONFIG_ESP_COREDUMP_ENABLE_TO_FLASH && CONFIG_ESP_COREDUMP_DATA_FORMAT_ELF
+#if CONFIG_ESP_COREDUMP_ENABLE_TO_FLASH
 
 /**
  * @brief Get panic reason from the core dump.
@@ -171,7 +161,7 @@ esp_err_t esp_core_dump_get_panic_reason(char *reason_buffer, size_t buffer_size
  */
 esp_err_t esp_core_dump_get_summary(esp_core_dump_summary_t *summary);
 
-#endif /* CONFIG_ESP_COREDUMP_ENABLE_TO_FLASH && CONFIG_ESP_COREDUMP_DATA_FORMAT_ELF */
+#endif /* CONFIG_ESP_COREDUMP_ENABLE_TO_FLASH */
 
 #ifdef __cplusplus
 }

components/espcoredump/include/port/riscv/esp_core_dump_summary_port.h

@@ -12,7 +12,7 @@ extern "C"
 {
 #endif
 
-#if CONFIG_ESP_COREDUMP_ENABLE_TO_FLASH && CONFIG_ESP_COREDUMP_DATA_FORMAT_ELF
+#if CONFIG_ESP_COREDUMP_ENABLE_TO_FLASH
 
 /**
  * @brief Backtrace information
@@ -40,7 +40,7 @@ typedef struct {
     uint32_t exc_a[8];    /* A0-A7 registers when the exception caused */
 } esp_core_dump_summary_extra_info_t;
 
-#endif /* CONFIG_ESP_COREDUMP_ENABLE_TO_FLASH && CONFIG_ESP_COREDUMP_DATA_FORMAT_ELF */
+#endif /* CONFIG_ESP_COREDUMP_ENABLE_TO_FLASH */
 
 #ifdef __cplusplus
 }

components/espcoredump/include/port/xtensa/esp_core_dump_summary_port.h

@@ -13,7 +13,7 @@ extern "C"
 {
 #endif
 
-#if CONFIG_ESP_COREDUMP_ENABLE_TO_FLASH && CONFIG_ESP_COREDUMP_DATA_FORMAT_ELF
+#if CONFIG_ESP_COREDUMP_ENABLE_TO_FLASH
 
 #define EPCx_REGISTER_COUNT XCHAL_NUM_INTLEVELS
 
@@ -39,7 +39,7 @@ typedef struct {
     uint8_t epcx_reg_bits;              /*!< Bit mask of available EPCx registers */
 } esp_core_dump_summary_extra_info_t;
 
-#endif /* CONFIG_ESP_COREDUMP_ENABLE_TO_FLASH && CONFIG_ESP_COREDUMP_DATA_FORMAT_ELF */
+#endif /* CONFIG_ESP_COREDUMP_ENABLE_TO_FLASH */
 
 #ifdef __cplusplus
 }

components/espcoredump/include_core_dump/core_dump_checksum.h

@@ -1,5 +1,5 @@
 /*
- * SPDX-FileCopyrightText: 2015-2024 Espressif Systems (Shanghai) CO LTD
+ * SPDX-FileCopyrightText: 2015-2025 Espressif Systems (Shanghai) CO LTD
  *
  * SPDX-License-Identifier: Apache-2.0
  */
@@ -10,8 +10,7 @@
  *
  * This file contains all the functions required by the core dump component to
  * calculate checksums for data to write (or already written) on the flash.
- * Currently, both CRC32 and SHA256 are supported, but this interface is
- * implementation independent.
+ * Currently, only SHA256 is supported.
  */
 
 #ifndef CORE_DUMP_CHECKSUM_H_
@@ -25,7 +24,7 @@ extern "C" {
 
 /**
  * @brief Maximum possible length for a checksum (regardless of the
- * implentation). This can be modified in the future if a new implementation
+ * implementation). This can be modified in the future if a new implementation
  * requires a larger size.
  */
 #define COREDUMP_CHECKSUM_MAX_LEN 32

components/espcoredump/include_core_dump/esp_core_dump_common.h

@@ -137,9 +137,9 @@ esp_err_t esp_core_dump_write_data(core_dump_write_data_t *wr_data, void *data,
 esp_err_t esp_core_dump_write_end(core_dump_write_data_t *wr_data);
 
 /**
- * @brief Stores the core dump in either binary or ELF format.
+ * @brief Stores the core dump in ELF format.
  */
-esp_err_t esp_core_dump_store(void);
+esp_err_t esp_core_dump_write_elf(void);
 
 /**
  * @brief Get TCB length, in bytes.

components/espcoredump/include_core_dump/esp_core_dump_port.h

@@ -106,10 +106,10 @@ uint32_t esp_core_dump_get_stack(core_dump_task_header_t* task_snapshot,
  * @note The goal of this function is to check whether the task passed is the
  *       task that crashed or not. If this is the case and if it didn't crash
  *       within an ISR, its stack pointer will be set to the panic frame,
- *       containing all the registers values when the error occured. This
+ *       containing all the registers values when the error occurred. This
  *       function also checks if the TCB address is sane or not.
  *
- * @param task Pointer to the frame exception generated when the panic occured.
+ * @param task Pointer to the frame exception generated when the panic occurred.
  *
  * @return True if the TCB is sane, false else.
  */
@@ -120,7 +120,7 @@ bool esp_core_dump_check_task(core_dump_task_header_t *task);
  *
  * @note In practice, this function is used to fill the ELF file with the
  *       PR_STATUS sections for all the existing tasks. This structure
- *       contains the CPU registers value when the exception occured.
+ *       contains the CPU registers value when the exception occurred.
  *
  * @param task     Task to dump the registers from.
  * @param reg_dump Pointer that will be filled with the registers dump.
@@ -152,7 +152,7 @@ void esp_core_dump_port_set_crashed_tcb(uint32_t handle);
  */
 uint32_t esp_core_dump_get_extra_info(void **info);
 
-#if CONFIG_ESP_COREDUMP_ENABLE_TO_FLASH && CONFIG_ESP_COREDUMP_DATA_FORMAT_ELF
+#if CONFIG_ESP_COREDUMP_ENABLE_TO_FLASH
 
 /**
  * @brief Parse extra information into summary
@@ -180,7 +180,7 @@ void esp_core_dump_summary_parse_exc_regs(esp_core_dump_summary_t *summary, void
  */
 void esp_core_dump_summary_parse_backtrace_info(esp_core_dump_bt_info_t *bt_info, const void *vaddr,
                                                 const void *paddr, uint32_t stack_size);
-#endif /* CONFIG_ESP_COREDUMP_ENABLE_TO_FLASH && CONFIG_ESP_COREDUMP_DATA_FORMAT_ELF */
+#endif /* CONFIG_ESP_COREDUMP_ENABLE_TO_FLASH */
 
 #ifdef __cplusplus
 }

components/espcoredump/include_core_dump/esp_core_dump_types.h

@@ -1,5 +1,5 @@
 /*
- * SPDX-FileCopyrightText: 2015-2024 Espressif Systems (Shanghai) CO LTD
+ * SPDX-FileCopyrightText: 2015-2025 Espressif Systems (Shanghai) CO LTD
  *
  * SPDX-License-Identifier: Apache-2.0
  */
@@ -66,14 +66,9 @@ extern "C" {
                                                 (((_maj_)&0xFF) << 8) | \
                                                 (((_min_)&0xFF) << 0) \
                                             )
-#define COREDUMP_VERSION_BIN                0
 #define COREDUMP_VERSION_ELF                1
 
-/* legacy bin coredumps (before IDF v4.1) has version set to 1 */
-#define COREDUMP_VERSION_BIN_LEGACY         COREDUMP_VERSION_MAKE(COREDUMP_VERSION_BIN, 1) // -> 0x0001
-#define COREDUMP_VERSION_BIN_CURRENT        COREDUMP_VERSION_MAKE(COREDUMP_VERSION_BIN, 3) // -> 0x0003
-#define COREDUMP_VERSION_ELF_CRC32          COREDUMP_VERSION_MAKE(COREDUMP_VERSION_ELF, 2) // -> 0x0102
-#define COREDUMP_VERSION_ELF_SHA256         COREDUMP_VERSION_MAKE(COREDUMP_VERSION_ELF, 3) // -> 0x0103
+#define COREDUMP_VERSION_ELF_SHA256         COREDUMP_VERSION_MAKE(COREDUMP_VERSION_ELF, 4) // -> 0x0104
 #define COREDUMP_CURR_TASK_MARKER           0xDEADBEEF
 #define COREDUMP_CURR_TASK_NOT_FOUND        -1
 
@@ -93,17 +88,6 @@ extern "C" {
 
 typedef uint32_t core_dump_crc_t;
 
-#if CONFIG_ESP_COREDUMP_CHECKSUM_CRC32
-
-typedef struct {
-    core_dump_crc_t crc;
-    uint32_t total_bytes_checksum;  /* Number of bytes used to calculate the checksum */
-} core_dump_crc_ctx_t;
-
-typedef core_dump_crc_ctx_t checksum_ctx_t;
-
-#else
-
 #if CONFIG_IDF_TARGET_ESP32
 #include "mbedtls/sha256.h" /* mbedtls_sha256_context */
 typedef mbedtls_sha256_context sha256_ctx_t;
@@ -122,8 +106,6 @@ typedef struct {
 
 typedef core_dump_sha_ctx_t checksum_ctx_t;
 
-#endif
-
 /**
  * @brief Chip ID associated to this implementation.
  */
@@ -138,13 +120,10 @@ typedef struct _core_dump_write_data_t {
 
 /**
  * @brief Core dump data header
- * This header predecesses the actual core dump data (ELF or binary). */
+ * This header predecesses the actual core dump data (ELF). */
 typedef struct _core_dump_header_t {
     uint32_t data_len;  /*!< Data length */
     uint32_t version;   /*!< Core dump version */
-    uint32_t tasks_num; /*!< Number of tasks */
-    uint32_t tcb_sz;    /*!< Size of a TCB, in bytes */
-    uint32_t mem_segs_num; /*!< Number of memory segments */
     uint32_t chip_rev; /*!< Chip revision */
 } core_dump_header_t;
 

components/espcoredump/linker.lf

@@ -42,8 +42,6 @@ entries:
         core_dump_common (noflash)
         core_dump_port (noflash)
         core_dump_elf (noflash)
-        core_dump_binary (noflash)
-        core_dump_crc (noflash)
         # ESP32 uses mbedtls for the sha and mbedtls is in the flash
         if IDF_TARGET_ESP32 = n:
             core_dump_sha (noflash)