lysann/mach-detours
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity Actions

fix detour_set_ignore_too_small + more docs

Browse source
This commit is contained in:
Lysann Tranvouez 2025-10-03 22:25:53 +02:00
parent 728e795c2c
commit 7c25e72f15
2 changed files with 42 additions and 20 deletions
Download patch file Download diff file Expand all files Collapse all files

30
include/mach_detours.h
View file

@ -127,7 +127,7 @@ mach_error_t detour_manage_all_threads();
/// * If a previous `detour_attach` or `detour_detach` operation failed, returns the error code from that call.
/// * `KERN_INVALID_ARGUMENT` if any of `detour`, `inout_pointer`, or `*inout_pointer` is nullptr
/// * `detour_err_too_small` if the target function only points to the detour, or if the target function is too
/// short to insert a detour
/// short to insert a detour. See also `detour_set_ignore_too_small`.
/// * `detour_err_too_large` if the instructions copied from the original function are too large to fit into the
/// trampoline. This is likely a bug in mach_detours.
/// * `KERN_RESOURCE_SHORTAGE` if `calloc` failed for the structure keeping track of the operation or the trampoline
@ -164,7 +164,7 @@ mach_error_t detour_attach_ex(detour_func_t* inout_pointer, detour_func_t detour
/// * If a previous `detour_attach` or `detour_detach` operation failed, returns the error code from that call.
/// * `KERN_INVALID_ARGUMENT` if any of `detour`, `inout_pointer`, or `*inout_pointer` is nullptr
/// * `KERN_FAILURE` if `inout_pointer` or `detour` are not a valid combination, or that detour is not yet or no
/// longer committed.
/// longer committed. See also `detour_set_ignore_too_small`.
/// * `KERN_RESOURCE_SHORTAGE` if `calloc` failed for the structure keeping track of the operation
/// * If `mach_vm_region_recurse` fails on the target address, forwards its error code
/// * If `mach_vm_protect` fails on the target address, forwards its error code
@ -193,9 +193,35 @@ mach_error_t detour_attach_and_commit_ex(detour_func_t* inout_pointer, detour_fu
mach_error_t detour_detach_and_commit(detour_func_t* inout_pointer, detour_func_t detour);
/// @brief Toggle whether to ignore attach operation failures due to `detour_err_too_small` and detach operation
/// failures due to `KERN_FAILURE`.
///
/// Default is `false`. If set to `true`, these failures will cause the attach/detach to abort but return `err_none`, as if
/// they were successful.
///
/// @returns the previous state of the flag
bool detour_set_ignore_too_small(bool value);
/// @brief Toggle whether to free memory allocated for trampoline regions when they are empty.
///
/// Default is `true` - free unused regions upon commit.<br/>
/// `false` means they are not freed upon commit. Note that there is no way to manually free unused regions.
///
/// @returns the previous state of the flag
bool detour_set_retain_regions(bool value);
/// @brief Sets the lower bound of the memory area that will not be used for detours trampoline regions
///
/// Default is `0x70000000`
///
/// @returns the previous state of the value
void* detour_set_system_region_lower_bound(void* value);
/// @brief Sets the upper bound of the memory area that will not be used for detours trampoline regions
///
/// Default is `0x80000000`
///
/// @returns the previous state of the value
void* detour_set_system_region_upper_bound(void* value);
#ifdef __cplusplus