fix: backtrace dump (#1057)

Author: sunxilin

core/include/ten_utils/backtrace/backtrace.h

@@ -14,12 +14,12 @@
 #include <stddef.h>
 #include <stdint.h>
 
-#ifdef __cplusplus
+#if defined(__cplusplus)
 extern "C" {
 #endif
 
 TEN_UTILS_API void ten_backtrace_dump_global(size_t skip);
 
-#ifdef __cplusplus
+#if defined(__cplusplus)
 } /* End extern "C".  */
 #endif

core/include/ten_utils/log/log.h

@@ -50,6 +50,12 @@
                           __FILE__, __LINE__, __VA_ARGS__);               \
   } while (0)
 
+#define TEN_LOGM(...)                                                     \
+  do {                                                                    \
+    ten_log_log_formatted(&ten_global_log, TEN_LOG_LEVEL_MANDATORY, __func__, \
+                          __FILE__, __LINE__, __VA_ARGS__);               \
+  } while (0)
+
 #define TEN_LOGV_AUX(log, ...)                                            \
   do {                                                                    \
     ten_log_log_formatted(log, TEN_LOG_LEVEL_VERBOSE, __func__, __FILE__, \
@@ -86,6 +92,12 @@
                           __LINE__, __VA_ARGS__);                       \
   } while (0)
 
