[wasm] Enable the log profiler

src/installer/pkg/sfx/Microsoft.NETCore.App/Directory.Build.props

@@ -220,6 +220,7 @@
  <PlatformManifestFileEntry Include="libmono-ee-interp.a" IsNative="true" />
  <PlatformManifestFileEntry Include="libmono-icall-table.a" IsNative="true" />
  <PlatformManifestFileEntry Include="libmono-profiler-aot.a" IsNative="true" />
+ <PlatformManifestFileEntry Include="libmono-profiler-log.a" IsNative="true" />
  <PlatformManifestFileEntry Include="libmono-profiler-browser.a" IsNative="true" />
  <PlatformManifestFileEntry Include="libmono-wasm-eh-js.a" IsNative="true" />
  <PlatformManifestFileEntry Include="libmono-wasm-eh-wasm.a" IsNative="true" />

src/mono/browser/runtime/profiler.ts

@@ -1,8 +1,8 @@
 // Licensed to the .NET Foundation under one or more agreements.
 // The .NET Foundation licenses this file to you under the MIT license.
 
-import { ENVIRONMENT_IS_WEB, mono_assert, runtimeHelpers } from "./globals";
-import { MonoMethod, AOTProfilerOptions, BrowserProfilerOptions } from "./types/internal";
+import { ENVIRONMENT_IS_WEB, mono_assert, Module, runtimeHelpers } from "./globals";
+import { MonoMethod, AOTProfilerOptions, BrowserProfilerOptions, LogProfilerOptions } from "./types/internal";
 import { profiler_c_functions as cwraps } from "./cwraps";
 import { utf8ToString } from "./strings";
 
@@ -99,3 +99,8 @@ export function mono_wasm_profiler_leave (method: MonoMethod): void {
  globalThis.performance.measure(methodName, options);
  }
 }
+
+// options = { configuration: "log profiler options string" }
+export function mono_wasm_init_log_profiler (options: LogProfilerOptions): void {
+ Module.ccall("mono_wasm_load_profiler_log", null, ["string"], [options.configuration]);
+}

src/mono/browser/runtime/startup.ts

