Add on-demand in-proc crash report generation. - #131220

Merged
lateralusX merged 8 commits into
dotnet:mainfrom
lateralusX:lateralusX/on-demand-in-proc-crash-report
Jul 24, 2026
Merged

Add on-demand in-proc crash report generation.#131220
lateralusX merged 8 commits into
dotnet:mainfrom
lateralusX:lateralusX/on-demand-in-proc-crash-report

Conversation

@lateralusX

@lateralusXlateralusX commented Jul 22, 2026

Copy link
Copy Markdown
Member

Summary

Adds an on-demand entry point to the in-proc crash reporter so a report can be generated programmatically while the runtime is still running, independent of the fatal-signal path. This is the reporting mechanism that a user-registered native
fatal-error handler (proposed in #129543) can call to produce a crash report.

Motivation

The in-proc crash reporter can currently only run from the PAL fatal-signal dispatcher. The fatal-error-handler proposal (#129543) needs a way to invoke just the reporting mechanism on demand, formatting the report to a caller-supplied sink,
without the watchdog/lifecycle/file-management that the signal path performs.

What's in this PR

  • On-demand report APIInProcCrashReportCreateReport(outputFormat, signal, context, outputCallback, callbackContext). Emits the same report as the signal path but streams the selected format (Json or Log) to a caller-supplied callback, with no watchdog or file output. Re-runnable; yields to any report already in flight.
  • Shared in-flight guard — the signal-path and on-demand CreateReport paths are made mutually exclusive over the shared signal-safe writers, module table, and process-global thread-suspension machinery via a single m_reportInFlight guard. The on-demand path releases the guard on completion; the signal path never does (the process is terminating).
  • Init / services split — reporter bring-up is split into CrashReportInitialize (VM callbacks only, so on-demand reports are possible) and InProcCrashReportInitializeServices (env-gated watchdog + lifecycle + PAL dispatcher registration). This lets the reporter be initialized from either the runtime startup path or a future fatal-error-handler setup path, without arming the signal-path crash-dump behavior.
  • Output sink refactorSignalSafeConsoleWriter and SignalSafeJsonWriter gain a small copyable sink abstraction so a single caller-supplied callback shape can drive either writer (platform console / drop-all / caller callback).
  • Stack-overflow classification fix — the in-proc SO stack trace is now captured only on the real stack-overflow path. Previously a FailFast (which funnels through the same fatal-error callstack logger) populated the SO-trace latch, causing an on-demand report to misclassify a FailFast as a StackOverflow. Gating capture to the real-SO path makes the latch authoritative for classification.

Behavior notes

  • No behavior changes when crash reporting is disabled: startup allocates nothing.
  • No behavior changes when crash reporting is enabled: allocates and configure signal-based in-proc crash reporter.

Testing

Follow-ups

@azure-pipelines

Copy link
Copy Markdown
Azure Pipelines:
Successfully started running 3 pipeline(s).
13 pipeline(s) were filtered out due to trigger conditions.
There may be pipelines that require an authorized user to comment /azp run to run.

@dotnet-policy-service

Copy link
Copy Markdown
Contributor

Tagging subscribers to this area: @steveisok, @tommcdon, @dotnet/dotnet-diag
See info in area-owners.md if you want to be subscribed.

CopilotAI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

This PR extends CoreCLR’s in-proc crash reporter to support on-demand report generation (JSON or compact log) via a caller-supplied callback, and refactors initialization so the reporter can be brought up without arming the fatal-signal crash-dump services.

Changes:

  • Adds an on-demand reporting entry point (InProcCrashReportCreateReport) and splits reporter init into “VM callbacks” vs “services + PAL registration”.
  • Refactors the signal-safe JSON/console writers to use small copyable “output sink” abstractions (platform sink / drop-all / caller callback).
  • Fixes stack-overflow classification by only capturing the “SO trace latch” on the real SO path (not on other fatal paths like FailFast).

Reviewed changes

Copilot reviewed 9 out of 9 changed files in this pull request and generated 2 comments.

Show a summary per file
FileDescription
src/coreclr/vm/eepolicy.cppGates stack-overflow trace capture behind an explicit “capture SO trace” flag to avoid misclassification.
src/coreclr/vm/crashreportstackwalker.hAdds CrashReportInitialize() declaration to support init without services.
src/coreclr/vm/crashreportstackwalker.cppImplements CrashReportInitialize() and updates CrashReportConfigure() to start services separately.
src/coreclr/debug/crashreport/signalsafejsonwriter.hIntroduces SignalSafeJsonOutputSink and replaces Init with SetOutputSink.
src/coreclr/debug/crashreport/signalsafejsonwriter.cppImplements sink plumbing + drop-all sink for JSON writer.
src/coreclr/debug/crashreport/signalsafeconsolewriter.hIntroduces SignalSafeConsoleOutputSink and sink selection APIs for console writer.
src/coreclr/debug/crashreport/signalsafeconsolewriter.cppImplements platform/drop-all sinks and sink-driven newline/flush behavior.
src/coreclr/debug/crashreport/inproccrashreporter.hAdds on-demand API, output callback type/format enum, and splits settings into VM vs services.
src/coreclr/debug/crashreport/inproccrashreporter.cppImplements on-demand report generation and shared in-flight guard, plus services init split.

Comment threadsrc/coreclr/debug/crashreport/signalsafeconsolewriter.cpp
Comment threadsrc/coreclr/debug/crashreport/inproccrashreporter.cpp
CopilotAI review requested due to automatic review settings July 23, 2026 08:21

CopilotAI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 9 out of 9 changed files in this pull request and generated 1 comment.

Comment threadsrc/coreclr/debug/crashreport/inproccrashreporter.cpp
@lateralusX
lateralusX marked this pull request as ready for review July 23, 2026 14:00
@lateralusXlateralusX changed the title WIP: Add on-demand in-proc crash report generation.Add on-demand in-proc crash report generation.Jul 23, 2026
@azure-pipelines

Copy link
Copy Markdown
Azure Pipelines:
Successfully started running 3 pipeline(s).
13 pipeline(s) were filtered out due to trigger conditions.
There may be pipelines that require an authorized user to comment /azp run to run.

@mdh1418mdh1418 left a comment

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.

Overall looks good to me, just one concern.

Comment threadsrc/coreclr/debug/crashreport/inproccrashreporter.cpp
@lateralusX
lateralusX merged commit 18c67a7 into dotnet:mainJul 24, 2026
109 of 112 checks passed
hez2010 pushed a commit to hez2010/runtime that referenced this pull request Jul 26, 2026
## Summary
Adds an on-demand entry point to the in-proc crash reporter so a report
can be generated programmatically while the runtime is still running,
independent of the fatal-signal path. This is the reporting mechanism
that a user-registered native
fatal-error handler (proposed in dotnet#129543) can call to produce a crash
report.
## Motivation
The in-proc crash reporter can currently only run from the PAL
fatal-signal dispatcher. The fatal-error-handler proposal (dotnet#129543)
needs a way to invoke just the reporting mechanism on demand, formatting
the report to a caller-supplied sink,
without the watchdog/lifecycle/file-management that the signal path
performs.
## What's in this PR
- **On-demand report API** —
`InProcCrashReportCreateReport(outputFormat, signal, context,
outputCallback, callbackContext)`. Emits the same report as the signal
path but streams the selected format (`Json` or `Log`) to a
caller-supplied callback, with no watchdog or file output. Re-runnable;
yields to any report already in flight.
- **Shared in-flight guard** — the signal-path and on-demand
`CreateReport` paths are made mutually exclusive over the shared
signal-safe writers, module table, and process-global thread-suspension
machinery via a single `m_reportInFlight` guard. The on-demand path
releases the guard on completion; the signal path never does (the
process is terminating).
- **Init / services split** — reporter bring-up is split into
`CrashReportInitialize` (VM callbacks only, so on-demand reports are
possible) and `InProcCrashReportInitializeServices` (env-gated watchdog
+ lifecycle + PAL dispatcher registration). This lets the reporter be
initialized from either the runtime startup path or a future
fatal-error-handler setup path, without arming the signal-path
crash-dump behavior.
- **Output sink refactor** — `SignalSafeConsoleWriter` and
`SignalSafeJsonWriter` gain a small copyable sink abstraction so a
single caller-supplied callback shape can drive either writer (platform
console / drop-all / caller callback).
- **Stack-overflow classification fix** — the in-proc SO stack trace is
now captured only on the real stack-overflow path. Previously a
`FailFast` (which funnels through the same fatal-error callstack logger)
populated the SO-trace latch, causing an on-demand report to misclassify
a `FailFast` as a `StackOverflow`. Gating capture to the real-SO path
makes the latch authoritative for classification.
## Behavior notes
- No behavior changes when crash reporting is disabled: startup
allocates nothing.
- No behavior changes when crash reporting is enabled: allocates and
configure signal-based in-proc crash reporter.
## Testing
- In-proc crash reporter lacks automatic tests, on-demand can be tested
through dotnet#129543 tests when integrated.
- Manually ran FailFast and StackOverflow paths on Android arm64
emulator.
- All tests in
https://github.com/mdh1418/runtime/blob/inproc_crashreport_tests/src/tests/FunctionalTests/Android/Device_Emulator/InProcCrashReport/OVERVIEW.md
pass on Android arm64 emulator.
## Follow-ups
- Wiring the on-demand entry point into the fatal-error handler once
dotnet#129543 lands.
@dotnet-milestone-botdotnet-milestone-botBot added this to the 11.0-rc1 milestone Jul 26, 2026
@github-actionsgithub-actionsBot locked and limited conversation to collaborators Aug 26, 2026
Sign up for freeto subscribe to this conversation on GitHub. Already have an account? Sign in.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@lateralusX@mdh1418
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content

Add on-demand in-proc crash report generation. - #131220

Merged
lateralusX merged 8 commits into
dotnet:mainfrom
lateralusX:lateralusX/on-demand-in-proc-crash-report
Jul 24, 2026
Merged

Add on-demand in-proc crash report generation.#131220
lateralusX merged 8 commits into
dotnet:mainfrom
lateralusX:lateralusX/on-demand-in-proc-crash-report

Conversation

@lateralusX

@lateralusXlateralusX commented Jul 22, 2026

Copy link
Copy Markdown
Member

Summary

Adds an on-demand entry point to the in-proc crash reporter so a report can be generated programmatically while the runtime is still running, independent of the fatal-signal path. This is the reporting mechanism that a user-registered native
fatal-error handler (proposed in #129543) can call to produce a crash report.

Motivation

The in-proc crash reporter can currently only run from the PAL fatal-signal dispatcher. The fatal-error-handler proposal (#129543) needs a way to invoke just the reporting mechanism on demand, formatting the report to a caller-supplied sink,
without the watchdog/lifecycle/file-management that the signal path performs.

What's in this PR

  • On-demand report APIInProcCrashReportCreateReport(outputFormat, signal, context, outputCallback, callbackContext). Emits the same report as the signal path but streams the selected format (Json or Log) to a caller-supplied callback, with no watchdog or file output. Re-runnable; yields to any report already in flight.
  • Shared in-flight guard — the signal-path and on-demand CreateReport paths are made mutually exclusive over the shared signal-safe writers, module table, and process-global thread-suspension machinery via a single m_reportInFlight guard. The on-demand path releases the guard on completion; the signal path never does (the process is terminating).
  • Init / services split — reporter bring-up is split into CrashReportInitialize (VM callbacks only, so on-demand reports are possible) and InProcCrashReportInitializeServices (env-gated watchdog + lifecycle + PAL dispatcher registration). This lets the reporter be initialized from either the runtime startup path or a future fatal-error-handler setup path, without arming the signal-path crash-dump behavior.
  • Output sink refactorSignalSafeConsoleWriter and SignalSafeJsonWriter gain a small copyable sink abstraction so a single caller-supplied callback shape can drive either writer (platform console / drop-all / caller callback).
  • Stack-overflow classification fix — the in-proc SO stack trace is now captured only on the real stack-overflow path. Previously a FailFast (which funnels through the same fatal-error callstack logger) populated the SO-trace latch, causing an on-demand report to misclassify a FailFast as a StackOverflow. Gating capture to the real-SO path makes the latch authoritative for classification.

Behavior notes

  • No behavior changes when crash reporting is disabled: startup allocates nothing.
  • No behavior changes when crash reporting is enabled: allocates and configure signal-based in-proc crash reporter.

Testing

Follow-ups

@azure-pipelines

Copy link
Copy Markdown
Azure Pipelines:
Successfully started running 3 pipeline(s).
13 pipeline(s) were filtered out due to trigger conditions.
There may be pipelines that require an authorized user to comment /azp run to run.

@dotnet-policy-service

Copy link
Copy Markdown
Contributor

Tagging subscribers to this area: @steveisok, @tommcdon, @dotnet/dotnet-diag
See info in area-owners.md if you want to be subscribed.

CopilotAI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

This PR extends CoreCLR’s in-proc crash reporter to support on-demand report generation (JSON or compact log) via a caller-supplied callback, and refactors initialization so the reporter can be brought up without arming the fatal-signal crash-dump services.

Changes:

  • Adds an on-demand reporting entry point (InProcCrashReportCreateReport) and splits reporter init into “VM callbacks” vs “services + PAL registration”.
  • Refactors the signal-safe JSON/console writers to use small copyable “output sink” abstractions (platform sink / drop-all / caller callback).
  • Fixes stack-overflow classification by only capturing the “SO trace latch” on the real SO path (not on other fatal paths like FailFast).

Reviewed changes

Copilot reviewed 9 out of 9 changed files in this pull request and generated 2 comments.

Show a summary per file
FileDescription
src/coreclr/vm/eepolicy.cppGates stack-overflow trace capture behind an explicit “capture SO trace” flag to avoid misclassification.
src/coreclr/vm/crashreportstackwalker.hAdds CrashReportInitialize() declaration to support init without services.
src/coreclr/vm/crashreportstackwalker.cppImplements CrashReportInitialize() and updates CrashReportConfigure() to start services separately.
src/coreclr/debug/crashreport/signalsafejsonwriter.hIntroduces SignalSafeJsonOutputSink and replaces Init with SetOutputSink.
src/coreclr/debug/crashreport/signalsafejsonwriter.cppImplements sink plumbing + drop-all sink for JSON writer.
src/coreclr/debug/crashreport/signalsafeconsolewriter.hIntroduces SignalSafeConsoleOutputSink and sink selection APIs for console writer.
src/coreclr/debug/crashreport/signalsafeconsolewriter.cppImplements platform/drop-all sinks and sink-driven newline/flush behavior.
src/coreclr/debug/crashreport/inproccrashreporter.hAdds on-demand API, output callback type/format enum, and splits settings into VM vs services.
src/coreclr/debug/crashreport/inproccrashreporter.cppImplements on-demand report generation and shared in-flight guard, plus services init split.

Comment threadsrc/coreclr/debug/crashreport/signalsafeconsolewriter.cpp
Comment threadsrc/coreclr/debug/crashreport/inproccrashreporter.cpp
CopilotAI review requested due to automatic review settings July 23, 2026 08:21

CopilotAI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 9 out of 9 changed files in this pull request and generated 1 comment.

Comment threadsrc/coreclr/debug/crashreport/inproccrashreporter.cpp
@lateralusX
lateralusX marked this pull request as ready for review July 23, 2026 14:00
@lateralusXlateralusX changed the title WIP: Add on-demand in-proc crash report generation.Add on-demand in-proc crash report generation.Jul 23, 2026
@azure-pipelines

Copy link
Copy Markdown
Azure Pipelines:
Successfully started running 3 pipeline(s).
13 pipeline(s) were filtered out due to trigger conditions.
There may be pipelines that require an authorized user to comment /azp run to run.

@mdh1418mdh1418 left a comment

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.

Overall looks good to me, just one concern.

Comment threadsrc/coreclr/debug/crashreport/inproccrashreporter.cpp
@lateralusX
lateralusX merged commit 18c67a7 into dotnet:mainJul 24, 2026
109 of 112 checks passed
hez2010 pushed a commit to hez2010/runtime that referenced this pull request Jul 26, 2026
## Summary
Adds an on-demand entry point to the in-proc crash reporter so a report
can be generated programmatically while the runtime is still running,
independent of the fatal-signal path. This is the reporting mechanism
that a user-registered native
fatal-error handler (proposed in dotnet#129543) can call to produce a crash
report.
## Motivation
The in-proc crash reporter can currently only run from the PAL
fatal-signal dispatcher. The fatal-error-handler proposal (dotnet#129543)
needs a way to invoke just the reporting mechanism on demand, formatting
the report to a caller-supplied sink,
without the watchdog/lifecycle/file-management that the signal path
performs.
## What's in this PR
- **On-demand report API** —
`InProcCrashReportCreateReport(outputFormat, signal, context,
outputCallback, callbackContext)`. Emits the same report as the signal
path but streams the selected format (`Json` or `Log`) to a
caller-supplied callback, with no watchdog or file output. Re-runnable;
yields to any report already in flight.
- **Shared in-flight guard** — the signal-path and on-demand
`CreateReport` paths are made mutually exclusive over the shared
signal-safe writers, module table, and process-global thread-suspension
machinery via a single `m_reportInFlight` guard. The on-demand path
releases the guard on completion; the signal path never does (the
process is terminating).
- **Init / services split** — reporter bring-up is split into
`CrashReportInitialize` (VM callbacks only, so on-demand reports are
possible) and `InProcCrashReportInitializeServices` (env-gated watchdog
+ lifecycle + PAL dispatcher registration). This lets the reporter be
initialized from either the runtime startup path or a future
fatal-error-handler setup path, without arming the signal-path
crash-dump behavior.
- **Output sink refactor** — `SignalSafeConsoleWriter` and
`SignalSafeJsonWriter` gain a small copyable sink abstraction so a
single caller-supplied callback shape can drive either writer (platform
console / drop-all / caller callback).
- **Stack-overflow classification fix** — the in-proc SO stack trace is
now captured only on the real stack-overflow path. Previously a
`FailFast` (which funnels through the same fatal-error callstack logger)
populated the SO-trace latch, causing an on-demand report to misclassify
a `FailFast` as a `StackOverflow`. Gating capture to the real-SO path
makes the latch authoritative for classification.
## Behavior notes
- No behavior changes when crash reporting is disabled: startup
allocates nothing.
- No behavior changes when crash reporting is enabled: allocates and
configure signal-based in-proc crash reporter.
## Testing
- In-proc crash reporter lacks automatic tests, on-demand can be tested
through dotnet#129543 tests when integrated.
- Manually ran FailFast and StackOverflow paths on Android arm64
emulator.
- All tests in
https://github.com/mdh1418/runtime/blob/inproc_crashreport_tests/src/tests/FunctionalTests/Android/Device_Emulator/InProcCrashReport/OVERVIEW.md
pass on Android arm64 emulator.
## Follow-ups
- Wiring the on-demand entry point into the fatal-error handler once
dotnet#129543 lands.
@dotnet-milestone-botdotnet-milestone-botBot added this to the 11.0-rc1 milestone Jul 26, 2026
@github-actionsgithub-actionsBot locked and limited conversation to collaborators Aug 26, 2026
Sign up for freeto subscribe to this conversation on GitHub. Already have an account? Sign in.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@lateralusX@mdh1418
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Add on-demand in-proc crash report generation. - #131220

Merged
lateralusX merged 8 commits into
dotnet:mainfrom
lateralusX:lateralusX/on-demand-in-proc-crash-report
Jul 24, 2026
Merged

Add on-demand in-proc crash report generation.#131220
lateralusX merged 8 commits into
dotnet:mainfrom
lateralusX:lateralusX/on-demand-in-proc-crash-report

Conversation

@lateralusX

@lateralusXlateralusX commented Jul 22, 2026

Copy link
Copy Markdown
Member

Summary

Adds an on-demand entry point to the in-proc crash reporter so a report can be generated programmatically while the runtime is still running, independent of the fatal-signal path. This is the reporting mechanism that a user-registered native
fatal-error handler (proposed in #129543) can call to produce a crash report.

Motivation

The in-proc crash reporter can currently only run from the PAL fatal-signal dispatcher. The fatal-error-handler proposal (#129543) needs a way to invoke just the reporting mechanism on demand, formatting the report to a caller-supplied sink,
without the watchdog/lifecycle/file-management that the signal path performs.

What's in this PR

  • On-demand report APIInProcCrashReportCreateReport(outputFormat, signal, context, outputCallback, callbackContext). Emits the same report as the signal path but streams the selected format (Json or Log) to a caller-supplied callback, with no watchdog or file output. Re-runnable; yields to any report already in flight.
  • Shared in-flight guard — the signal-path and on-demand CreateReport paths are made mutually exclusive over the shared signal-safe writers, module table, and process-global thread-suspension machinery via a single m_reportInFlight guard. The on-demand path releases the guard on completion; the signal path never does (the process is terminating).
  • Init / services split — reporter bring-up is split into CrashReportInitialize (VM callbacks only, so on-demand reports are possible) and InProcCrashReportInitializeServices (env-gated watchdog + lifecycle + PAL dispatcher registration). This lets the reporter be initialized from either the runtime startup path or a future fatal-error-handler setup path, without arming the signal-path crash-dump behavior.
  • Output sink refactorSignalSafeConsoleWriter and SignalSafeJsonWriter gain a small copyable sink abstraction so a single caller-supplied callback shape can drive either writer (platform console / drop-all / caller callback).
  • Stack-overflow classification fix — the in-proc SO stack trace is now captured only on the real stack-overflow path. Previously a FailFast (which funnels through the same fatal-error callstack logger) populated the SO-trace latch, causing an on-demand report to misclassify a FailFast as a StackOverflow. Gating capture to the real-SO path makes the latch authoritative for classification.

Behavior notes

  • No behavior changes when crash reporting is disabled: startup allocates nothing.
  • No behavior changes when crash reporting is enabled: allocates and configure signal-based in-proc crash reporter.

Testing

Follow-ups

@azure-pipelines

Copy link
Copy Markdown
Azure Pipelines:
Successfully started running 3 pipeline(s).
13 pipeline(s) were filtered out due to trigger conditions.
There may be pipelines that require an authorized user to comment /azp run to run.

@dotnet-policy-service

Copy link
Copy Markdown
Contributor

Tagging subscribers to this area: @steveisok, @tommcdon, @dotnet/dotnet-diag
See info in area-owners.md if you want to be subscribed.

CopilotAI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

This PR extends CoreCLR’s in-proc crash reporter to support on-demand report generation (JSON or compact log) via a caller-supplied callback, and refactors initialization so the reporter can be brought up without arming the fatal-signal crash-dump services.

Changes:

  • Adds an on-demand reporting entry point (InProcCrashReportCreateReport) and splits reporter init into “VM callbacks” vs “services + PAL registration”.
  • Refactors the signal-safe JSON/console writers to use small copyable “output sink” abstractions (platform sink / drop-all / caller callback).
  • Fixes stack-overflow classification by only capturing the “SO trace latch” on the real SO path (not on other fatal paths like FailFast).

Reviewed changes

Copilot reviewed 9 out of 9 changed files in this pull request and generated 2 comments.

Show a summary per file
FileDescription
src/coreclr/vm/eepolicy.cppGates stack-overflow trace capture behind an explicit “capture SO trace” flag to avoid misclassification.
src/coreclr/vm/crashreportstackwalker.hAdds CrashReportInitialize() declaration to support init without services.
src/coreclr/vm/crashreportstackwalker.cppImplements CrashReportInitialize() and updates CrashReportConfigure() to start services separately.
src/coreclr/debug/crashreport/signalsafejsonwriter.hIntroduces SignalSafeJsonOutputSink and replaces Init with SetOutputSink.
src/coreclr/debug/crashreport/signalsafejsonwriter.cppImplements sink plumbing + drop-all sink for JSON writer.
src/coreclr/debug/crashreport/signalsafeconsolewriter.hIntroduces SignalSafeConsoleOutputSink and sink selection APIs for console writer.
src/coreclr/debug/crashreport/signalsafeconsolewriter.cppImplements platform/drop-all sinks and sink-driven newline/flush behavior.
src/coreclr/debug/crashreport/inproccrashreporter.hAdds on-demand API, output callback type/format enum, and splits settings into VM vs services.
src/coreclr/debug/crashreport/inproccrashreporter.cppImplements on-demand report generation and shared in-flight guard, plus services init split.

Comment threadsrc/coreclr/debug/crashreport/signalsafeconsolewriter.cpp
Comment threadsrc/coreclr/debug/crashreport/inproccrashreporter.cpp
CopilotAI review requested due to automatic review settings July 23, 2026 08:21

CopilotAI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 9 out of 9 changed files in this pull request and generated 1 comment.

Comment threadsrc/coreclr/debug/crashreport/inproccrashreporter.cpp
@lateralusX
lateralusX marked this pull request as ready for review July 23, 2026 14:00
@lateralusXlateralusX changed the title WIP: Add on-demand in-proc crash report generation.Add on-demand in-proc crash report generation.Jul 23, 2026
@azure-pipelines

Copy link
Copy Markdown
Azure Pipelines:
Successfully started running 3 pipeline(s).
13 pipeline(s) were filtered out due to trigger conditions.
There may be pipelines that require an authorized user to comment /azp run to run.

@mdh1418mdh1418 left a comment

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.

Overall looks good to me, just one concern.

Comment threadsrc/coreclr/debug/crashreport/inproccrashreporter.cpp
@lateralusX
lateralusX merged commit 18c67a7 into dotnet:mainJul 24, 2026
109 of 112 checks passed
hez2010 pushed a commit to hez2010/runtime that referenced this pull request Jul 26, 2026
## Summary
Adds an on-demand entry point to the in-proc crash reporter so a report
can be generated programmatically while the runtime is still running,
independent of the fatal-signal path. This is the reporting mechanism
that a user-registered native
fatal-error handler (proposed in dotnet#129543) can call to produce a crash
report.
## Motivation
The in-proc crash reporter can currently only run from the PAL
fatal-signal dispatcher. The fatal-error-handler proposal (dotnet#129543)
needs a way to invoke just the reporting mechanism on demand, formatting
the report to a caller-supplied sink,
without the watchdog/lifecycle/file-management that the signal path
performs.
## What's in this PR
- **On-demand report API** —
`InProcCrashReportCreateReport(outputFormat, signal, context,
outputCallback, callbackContext)`. Emits the same report as the signal
path but streams the selected format (`Json` or `Log`) to a
caller-supplied callback, with no watchdog or file output. Re-runnable;
yields to any report already in flight.
- **Shared in-flight guard** — the signal-path and on-demand
`CreateReport` paths are made mutually exclusive over the shared
signal-safe writers, module table, and process-global thread-suspension
machinery via a single `m_reportInFlight` guard. The on-demand path
releases the guard on completion; the signal path never does (the
process is terminating).
- **Init / services split** — reporter bring-up is split into
`CrashReportInitialize` (VM callbacks only, so on-demand reports are
possible) and `InProcCrashReportInitializeServices` (env-gated watchdog
+ lifecycle + PAL dispatcher registration). This lets the reporter be
initialized from either the runtime startup path or a future
fatal-error-handler setup path, without arming the signal-path
crash-dump behavior.
- **Output sink refactor** — `SignalSafeConsoleWriter` and
`SignalSafeJsonWriter` gain a small copyable sink abstraction so a
single caller-supplied callback shape can drive either writer (platform
console / drop-all / caller callback).
- **Stack-overflow classification fix** — the in-proc SO stack trace is
now captured only on the real stack-overflow path. Previously a
`FailFast` (which funnels through the same fatal-error callstack logger)
populated the SO-trace latch, causing an on-demand report to misclassify
a `FailFast` as a `StackOverflow`. Gating capture to the real-SO path
makes the latch authoritative for classification.
## Behavior notes
- No behavior changes when crash reporting is disabled: startup
allocates nothing.
- No behavior changes when crash reporting is enabled: allocates and
configure signal-based in-proc crash reporter.
## Testing
- In-proc crash reporter lacks automatic tests, on-demand can be tested
through dotnet#129543 tests when integrated.
- Manually ran FailFast and StackOverflow paths on Android arm64
emulator.
- All tests in
https://github.com/mdh1418/runtime/blob/inproc_crashreport_tests/src/tests/FunctionalTests/Android/Device_Emulator/InProcCrashReport/OVERVIEW.md
pass on Android arm64 emulator.
## Follow-ups
- Wiring the on-demand entry point into the fatal-error handler once
dotnet#129543 lands.
@dotnet-milestone-botdotnet-milestone-botBot added this to the 11.0-rc1 milestone Jul 26, 2026
@github-actionsgithub-actionsBot locked and limited conversation to collaborators Aug 26, 2026
Sign up for freeto subscribe to this conversation on GitHub. Already have an account? Sign in.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@lateralusX@mdh1418
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Add on-demand in-proc crash report generation. - #131220

Merged
lateralusX merged 8 commits into
dotnet:mainfrom
lateralusX:lateralusX/on-demand-in-proc-crash-report
Jul 24, 2026
Merged

Add on-demand in-proc crash report generation.#131220
lateralusX merged 8 commits into
dotnet:mainfrom
lateralusX:lateralusX/on-demand-in-proc-crash-report

Conversation

@lateralusX

@lateralusXlateralusX commented Jul 22, 2026

Copy link
Copy Markdown
Member

Summary

Adds an on-demand entry point to the in-proc crash reporter so a report can be generated programmatically while the runtime is still running, independent of the fatal-signal path. This is the reporting mechanism that a user-registered native
fatal-error handler (proposed in #129543) can call to produce a crash report.

Motivation

The in-proc crash reporter can currently only run from the PAL fatal-signal dispatcher. The fatal-error-handler proposal (#129543) needs a way to invoke just the reporting mechanism on demand, formatting the report to a caller-supplied sink,
without the watchdog/lifecycle/file-management that the signal path performs.

What's in this PR

  • On-demand report APIInProcCrashReportCreateReport(outputFormat, signal, context, outputCallback, callbackContext). Emits the same report as the signal path but streams the selected format (Json or Log) to a caller-supplied callback, with no watchdog or file output. Re-runnable; yields to any report already in flight.
  • Shared in-flight guard — the signal-path and on-demand CreateReport paths are made mutually exclusive over the shared signal-safe writers, module table, and process-global thread-suspension machinery via a single m_reportInFlight guard. The on-demand path releases the guard on completion; the signal path never does (the process is terminating).
  • Init / services split — reporter bring-up is split into CrashReportInitialize (VM callbacks only, so on-demand reports are possible) and InProcCrashReportInitializeServices (env-gated watchdog + lifecycle + PAL dispatcher registration). This lets the reporter be initialized from either the runtime startup path or a future fatal-error-handler setup path, without arming the signal-path crash-dump behavior.
  • Output sink refactorSignalSafeConsoleWriter and SignalSafeJsonWriter gain a small copyable sink abstraction so a single caller-supplied callback shape can drive either writer (platform console / drop-all / caller callback).
  • Stack-overflow classification fix — the in-proc SO stack trace is now captured only on the real stack-overflow path. Previously a FailFast (which funnels through the same fatal-error callstack logger) populated the SO-trace latch, causing an on-demand report to misclassify a FailFast as a StackOverflow. Gating capture to the real-SO path makes the latch authoritative for classification.

Behavior notes

  • No behavior changes when crash reporting is disabled: startup allocates nothing.
  • No behavior changes when crash reporting is enabled: allocates and configure signal-based in-proc crash reporter.

Testing

Follow-ups

@azure-pipelines

Copy link
Copy Markdown
Azure Pipelines:
Successfully started running 3 pipeline(s).
13 pipeline(s) were filtered out due to trigger conditions.
There may be pipelines that require an authorized user to comment /azp run to run.

@dotnet-policy-service

Copy link
Copy Markdown
Contributor

Tagging subscribers to this area: @steveisok, @tommcdon, @dotnet/dotnet-diag
See info in area-owners.md if you want to be subscribed.

CopilotAI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

This PR extends CoreCLR’s in-proc crash reporter to support on-demand report generation (JSON or compact log) via a caller-supplied callback, and refactors initialization so the reporter can be brought up without arming the fatal-signal crash-dump services.

Changes:

  • Adds an on-demand reporting entry point (InProcCrashReportCreateReport) and splits reporter init into “VM callbacks” vs “services + PAL registration”.
  • Refactors the signal-safe JSON/console writers to use small copyable “output sink” abstractions (platform sink / drop-all / caller callback).
  • Fixes stack-overflow classification by only capturing the “SO trace latch” on the real SO path (not on other fatal paths like FailFast).

Reviewed changes

Copilot reviewed 9 out of 9 changed files in this pull request and generated 2 comments.

Show a summary per file
FileDescription
src/coreclr/vm/eepolicy.cppGates stack-overflow trace capture behind an explicit “capture SO trace” flag to avoid misclassification.
src/coreclr/vm/crashreportstackwalker.hAdds CrashReportInitialize() declaration to support init without services.
src/coreclr/vm/crashreportstackwalker.cppImplements CrashReportInitialize() and updates CrashReportConfigure() to start services separately.
src/coreclr/debug/crashreport/signalsafejsonwriter.hIntroduces SignalSafeJsonOutputSink and replaces Init with SetOutputSink.
src/coreclr/debug/crashreport/signalsafejsonwriter.cppImplements sink plumbing + drop-all sink for JSON writer.
src/coreclr/debug/crashreport/signalsafeconsolewriter.hIntroduces SignalSafeConsoleOutputSink and sink selection APIs for console writer.
src/coreclr/debug/crashreport/signalsafeconsolewriter.cppImplements platform/drop-all sinks and sink-driven newline/flush behavior.
src/coreclr/debug/crashreport/inproccrashreporter.hAdds on-demand API, output callback type/format enum, and splits settings into VM vs services.
src/coreclr/debug/crashreport/inproccrashreporter.cppImplements on-demand report generation and shared in-flight guard, plus services init split.

Comment threadsrc/coreclr/debug/crashreport/signalsafeconsolewriter.cpp
Comment threadsrc/coreclr/debug/crashreport/inproccrashreporter.cpp
CopilotAI review requested due to automatic review settings July 23, 2026 08:21

CopilotAI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 9 out of 9 changed files in this pull request and generated 1 comment.

Comment threadsrc/coreclr/debug/crashreport/inproccrashreporter.cpp
@lateralusX
lateralusX marked this pull request as ready for review July 23, 2026 14:00
@lateralusXlateralusX changed the title WIP: Add on-demand in-proc crash report generation.Add on-demand in-proc crash report generation.Jul 23, 2026
@azure-pipelines

Copy link
Copy Markdown
Azure Pipelines:
Successfully started running 3 pipeline(s).
13 pipeline(s) were filtered out due to trigger conditions.
There may be pipelines that require an authorized user to comment /azp run to run.

@mdh1418mdh1418 left a comment

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.

Overall looks good to me, just one concern.

Comment threadsrc/coreclr/debug/crashreport/inproccrashreporter.cpp
@lateralusX
lateralusX merged commit 18c67a7 into dotnet:mainJul 24, 2026
109 of 112 checks passed
hez2010 pushed a commit to hez2010/runtime that referenced this pull request Jul 26, 2026
## Summary
Adds an on-demand entry point to the in-proc crash reporter so a report
can be generated programmatically while the runtime is still running,
independent of the fatal-signal path. This is the reporting mechanism
that a user-registered native
fatal-error handler (proposed in dotnet#129543) can call to produce a crash
report.
## Motivation
The in-proc crash reporter can currently only run from the PAL
fatal-signal dispatcher. The fatal-error-handler proposal (dotnet#129543)
needs a way to invoke just the reporting mechanism on demand, formatting
the report to a caller-supplied sink,
without the watchdog/lifecycle/file-management that the signal path
performs.
## What's in this PR
- **On-demand report API** —
`InProcCrashReportCreateReport(outputFormat, signal, context,
outputCallback, callbackContext)`. Emits the same report as the signal
path but streams the selected format (`Json` or `Log`) to a
caller-supplied callback, with no watchdog or file output. Re-runnable;
yields to any report already in flight.
- **Shared in-flight guard** — the signal-path and on-demand
`CreateReport` paths are made mutually exclusive over the shared
signal-safe writers, module table, and process-global thread-suspension
machinery via a single `m_reportInFlight` guard. The on-demand path
releases the guard on completion; the signal path never does (the
process is terminating).
- **Init / services split** — reporter bring-up is split into
`CrashReportInitialize` (VM callbacks only, so on-demand reports are
possible) and `InProcCrashReportInitializeServices` (env-gated watchdog
+ lifecycle + PAL dispatcher registration). This lets the reporter be
initialized from either the runtime startup path or a future
fatal-error-handler setup path, without arming the signal-path
crash-dump behavior.
- **Output sink refactor** — `SignalSafeConsoleWriter` and
`SignalSafeJsonWriter` gain a small copyable sink abstraction so a
single caller-supplied callback shape can drive either writer (platform
console / drop-all / caller callback).
- **Stack-overflow classification fix** — the in-proc SO stack trace is
now captured only on the real stack-overflow path. Previously a
`FailFast` (which funnels through the same fatal-error callstack logger)
populated the SO-trace latch, causing an on-demand report to misclassify
a `FailFast` as a `StackOverflow`. Gating capture to the real-SO path
makes the latch authoritative for classification.
## Behavior notes
- No behavior changes when crash reporting is disabled: startup
allocates nothing.
- No behavior changes when crash reporting is enabled: allocates and
configure signal-based in-proc crash reporter.
## Testing
- In-proc crash reporter lacks automatic tests, on-demand can be tested
through dotnet#129543 tests when integrated.
- Manually ran FailFast and StackOverflow paths on Android arm64
emulator.
- All tests in
https://github.com/mdh1418/runtime/blob/inproc_crashreport_tests/src/tests/FunctionalTests/Android/Device_Emulator/InProcCrashReport/OVERVIEW.md
pass on Android arm64 emulator.
## Follow-ups
- Wiring the on-demand entry point into the fatal-error handler once
dotnet#129543 lands.
@dotnet-milestone-botdotnet-milestone-botBot added this to the 11.0-rc1 milestone Jul 26, 2026
@github-actionsgithub-actionsBot locked and limited conversation to collaborators Aug 26, 2026
Sign up for freeto subscribe to this conversation on GitHub. Already have an account? Sign in.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@lateralusX@mdh1418
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content

Add on-demand in-proc crash report generation. - #131220

Merged
lateralusX merged 8 commits into
dotnet:mainfrom
lateralusX:lateralusX/on-demand-in-proc-crash-report
Jul 24, 2026
Merged

Add on-demand in-proc crash report generation.#131220
lateralusX merged 8 commits into
dotnet:mainfrom
lateralusX:lateralusX/on-demand-in-proc-crash-report

Conversation

@lateralusX

@lateralusXlateralusX commented Jul 22, 2026

Copy link
Copy Markdown
Member

Summary

Adds an on-demand entry point to the in-proc crash reporter so a report can be generated programmatically while the runtime is still running, independent of the fatal-signal path. This is the reporting mechanism that a user-registered native
fatal-error handler (proposed in #129543) can call to produce a crash report.

Motivation

The in-proc crash reporter can currently only run from the PAL fatal-signal dispatcher. The fatal-error-handler proposal (#129543) needs a way to invoke just the reporting mechanism on demand, formatting the report to a caller-supplied sink,
without the watchdog/lifecycle/file-management that the signal path performs.

What's in this PR

  • On-demand report APIInProcCrashReportCreateReport(outputFormat, signal, context, outputCallback, callbackContext). Emits the same report as the signal path but streams the selected format (Json or Log) to a caller-supplied callback, with no watchdog or file output. Re-runnable; yields to any report already in flight.
  • Shared in-flight guard — the signal-path and on-demand CreateReport paths are made mutually exclusive over the shared signal-safe writers, module table, and process-global thread-suspension machinery via a single m_reportInFlight guard. The on-demand path releases the guard on completion; the signal path never does (the process is terminating).
  • Init / services split — reporter bring-up is split into CrashReportInitialize (VM callbacks only, so on-demand reports are possible) and InProcCrashReportInitializeServices (env-gated watchdog + lifecycle + PAL dispatcher registration). This lets the reporter be initialized from either the runtime startup path or a future fatal-error-handler setup path, without arming the signal-path crash-dump behavior.
  • Output sink refactorSignalSafeConsoleWriter and SignalSafeJsonWriter gain a small copyable sink abstraction so a single caller-supplied callback shape can drive either writer (platform console / drop-all / caller callback).
  • Stack-overflow classification fix — the in-proc SO stack trace is now captured only on the real stack-overflow path. Previously a FailFast (which funnels through the same fatal-error callstack logger) populated the SO-trace latch, causing an on-demand report to misclassify a FailFast as a StackOverflow. Gating capture to the real-SO path makes the latch authoritative for classification.

Behavior notes

  • No behavior changes when crash reporting is disabled: startup allocates nothing.
  • No behavior changes when crash reporting is enabled: allocates and configure signal-based in-proc crash reporter.

Testing

Follow-ups

@azure-pipelines

Copy link
Copy Markdown
Azure Pipelines:
Successfully started running 3 pipeline(s).
13 pipeline(s) were filtered out due to trigger conditions.
There may be pipelines that require an authorized user to comment /azp run to run.

@dotnet-policy-service

Copy link
Copy Markdown
Contributor

Tagging subscribers to this area: @steveisok, @tommcdon, @dotnet/dotnet-diag
See info in area-owners.md if you want to be subscribed.

CopilotAI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

This PR extends CoreCLR’s in-proc crash reporter to support on-demand report generation (JSON or compact log) via a caller-supplied callback, and refactors initialization so the reporter can be brought up without arming the fatal-signal crash-dump services.

Changes:

  • Adds an on-demand reporting entry point (InProcCrashReportCreateReport) and splits reporter init into “VM callbacks” vs “services + PAL registration”.
  • Refactors the signal-safe JSON/console writers to use small copyable “output sink” abstractions (platform sink / drop-all / caller callback).
  • Fixes stack-overflow classification by only capturing the “SO trace latch” on the real SO path (not on other fatal paths like FailFast).

Reviewed changes

Copilot reviewed 9 out of 9 changed files in this pull request and generated 2 comments.

Show a summary per file
FileDescription
src/coreclr/vm/eepolicy.cppGates stack-overflow trace capture behind an explicit “capture SO trace” flag to avoid misclassification.
src/coreclr/vm/crashreportstackwalker.hAdds CrashReportInitialize() declaration to support init without services.
src/coreclr/vm/crashreportstackwalker.cppImplements CrashReportInitialize() and updates CrashReportConfigure() to start services separately.
src/coreclr/debug/crashreport/signalsafejsonwriter.hIntroduces SignalSafeJsonOutputSink and replaces Init with SetOutputSink.
src/coreclr/debug/crashreport/signalsafejsonwriter.cppImplements sink plumbing + drop-all sink for JSON writer.
src/coreclr/debug/crashreport/signalsafeconsolewriter.hIntroduces SignalSafeConsoleOutputSink and sink selection APIs for console writer.
src/coreclr/debug/crashreport/signalsafeconsolewriter.cppImplements platform/drop-all sinks and sink-driven newline/flush behavior.
src/coreclr/debug/crashreport/inproccrashreporter.hAdds on-demand API, output callback type/format enum, and splits settings into VM vs services.
src/coreclr/debug/crashreport/inproccrashreporter.cppImplements on-demand report generation and shared in-flight guard, plus services init split.

Comment threadsrc/coreclr/debug/crashreport/signalsafeconsolewriter.cpp
Comment threadsrc/coreclr/debug/crashreport/inproccrashreporter.cpp
CopilotAI review requested due to automatic review settings July 23, 2026 08:21

CopilotAI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 9 out of 9 changed files in this pull request and generated 1 comment.

Comment threadsrc/coreclr/debug/crashreport/inproccrashreporter.cpp
@lateralusX
lateralusX marked this pull request as ready for review July 23, 2026 14:00
@lateralusXlateralusX changed the title WIP: Add on-demand in-proc crash report generation.Add on-demand in-proc crash report generation.Jul 23, 2026
@azure-pipelines

Copy link
Copy Markdown
Azure Pipelines:
Successfully started running 3 pipeline(s).
13 pipeline(s) were filtered out due to trigger conditions.
There may be pipelines that require an authorized user to comment /azp run to run.

@mdh1418mdh1418 left a comment

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.

Overall looks good to me, just one concern.

Comment threadsrc/coreclr/debug/crashreport/inproccrashreporter.cpp
@lateralusX
lateralusX merged commit 18c67a7 into dotnet:mainJul 24, 2026
109 of 112 checks passed
hez2010 pushed a commit to hez2010/runtime that referenced this pull request Jul 26, 2026
## Summary
Adds an on-demand entry point to the in-proc crash reporter so a report
can be generated programmatically while the runtime is still running,
independent of the fatal-signal path. This is the reporting mechanism
that a user-registered native
fatal-error handler (proposed in dotnet#129543) can call to produce a crash
report.
## Motivation
The in-proc crash reporter can currently only run from the PAL
fatal-signal dispatcher. The fatal-error-handler proposal (dotnet#129543)
needs a way to invoke just the reporting mechanism on demand, formatting
the report to a caller-supplied sink,
without the watchdog/lifecycle/file-management that the signal path
performs.
## What's in this PR
- **On-demand report API** —
`InProcCrashReportCreateReport(outputFormat, signal, context,
outputCallback, callbackContext)`. Emits the same report as the signal
path but streams the selected format (`Json` or `Log`) to a
caller-supplied callback, with no watchdog or file output. Re-runnable;
yields to any report already in flight.
- **Shared in-flight guard** — the signal-path and on-demand
`CreateReport` paths are made mutually exclusive over the shared
signal-safe writers, module table, and process-global thread-suspension
machinery via a single `m_reportInFlight` guard. The on-demand path
releases the guard on completion; the signal path never does (the
process is terminating).
- **Init / services split** — reporter bring-up is split into
`CrashReportInitialize` (VM callbacks only, so on-demand reports are
possible) and `InProcCrashReportInitializeServices` (env-gated watchdog
+ lifecycle + PAL dispatcher registration). This lets the reporter be
initialized from either the runtime startup path or a future
fatal-error-handler setup path, without arming the signal-path
crash-dump behavior.
- **Output sink refactor** — `SignalSafeConsoleWriter` and
`SignalSafeJsonWriter` gain a small copyable sink abstraction so a
single caller-supplied callback shape can drive either writer (platform
console / drop-all / caller callback).
- **Stack-overflow classification fix** — the in-proc SO stack trace is
now captured only on the real stack-overflow path. Previously a
`FailFast` (which funnels through the same fatal-error callstack logger)
populated the SO-trace latch, causing an on-demand report to misclassify
a `FailFast` as a `StackOverflow`. Gating capture to the real-SO path
makes the latch authoritative for classification.
## Behavior notes
- No behavior changes when crash reporting is disabled: startup
allocates nothing.
- No behavior changes when crash reporting is enabled: allocates and
configure signal-based in-proc crash reporter.
## Testing
- In-proc crash reporter lacks automatic tests, on-demand can be tested
through dotnet#129543 tests when integrated.
- Manually ran FailFast and StackOverflow paths on Android arm64
emulator.
- All tests in
https://github.com/mdh1418/runtime/blob/inproc_crashreport_tests/src/tests/FunctionalTests/Android/Device_Emulator/InProcCrashReport/OVERVIEW.md
pass on Android arm64 emulator.
## Follow-ups
- Wiring the on-demand entry point into the fatal-error handler once
dotnet#129543 lands.
@dotnet-milestone-botdotnet-milestone-botBot added this to the 11.0-rc1 milestone Jul 26, 2026
@github-actionsgithub-actionsBot locked and limited conversation to collaborators Aug 26, 2026
Sign up for freeto subscribe to this conversation on GitHub. Already have an account? Sign in.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@lateralusX@mdh1418
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Add on-demand in-proc crash report generation. - #131220

Merged
lateralusX merged 8 commits into
dotnet:mainfrom
lateralusX:lateralusX/on-demand-in-proc-crash-report
Jul 24, 2026
Merged

Add on-demand in-proc crash report generation.#131220
lateralusX merged 8 commits into
dotnet:mainfrom
lateralusX:lateralusX/on-demand-in-proc-crash-report

Conversation

@lateralusX

@lateralusXlateralusX commented Jul 22, 2026

Copy link
Copy Markdown
Member

Summary

Adds an on-demand entry point to the in-proc crash reporter so a report can be generated programmatically while the runtime is still running, independent of the fatal-signal path. This is the reporting mechanism that a user-registered native
fatal-error handler (proposed in #129543) can call to produce a crash report.

Motivation

The in-proc crash reporter can currently only run from the PAL fatal-signal dispatcher. The fatal-error-handler proposal (#129543) needs a way to invoke just the reporting mechanism on demand, formatting the report to a caller-supplied sink,
without the watchdog/lifecycle/file-management that the signal path performs.

What's in this PR

  • On-demand report APIInProcCrashReportCreateReport(outputFormat, signal, context, outputCallback, callbackContext). Emits the same report as the signal path but streams the selected format (Json or Log) to a caller-supplied callback, with no watchdog or file output. Re-runnable; yields to any report already in flight.
  • Shared in-flight guard — the signal-path and on-demand CreateReport paths are made mutually exclusive over the shared signal-safe writers, module table, and process-global thread-suspension machinery via a single m_reportInFlight guard. The on-demand path releases the guard on completion; the signal path never does (the process is terminating).
  • Init / services split — reporter bring-up is split into CrashReportInitialize (VM callbacks only, so on-demand reports are possible) and InProcCrashReportInitializeServices (env-gated watchdog + lifecycle + PAL dispatcher registration). This lets the reporter be initialized from either the runtime startup path or a future fatal-error-handler setup path, without arming the signal-path crash-dump behavior.
  • Output sink refactorSignalSafeConsoleWriter and SignalSafeJsonWriter gain a small copyable sink abstraction so a single caller-supplied callback shape can drive either writer (platform console / drop-all / caller callback).
  • Stack-overflow classification fix — the in-proc SO stack trace is now captured only on the real stack-overflow path. Previously a FailFast (which funnels through the same fatal-error callstack logger) populated the SO-trace latch, causing an on-demand report to misclassify a FailFast as a StackOverflow. Gating capture to the real-SO path makes the latch authoritative for classification.

Behavior notes

  • No behavior changes when crash reporting is disabled: startup allocates nothing.
  • No behavior changes when crash reporting is enabled: allocates and configure signal-based in-proc crash reporter.

Testing

Follow-ups

@azure-pipelines

Copy link
Copy Markdown
Azure Pipelines:
Successfully started running 3 pipeline(s).
13 pipeline(s) were filtered out due to trigger conditions.
There may be pipelines that require an authorized user to comment /azp run to run.

@dotnet-policy-service

Copy link
Copy Markdown
Contributor

Tagging subscribers to this area: @steveisok, @tommcdon, @dotnet/dotnet-diag
See info in area-owners.md if you want to be subscribed.

CopilotAI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

This PR extends CoreCLR’s in-proc crash reporter to support on-demand report generation (JSON or compact log) via a caller-supplied callback, and refactors initialization so the reporter can be brought up without arming the fatal-signal crash-dump services.

Changes:

  • Adds an on-demand reporting entry point (InProcCrashReportCreateReport) and splits reporter init into “VM callbacks” vs “services + PAL registration”.
  • Refactors the signal-safe JSON/console writers to use small copyable “output sink” abstractions (platform sink / drop-all / caller callback).
  • Fixes stack-overflow classification by only capturing the “SO trace latch” on the real SO path (not on other fatal paths like FailFast).

Reviewed changes

Copilot reviewed 9 out of 9 changed files in this pull request and generated 2 comments.

Show a summary per file
FileDescription
src/coreclr/vm/eepolicy.cppGates stack-overflow trace capture behind an explicit “capture SO trace” flag to avoid misclassification.
src/coreclr/vm/crashreportstackwalker.hAdds CrashReportInitialize() declaration to support init without services.
src/coreclr/vm/crashreportstackwalker.cppImplements CrashReportInitialize() and updates CrashReportConfigure() to start services separately.
src/coreclr/debug/crashreport/signalsafejsonwriter.hIntroduces SignalSafeJsonOutputSink and replaces Init with SetOutputSink.
src/coreclr/debug/crashreport/signalsafejsonwriter.cppImplements sink plumbing + drop-all sink for JSON writer.
src/coreclr/debug/crashreport/signalsafeconsolewriter.hIntroduces SignalSafeConsoleOutputSink and sink selection APIs for console writer.
src/coreclr/debug/crashreport/signalsafeconsolewriter.cppImplements platform/drop-all sinks and sink-driven newline/flush behavior.
src/coreclr/debug/crashreport/inproccrashreporter.hAdds on-demand API, output callback type/format enum, and splits settings into VM vs services.
src/coreclr/debug/crashreport/inproccrashreporter.cppImplements on-demand report generation and shared in-flight guard, plus services init split.

Comment threadsrc/coreclr/debug/crashreport/signalsafeconsolewriter.cpp
Comment threadsrc/coreclr/debug/crashreport/inproccrashreporter.cpp
CopilotAI review requested due to automatic review settings July 23, 2026 08:21

CopilotAI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 9 out of 9 changed files in this pull request and generated 1 comment.

Comment threadsrc/coreclr/debug/crashreport/inproccrashreporter.cpp
@lateralusX
lateralusX marked this pull request as ready for review July 23, 2026 14:00
@lateralusXlateralusX changed the title WIP: Add on-demand in-proc crash report generation.Add on-demand in-proc crash report generation.Jul 23, 2026
@azure-pipelines

Copy link
Copy Markdown
Azure Pipelines:
Successfully started running 3 pipeline(s).
13 pipeline(s) were filtered out due to trigger conditions.
There may be pipelines that require an authorized user to comment /azp run to run.

@mdh1418mdh1418 left a comment

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.

Overall looks good to me, just one concern.

Comment threadsrc/coreclr/debug/crashreport/inproccrashreporter.cpp
@lateralusX
lateralusX merged commit 18c67a7 into dotnet:mainJul 24, 2026
109 of 112 checks passed
hez2010 pushed a commit to hez2010/runtime that referenced this pull request Jul 26, 2026
## Summary
Adds an on-demand entry point to the in-proc crash reporter so a report
can be generated programmatically while the runtime is still running,
independent of the fatal-signal path. This is the reporting mechanism
that a user-registered native
fatal-error handler (proposed in dotnet#129543) can call to produce a crash
report.
## Motivation
The in-proc crash reporter can currently only run from the PAL
fatal-signal dispatcher. The fatal-error-handler proposal (dotnet#129543)
needs a way to invoke just the reporting mechanism on demand, formatting
the report to a caller-supplied sink,
without the watchdog/lifecycle/file-management that the signal path
performs.
## What's in this PR
- **On-demand report API** —
`InProcCrashReportCreateReport(outputFormat, signal, context,
outputCallback, callbackContext)`. Emits the same report as the signal
path but streams the selected format (`Json` or `Log`) to a
caller-supplied callback, with no watchdog or file output. Re-runnable;
yields to any report already in flight.
- **Shared in-flight guard** — the signal-path and on-demand
`CreateReport` paths are made mutually exclusive over the shared
signal-safe writers, module table, and process-global thread-suspension
machinery via a single `m_reportInFlight` guard. The on-demand path
releases the guard on completion; the signal path never does (the
process is terminating).
- **Init / services split** — reporter bring-up is split into
`CrashReportInitialize` (VM callbacks only, so on-demand reports are
possible) and `InProcCrashReportInitializeServices` (env-gated watchdog
+ lifecycle + PAL dispatcher registration). This lets the reporter be
initialized from either the runtime startup path or a future
fatal-error-handler setup path, without arming the signal-path
crash-dump behavior.
- **Output sink refactor** — `SignalSafeConsoleWriter` and
`SignalSafeJsonWriter` gain a small copyable sink abstraction so a
single caller-supplied callback shape can drive either writer (platform
console / drop-all / caller callback).
- **Stack-overflow classification fix** — the in-proc SO stack trace is
now captured only on the real stack-overflow path. Previously a
`FailFast` (which funnels through the same fatal-error callstack logger)
populated the SO-trace latch, causing an on-demand report to misclassify
a `FailFast` as a `StackOverflow`. Gating capture to the real-SO path
makes the latch authoritative for classification.
## Behavior notes
- No behavior changes when crash reporting is disabled: startup
allocates nothing.
- No behavior changes when crash reporting is enabled: allocates and
configure signal-based in-proc crash reporter.
## Testing
- In-proc crash reporter lacks automatic tests, on-demand can be tested
through dotnet#129543 tests when integrated.
- Manually ran FailFast and StackOverflow paths on Android arm64
emulator.
- All tests in
https://github.com/mdh1418/runtime/blob/inproc_crashreport_tests/src/tests/FunctionalTests/Android/Device_Emulator/InProcCrashReport/OVERVIEW.md
pass on Android arm64 emulator.
## Follow-ups
- Wiring the on-demand entry point into the fatal-error handler once
dotnet#129543 lands.
@dotnet-milestone-botdotnet-milestone-botBot added this to the 11.0-rc1 milestone Jul 26, 2026
@github-actionsgithub-actionsBot locked and limited conversation to collaborators Aug 26, 2026
Sign up for freeto subscribe to this conversation on GitHub. Already have an account? Sign in.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@lateralusX@mdh1418
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Add on-demand in-proc crash report generation. - #131220

Merged
lateralusX merged 8 commits into
dotnet:mainfrom
lateralusX:lateralusX/on-demand-in-proc-crash-report
Jul 24, 2026
Merged

Add on-demand in-proc crash report generation.#131220
lateralusX merged 8 commits into
dotnet:mainfrom
lateralusX:lateralusX/on-demand-in-proc-crash-report

Conversation

@lateralusX

@lateralusXlateralusX commented Jul 22, 2026

Copy link
Copy Markdown
Member

Summary

Adds an on-demand entry point to the in-proc crash reporter so a report can be generated programmatically while the runtime is still running, independent of the fatal-signal path. This is the reporting mechanism that a user-registered native
fatal-error handler (proposed in #129543) can call to produce a crash report.

Motivation

The in-proc crash reporter can currently only run from the PAL fatal-signal dispatcher. The fatal-error-handler proposal (#129543) needs a way to invoke just the reporting mechanism on demand, formatting the report to a caller-supplied sink,
without the watchdog/lifecycle/file-management that the signal path performs.

What's in this PR

  • On-demand report APIInProcCrashReportCreateReport(outputFormat, signal, context, outputCallback, callbackContext). Emits the same report as the signal path but streams the selected format (Json or Log) to a caller-supplied callback, with no watchdog or file output. Re-runnable; yields to any report already in flight.
  • Shared in-flight guard — the signal-path and on-demand CreateReport paths are made mutually exclusive over the shared signal-safe writers, module table, and process-global thread-suspension machinery via a single m_reportInFlight guard. The on-demand path releases the guard on completion; the signal path never does (the process is terminating).
  • Init / services split — reporter bring-up is split into CrashReportInitialize (VM callbacks only, so on-demand reports are possible) and InProcCrashReportInitializeServices (env-gated watchdog + lifecycle + PAL dispatcher registration). This lets the reporter be initialized from either the runtime startup path or a future fatal-error-handler setup path, without arming the signal-path crash-dump behavior.
  • Output sink refactorSignalSafeConsoleWriter and SignalSafeJsonWriter gain a small copyable sink abstraction so a single caller-supplied callback shape can drive either writer (platform console / drop-all / caller callback).
  • Stack-overflow classification fix — the in-proc SO stack trace is now captured only on the real stack-overflow path. Previously a FailFast (which funnels through the same fatal-error callstack logger) populated the SO-trace latch, causing an on-demand report to misclassify a FailFast as a StackOverflow. Gating capture to the real-SO path makes the latch authoritative for classification.

Behavior notes

  • No behavior changes when crash reporting is disabled: startup allocates nothing.
  • No behavior changes when crash reporting is enabled: allocates and configure signal-based in-proc crash reporter.

Testing

Follow-ups

@azure-pipelines

Copy link
Copy Markdown
Azure Pipelines:
Successfully started running 3 pipeline(s).
13 pipeline(s) were filtered out due to trigger conditions.
There may be pipelines that require an authorized user to comment /azp run to run.

@dotnet-policy-service

Copy link
Copy Markdown
Contributor

Tagging subscribers to this area: @steveisok, @tommcdon, @dotnet/dotnet-diag
See info in area-owners.md if you want to be subscribed.

CopilotAI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

This PR extends CoreCLR’s in-proc crash reporter to support on-demand report generation (JSON or compact log) via a caller-supplied callback, and refactors initialization so the reporter can be brought up without arming the fatal-signal crash-dump services.

Changes:

  • Adds an on-demand reporting entry point (InProcCrashReportCreateReport) and splits reporter init into “VM callbacks” vs “services + PAL registration”.
  • Refactors the signal-safe JSON/console writers to use small copyable “output sink” abstractions (platform sink / drop-all / caller callback).
  • Fixes stack-overflow classification by only capturing the “SO trace latch” on the real SO path (not on other fatal paths like FailFast).

Reviewed changes

Copilot reviewed 9 out of 9 changed files in this pull request and generated 2 comments.

Show a summary per file
FileDescription
src/coreclr/vm/eepolicy.cppGates stack-overflow trace capture behind an explicit “capture SO trace” flag to avoid misclassification.
src/coreclr/vm/crashreportstackwalker.hAdds CrashReportInitialize() declaration to support init without services.
src/coreclr/vm/crashreportstackwalker.cppImplements CrashReportInitialize() and updates CrashReportConfigure() to start services separately.
src/coreclr/debug/crashreport/signalsafejsonwriter.hIntroduces SignalSafeJsonOutputSink and replaces Init with SetOutputSink.
src/coreclr/debug/crashreport/signalsafejsonwriter.cppImplements sink plumbing + drop-all sink for JSON writer.
src/coreclr/debug/crashreport/signalsafeconsolewriter.hIntroduces SignalSafeConsoleOutputSink and sink selection APIs for console writer.
src/coreclr/debug/crashreport/signalsafeconsolewriter.cppImplements platform/drop-all sinks and sink-driven newline/flush behavior.
src/coreclr/debug/crashreport/inproccrashreporter.hAdds on-demand API, output callback type/format enum, and splits settings into VM vs services.
src/coreclr/debug/crashreport/inproccrashreporter.cppImplements on-demand report generation and shared in-flight guard, plus services init split.

Comment threadsrc/coreclr/debug/crashreport/signalsafeconsolewriter.cpp
Comment threadsrc/coreclr/debug/crashreport/inproccrashreporter.cpp
CopilotAI review requested due to automatic review settings July 23, 2026 08:21

CopilotAI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 9 out of 9 changed files in this pull request and generated 1 comment.

Comment threadsrc/coreclr/debug/crashreport/inproccrashreporter.cpp
@lateralusX
lateralusX marked this pull request as ready for review July 23, 2026 14:00
@lateralusXlateralusX changed the title WIP: Add on-demand in-proc crash report generation.Add on-demand in-proc crash report generation.Jul 23, 2026
@azure-pipelines

Copy link
Copy Markdown
Azure Pipelines:
Successfully started running 3 pipeline(s).
13 pipeline(s) were filtered out due to trigger conditions.
There may be pipelines that require an authorized user to comment /azp run to run.

@mdh1418mdh1418 left a comment

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.

Overall looks good to me, just one concern.

Comment threadsrc/coreclr/debug/crashreport/inproccrashreporter.cpp
@lateralusX
lateralusX merged commit 18c67a7 into dotnet:mainJul 24, 2026
109 of 112 checks passed
hez2010 pushed a commit to hez2010/runtime that referenced this pull request Jul 26, 2026
## Summary
Adds an on-demand entry point to the in-proc crash reporter so a report
can be generated programmatically while the runtime is still running,
independent of the fatal-signal path. This is the reporting mechanism
that a user-registered native
fatal-error handler (proposed in dotnet#129543) can call to produce a crash
report.
## Motivation
The in-proc crash reporter can currently only run from the PAL
fatal-signal dispatcher. The fatal-error-handler proposal (dotnet#129543)
needs a way to invoke just the reporting mechanism on demand, formatting
the report to a caller-supplied sink,
without the watchdog/lifecycle/file-management that the signal path
performs.
## What's in this PR
- **On-demand report API** —
`InProcCrashReportCreateReport(outputFormat, signal, context,
outputCallback, callbackContext)`. Emits the same report as the signal
path but streams the selected format (`Json` or `Log`) to a
caller-supplied callback, with no watchdog or file output. Re-runnable;
yields to any report already in flight.
- **Shared in-flight guard** — the signal-path and on-demand
`CreateReport` paths are made mutually exclusive over the shared
signal-safe writers, module table, and process-global thread-suspension
machinery via a single `m_reportInFlight` guard. The on-demand path
releases the guard on completion; the signal path never does (the
process is terminating).
- **Init / services split** — reporter bring-up is split into
`CrashReportInitialize` (VM callbacks only, so on-demand reports are
possible) and `InProcCrashReportInitializeServices` (env-gated watchdog
+ lifecycle + PAL dispatcher registration). This lets the reporter be
initialized from either the runtime startup path or a future
fatal-error-handler setup path, without arming the signal-path
crash-dump behavior.
- **Output sink refactor** — `SignalSafeConsoleWriter` and
`SignalSafeJsonWriter` gain a small copyable sink abstraction so a
single caller-supplied callback shape can drive either writer (platform
console / drop-all / caller callback).
- **Stack-overflow classification fix** — the in-proc SO stack trace is
now captured only on the real stack-overflow path. Previously a
`FailFast` (which funnels through the same fatal-error callstack logger)
populated the SO-trace latch, causing an on-demand report to misclassify
a `FailFast` as a `StackOverflow`. Gating capture to the real-SO path
makes the latch authoritative for classification.
## Behavior notes
- No behavior changes when crash reporting is disabled: startup
allocates nothing.
- No behavior changes when crash reporting is enabled: allocates and
configure signal-based in-proc crash reporter.
## Testing
- In-proc crash reporter lacks automatic tests, on-demand can be tested
through dotnet#129543 tests when integrated.
- Manually ran FailFast and StackOverflow paths on Android arm64
emulator.
- All tests in
https://github.com/mdh1418/runtime/blob/inproc_crashreport_tests/src/tests/FunctionalTests/Android/Device_Emulator/InProcCrashReport/OVERVIEW.md
pass on Android arm64 emulator.
## Follow-ups
- Wiring the on-demand entry point into the fatal-error handler once
dotnet#129543 lands.
@dotnet-milestone-botdotnet-milestone-botBot added this to the 11.0-rc1 milestone Jul 26, 2026
@github-actionsgithub-actionsBot locked and limited conversation to collaborators Aug 26, 2026
Sign up for freeto subscribe to this conversation on GitHub. Already have an account? Sign in.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@lateralusX@mdh1418
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content

Add on-demand in-proc crash report generation. - #131220

Merged
lateralusX merged 8 commits into
dotnet:mainfrom
lateralusX:lateralusX/on-demand-in-proc-crash-report
Jul 24, 2026
Merged

Add on-demand in-proc crash report generation.#131220
lateralusX merged 8 commits into
dotnet:mainfrom
lateralusX:lateralusX/on-demand-in-proc-crash-report

Conversation

@lateralusX

@lateralusXlateralusX commented Jul 22, 2026

Copy link
Copy Markdown
Member

Summary

Adds an on-demand entry point to the in-proc crash reporter so a report can be generated programmatically while the runtime is still running, independent of the fatal-signal path. This is the reporting mechanism that a user-registered native
fatal-error handler (proposed in #129543) can call to produce a crash report.

Motivation

The in-proc crash reporter can currently only run from the PAL fatal-signal dispatcher. The fatal-error-handler proposal (#129543) needs a way to invoke just the reporting mechanism on demand, formatting the report to a caller-supplied sink,
without the watchdog/lifecycle/file-management that the signal path performs.

What's in this PR

  • On-demand report APIInProcCrashReportCreateReport(outputFormat, signal, context, outputCallback, callbackContext). Emits the same report as the signal path but streams the selected format (Json or Log) to a caller-supplied callback, with no watchdog or file output. Re-runnable; yields to any report already in flight.
  • Shared in-flight guard — the signal-path and on-demand CreateReport paths are made mutually exclusive over the shared signal-safe writers, module table, and process-global thread-suspension machinery via a single m_reportInFlight guard. The on-demand path releases the guard on completion; the signal path never does (the process is terminating).
  • Init / services split — reporter bring-up is split into CrashReportInitialize (VM callbacks only, so on-demand reports are possible) and InProcCrashReportInitializeServices (env-gated watchdog + lifecycle + PAL dispatcher registration). This lets the reporter be initialized from either the runtime startup path or a future fatal-error-handler setup path, without arming the signal-path crash-dump behavior.
  • Output sink refactorSignalSafeConsoleWriter and SignalSafeJsonWriter gain a small copyable sink abstraction so a single caller-supplied callback shape can drive either writer (platform console / drop-all / caller callback).
  • Stack-overflow classification fix — the in-proc SO stack trace is now captured only on the real stack-overflow path. Previously a FailFast (which funnels through the same fatal-error callstack logger) populated the SO-trace latch, causing an on-demand report to misclassify a FailFast as a StackOverflow. Gating capture to the real-SO path makes the latch authoritative for classification.

Behavior notes

  • No behavior changes when crash reporting is disabled: startup allocates nothing.
  • No behavior changes when crash reporting is enabled: allocates and configure signal-based in-proc crash reporter.

Testing

Follow-ups

@azure-pipelines

Copy link
Copy Markdown
Azure Pipelines:
Successfully started running 3 pipeline(s).
13 pipeline(s) were filtered out due to trigger conditions.
There may be pipelines that require an authorized user to comment /azp run to run.

@dotnet-policy-service

Copy link
Copy Markdown
Contributor

Tagging subscribers to this area: @steveisok, @tommcdon, @dotnet/dotnet-diag
See info in area-owners.md if you want to be subscribed.

CopilotAI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

This PR extends CoreCLR’s in-proc crash reporter to support on-demand report generation (JSON or compact log) via a caller-supplied callback, and refactors initialization so the reporter can be brought up without arming the fatal-signal crash-dump services.

Changes:

  • Adds an on-demand reporting entry point (InProcCrashReportCreateReport) and splits reporter init into “VM callbacks” vs “services + PAL registration”.
  • Refactors the signal-safe JSON/console writers to use small copyable “output sink” abstractions (platform sink / drop-all / caller callback).
  • Fixes stack-overflow classification by only capturing the “SO trace latch” on the real SO path (not on other fatal paths like FailFast).

Reviewed changes

Copilot reviewed 9 out of 9 changed files in this pull request and generated 2 comments.

Show a summary per file
FileDescription
src/coreclr/vm/eepolicy.cppGates stack-overflow trace capture behind an explicit “capture SO trace” flag to avoid misclassification.
src/coreclr/vm/crashreportstackwalker.hAdds CrashReportInitialize() declaration to support init without services.
src/coreclr/vm/crashreportstackwalker.cppImplements CrashReportInitialize() and updates CrashReportConfigure() to start services separately.
src/coreclr/debug/crashreport/signalsafejsonwriter.hIntroduces SignalSafeJsonOutputSink and replaces Init with SetOutputSink.
src/coreclr/debug/crashreport/signalsafejsonwriter.cppImplements sink plumbing + drop-all sink for JSON writer.
src/coreclr/debug/crashreport/signalsafeconsolewriter.hIntroduces SignalSafeConsoleOutputSink and sink selection APIs for console writer.
src/coreclr/debug/crashreport/signalsafeconsolewriter.cppImplements platform/drop-all sinks and sink-driven newline/flush behavior.
src/coreclr/debug/crashreport/inproccrashreporter.hAdds on-demand API, output callback type/format enum, and splits settings into VM vs services.
src/coreclr/debug/crashreport/inproccrashreporter.cppImplements on-demand report generation and shared in-flight guard, plus services init split.

Comment threadsrc/coreclr/debug/crashreport/signalsafeconsolewriter.cpp
Comment threadsrc/coreclr/debug/crashreport/inproccrashreporter.cpp
CopilotAI review requested due to automatic review settings July 23, 2026 08:21

CopilotAI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 9 out of 9 changed files in this pull request and generated 1 comment.

Comment threadsrc/coreclr/debug/crashreport/inproccrashreporter.cpp
@lateralusX
lateralusX marked this pull request as ready for review July 23, 2026 14:00
@lateralusXlateralusX changed the title WIP: Add on-demand in-proc crash report generation.Add on-demand in-proc crash report generation.Jul 23, 2026
@azure-pipelines

Copy link
Copy Markdown
Azure Pipelines:
Successfully started running 3 pipeline(s).
13 pipeline(s) were filtered out due to trigger conditions.
There may be pipelines that require an authorized user to comment /azp run to run.

@mdh1418mdh1418 left a comment

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.

Overall looks good to me, just one concern.

Comment threadsrc/coreclr/debug/crashreport/inproccrashreporter.cpp
@lateralusX
lateralusX merged commit 18c67a7 into dotnet:mainJul 24, 2026
109 of 112 checks passed
hez2010 pushed a commit to hez2010/runtime that referenced this pull request Jul 26, 2026
## Summary
Adds an on-demand entry point to the in-proc crash reporter so a report
can be generated programmatically while the runtime is still running,
independent of the fatal-signal path. This is the reporting mechanism
that a user-registered native
fatal-error handler (proposed in dotnet#129543) can call to produce a crash
report.
## Motivation
The in-proc crash reporter can currently only run from the PAL
fatal-signal dispatcher. The fatal-error-handler proposal (dotnet#129543)
needs a way to invoke just the reporting mechanism on demand, formatting
the report to a caller-supplied sink,
without the watchdog/lifecycle/file-management that the signal path
performs.
## What's in this PR
- **On-demand report API** —
`InProcCrashReportCreateReport(outputFormat, signal, context,
outputCallback, callbackContext)`. Emits the same report as the signal
path but streams the selected format (`Json` or `Log`) to a
caller-supplied callback, with no watchdog or file output. Re-runnable;
yields to any report already in flight.
- **Shared in-flight guard** — the signal-path and on-demand
`CreateReport` paths are made mutually exclusive over the shared
signal-safe writers, module table, and process-global thread-suspension
machinery via a single `m_reportInFlight` guard. The on-demand path
releases the guard on completion; the signal path never does (the
process is terminating).
- **Init / services split** — reporter bring-up is split into
`CrashReportInitialize` (VM callbacks only, so on-demand reports are
possible) and `InProcCrashReportInitializeServices` (env-gated watchdog
+ lifecycle + PAL dispatcher registration). This lets the reporter be
initialized from either the runtime startup path or a future
fatal-error-handler setup path, without arming the signal-path
crash-dump behavior.
- **Output sink refactor** — `SignalSafeConsoleWriter` and
`SignalSafeJsonWriter` gain a small copyable sink abstraction so a
single caller-supplied callback shape can drive either writer (platform
console / drop-all / caller callback).
- **Stack-overflow classification fix** — the in-proc SO stack trace is
now captured only on the real stack-overflow path. Previously a
`FailFast` (which funnels through the same fatal-error callstack logger)
populated the SO-trace latch, causing an on-demand report to misclassify
a `FailFast` as a `StackOverflow`. Gating capture to the real-SO path
makes the latch authoritative for classification.
## Behavior notes
- No behavior changes when crash reporting is disabled: startup
allocates nothing.
- No behavior changes when crash reporting is enabled: allocates and
configure signal-based in-proc crash reporter.
## Testing
- In-proc crash reporter lacks automatic tests, on-demand can be tested
through dotnet#129543 tests when integrated.
- Manually ran FailFast and StackOverflow paths on Android arm64
emulator.
- All tests in
https://github.com/mdh1418/runtime/blob/inproc_crashreport_tests/src/tests/FunctionalTests/Android/Device_Emulator/InProcCrashReport/OVERVIEW.md
pass on Android arm64 emulator.
## Follow-ups
- Wiring the on-demand entry point into the fatal-error handler once
dotnet#129543 lands.
@dotnet-milestone-botdotnet-milestone-botBot added this to the 11.0-rc1 milestone Jul 26, 2026
@github-actionsgithub-actionsBot locked and limited conversation to collaborators Aug 26, 2026
Sign up for freeto subscribe to this conversation on GitHub. Already have an account? Sign in.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@lateralusX@mdh1418