+#define TEN_LOGM_AUX(log, ...)                                          \
+  do {                                                                  \
+    ten_log_log_formatted(log, TEN_LOG_LEVEL_MANDATORY, __func__, __FILE__, \
+                          __LINE__, __VA_ARGS__);                       \
+  } while (0)
+
 typedef enum TEN_LOG_LEVEL {
   TEN_LOG_LEVEL_INVALID,
 
@@ -95,6 +107,8 @@ typedef enum TEN_LOG_LEVEL {
   TEN_LOG_LEVEL_WARN,
   TEN_LOG_LEVEL_ERROR,
   TEN_LOG_LEVEL_FATAL,
+
+  TEN_LOG_LEVEL_MANDATORY
 } TEN_LOG_LEVEL;
 
 typedef struct ten_string_t ten_string_t;

core/include_internal/ten_runtime/engine/engine.h

@@ -51,6 +51,8 @@ struct ten_engine_t {
   // TODO(Wei): Perhaps this variable can be removed.
   bool is_ready_to_handle_msg;
 
+  ten_string_t graph_name;
+
   // When app creates an engine, it will create a randomized graph ID for the
   // engine. It _must_ be a UUID4 string.
   ten_string_t graph_id;
@@ -112,3 +114,6 @@ TEN_RUNTIME_PRIVATE_API bool ten_engine_is_ready_to_handle_msg(
 
 TEN_RUNTIME_PRIVATE_API const char *ten_engine_get_id(ten_engine_t *self,
                                                       bool check_thread);
+
+TEN_RUNTIME_PRIVATE_API void ten_engine_set_graph_name(ten_engine_t *self,
+                                                       const char *name);

core/include_internal/ten_runtime/extension_thread/extension_thread.h

@@ -46,6 +46,8 @@ typedef struct ten_extension_thread_t {
   ten_signature_t signature;
   ten_sanitizer_thread_check_t thread_check;
 
+  int64_t tid;
+
   TEN_EXTENSION_THREAD_STATE state;
   bool is_close_triggered;
 

core/include_internal/ten_utils/backtrace/backtrace.h

@@ -14,10 +14,14 @@
 #include <stddef.h>
 #include <stdint.h>
 
-#ifdef __cplusplus
+#define MAX_CAPTURED_CALL_STACK_DEPTH 128
+
+#if defined(__cplusplus)
 extern "C" {
 #endif
 
+// This is a virtual type, only used as the type for parameters of public
+// functions.
 typedef struct ten_backtrace_t ten_backtrace_t;
 
 /**
@@ -38,7 +42,7 @@ typedef struct ten_backtrace_t ten_backtrace_t;
  * @note The @a filename and @a function buffers may become invalid after this
  * function returns.
  */
-typedef int (*ten_backtrace_dump_file_line_func_t)(
+typedef int (*ten_backtrace_on_dump_file_line_func_t)(
     ten_backtrace_t *ten_backtrace, uintptr_t pc, const char *filename,
     int lineno, const char *function, void *data);
 
@@ -55,7 +59,7 @@ typedef int (*ten_backtrace_dump_file_line_func_t)(
  * @note @a symname will be NULL if no error occurred but the symbol could not
  * be found.
  */
-typedef void (*ten_backtrace_dump_syminfo_func_t)(
+typedef void (*ten_backtrace_on_dump_syminfo_func_t)(
     ten_backtrace_t *ten_backtrace, uintptr_t pc, const char *sym_name,
     uintptr_t sym_val, uintptr_t sym_size, void *data);
 
@@ -78,52 +82,52 @@ typedef void (*ten_backtrace_dump_syminfo_func_t)(
  * but the function requires a symbol table (e.g., backtrace_syminfo). This may
  * be used as a signal that some other approach should be tried.
  */
-typedef void (*ten_backtrace_error_func_t)(ten_backtrace_t *self,
-                                           const char *msg, int errnum,
-                                           void *data);
+typedef void (*ten_backtrace_on_error_func_t)(ten_backtrace_t *self,
+                                              const char *msg, int errnum,
+                                              void *data);
 
 /**
  * @brief Given @a pc, a program counter in the current program, call the
- * @a dump_file_line_cb function with filename, line number, and function name
+ * @a on_dump_file_line function with filename, line number, and function name
  * information. This will normally call the callback function exactly once.
  * However, if the @a pc happens to describe an inlined call, and the debugging
  * information contains the necessary information, then this may call the
  * callback function multiple times. This will make at least one call to either
- * @a dump_file_line_cb or @a error_cb.
+ * @a on_dump_file_line or @a on_error.
  *
- * @return The first non-zero value returned by @a dump_file_line_cb or @a
- * error_cb, or 0.
+ * @return The first non-zero value returned by @a on_dump_file_line or @a
+ * on_error, or 0.
  */
-TEN_UTILS_API int ten_backtrace_get_file_line_info(
+TEN_UTILS_PRIVATE_API int ten_backtrace_get_file_line_info(
     ten_backtrace_t *self, uintptr_t pc,
-    ten_backtrace_dump_file_line_func_t dump_file_line_cb,
-    ten_backtrace_error_func_t error_cb, void *data);
+    ten_backtrace_on_dump_file_line_func_t on_dump_file_line,
+    ten_backtrace_on_error_func_t on_error, void *data);
 
 /**
  * @brief Given @a pc, an address or program counter in the current program,
  * call the callback information with the symbol name and value describing the
  * function or variable in which @a pc may be found.
- * This will call either @a dump_syminfo_cb or @a error_cb exactly once.
+ * This will call either @a on_dump_syminfo or @a on_error exactly once.
  *
  * @return 1 on success, 0 on failure.
  *
  * @note This function requires the symbol table but does not require the debug
  * info. Note that if the symbol table is present but @a pc could not be found
- * in the table, @a dump_syminfo_cb will be called with a NULL @a sym_name
+ * in the table, @a on_dump_syminfo will be called with a NULL @a sym_name
  * argument. Returns 1 on success, 0 on error.
  */
-TEN_UTILS_API int ten_backtrace_get_syminfo(
+TEN_UTILS_PRIVATE_API int ten_backtrace_get_syminfo(
     ten_backtrace_t *self, uintptr_t pc,
-    ten_backtrace_dump_syminfo_func_t dump_syminfo_cb,
-    ten_backtrace_error_func_t error_cb, void *data);
+    ten_backtrace_on_dump_syminfo_func_t on_dump_syminfo,
+    ten_backtrace_on_error_func_t on_error, void *data);
 
 TEN_UTILS_API void ten_backtrace_create_global(void);
 
-TEN_UTILS_API ten_backtrace_t *ten_backtrace_create(void);
+TEN_UTILS_PRIVATE_API ten_backtrace_t *ten_backtrace_create(void);
 
 TEN_UTILS_API void ten_backtrace_destroy_global(void);
 
-TEN_UTILS_API void ten_backtrace_destroy(ten_backtrace_t *self);
+TEN_UTILS_PRIVATE_API void ten_backtrace_destroy(ten_backtrace_t *self);
 
 /**
  * @brief Get a full stack backtrace.
@@ -139,8 +143,9 @@ TEN_UTILS_API void ten_backtrace_destroy(ten_backtrace_t *self);
  * 'dump' callback or 'error' callback.
  * @note This function requires debug info for the executable.
  */
-TEN_UTILS_API void ten_backtrace_dump(ten_backtrace_t *self, size_t skip);
+TEN_UTILS_PRIVATE_API void ten_backtrace_dump(ten_backtrace_t *self,
+                                              size_t skip);
 
-#ifdef __cplusplus
+#if defined(__cplusplus)
 } /* End extern "C".  */
 #endif

core/include_internal/ten_utils/backtrace/buffer.h

@@ -0,0 +1,27 @@
+//
+// Copyright © 2025 Agora
+// This file is part of TEN Framework, an open source project.
+// Licensed under the Apache License, Version 2.0, with certain conditions.
+// Refer to the "LICENSE" file in the root directory for more information.
+//
+#pragma once
+
+#include "ten_utils/ten_config.h"
+
+#include <stddef.h>
+
+typedef struct ten_backtrace_t ten_backtrace_t;
+
+typedef struct ten_backtrace_buffer_t {
+  char *data;
+  size_t capacity;
+  size_t length;
+  int overflow;
+} ten_backtrace_buffer_t;
+
+TEN_UTILS_PRIVATE_API void ten_backtrace_buffer_init(
+    ten_backtrace_buffer_t *self, char *data, size_t capacity);
+
+TEN_UTILS_PRIVATE_API int ten_backtrace_buffer_dump(
+    ten_backtrace_t *self, uintptr_t pc, const char *filename, int lineno,
+    const char *function, void *data);

core/include_internal/ten_utils/backtrace/common.h

@@ -11,24 +11,24 @@
 #include "include_internal/ten_utils/backtrace/backtrace.h"
 
 typedef struct ten_backtrace_common_t {
-  ten_backtrace_dump_file_line_func_t dump_cb;
-  ten_backtrace_error_func_t error_cb;
+  ten_backtrace_on_dump_file_line_func_t on_dump_file_line;
+  ten_backtrace_on_error_func_t on_error;
   void *cb_data;  // The user-defined argument to the above callback functions.
 } ten_backtrace_common_t;
 
 TEN_UTILS_PRIVATE_API ten_backtrace_t *g_ten_backtrace;
 
 TEN_UTILS_PRIVATE_API void ten_backtrace_common_init(
-    ten_backtrace_common_t *self, ten_backtrace_dump_file_line_func_t dump_cb,
-    ten_backtrace_error_func_t error_cb);
+    ten_backtrace_common_t *self,
+    ten_backtrace_on_dump_file_line_func_t on_dump_file_line,
+    ten_backtrace_on_error_func_t on_error);
 
 TEN_UTILS_PRIVATE_API void ten_backtrace_common_deinit(ten_backtrace_t *self);
 
-TEN_UTILS_PRIVATE_API int ten_backtrace_default_dump_cb(
+TEN_UTILS_PRIVATE_API int ten_backtrace_default_dump(
     ten_backtrace_t *self, uintptr_t pc, const char *filename, int lineno,
     const char *function, void *data);
 
-TEN_UTILS_PRIVATE_API void ten_backtrace_default_error_cb(ten_backtrace_t *self,
-                                                          const char *msg,
-                                                          int errnum,
-                                                          void *data);
+TEN_UTILS_PRIVATE_API void ten_backtrace_default_error(ten_backtrace_t *self,
+                                                       const char *msg,
+                                                       int errnum, void *data);

core/include_internal/ten_utils/backtrace/file.h

@@ -0,0 +1,26 @@
+//
+// Copyright © 2025 Agora
+// This file is part of TEN Framework, an open source project.
+// Licensed under the Apache License, Version 2.0, with certain conditions.
+// Refer to the "LICENSE" file in the root directory for more information.
+//
+#pragma once
+
+#include "ten_utils/ten_config.h"
+
+#include <stdbool.h>
+#include <stddef.h>
+
+#define NORMALIZE_PATH_BUF_SIZE 4096
+
+/**
+ * @brief Normalizes a file path by resolving '..' and '.' path components.
+ *
+ * @param path The input path to normalize
+ * @param normalized_path Buffer to receive the normalized path
+ * @param buffer_size Size of the normalized_path buffer
+ * @return true on success, false if buffer is too small or path is invalid
+ */
+TEN_UTILS_API bool ten_backtrace_normalize_path(const char *path,
+                                                char *normalized_path,
+                                                size_t buffer_size);

core/include_internal/ten_utils/backtrace/platform/posix/darwin/internal.h

@@ -0,0 +1,20 @@
+//
+// Copyright © 2025 Agora
+// This file is part of TEN Framework, an open source project.
+// Licensed under the Apache License, Version 2.0, with certain conditions.
+// Refer to the "LICENSE" file in the root directory for more information.
+//
+#pragma once
+
+#include "ten_utils/ten_config.h"
+
+#include "include_internal/ten_utils/backtrace/common.h"
+
+/**
+ * @note On Mac, we are currently using a simple method instead of a complicated
+ * posix method to dump backtrace. So we only need a field of
+ * 'ten_backtrace_common_t'.
+ */
+typedef struct ten_backtrace_mac_t {
+  ten_backtrace_common_t common;
+} ten_backtrace_mac_t;

core/include_internal/ten_utils/backtrace/platform/posix/dwarf.h

@@ -0,0 +1,91 @@
+//
+// Copyright © 2025 Agora
+// This file is part of TEN Framework, an open source project.
+// Licensed under the Apache License, Version 2.0, with certain conditions.
+// Refer to the "LICENSE" file in the root directory for more information.
+//
+#pragma once
+
+#include "ten_utils/ten_config.h"
+
+#include <stddef.h>
+#include <stdio.h>
+
+#include "include_internal/ten_utils/backtrace/backtrace.h"
+#include "include_internal/ten_utils/backtrace/platform/posix/dwarf_internal/abbreviation.h"  // IWYU pragma: keep
+#include "include_internal/ten_utils/backtrace/platform/posix/dwarf_internal/attribute.h"  // IWYU pragma: keep
+#include "include_internal/ten_utils/backtrace/platform/posix/dwarf_internal/buf.h"  // IWYU pragma: keep
+#include "include_internal/ten_utils/backtrace/platform/posix/dwarf_internal/form.h"  // IWYU pragma: keep
+#include "include_internal/ten_utils/backtrace/platform/posix/dwarf_internal/function.h"  // IWYU pragma: keep
+#include "include_internal/ten_utils/backtrace/platform/posix/dwarf_internal/line.h"  // IWYU pragma: keep
+#include "include_internal/ten_utils/backtrace/platform/posix/dwarf_internal/range_list.h"  // IWYU pragma: keep
+#include "include_internal/ten_utils/backtrace/platform/posix/dwarf_internal/section.h"  // IWYU pragma: keep
+#include "include_internal/ten_utils/backtrace/platform/posix/dwarf_internal/tag.h"  // IWYU pragma: keep
+#include "include_internal/ten_utils/backtrace/platform/posix/dwarf_internal/unit.h"  // IWYU pragma: keep
+
+#define IS_DIR_SEPARATOR(c) ((c) == '/')
+#define IS_ABSOLUTE_PATH(f) (IS_DIR_SEPARATOR((f)[0]))
+
+TEN_UTILS_PRIVATE_API uint64_t read_address(ten_backtrace_t *self,
+                                            dwarf_buf *buf, int addrsize);
+
+TEN_UTILS_PRIVATE_API bool advance(ten_backtrace_t *self, dwarf_buf *buf,
+                                   size_t count);
+
+TEN_UTILS_PRIVATE_API uint16_t read_uint16(ten_backtrace_t *self,
+                                           dwarf_buf *buf);
+
+TEN_UTILS_PRIVATE_API uint32_t read_uint24(ten_backtrace_t *self,
+                                           dwarf_buf *buf);
+
+TEN_UTILS_PRIVATE_API uint32_t read_uint32(ten_backtrace_t *self,
+                                           dwarf_buf *buf);
+
+TEN_UTILS_PRIVATE_API uint64_t read_uint64(ten_backtrace_t *self,
+                                           dwarf_buf *buf);
+
+TEN_UTILS_PRIVATE_API uint64_t read_offset(ten_backtrace_t *self,
+                                           dwarf_buf *buf, int is_dwarf64);
+
+TEN_UTILS_PRIVATE_API uint64_t read_uleb128(ten_backtrace_t *self,
+                                            dwarf_buf *buf);
+
+TEN_UTILS_PRIVATE_API int64_t read_sleb128(ten_backtrace_t *self,
+                                           dwarf_buf *buf);
+
+TEN_UTILS_PRIVATE_API const char *read_string(ten_backtrace_t *self,
+                                              dwarf_buf *buf);
+
+TEN_UTILS_PRIVATE_API unsigned char read_byte(ten_backtrace_t *self,
+                                              dwarf_buf *buf);
+
+TEN_UTILS_PRIVATE_API signed char read_sbyte(ten_backtrace_t *self,
+                                             dwarf_buf *buf);
+
+TEN_UTILS_PRIVATE_API void dwarf_buf_error(ten_backtrace_t *self,
+                                           dwarf_buf *buf, const char *msg,
+                                           int errnum);
+
+TEN_UTILS_PRIVATE_API int resolve_string(
+    ten_backtrace_t *self, const dwarf_sections *dwarf_sections, int is_dwarf64,
+    int is_bigendian, uint64_t str_offsets_base, const attr_val *val,
+    ten_backtrace_on_error_func_t on_error, void *data, const char **string);
+
+TEN_UTILS_PRIVATE_API uint64_t read_initial_length(ten_backtrace_t *self,
+                                                   dwarf_buf *buf,
+                                                   int *is_dwarf64);
+
+TEN_UTILS_PRIVATE_API int resolve_addr_index(
+    ten_backtrace_t *self, const dwarf_sections *dwarf_sections,
+    uint64_t addr_base, int addrsize, int is_bigendian, uint64_t addr_index,
+    ten_backtrace_on_error_func_t on_error, void *data, uintptr_t *address);
+
+TEN_UTILS_PRIVATE_API const char *read_referenced_name_from_attr(
+    ten_backtrace_t *self, dwarf_data *ddata, unit *u, attr *attr,
+    attr_val *val, ten_backtrace_on_error_func_t on_error, void *data);
+
+TEN_UTILS_PRIVATE_API int build_address_map(
+    ten_backtrace_t *self, uintptr_t base_address,
+    const dwarf_sections *dwarf_sections, int is_bigendian, dwarf_data *altlink,
+    ten_backtrace_on_error_func_t on_error, void *data,
+    struct unit_addrs_vector *addrs, struct unit_vector *unit_vec);