@@ -9,7 +9,7 @@ import { exportedRuntimeAPI, INTERNAL, loaderHelpers, Module, runtimeHelpers, cr
 import cwraps, { init_c_exports, threads_c_functions as tcwraps } from "./cwraps";
 import { mono_wasm_raise_debug_event, mono_wasm_runtime_ready } from "./debug";
 import { toBase64StringImpl } from "./base64";
-import { mono_wasm_init_aot_profiler, mono_wasm_init_browser_profiler } from "./profiler";
+import { mono_wasm_init_aot_profiler, mono_wasm_init_browser_profiler, mono_wasm_init_log_profiler } from "./profiler";
 import { initialize_marshalers_to_cs } from "./marshal-to-cs";
 import { initialize_marshalers_to_js } from "./marshal-to-js";
 import { init_polyfills_async } from "./polyfills";
@@ -318,6 +318,10 @@ async function onRuntimeInitializedAsync (userOnRuntimeInitialized: () => void)
 
  await wait_for_all_assets();
 
+ if (runtimeHelpers.config.logProfilerOptions) {
+ mono_wasm_init_log_profiler(runtimeHelpers.config.logProfilerOptions);
+ }
+
  if (WasmEnableThreads) {
  runtimeHelpers.deputyWorker.thread!.postMessageToWorker({
  type:"deputyThread",

src/mono/browser/runtime/types/internal.ts

@@ -77,6 +77,7 @@ export type MonoConfigInternal = MonoConfig & {
  assets?: AssetEntryInternal[],
  runtimeOptions?: string[], // array of runtime options as strings
  aotProfilerOptions?: AOTProfilerOptions, // dictionary-style Object. If omitted, aot profiler will not be initialized.
+ logProfilerOptions?: LogProfilerOptions, // dictionary-style Object. If omitted, log profiler will not be initialized.
  browserProfilerOptions?: BrowserProfilerOptions, // dictionary-style Object. If omitted, browser profiler will not be initialized.
  waitForDebugger?: number,
  appendElementOnExit?: boolean
@@ -274,6 +275,10 @@ export type AOTProfilerOptions = {
 export type BrowserProfilerOptions = {
 }
 
+export type LogProfilerOptions = {
+ configuration?: string // log profiler options string"
+}
+
 // how we extended emscripten Module
 export type DotnetModule = EmscriptenModule & DotnetModuleConfig;
 export type DotnetModuleInternal = EmscriptenModule & DotnetModuleConfig & EmscriptenModuleInternal;

src/mono/mono.proj

@@ -1185,6 +1185,9 @@ JS_ENGINES = [NODE_JS]
  <_MonoRuntimeArtifacts Condition="'$(TargetsBrowser)' == 'true' and '$(BuildMonoAOTCrossCompilerOnly)' != 'true'" Include="$(MonoObjDir)out\lib\libmono-profiler-aot.a">
  <Destination>$(RuntimeBinDir)libmono-profiler-aot.a</Destination>
  </_MonoRuntimeArtifacts>
+ <_MonoRuntimeArtifacts Condition="'$(TargetsBrowser)' == 'true' and '$(BuildMonoAOTCrossCompilerOnly)' != 'true'" Include="$(MonoObjDir)out\lib\libmono-profiler-log.a">
+ <Destination>$(RuntimeBinDir)libmono-profiler-log.a</Destination>
+ </_MonoRuntimeArtifacts>
  <_MonoRuntimeArtifacts Condition="'$(TargetsBrowser)' == 'true' and '$(BuildMonoAOTCrossCompilerOnly)' != 'true'" Include="$(MonoObjDir)out\lib\libmono-profiler-browser.a">
  <Destination>$(RuntimeBinDir)libmono-profiler-browser.a</Destination>
  </_MonoRuntimeArtifacts>

src/mono/mono/mini/mini-wasm.c

@@ -577,7 +577,6 @@ mono_init_native_crash_info (void)
 void
 mono_runtime_setup_stat_profiler (void)
 {
- g_error ("mono_runtime_setup_stat_profiler");
 }
 
 gboolean

src/mono/mono/profiler/CMakeLists.txt

@@ -6,6 +6,7 @@ include_directories(
  ${PROJECT_BINARY_DIR}/../../mono/eglib
  ${CMAKE_CURRENT_SOURCE_DIR}/../..
  ${PROJECT_SOURCE_DIR}/../
+ ${PROJECT_SOURCE_DIR}/../../../native/public
  ${PROJECT_SOURCE_DIR}/../eglib
  ${PROJECT_SOURCE_DIR}/../sgen)
 
@@ -34,6 +35,20 @@ if(NOT DISABLE_LIBS)
  endif()
  endif()
 
+ if(HOST_WASM AND NOT HOST_WASI)
+ add_library(mono-profiler-log-static STATIC helper.c log.c log-args.c)
+ set_target_properties(mono-profiler-log-static PROPERTIES OUTPUT_NAME mono-profiler-log)
+ install(TARGETS mono-profiler-log-static LIBRARY)
+
+ if(NOT DISABLE_LOG_PROFILER_GZ)
+ if (CLR_CMAKE_USE_SYSTEM_ZLIB)
+ target_link_libraries(mono-profiler-log-static PRIVATE ${Z_LIBS})
+ else()
+ target_link_libraries(mono-profiler-log-static PRIVATE zlib)
+ endif()
+ endif()
+ endif()
+
  if(NOT HOST_WASI)
  add_library(mono-profiler-aot-static STATIC aot.c helper.c)
  target_link_libraries(mono-profiler-aot-static PRIVATE monoapi)

src/mono/mono/profiler/helper.c

@@ -8,7 +8,9 @@
 
 #include <config.h>
 
+#if !defined (HOST_WASM)
 #include <mono/utils/mono-logger-internals.h>
+#endif
 
 #ifdef HAVE_UNISTD_H
 #include <unistd.h>
@@ -42,6 +44,7 @@ mono_profhelper_close_socket_fd (SOCKET fd)
 void
 mono_profhelper_setup_command_server (SOCKET *server_socket, int *command_port, const char* profiler_name)
 {
+#if !defined (HOST_WASM)
  *server_socket = socket (PF_INET, SOCK_STREAM, 0);
 
  if (*server_socket == INVALID_SOCKET) {
@@ -77,11 +80,13 @@ mono_profhelper_setup_command_server (SOCKET *server_socket, int *command_port,
  }
 
  *command_port = ntohs (server_address.sin_port);
+#endif
 }
 
 void
 mono_profhelper_add_to_fd_set (fd_set *set, SOCKET fd, int *max_fd)
 {
+#if !defined (HOST_WASM)
  /*
  * This should only trigger for the basic FDs (server socket, pipes) at
  * startup if for some mysterious reason they're too large. In this case,
@@ -99,4 +104,5 @@ mono_profhelper_add_to_fd_set (fd_set *set, SOCKET fd, int *max_fd)
 
  if (*max_fd < GUINT64_TO_INT(fd))
  *max_fd = (int)fd;
+#endif
 }

src/mono/mono/profiler/log.c

@@ -617,6 +617,7 @@ buffer_lock_helper (void);
 static void
 buffer_lock (void)
 {
+#if !defined (HOST_WASM)
  /*
  * If the thread holding the exclusive lock tries to modify the
  * reader count, just make it a no-op. This way, we also avoid
@@ -657,6 +658,8 @@ buffer_lock (void)
  }
 
  mono_memory_barrier ();
+
+#endif //HOST_WASM
 }
 
 static void
@@ -3499,6 +3502,7 @@ runtime_initialized (MonoProfiler *profiler)
 
  mono_os_sem_init (&log_profiler.attach_threads_sem, 0);
 
+#if !defined (HOST_WASM)
  /*
  * We must start the helper thread before the writer thread. This is
  * because start_helper_thread () sets up the command port which is written
@@ -3507,6 +3511,9 @@ runtime_initialized (MonoProfiler *profiler)
  start_helper_thread ();
  start_writer_thread ();
  start_dumper_thread ();
+#else
+ dump_header ();
+#endif
 
  /*
  * Wait for all the internal threads to be started. If we don't do this, we
@@ -3588,7 +3595,7 @@ create_profiler (const char *args, const char *filename, GPtrArray *filters)
  }
  }
  if (*nf == '|') {
-#if HAVE_API_SUPPORT_WIN32_PIPE_OPEN_CLOSE && !defined (HOST_WIN32)
+#if HAVE_API_SUPPORT_WIN32_PIPE_OPEN_CLOSE && !defined (HOST_WIN32) && !defined (HOST_WASM)
  log_profiler.file = popen (nf + 1, "w");
  log_profiler.pipe_output = 1;
 #else
@@ -3770,3 +3777,17 @@ mono_profiler_init_log (const char *desc)
 done:
  ;
 }
+
+#if defined (HOST_WASM)
+
+MONO_API void
+mono_profiler_flush_log (void);
+
+void
+mono_profiler_flush_log (void)
+{
+ while (handle_writer_queue_entry ());
+ while (handle_dumper_queue_entry ());
+}
+
+#endif // HOST_WASM

src/mono/wasm/features.md

@@ -426,6 +426,48 @@ import { dotnet } from './dotnet.js'
 await dotnet.withConfig({browserProfilerOptions: {}}).run();
 ```
 
+### Log Profiling for Memory Troubleshooting
+
+You can enable integration with browser profiler via following elements in your .csproj:
+
+```xml
+<PropertyGroup>
+ <WasmProfilers>log;</WasmProfilers>
+</PropertyGroup>
+```
+
+In simple browser template, you can add following to your `main.js`
+
+```javascript
+import { dotnet } from './dotnet.js'
+await dotnet.withConfig({ logProfilerOptions: { configuration: "log:alloc,output=output.mlpd" }}).run();
+```
+
+In order to trigger a heap shot, add the following:
+
+```csharp
+using System.Runtime.CompilerServices;
+
+namespace Mono.Profiler.Log
+{
+ /// <summary>
+ /// Internal calls to match with https://github.com/dotnet/runtime/blob/release/6.0/src/mono/mono/profiler/log.c#L4061-L4097
+ /// </summary>
+ internal class LogProfiler
+ {
+ [MethodImplAttribute(MethodImplOptions.InternalCall)]
+ public extern static void TriggerHeapshot();
+
+ [DllImport("__Native")]
+ public extern static private void mono_profiler_flush_log();
+ }
+}
+```
+
+Invoke `LogProfiler.TriggerHeapshot()` from your code in order to create a memory heap shot, then invoke `mono_profiler_flush_log` in order to flush the contents of the profile to the VFS.
+
+You can download the mpld file to analyze it.
+
 ### Diagnostic tools
 
 We have initial implementation of diagnostic server and [event pipe](https://learn.microsoft.com/dotnet/core/diagnostics/eventpipe)