Enhance memory profiling with structured logging support (#4896)

* Enhance memory profiling with structured logging support

- Enable memory profiling and structured logging in CMake configuration.
- Update memory tracing definitions to support custom sections.
- Replace os_printf with MEM_PROF_PRINTF for memory-related outputs.
- Add verbose logging for memory consumption in various modules.

build-scripts/SConscript_config

@@ -103,6 +103,10 @@ if GetDepend(['WAMR_BUILD_MEMORY_PROFILING']):
     CPPDEFINES += ['WASM_ENABLE_MEMORY_PROFILING=1']
     print('[WAMR] Memory profiling enabled')
 
+if GetDepend(['WAMR_BUILD_MEMORY_TRACING']):
+    CPPDEFINES += ['WASM_ENABLE_MEMORY_TRACING=1']
+    print('[WAMR] Memory tracing enabled')
+
 if GetDepend(['WAMR_BUILD_CUSTOM_NAME_SECTION']):
     CPPDEFINES += ['WASM_ENABLE_CUSTOM_NAME_SECTION=1']
     print('[WAMR] Custom name section enabled')

build-scripts/config_common.cmake

@@ -478,6 +478,10 @@ if (WAMR_BUILD_MEMORY_PROFILING EQUAL 1)
   add_definitions (-DWASM_ENABLE_MEMORY_PROFILING=1)
   message ("     Memory profiling enabled")
 endif ()
+if (WAMR_BUILD_MEMORY_TRACING EQUAL 1)
+  add_definitions (-DWASM_ENABLE_MEMORY_TRACING=1)
+  message ("     Memory tracing enabled")
+endif ()
 if (WAMR_BUILD_PERF_PROFILING EQUAL 1)
   add_definitions (-DWASM_ENABLE_PERF_PROFILING=1)
   message ("     Performance profiling enabled")

build-scripts/esp-idf/wamr/CMakeLists.txt

@@ -56,6 +56,10 @@ if (NOT CMAKE_BUILD_EARLY_EXPANSION)
     set (WAMR_BUILD_MEMORY_PROFILING 1)
   endif ()
 
+  if (CONFIG_WAMR_ENABLE_MEMORY_TRACING)
+    set (WAMR_BUILD_MEMORY_TRACING 1)
+  endif ()
+
   if (CONFIG_WAMR_ENABLE_PERF_PROFILING)
     set (WAMR_BUILD_PERF_PROFILING 1)
   endif ()

core/iwasm/aot/aot_runtime.c

@@ -3781,6 +3781,17 @@ aot_get_module_mem_consumption(const AOTModule *module,
         mem_conspn->aot_code_size += sizeof(uint8) * obj_data->size;
     }
 
+#if WASM_ENABLE_LOAD_CUSTOM_SECTION != 0
+    {
+        WASMCustomSection *section = module->custom_section_list;
+        while (section) {
+            mem_conspn->custom_sections_size +=
+                sizeof(WASMCustomSection) + section->content_len;
+            section = section->next;
+        }
+    }
+#endif
+
     mem_conspn->total_size += mem_conspn->module_struct_size;
     mem_conspn->total_size += mem_conspn->types_size;
     mem_conspn->total_size += mem_conspn->imports_size;
@@ -3793,6 +3804,9 @@ aot_get_module_mem_consumption(const AOTModule *module,
     mem_conspn->total_size += mem_conspn->data_segs_size;
     mem_conspn->total_size += mem_conspn->const_strs_size;
     mem_conspn->total_size += mem_conspn->aot_code_size;
+#if WASM_ENABLE_LOAD_CUSTOM_SECTION != 0
+    mem_conspn->total_size += mem_conspn->custom_sections_size;
+#endif
 }
 
 void

core/iwasm/common/wasm_native.c

@@ -268,7 +268,7 @@ register_natives(const char *module_name, NativeSymbol *native_symbols,
     if (!(node = wasm_runtime_malloc(sizeof(NativeSymbolsNode))))
         return false;
 #if WASM_ENABLE_MEMORY_TRACING != 0
-    os_printf("Register native, size: %u\n", sizeof(NativeSymbolsNode));
+    LOG_VERBOSE("Register native, size: %u", sizeof(NativeSymbolsNode));
 #endif
 
     node->module_name = module_name;

core/iwasm/common/wasm_runtime_common.c

@@ -2029,21 +2029,25 @@ wasm_runtime_dump_module_mem_consumption(const WASMModuleCommon *module)
     }
 #endif
 
-    os_printf("WASM module memory consumption, total size: %u\n",
-              mem_conspn.total_size);
-    os_printf("    module struct size: %u\n", mem_conspn.module_struct_size);
-    os_printf("    types size: %u\n", mem_conspn.types_size);
-    os_printf("    imports size: %u\n", mem_conspn.imports_size);
-    os_printf("    funcs size: %u\n", mem_conspn.functions_size);
-    os_printf("    tables size: %u\n", mem_conspn.tables_size);
-    os_printf("    memories size: %u\n", mem_conspn.memories_size);
-    os_printf("    globals size: %u\n", mem_conspn.globals_size);
-    os_printf("    exports size: %u\n", mem_conspn.exports_size);
-    os_printf("    table segs size: %u\n", mem_conspn.table_segs_size);
-    os_printf("    data segs size: %u\n", mem_conspn.data_segs_size);
-    os_printf("    const strings size: %u\n", mem_conspn.const_strs_size);
+    LOG_VERBOSE("WASM module memory consumption, total size: %u",
+                mem_conspn.total_size);
+    LOG_VERBOSE("    module struct size: %u", mem_conspn.module_struct_size);
+    LOG_VERBOSE("    types size: %u", mem_conspn.types_size);
+    LOG_VERBOSE("    imports size: %u", mem_conspn.imports_size);
+    LOG_VERBOSE("    funcs size: %u", mem_conspn.functions_size);
+    LOG_VERBOSE("    tables size: %u", mem_conspn.tables_size);
+    LOG_VERBOSE("    memories size: %u", mem_conspn.memories_size);
+    LOG_VERBOSE("    globals size: %u", mem_conspn.globals_size);
+    LOG_VERBOSE("    exports size: %u", mem_conspn.exports_size);
+    LOG_VERBOSE("    table segs size: %u", mem_conspn.table_segs_size);
+    LOG_VERBOSE("    data segs size: %u", mem_conspn.data_segs_size);
+    LOG_VERBOSE("    const strings size: %u", mem_conspn.const_strs_size);
+#if WASM_ENABLE_LOAD_CUSTOM_SECTION != 0
+    LOG_VERBOSE("    custom sections size: %u",
+                mem_conspn.custom_sections_size);
+#endif
 #if WASM_ENABLE_AOT != 0
-    os_printf("    aot code size: %u\n", mem_conspn.aot_code_size);
+    LOG_VERBOSE("    aot code size: %u", mem_conspn.aot_code_size);
 #endif
 }
 
