Skip to content

Commit

Permalink
Fixed memory leak on Apple platforms (#17)
Browse files Browse the repository at this point in the history
  • Loading branch information
aw-cf authored Feb 15, 2024
1 parent 857354c commit 3cfc527
Showing 1 changed file with 37 additions and 25 deletions.
62 changes: 37 additions & 25 deletions src/apple.rs
Original file line number Diff line number Diff line change
Expand Up @@ -2,42 +2,54 @@ extern crate libc;

use std::num::NonZeroUsize;

use self::libc::{kern_return_t, mach_msg_type_number_t, mach_port_t, thread_t};

// This constant is from
// /Applications/Xcode.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk/
// usr/include/mach/machine/thread_state.h.
//
// It has not been updated since Apple devices started to support 64-bit ARM (iOS), so it
// should be very stable.
const THREAD_STATE_MAX: i32 = 1296;
#[allow(non_camel_case_types)]
// https://github.com/apple/darwin-xnu/blob/a1babec6b135d1f35b2590a1990af3c5c5393479/osfmk/mach/mach_types.defs#L155
type task_inspect_t = mach_port_t;
use self::libc::{
kern_return_t, mach_port_t, natural_t, task_threads, thread_act_array_t, vm_size_t,
};

#[allow(non_camel_case_types)]
// https://github.com/apple/darwin-xnu/blob/a1babec6b135d1f35b2590a1990af3c5c5393479/osfmk/mach/mach_types.defs#L238
type thread_array_t = [thread_t; THREAD_STATE_MAX as usize];
// https://developer.apple.com/documentation/kernel/mach_port_name_t
type mach_port_name_t = natural_t;

extern "C" {
// https://developer.apple.com/documentation/kernel/1537751-task_threads/
fn task_threads(
target_task: task_inspect_t,
act_list: *mut thread_array_t,
act_listCnt: *mut mach_msg_type_number_t,
// https://developer.apple.com/documentation/kernel/1402285-mach_vm_deallocate
fn mach_vm_deallocate(
target_task: mach_port_t,
address: *mut u32,
size: vm_size_t,
) -> kern_return_t;

// https://developer.apple.com/documentation/kernel/1578777-mach_port_deallocate
fn mach_port_deallocate(task: mach_port_t, name: mach_port_name_t) -> kern_return_t;
}

pub(crate) fn num_threads() -> Option<NonZeroUsize> {
// http://web.mit.edu/darwin/src/modules/xnu/osfmk/man/task_threads.html
let mut thread_state = [0u32; THREAD_STATE_MAX as usize];
// https://developer.apple.com/documentation/kernel/1537751-task_threads
let mut thread_list: thread_act_array_t = std::ptr::null_mut();
let mut thread_count = 0;

// Safety: `mach_task_self` always returns a valid value, `thread_state` is large enough, and
// both it and `thread_count` are writable.
let result =
unsafe { task_threads(libc::mach_task_self(), &mut thread_state, &mut thread_count) };
// Safety:
// - `mach_task_self` always returns a valid value,
// - `thread_list` is a pointer that will point to kernel allocated memory that needs to be
// deallocated if the call succeeds
let task = unsafe { libc::mach_task_self() };
let result = unsafe { task_threads(task, &mut thread_list, &mut thread_count) };

if result == libc::KERN_SUCCESS {
// Deallocate the mach port rights for the threads
for thread in 0..thread_count {
unsafe {
mach_port_deallocate(task, *(thread_list.offset(thread as isize)) as u32);
}
}
// Deallocate the thread list
unsafe {
mach_vm_deallocate(
task,
thread_list,
std::mem::size_of::<mach_port_t>() * thread_count as usize,
);
}

NonZeroUsize::new(thread_count as usize)
} else {
None
Expand Down

0 comments on commit 3cfc527

Please sign in to comment.