From 517c822cf12e8ed892d2de3df0e3959c5a0c501c Mon Sep 17 00:00:00 2001
From: Chip Weinberger <weinberger.c@gmail.com>
Date: Thu, 1 Jun 2023 17:57:08 -0700
Subject: [PATCH] [Debug Helpers] add esp_backtrace_print_all_tasks function

---
 .../esp_system/include/esp_debug_helpers.h    | 27 ++++++++
 .../port/arch/xtensa/debug_helpers.c          | 65 +++++++++++++++++++
 2 files changed, 92 insertions(+)

diff --git a/components/esp_system/include/esp_debug_helpers.h b/components/esp_system/include/esp_debug_helpers.h
index c5d92a50708d..3960c4ad41f5 100644
--- a/components/esp_system/include/esp_debug_helpers.h
+++ b/components/esp_system/include/esp_debug_helpers.h
@@ -12,6 +12,11 @@ extern "C" {
 
 #ifndef __ASSEMBLER__
 
+#if CONFIG_FREERTOS_ENABLE_TASK_SNAPSHOT
+#include "freertos/FreeRTOS.h"
+#include "freertos/task_snapshot.h"
+#endif
+
 #include <stdbool.h>
 #include "esp_err.h"
 #include "soc/soc.h"  // [refactor-todo] IDF-2297
@@ -109,6 +114,28 @@ esp_err_t esp_backtrace_print_from_frame(int depth, const esp_backtrace_frame_t*
  */
 esp_err_t esp_backtrace_print(int depth);
 
+#if CONFIG_FREERTOS_ENABLE_TASK_SNAPSHOT
+/**
+ * @brief Convert a FreeRTOS TaskSnapshot into a esp_backtrace_frame_t
+ *
+ * @param snapshot The task snapshot, from vTaskGetSnapshot or uxTaskGetSnapshotAll
+ *
+ * @return the backtrace frame
+ */
+esp_backtrace_frame_t esp_task_snapshot_to_backtrace_frame(TaskSnapshot_t snapshot);
+
+/**
+ * @brief Print the backtrace of every task on the system
+ *
+ * @param depth The maximum number of stack frames to print (should be > 0)
+ *
+ * @return
+ *      - ESP_OK    All backtraces successfully printed to completion or to depth limit
+ *      - ESP_FAIL  One or more backtraces is corrupt
+ */
+esp_err_t esp_backtrace_print_all_tasks(int depth, bool panic);
+#endif
+
 /**
  * @brief Set a watchpoint to break/panic when a certain memory range is accessed.
  * Superseded by esp_cpu_set_watchpoint in esp_cpu.h.
diff --git a/components/esp_system/port/arch/xtensa/debug_helpers.c b/components/esp_system/port/arch/xtensa/debug_helpers.c
index 9cb55d2eff86..90d257a3d02a 100644
--- a/components/esp_system/port/arch/xtensa/debug_helpers.c
+++ b/components/esp_system/port/arch/xtensa/debug_helpers.c
@@ -7,6 +7,13 @@
 #include <string.h>
 
 #include "sdkconfig.h"
+
+#if CONFIG_FREERTOS_ENABLE_TASK_SNAPSHOT
+#include "freertos/FreeRTOS.h"
+#include "freertos/task.h"
+#include "freertos/task_snapshot.h"
+#endif
+
 #include "esp_types.h"
 #include "esp_attr.h"
 #include "esp_err.h"
@@ -101,3 +108,61 @@ esp_err_t IRAM_ATTR esp_backtrace_print(int depth)
     esp_backtrace_get_start(&(start.pc), &(start.sp), &(start.next_pc));
     return esp_backtrace_print_from_frame(depth, &start, false);
 }
+
+
+#if CONFIG_FREERTOS_ENABLE_TASK_SNAPSHOT
+
+esp_backtrace_frame_t esp_task_snapshot_to_backtrace_frame(TaskSnapshot_t snapshot)
+{
+    XtExcFrame* xtf = (XtExcFrame*)snapshot.pxTopOfStack;
+
+    esp_backtrace_frame_t frame = {
+        .pc = xtf->pc,
+        .sp = xtf->a1,
+        .next_pc = xtf->a0,
+        .exc_frame = xtf,
+    };
+
+    return frame;
+}
+
+esp_err_t IRAM_ATTR esp_backtrace_print_all_tasks(int depth, bool panic)
+{
+    // todo: should we disable context switching, and the other core?
+    // It works fine without that, but still seems like a good idea.
+
+    uint32_t task_count = uxTaskGetNumberOfTasks();
+
+    TaskSnapshot_t* snapshots = (TaskSnapshot_t*) calloc(task_count * sizeof(TaskSnapshot_t), 1);
+
+    // get snapshots
+    UBaseType_t tcb_size = 0;
+    uint32_t got = uxTaskGetSnapshotAll(snapshots, task_count, &tcb_size);
+
+    uint32_t len = got < task_count ? got : task_count;
+
+    print_str("printing all tasks:\n\n", panic);
+
+    esp_err_t err = ESP_OK;
+
+    for (uint32_t i = 0; i < len; i++) {
+
+        TaskHandle_t handle = (TaskHandle_t) snapshots[i].pxTCB;
+
+        char* name = pcTaskGetName(handle);
+
+        print_str(name ? name : "No Name" , panic);
+
+        esp_backtrace_frame_t frame = esp_task_snapshot_to_backtrace_frame(snapshots[i]);
+
+        esp_err_t nerr = esp_backtrace_print_from_frame(depth, &frame, panic);
+        if (nerr != ESP_OK) {
+            err = nerr;
+        }
+    }
+
+    free(snapshots);
+    return err;
+}
+
+#endif // CONFIG_FREERTOS_ENABLE_TASK_SNAPSHOT