@@ -2066,16 +2070,16 @@ wasm_runtime_dump_module_inst_mem_consumption(
     }
 #endif
 
-    os_printf("WASM module inst memory consumption, total size: %lu\n",
-              mem_conspn.total_size);
-    os_printf("    module inst struct size: %u\n",
-              mem_conspn.module_inst_struct_size);
-    os_printf("    memories size: %lu\n", mem_conspn.memories_size);
-    os_printf("        app heap size: %u\n", mem_conspn.app_heap_size);
-    os_printf("    tables size: %u\n", mem_conspn.tables_size);
-    os_printf("    functions size: %u\n", mem_conspn.functions_size);
-    os_printf("    globals size: %u\n", mem_conspn.globals_size);
-    os_printf("    exports size: %u\n", mem_conspn.exports_size);
+    LOG_VERBOSE("WASM module inst memory consumption, total size: %lu",
+                mem_conspn.total_size);
+    LOG_VERBOSE("    module inst struct size: %u",
+                mem_conspn.module_inst_struct_size);
+    LOG_VERBOSE("    memories size: %lu", mem_conspn.memories_size);
+    LOG_VERBOSE("        app heap size: %u", mem_conspn.app_heap_size);
+    LOG_VERBOSE("    tables size: %u", mem_conspn.tables_size);
+    LOG_VERBOSE("    functions size: %u", mem_conspn.functions_size);
+    LOG_VERBOSE("    globals size: %u", mem_conspn.globals_size);
+    LOG_VERBOSE("    exports size: %u", mem_conspn.exports_size);
 }
 
 void
