Add heap corruption exception handling (#86)

* Add heap corruption exception handling * Fix naming * Fix lints * Update minidump/fix deny * More lint fixes, bump MSRV * And again --------- Co-authored-by: Tomasz Stachowiak <[email protected]>
EmbarkStudios · Jun 8, 2024 · e524a89 · e524a89
1 parent 065f3dd
commit e524a89
Show file tree

Hide file tree

Showing 13 changed files with 75 additions and 175 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/crash-context/Cargo.toml b/crash-context/Cargo.toml
@@ -14,7 +14,7 @@ documentation = "https://docs.rs/crash-context"
 homepage = "https://github.com/EmbarkStudios/crash-handling/tree/main/crash-context"
 categories = ["external-ffi-bindings"]
 keywords = ["crash", "libc", "getcontext"]
-rust-version = "1.59.0" # We use `global_asm!`
+rust-version = "1.62.0" # We use `global_asm!`
 
 [dependencies]
 # Nicer cfg handling

diff --git a/crash-context/src/linux.rs b/crash-context/src/linux.rs
@@ -10,7 +10,7 @@ pub struct CrashContext {
     ///
     /// Note that we use [`crate::ucontext_t`] instead of [`libc::ucontext_t`]
     /// as libc's differs between glibc and musl <https://github.com/rust-lang/libc/pull/1646>
-    /// even though the ucontext_t received from a signal will be the same
+    /// even though the `ucontext_t` received from a signal will be the same
     /// regardless of the libc implementation used as it is only arch specific
     /// and not libc specific
     ///

diff --git a/crash-context/src/mac/resource.rs b/crash-context/src/mac/resource.rs
@@ -17,7 +17,7 @@ pub enum ResourceException {
     Cpu(CpuResourceException),
     /// This is sent by the kernel when the platform idle wakeups monitor is tripped. Possibly fatal.
     Wakeups(WakeupsResourceException),
-    /// This is sent by the kernel when a task crosses its high watermark memory limit. Never fatal at least on current MacOS versions.
+    /// This is sent by the kernel when a task crosses its high watermark memory limit. Never fatal at least on current `MacOS` versions.
     Memory(MemoryResourceException),
     /// This is sent by the kernel when a task crosses its I/O limits. Never fatal.
     Io(IoResourceException),
@@ -27,7 +27,7 @@ pub enum ResourceException {
     /// filled its port space. Always fatal.
     Ports(PortsResourceException),
     /// An unknown resource kind due to an addition to the set of possible
-    /// resource exception kinds in exc_resource.h
+    /// resource exception kinds in `exc_resource.h`
     Unknown { kind: u8, flavor: u8 },
 }
 

diff --git a/crash-context/src/windows.rs b/crash-context/src/windows.rs
@@ -5,7 +5,7 @@ pub struct CrashContext {
     /// Note that this is a pointer into the actual memory of the crashed process,
     /// and is a pointer to an [EXCEPTION_POINTERS](https://learn.microsoft.com/en-us/windows/win32/api/winnt/ns-winnt-exception_pointers)
     pub exception_pointers: *const EXCEPTION_POINTERS,
-    /// The top level exception code from the exception_pointers. This is provided
+    /// The top level exception code from the `exception_pointers`. This is provided
     /// so that external processes don't need to use `ReadProcessMemory` to inspect
     /// the exception code
     pub exception_code: i32,

diff --git a/crash-handler/src/mac/state.rs b/crash-handler/src/mac/state.rs
@@ -9,7 +9,7 @@ enum MessageIds {
     SignalCrash = 0,
     /// Message ID telling the handler thread to quit.
     Shutdown = 2,
-    /// Taken from mach_exc in /usr/include/mach/exc.defs.
+    /// Taken from `mach_exc` in `/usr/include/mach/exc.defs`.
     Exception = 2405,
     ExceptionStateIdentity = 2407,
 }

diff --git a/crash-handler/src/unix/pthread_interpose.rs b/crash-handler/src/unix/pthread_interpose.rs
@@ -81,7 +81,10 @@ pub extern "C" fn pthread_create(
             REAL_PTHREAD_CREATE = Some(std::mem::transmute(ptr));
         }
 
-        libc::pthread_key_create(&mut THREAD_DESTRUCTOR_KEY, Some(uninstall_sig_alt_stack));
+        libc::pthread_key_create(
+            std::ptr::addr_of_mut!(THREAD_DESTRUCTOR_KEY),
+            Some(uninstall_sig_alt_stack),
+        );
     });
 
     let real_pthread_create = unsafe { REAL_PTHREAD_CREATE.as_ref() }.expect("pthread_create() intercept failed but the intercept function is still being called, this won't work");