1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75
use crate::arch::Detour;
use crate::error::Result;
/// A raw detour.
///
/// # Example
///
/// ```rust
/// # use detour::Result;
/// use detour::RawDetour;
/// use std::mem;
///
/// fn add5(val: i32) -> i32 {
/// val + 5
/// }
///
/// fn add10(val: i32) -> i32 {
/// val + 10
/// }
///
/// # fn main() -> Result<()> {
/// let mut hook = unsafe { RawDetour::new(add5 as *const (), add10 as *const ())? };
///
/// assert_eq!(add5(5), 10);
/// assert_eq!(hook.is_enabled(), false);
///
/// unsafe { hook.enable()? };
/// assert!(hook.is_enabled());
///
/// let original: fn(i32) -> i32 = unsafe { mem::transmute(hook.trampoline()) };
///
/// assert_eq!(add5(5), 15);
/// assert_eq!(original(5), 10);
///
/// unsafe { hook.disable()? };
/// assert_eq!(add5(5), 10);
/// # Ok(())
/// # }
/// ```
#[derive(Debug)]
pub struct RawDetour(Detour);
// TODO: stop all threads in target during patch?
impl RawDetour {
/// Constructs a new inline detour patcher.
///
/// The hook is disabled by default. Even when this function is succesful,
/// there is no guaranteee that the detour function will actually get called
/// when the target function gets called. An invocation of the target
/// function might for example get inlined in which case it is impossible to
/// hook at runtime.
pub unsafe fn new(target: *const (), detour: *const ()) -> Result<Self> {
Detour::new(target, detour).map(RawDetour)
}
/// Enables the detour.
pub unsafe fn enable(&self) -> Result<()> {
self.0.enable()
}
/// Disables the detour.
pub unsafe fn disable(&self) -> Result<()> {
self.0.disable()
}
/// Returns whether the detour is enabled or not.
pub fn is_enabled(&self) -> bool {
self.0.is_enabled()
}
/// Returns a reference to the generated trampoline.
pub fn trampoline(&self) -> &() {
self.0.trampoline()
}
}