Skip to content

Enable in-proc crash reporting on MacOS + Linux #131410

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mdh1418 wants to merge 2 commits into
base: main
Choose a base branch
from
+25 −15
Open

Enable in-proc crash reporting on MacOS + Linux #131410

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
99ffd8b
Enable in-proc crash reporting on desktop
mdh1418 Jul 27, 2026
f67f487
Use existing settings for crash reporter selection
mdh1418 Jul 27, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/design/coreclr/botr/xplat-minidump-generation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,8 +65,8 @@ Environment variables supported:
- `DOTNET_CreateDumpDiagnostics`: if set to "1", enables the _createdump_ utilities diagnostic messages (TRACE macro).
- `DOTNET_CreateDumpVerboseDiagnostics`: if set to "1", enables the _createdump_ utilities verbose diagnostic messages (TRACE_VERBOSE macro).
- `DOTNET_CreateDumpLogToFile`: if set, it is the path of the file to write the _createdump_ diagnostic messages.
- `DOTNET_EnableCrashReport`: In .NET 6.0 or greater, if set to "1", createdump also generates a json formatted crash report which includes information about the threads and stack frames of the crashing application. The crash report name is the dump path/name with _.crashreport.json_ appended.
- `DOTNET_EnableCrashReportOnly`: In .NET 7.0 or greater, same as DOTNET_EnableCrashReport except the core dump is not generated.
- `DOTNET_EnableCrashReport`: In .NET 6.0 or greater, if set to "1" together with `DOTNET_DbgEnableMiniDump`, createdump also generates a json formatted crash report which includes information about the threads and stack frames of the crashing application. The crash report name is the dump path/name with _.crashreport.json_ appended. Starting in .NET 11, when `DOTNET_DbgEnableMiniDump` is not enabled on a platform that supports the in-process crash reporter, this setting enables the in-process reporter instead.
- `DOTNET_EnableCrashReportOnly`: In .NET 7.0 or greater, same as `DOTNET_EnableCrashReport` except createdump does not generate the core dump. Starting in .NET 11, when `DOTNET_DbgEnableMiniDump` is not enabled, this setting also enables the in-process reporter on supported platforms.

DOTNET_DbgMiniDumpType values:

Expand Down
2 changes: 1 addition & 1 deletion src/coreclr/clrfeatures.cmake
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ if(NOT DEFINED FEATURE_SINGLE_FILE_DIAGNOSTICS)
endif(NOT DEFINED FEATURE_SINGLE_FILE_DIAGNOSTICS)

if(NOT DEFINED FEATURE_INPROC_CRASHREPORT)
if(CLR_CMAKE_TARGET_ANDROID OR CLR_CMAKE_TARGET_IOS OR CLR_CMAKE_TARGET_TVOS OR CLR_CMAKE_TARGET_MACCATALYST)
if(CLR_CMAKE_TARGET_ANDROID OR CLR_CMAKE_TARGET_IOS OR CLR_CMAKE_TARGET_TVOS OR CLR_CMAKE_TARGET_MACCATALYST OR CLR_CMAKE_TARGET_LINUX OR CLR_CMAKE_TARGET_OSX)

@jkotas jkotas Jul 28, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should it be enabled unconditionally everywhere?

@mdh1418 mdh1418 Jul 28, 2026

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I suspect it won't work at all on wasm/wasi, I can make it an exclude instead now that the supported set is larger

@mdh1418 mdh1418 Jul 29, 2026

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I suspect the code may not compile properly on other platforms like community supported ones, so I'd prefer to not make this included unconditionally given it could break builds.

set(FEATURE_INPROC_CRASHREPORT 1)
else()
set(FEATURE_INPROC_CRASHREPORT 0)
Expand Down
24 changes: 12 additions & 12 deletions src/coreclr/debug/crashreport/inproccrashreporter.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
#include <minipal/thread.h>
#if defined(__ANDROID__)
#include <android/log.h>
#elif defined(TARGET_IOS) || defined(TARGET_TVOS) || defined(TARGET_MACCATALYST)
#elif defined(TARGET_APPLE)
#include <mach/mach.h>
#include <sys/sysctl.h>
#endif
Expand Down Expand Up @@ -100,7 +100,7 @@ struct StackOverflowTraceSnapshot
static char sccsid[] = "@(#)Version N/A";
#endif

#if defined(TARGET_IOS) || defined(TARGET_TVOS) || defined(TARGET_MACCATALYST)
#if defined(TARGET_APPLE)
// Query a sysctl by name into a caller-supplied buffer. Called from Initialize, NOT from the
// signal handler -- sysctl/sysctlbyname is not on POSIX's async-signal-safe list, so the
// queried values are cached for use during crash reporting.
Expand All @@ -118,7 +118,7 @@ static void CacheSysctlString(const char* sysctlName, char* buffer, size_t buffe
buffer[0] = '\0';
}
}
#endif // defined(TARGET_IOS) || defined(TARGET_TVOS) || defined(TARGET_MACCATALYST)
#endif // TARGET_APPLE

// Bounded module table that deduplicates each unique module observed during a
// single crash report. Frames in the compact log refer to modules by short
Expand Down Expand Up @@ -426,7 +426,7 @@ class InProcCrashReporter
char m_reportFilePath[CRASHREPORT_PATH_BUFFER_SIZE];
char m_processName[CRASHREPORT_STRING_BUFFER_SIZE];
char m_stringScratch[CRASHREPORT_STRING_BUFFER_SIZE];
#if defined(TARGET_IOS) || defined(TARGET_TVOS) || defined(TARGET_MACCATALYST)
#if defined(TARGET_APPLE)
char m_osVersion[CRASHREPORT_STRING_BUFFER_SIZE];
char m_systemModel[CRASHREPORT_STRING_BUFFER_SIZE];
#endif
Expand Down Expand Up @@ -814,7 +814,7 @@ InProcCrashReporter::Initialize(
}
}