@@ -2084,14 +2088,14 @@ wasm_runtime_dump_exec_env_mem_consumption(const WASMExecEnv *exec_env)
     uint32 total_size =
         offsetof(WASMExecEnv, wasm_stack_u.bottom) + exec_env->wasm_stack_size;
 
-    os_printf("Exec env memory consumption, total size: %u\n", total_size);
-    os_printf("    exec env struct size: %u\n",
-              offsetof(WASMExecEnv, wasm_stack_u.bottom));
+    LOG_VERBOSE("Exec env memory consumption, total size: %u", total_size);
+    LOG_VERBOSE("    exec env struct size: %u",
+                offsetof(WASMExecEnv, wasm_stack_u.bottom));
 #if WASM_ENABLE_INTERP != 0 && WASM_ENABLE_FAST_INTERP == 0
-    os_printf("        block addr cache size: %u\n",
-              sizeof(exec_env->block_addr_cache));
+    LOG_VERBOSE("        block addr cache size: %u",
+                sizeof(exec_env->block_addr_cache));
 #endif
-    os_printf("    stack size: %u\n", exec_env->wasm_stack_size);
+    LOG_VERBOSE("    stack size: %u", exec_env->wasm_stack_size);
 }
 
 uint32
@@ -2152,20 +2156,20 @@ wasm_runtime_dump_mem_consumption(WASMExecEnv *exec_env)
                  + exec_env->wasm_stack_size + module_mem_consps.total_size
                  + module_inst_mem_consps.total_size;
 
-    os_printf("\nMemory consumption summary (bytes):\n");
+    LOG_VERBOSE("Memory consumption summary (bytes):");
     wasm_runtime_dump_module_mem_consumption(module_common);
     wasm_runtime_dump_module_inst_mem_consumption(module_inst_common);
     wasm_runtime_dump_exec_env_mem_consumption(exec_env);
-    os_printf("\nTotal memory consumption of module, module inst and "
-              "exec env: %" PRIu64 "\n",
-              total_size);
-    os_printf("Total interpreter stack used: %u\n",
-              exec_env->max_wasm_stack_used);
+    LOG_VERBOSE("Total memory consumption of module, module inst and "
+                "exec env: %" PRIu64,
+                total_size);
+    LOG_VERBOSE("Total interpreter stack used: %u",
+                exec_env->max_wasm_stack_used);
 
     if (max_aux_stack_used != (uint32)-1)
-        os_printf("Total auxiliary stack used: %u\n", max_aux_stack_used);
+        LOG_VERBOSE("Total auxiliary stack used: %u", max_aux_stack_used);
     else
-        os_printf("Total aux stack used: no enough info to profile\n");
+        LOG_VERBOSE("Total aux stack used: no enough info to profile");
 
     /*
      * Report the native stack usage estimation.
@@ -2177,13 +2181,13 @@ wasm_runtime_dump_mem_consumption(WASMExecEnv *exec_env)
      * It doesn't cover host func implementations, signal handlers, etc.
      */
     if (exec_env->native_stack_top_min != (void *)UINTPTR_MAX)
-        os_printf("Native stack left: %zd\n",
-                  exec_env->native_stack_top_min
-                      - exec_env->native_stack_boundary);
+        LOG_VERBOSE("Native stack left: %zd",
+                    exec_env->native_stack_top_min
+                        - exec_env->native_stack_boundary);
     else
-        os_printf("Native stack left: no enough info to profile\n");
+        LOG_VERBOSE("Native stack left: no enough info to profile");
 
