8000 Remove direct dependency on windows-sys by Jake-Shadle · Pull Request #173 · rust-minidump/minidump-writer · GitHub
[go: up one dir, main page]
Skip to content

Repository navigation

Remove direct dependency on windows-sys #173

New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Merged
Jake-Shadle merged 1 commit into from
May 6, 2026
Merged

Remove direct dependency on windows-sys #173

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion Cargo.lock
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 0 additions & 5 deletions Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,11 +48,6 @@ procfs-core = { version = "0.18", default-features = false, features = ["serde1"

[target.'cfg(target_os = "windows")'.dependencies]
bitflags = "2.4"
windows-sys = { version = ">=0.52", features = [
"Win32_Foundation",
"Win32_System_Diagnostics_Debug",
"Win32_System_ProcessStatus",
] }

[target.'cfg(target_os = "macos")'.dependencies]
# Binds some additional mac specifics not in libc, note that other dependents
Expand Down
84 changes: 61 additions & 23 deletions src/windows/ffi.rs
View file
Open in desktop
< 8000 /tr>
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,13 @@

pub use crash_context::{CONTEXT, EXCEPTION_POINTERS, EXCEPTION_RECORD, capture_context};

use core::ffi::c_void;

pub type HANDLE = isize;
pub type HMODULE = isize;
pub type BOOL = i32;
pub const FALSE: BOOL = 0;
pub const MAX_PATH: u32 = 260;

pub type Hresult = i32;
pub const STATUS_NONCONTINUABLE_EXCEPTION: i32 = -1073741787;
Expand Down Expand Up @@ -144,7 +148,7 @@ pub type VS_FIXEDFILEINFO_FILE_FLAGS = u32;
pub struct MINIDUMP_USER_STREAM {
pub Type: u32,
pub BufferSize: u32,
pub Buffer: *mut std::ffi::c_void,
pub Buffer: *mut c_void,
}
#[repr(C, packed(4))]
pub struct MINIDUMP_USER_STREAM_INFORMATION {
Expand Down Expand Up @@ -187,9 +191,9 @@ pub struct MINIDUMP_MODULE_CALLBACK {
pub CheckSum: u32,
pub TimeDateStamp: u32,
pub VersionInfo: VS_FIXEDFILEINFO,
pub CvRecord: *mut std::ffi::c_void,
pub CvRecord: *mut c_void,
pub SizeOfCvRecord: u32,
pub MiscRecord: *mut std::ffi::c_void,
pub MiscRecord: *mut c_void,
pub SizeOfMiscRecord: u32,
}

Expand All @@ -207,7 +211,7 @@ pub struct MINIDUMP_INCLUDE_MODULE_CALLBACK {
pub struct MINIDUMP_IO_CALLBACK {
pub Handle: HANDLE,
pub Offset: u64,
pub Buffer: *mut std::ffi::c_void,
pub Buffer: *mut c_void,
pub BufferBytes: u32,
}

Expand All @@ -226,14 +230,14 @@ pub struct MINIDUMP_VM_QUERY_CALLBACK {
#[repr(C, packed(4))]
pub struct MINIDUMP_VM_PRE_READ_CALLBACK {
pub Offset: u64,
pub Buffer: *mut std::ffi::c_void,
pub Buffer: *mut c_void,
pub Size: u32,
}

#[repr(C, packed(4))]
pub struct MINIDUMP_VM_POST_READ_CALLBACK {
pub Offset: u64,
pub Buffer: *mut std::ffi::c_void,
pub Buffer: *mut c_void,
pub Size: u32,
pub Completed: u32,
pub Status: Hresult,
Expand Down Expand Up @@ -296,20 +300,22 @@ cfg_if::cfg_if! {
}
}

use std::mem::ManuallyDrop;

#[repr(C)]
pub union MINIDUMP_CALLBACK_INPUT_0 {
pub Status: Hresult,
pub Thread: std::mem::ManuallyDrop<MINIDUMP_THREAD_CALLBACK>,
pub ThreadEx: std::mem::ManuallyDrop<MINIDUMP_THREAD_EX_CALLBACK>,
pub Module: std::mem::ManuallyDrop<MINIDUMP_MODULE_CALLBACK>,
pub IncludeThread: std::mem::ManuallyDrop<MINIDUMP_INCLUDE_THREAD_CALLBACK>,
pub IncludeModule: std::mem::ManuallyDrop<MINIDUMP_INCLUDE_MODULE_CALLBACK>,
pub Io: std::mem::ManuallyDrop<MINIDUMP_IO_CALLBACK>,
pub ReadMemoryFailure: std::mem::ManuallyDrop<MINIDUMP_READ_MEMORY_FAILURE_CALLBACK>,
pub Thread: ManuallyDrop<MINIDUMP_THREAD_CALLBACK>,
pub ThreadEx: ManuallyDrop<MINIDUMP_THREAD_EX_CALLBACK>,
pub Module: ManuallyDrop<MINIDUMP_MODULE_CALLBACK>,
pub IncludeThread: ManuallyDrop<MINIDUMP_INCLUDE_THREAD_CALLBACK>,
pub IncludeModule: ManuallyDrop<MINIDUMP_INCLUDE_MODULE_CALLBACK>,
pub Io: ManuallyDrop<MINIDUMP_IO_CALLBACK>,
pub ReadMemoryFailure: ManuallyDrop<MINIDUMP_READ_MEMORY_FAILURE_CALLBACK>,
pub SecondaryFlags: u32,
pub VmQuery: std::mem::ManuallyDrop<MINIDUMP_VM_QUERY_CALLBACK>,
pub VmPreRead: std::mem::ManuallyDrop<MINIDUMP_VM_PRE_READ_CALLBACK>,
pub VmPostRead: std::mem::ManuallyDrop<MINIDUMP_VM_POST_READ_CALLBACK>,
pub VmQuery: ManuallyDrop<MINIDUMP_VM_QUERY_CALLBACK>,
pub VmPreRead: ManuallyDrop<MINIDUMP_VM_PRE_READ_CALLBACK>,
pub VmPostRead: ManuallyDrop<MINIDUMP_VM_POST_READ_CALLBACK>,
}

#[repr(C, packed(4))]
Expand Down Expand Up @@ -387,12 +393,12 @@ pub union MINIDUMP_CALLBACK_OUTPUT_0 {
pub ModuleWriteFlags: ModuleWriteFlags,
pub ThreadWriteFlags: u32,
pub SecondaryFlags: u32,
pub Anonymous1: std::mem::ManuallyDrop<MINIDUMP_CALLBACK_OUTPUT_0_0>,
pub Anonymous2: std::mem::ManuallyDrop<MINIDUMP_CALLBACK_OUTPUT_0_1>,
pub Anonymous1: ManuallyDrop<MINIDUMP_CALLBACK_OUTPUT_0_0>,
pub Anonymous2: ManuallyDrop<MINIDUMP_CALLBACK_OUTPUT_0_1>,
pub Handle: HANDLE,
pub Anonymous3: std::mem::ManuallyDrop<MINIDUMP_CALLBACK_OUTPUT_0_2>,
pub Anonymous4: std::mem::ManuallyDrop<MINIDUMP_CALLBACK_OUTPUT_0_3>,
pub Anonymous5: std::mem::ManuallyDrop<MINIDUMP_CALLBACK_OUTPUT_0_4>,
pub Anonymous3: ManuallyDrop<MINIDUMP_CALLBACK_OUTPUT_0_2>,
pub Anonymous4: ManuallyDrop<MINIDUMP_CALLBACK_OUTPUT_0_3>,
pub Anonymous5: ManuallyDrop<MINIDUMP_CALLBACK_OUTPUT_0_4>,
pub Status: Hresult,
}

Expand All @@ -403,7 +409,7 @@ pub struct MINIDUMP_CALLBACK_OUTPUT {

pub type MINIDUMP_CALLBACK_ROUTINE = Option<
unsafe extern "system" fn(
CallbackParam: *mut std::ffi::c_void,
CallbackParam: *mut c_void,
CallbackInput: *const MINIDUMP_CALLBACK_INPUT,
CallbackOutput: *mut MINIDUMP_CALLBACK_OUTPUT,
) -> BOOL,
Expand All @@ -412,7 +418,14 @@ pub type MINIDUMP_CALLBACK_ROUTINE = Option<
#[repr(C, packed(4))]
pub struct MINIDUMP_CALLBACK_INFORMATION {
pub CallbackRoutine: MINIDUMP_CALLBACK_ROUTINE,
pub CallbackParam: *mut std::ffi::c_void,
pub CallbackParam: *mut c_void,
}

#[repr(C)]
pub struct MODULEINFO {
pub base_of_dll: *mut c_void,
pub size_of_image: u32,
pub entry_point: *mut c_void,
}

#[link(name = "kernel32")]
Expand All @@ -432,7 +445,32 @@ unsafe extern "system" {
) -> HANDLE;
pub fn ResumeThread(thread: HANDLE) -> u32;
pub fn SuspendThread(thread: HANDLE) -> u32;
pub fn ReadProcessMemory(
process: HANDLE,
base_addr: *const c_void,
buffer: *mut c_void,
size: usize,
bytes_read: *mut usize,
) -> BOOL;
pub fn GetThreadContext(thread: HANDLE, context: *mut CONTEXT) -> BOOL;
pub fn K32EnumProcessModules(
process: HANDLE,
module: *mut HMODULE,
size: u32,
needed: *mut u32,
) -> BOOL;
pub fn K32GetModuleBaseNameW(
process: HANDLE,
module: HMODULE,
base_name: *mut u16,
size: u32,
) -> u32;
pub fn K32GetModuleInformation(
process: HANDLE,
module: HMODULE,
mod_info: *mut MODULEINFO,
cb: u32,
) -> BOOL;
}

#[link(name = "dbghelp")]
Expand Down
37 changes: 16 additions & 21 deletions src/windows/process_reader.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,23 +1,15 @@
use {
crate::{module_reader::ModuleMemory, serializers::*},
super::ffi::{self, HMODULE},
crate::{module_reader::ModuleMemory, serializers::serialize_io_error},
std::{
convert::TryInto,
ffi::OsString,
mem::{MaybeUninit, size_of},
os::windows::ffi::OsStringExt,
},
windows_sys::Win32::{
Foundation::{FALSE, HMODULE, MAX_PATH},
System::{
Diagnostics::Debug::ReadProcessMemory,
ProcessStatus::{
K32En 8BD0 umProcessModules, K32GetModuleBaseNameW, K32GetModuleInformation, MODULEINFO,
},
},
},
};

pub type ProcessHandle = windows_sys::Win32::Foundation::HANDLE;
pub type ProcessHandle = ffi::HANDLE;

pub struct ProcessReader {
process: ProcessHandle,
Expand Down Expand Up @@ -51,7 +43,7 @@ impl ProcessReader {
pub fn read(&self, src: usize, dst: &mut [u8]) -> Result<usize, CopyFromProcessError> {
let mut size: usize = 0;
let res = unsafe {
ReadProcessMemory(
ffi::ReadProcessMemory(
self.process,
src as _,
dst.as_mut_ptr() as _,
Expand All @@ -60,7 +52,7 @@ impl ProcessReader {
)
};

if res != FALSE {
if res != ffi::FALSE {
Ok(size)
} else {
Err(CopyFromProcessError {
Expand All @@ -81,7 +73,7 @@ impl ProcessReader {
// sufficient for our use-cases.
if name.is_some_and(|name| name.eq_ignore_ascii_case(module_name)) {
self.get_module_info(module)
.map(|module| module.lpBaseOfDll as usize)
.map(|module| module.base_of_dll as usize)
} else {
None
}
Expand All @@ -102,7 +94,7 @@ impl ProcessReader {
.try_into()
.map_err(|_| FindModuleError::ModuleListTooLarge)?;
let res = unsafe {
K32EnumProcessModules(
ffi::K32EnumProcessModules(
self.process,
module_array.as_mut_ptr() as *mut _,
buffer_size,
Expand Down Expand Up @@ -130,9 +122,12 @@ impl ProcessReader {
}

fn get_module_name(&self, module: HMODULE) -> Option<String> {
use ffi::MAX_PATH;

let mut path: [u16; MAX_PATH as usize] = [0; MAX_PATH as usize];
let res =
unsafe { K32GetModuleBaseNameW(self.process, module, path.as_mut_ptr(), MAX_PATH) };
let res = unsafe {
ffi::K32GetModuleBaseNameW(self.process, module, path.as_mut_ptr(), MAX_PATH)
};

if res == 0 {
None
Expand All @@ -143,14 +138,14 @@ impl ProcessReader {
}
}

fn get_module_info(&self, module: HMODULE) -> Option<MODULEINFO> {
let mut info: MaybeUninit<MODULEINFO> = MaybeUninit::uninit();
fn get_module_info(&self, module: HMODULE) -> Option<ffi::MODULEINFO> {
let mut info: MaybeUninit<ffi::MODULEINFO> = MaybeUninit::uninit();
let res = unsafe {
K32GetModuleInformation(
ffi::K32GetModuleInformation(
self.process,
module,
info.as_mut_ptr(),
size_of::<MODULEINFO>() as u32,
size_of::<ffi::MODULEINFO>() as u32,
)
};

Expand Down
Loading
0