#if defined(TARGET_IOS) || defined(TARGET_TVOS) || defined(TARGET_MACCATALYST)
#if defined(TARGET_APPLE)
// Cache sysctl values at Initialize because sysctl/sysctlbyname is not on POSIX's
// async-signal-safe list; CreateReport reads these from the signal-handler path.
CacheSysctlString("kern.osproductversion", m_osVersion, sizeof(m_osVersion));
Expand Down Expand Up @@ -1161,9 +1161,9 @@ CrashReportHelpers::GetInstructionPointer(
}

ucontext_t* ucontext = reinterpret_cast<ucontext_t*>(context);
#if (defined(TARGET_IOS) || defined(TARGET_TVOS) || defined(TARGET_MACCATALYST)) && defined(__x86_64__)
#if defined(TARGET_APPLE) && defined(__x86_64__)
return static_cast<uint64_t>(ucontext->uc_mcontext->__ss.__rip);
#elif (defined(TARGET_IOS) || defined(TARGET_TVOS) || defined(TARGET_MACCATALYST)) && defined(__aarch64__)
#elif defined(TARGET_APPLE) && defined(__aarch64__)
return reinterpret_cast<uint64_t>(arm_thread_state64_get_pc_fptr(ucontext->uc_mcontext->__ss));
#elif defined(__x86_64__)
return static_cast<uint64_t>(ucontext->uc_mcontext.gregs[REG_RIP]);
Expand All @@ -1186,9 +1186,9 @@ CrashReportHelpers::GetStackPointer(
}

ucontext_t* ucontext = reinterpret_cast<ucontext_t*>(context);
#if (defined(TARGET_IOS) || defined(TARGET_TVOS) || defined(TARGET_MACCATALYST)) && defined(__x86_64__)
#if defined(TARGET_APPLE) && defined(__x86_64__)
return static_cast<uint64_t>(ucontext->uc_mcontext->__ss.__rsp);
#elif (defined(TARGET_IOS) || defined(TARGET_TVOS) || defined(TARGET_MACCATALYST)) && defined(__aarch64__)
#elif defined(TARGET_APPLE) && defined(__aarch64__)
return static_cast<uint64_t>(arm_thread_state64_get_sp(ucontext->uc_mcontext->__ss));
#elif defined(__x86_64__)
return static_cast<uint64_t>(ucontext->uc_mcontext.gregs[REG_RSP]);
Expand All @@ -1211,9 +1211,9 @@ CrashReportHelpers::GetFramePointer(
}

ucontext_t* ucontext = reinterpret_cast<ucontext_t*>(context);
#if (defined(TARGET_IOS) || defined(TARGET_TVOS) || defined(TARGET_MACCATALYST)) && defined(__x86_64__)
#if defined(TARGET_APPLE) && defined(__x86_64__)
return static_cast<uint64_t>(ucontext->uc_mcontext->__ss.__rbp);
#elif (defined(TARGET_IOS) || defined(TARGET_TVOS) || defined(TARGET_MACCATALYST)) && defined(__aarch64__)
#elif defined(TARGET_APPLE) && defined(__aarch64__)
return static_cast<uint64_t>(arm_thread_state64_get_fp(ucontext->uc_mcontext->__ss));
#elif defined(__x86_64__)
return static_cast<uint64_t>(ucontext->uc_mcontext.gregs[REG_RBP]);
Expand Down Expand Up @@ -2212,7 +2212,7 @@ InProcCrashReporter::EndJsonReport(

m_jsonWriter.OpenObject("parameters");
m_jsonWriter.WriteSignedDecimalAsString("signal", static_cast<int64_t>(signal));
#if defined(TARGET_IOS) || defined(TARGET_TVOS) || defined(TARGET_MACCATALYST)
#if defined(TARGET_APPLE)
if (m_osVersion[0] != '\0')
{
m_jsonWriter.WriteString("OSVersion", m_osVersion);
Expand Down
10 changes: 10 additions & 0 deletions src/coreclr/vm/crashreportstackwalker.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -711,6 +711,16 @@ CrashReportInitialize()
void
CrashReportConfigure()
{
#if !defined(TARGET_ANDROID) && !defined(TARGET_IOS) && !defined(TARGET_TVOS) && !defined(TARGET_MACCATALYST)
// Preserve createdump's existing ownership of EnableCrashReport* when it is enabled.
CLRConfigNoCache enabledMiniDumpCfg = CLRConfigNoCache::Get("DbgEnableMiniDump", /*noprefix*/ false, &getenv);
DWORD miniDumpEnabled = 0;
if (enabledMiniDumpCfg.IsSet() && enabledMiniDumpCfg.TryAsInteger(10, miniDumpEnabled) && miniDumpEnabled != 0)
{
return;
}
#endif // !defined(TARGET_ANDROID) && !defined(TARGET_IOS) && !defined(TARGET_TVOS) && !defined(TARGET_MACCATALYST)

// Read crash report configuration here rather than in PROCAbortInitialize
// because on Android the DOTNET_* environment variables are set via JNI
// after PAL_Initialize has already run.
Expand Down
Loading