-    os_printf("Total app heap used: %u\n", app_heap_peak_size);
+    LOG_VERBOSE("Total app heap used: %u", app_heap_peak_size);
 }
 #endif /* end of (WASM_ENABLE_MEMORY_PROFILING != 0) \
                  || (WASM_ENABLE_MEMORY_TRACING != 0) */

core/iwasm/common/wasm_runtime_common.h

@@ -529,6 +529,9 @@ typedef struct WASMModuleMemConsumption {
     uint32 table_segs_size;
     uint32 data_segs_size;
     uint32 const_strs_size;
+#if WASM_ENABLE_LOAD_CUSTOM_SECTION != 0
+    uint32 custom_sections_size;
+#endif
 #if WASM_ENABLE_AOT != 0
     uint32 aot_code_size;
 #endif

core/iwasm/interpreter/wasm_runtime.c

@@ -4214,6 +4214,17 @@ wasm_get_module_mem_consumption(const WASMModule *module,
         }
     }
 
+#if WASM_ENABLE_LOAD_CUSTOM_SECTION != 0
+    {
+        WASMCustomSection *section = module->custom_section_list;
+        while (section) {
+            mem_conspn->custom_sections_size +=
+                sizeof(WASMCustomSection) + section->content_len;
+            section = section->next;
+        }
+    }
+#endif
+
     mem_conspn->total_size += mem_conspn->module_struct_size;
     mem_conspn->total_size += mem_conspn->types_size;
     mem_conspn->total_size += mem_conspn->imports_size;
@@ -4225,6 +4236,9 @@ wasm_get_module_mem_consumption(const WASMModule *module,
     mem_conspn->total_size += mem_conspn->table_segs_size;
     mem_conspn->total_size += mem_conspn->data_segs_size;
     mem_conspn->total_size += mem_conspn->const_strs_size;
+#if WASM_ENABLE_LOAD_CUSTOM_SECTION != 0
+    mem_conspn->total_size += mem_conspn->custom_sections_size;
+#endif
 }
 
 void

core/shared/mem-alloc/ems/ems_kfc.c

@@ -76,11 +76,11 @@ gc_init_with_pool(char *buf, gc_size_t buf_size)
     heap_max_size = (uint32)(buf_end - base_addr) & (uint32)~7;
 
 #if WASM_ENABLE_MEMORY_TRACING != 0
-    os_printf("Heap created, total size: %u\n", buf_size);
-    os_printf("   heap struct size: %u\n", sizeof(gc_heap_t));
-    os_printf("   actual heap size: %u\n", heap_max_size);
-    os_printf("   padding bytes: %u\n",
-              buf_size - sizeof(gc_heap_t) - heap_max_size);
+    LOG_VERBOSE("Heap created, total size: %u", buf_size);
+    LOG_VERBOSE("   heap struct size: %u", sizeof(gc_heap_t));
+    LOG_VERBOSE("   actual heap size: %u", heap_max_size);
+    LOG_VERBOSE("   padding bytes: %u",
+                buf_size - sizeof(gc_heap_t) - heap_max_size);
 #endif
     return gc_init_internal(heap, base_addr, heap_max_size);
 }
@@ -119,11 +119,11 @@ gc_init_with_struct_and_pool(char *struct_buf, gc_size_t struct_buf_size,
     heap_max_size = (uint32)(pool_buf_end - base_addr) & (uint32)~7;
 
 #if WASM_ENABLE_MEMORY_TRACING != 0
-    os_printf("Heap created, total size: %u\n",
-              struct_buf_size + pool_buf_size);
-    os_printf("   heap struct size: %u\n", sizeof(gc_heap_t));
-    os_printf("   actual heap size: %u\n", heap_max_size);
-    os_printf("   padding bytes: %u\n", pool_buf_size - heap_max_size);
+    LOG_VERBOSE("Heap created, total size: %u",
+                struct_buf_size + pool_buf_size);
+    LOG_VERBOSE("   heap struct size: %u", sizeof(gc_heap_t));
+    LOG_VERBOSE("   actual heap size: %u", heap_max_size);
+    LOG_VERBOSE("   padding bytes: %u", pool_buf_size - heap_max_size);
 #endif
     return gc_init_internal(heap, base_addr, heap_max_size);
 }

