Files
ghostty-rs/crates/ghostty-crash/Cargo.toml
T
ddidderr b1ad29fa97 feat(crash): Breakpad-style minidumps on macOS and Windows
Ghostty links sentry-native with the breakpad backend on every platform
(SharedDeps.zig), so it writes minidumps on macOS and Windows as well.
- macOS: a Mach exception port handler thread (structured like
  Breakpad's exception_handler) catches EXC_BAD_ACCESS/BAD_INSTRUCTION/
  ARITHMETIC/BREAKPOINT, suspends other threads, reads the crashed
  thread state and writes a minidump via minidump-writer as the
  event.minidump attachment, then restores the previous ports so the
  BSD signal and default termination follow. The signal path remains
  the fallback (and handles SIGABRT); a watchdog alarm bounds dumping.
- Windows: SetUnhandledExceptionFilter hands off to a pre-started dump
  thread using minidump-writer's dump_crash_context.
- The screen-file open action decodes the escaped path to raw OS bytes
  (also for the C action passed to embedders).

macOS/Windows code is compile-checked (clippy -D warnings) only; the
shared Mach message decoding and minidump attachment logic have Linux
unit tests. Platform matrix in docs/rewrite/notes/crash-CR.md.

Test Plan:
- cargo test --workspace (3348 passed)
- just check-macos; just check-macos x86_64-apple-darwin; just check-windows
2026-10-12 08:55:27 +02:00

74 lines
2.0 KiB
TOML

[package]
name = "ghostty-crash"
version.workspace = true
edition.workspace = true
license.workspace = true
description = "Local crash capture (Sentry envelope files), port of ghostty/src/crash"
[features]
# Mirrors upstream's `-Dsentry` build option (default off on Linux): when
# disabled `init()` is a no-op. `install()` always works (used by tests).
sentry = []
[dependencies]
ghostty-os.workspace = true
log = "0.4.34"
serde_json = { version = "1", features = ["preserve_order"] }
thiserror = "2.0.21"
[target.'cfg(unix)'.dependencies]
libc = "0.2"
[target.'cfg(target_vendor = "apple")'.dependencies]
mach2 = "0.6"
[target.'cfg(any(target_os = "linux", target_os = "macos", windows))'.dependencies]
minidump-writer = "0.13.0"
[target.'cfg(windows)'.dependencies]
windows-sys = { version = "0.61", features = [
"Win32_Foundation",
"Win32_Security",
"Win32_System_Diagnostics_Debug",
"Win32_System_Kernel",
"Win32_System_Threading",
] }
[dev-dependencies]
minidump = "0.27.0"
tempfile = "3.27.0"
# The fatal-signal handler needs sigaction/sigaltstack/raw syscalls. Unsafe is
# denied crate-wide and only allowed in `signal.rs` with SAFETY comments.
[lints.rust]
unsafe_code = "deny"
[lints.clippy]
pedantic = { level = "warn", priority = -1 }
todo = "warn"
unwrap_used = "warn"
# Porting a low-level terminal emulator involves a lot of intentional
# numeric casts and long state-machine functions; these pedantic lints are
# noise for this codebase.
cast_possible_truncation = "allow"
cast_possible_wrap = "allow"
cast_sign_loss = "allow"
cast_precision_loss = "allow"
cast_lossless = "allow"
module_name_repetitions = "allow"
too_many_lines = "allow"
missing_errors_doc = "allow"
missing_panics_doc = "allow"
similar_names = "allow"
struct_excessive_bools = "allow"
fn_params_excessive_bools = "allow"
match_same_arms = "allow"
unreadable_literal = "allow"
many_single_char_names = "allow"
doc_markdown = "allow"
must_use_candidate = "allow"
return_self_not_must_use = "allow"
used_underscore_binding = "allow"
large_stack_arrays = "allow"
inline_always = "allow"