core/shared/utils/uncommon/bh_read_file.c

@@ -48,7 +48,7 @@ bh_read_file_to_buffer(const char *filename, uint32 *ret_size)
         return NULL;
     }
 #if WASM_ENABLE_MEMORY_TRACING != 0
-    printf("Read file, total size: %u\n", file_size);
+    LOG_VERBOSE("Read file, total size: %u", file_size);
 #endif
 
     read_size = _read(file, buffer, file_size);
@@ -99,7 +99,7 @@ bh_read_file_to_buffer(const char *filename, uint32 *ret_size)
         return NULL;
     }
 #if WASM_ENABLE_MEMORY_TRACING != 0
-    printf("Read file, total size: %u\n", file_size);
+    LOG_VERBOSE("Read file, total size: %u", file_size);
 #endif
 
     read_size = (uint32)read(file, buffer, file_size);

doc/build_wamr.md

@@ -79,6 +79,7 @@ add_library(vmlib ${WAMR_RUNTIME_LIB_SOURCE})
 | [WAMR_BUILD_LOAD_CUSTOM_SECTION](#load-wasm-custom-sections)                                             | loading custom sections              |
 | [WAMR_BUILD_MEMORY64](#memory64-feature)                                                                 | memory64 support                     |
 | [WAMR_BUILD_MEMORY_PROFILING](#memory-profiling-experiment)                                              | memory profiling                     |
+| [WAMR_BUILD_MEMORY_TRACING](#memory-tracing)                                                             | memory tracing                       |
 | [WAMR_BUILD_MINI_LOADER](#wasm-mini-loader) :warning: :exclamation:                                      | mini loader                          |
 | [WAMR_BUILD_MODULE_INST_CONTEXT](#module-instance-context-apis)                                          | module instance context              |
 | [WAMR_BUILD_MULTI_MEMORY](#multi-memory)                                                                 | multi-memory support                 |
@@ -384,6 +385,13 @@ SIMDE (SIMD Everywhere) implements SIMD operations in fast interpreter mode.
 > [!NOTE]
 > When enabled, call `void wasm_runtime_dump_mem_consumption(wasm_exec_env_t exec_env)` to dump memory usage. Currently only module, module_instance, and exec_env memory are measured; other components such as `wasi-ctx`, `multi-module`, and `thread-manager` are not included. See [Memory usage estimation for a module](./memory_usage.md).
 
+### **memory tracing**
+
+- **WAMR_BUILD_MEMORY_TRACING**=1/0, default to off.
+
+> [!NOTE]
+> When enabled, detailed memory allocation and deallocation traces are printed at runtime, which is useful for debugging memory issues.
+
 ### **performance profiling (Experiment)**
 
 - **WAMR_BUILD_PERF_PROFILING**=1/0, default to off.

product-mini/platforms/nuttx/CMakeLists.txt

@@ -75,9 +75,7 @@ else()
 endif()
 
 if(CONFIG_INTERPRETERS_WAMR_MEMORY_TRACING)
-  add_definitions(-DWASM_ENABLE_MEMORY_TRACING=1)
-else()
-  add_definitions(-DWASM_ENABLE_MEMORY_TRACING=0)
+  set(WAMR_BUILD_MEMORY_TRACING 1)
 endif()
 
 if(CONFIG_INTERPRETERS_WAMR_SHARED_MEMORY)

samples/custom-section/src/main.c

@@ -5,6 +5,7 @@
 
 #include "bh_getopt.h"
 #include "bh_read_file.h"
+#include "bh_log.h"
 #include "wasm_export.h"
 
 int32_t
@@ -79,6 +80,8 @@ main(int argc, char *argv_main[])
         return -1;
     }
 
+    bh_log_set_verbose_level(BH_LOG_LEVEL_VERBOSE);
+
     reset_custom_section_handles();
 
     buffer = bh_read_file_to_buffer(wasm_path, &buf_size);