lazymio/unicorn
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge pull request #1867 from mlgiraud/fix/no_ffi_in_api

Browse Source 
fix: Wrap uc_hook to not expose ffi types in public api
This commit is contained in:
lazymio
2023-08-14 18:06:14 +08:00
committed by GitHub
parent 19a794b97e bb7df65a1c
commit 44ca44ea1e
2 changed files with 69 additions and 56 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
bindings/rust/src/ffi.rs
View File

@@ -10,6 +10,7 @@ use core::ffi::c_void;
use libc::{c_char, c_int}; use libc::{c_char, c_int};
pub type uc_handle = *mut c_void; pub type uc_handle = *mut c_void;
// TODO: Use c_size_t as soon as it is stable. The c api exposes uc_hook as size_t
pub type uc_hook = *mut c_void; pub type uc_hook = *mut c_void;
pub type uc_context = *mut c_void; pub type uc_context = *mut c_void;

124
bindings/rust/src/lib.rs
View File

@@ -54,6 +54,7 @@ pub use crate::{
use alloc::{boxed::Box, rc::Rc, vec::Vec}; use alloc::{boxed::Box, rc::Rc, vec::Vec};
use core::{cell::UnsafeCell, ptr}; use core::{cell::UnsafeCell, ptr};
use bitflags::Flags;
use ffi::uc_handle; use ffi::uc_handle;
use libc::c_void; use libc::c_void;
@@ -130,12 +131,15 @@ impl<'a> MmioCallbackScope<'a> {
} }
} }
#[derive(Clone, Copy, PartialEq, Eq, Debug)]
pub struct UcHookId(ffi::uc_hook);
pub struct UnicornInner<'a, D> { pub struct UnicornInner<'a, D> {
pub handle: uc_handle, pub handle: uc_handle,
pub ffi: bool, pub ffi: bool,
pub arch: Arch, pub arch: Arch,
/// to keep ownership over the hook for this uc instance's lifetime /// to keep ownership over the hook for this uc instance's lifetime
pub hooks: Vec<(ffi::uc_hook, Box<dyn ffi::IsUcHook<'a> + 'a>)>, pub hooks: Vec<(UcHookId, Box<dyn ffi::IsUcHook<'a> + 'a>)>,
/// To keep ownership over the mmio callbacks for this uc instance's lifetime /// To keep ownership over the mmio callbacks for this uc instance's lifetime
pub mmio_callbacks: Vec<MmioCallbackScope<'a>>, pub mmio_callbacks: Vec<MmioCallbackScope<'a>>,
pub data: D, pub data: D,
@@ -620,11 +624,11 @@ impl<'a, D> Unicorn<'a, D> {
begin: u64, begin: u64,
end: u64, end: u64,
callback: F, callback: F,
) -> Result<ffi::uc_hook, uc_error> ) -> Result<UcHookId, uc_error>
where where
F: FnMut(&mut crate::Unicorn<D>, u64, u32) + 'a, F: FnMut(&mut crate::Unicorn<D>, u64, u32) + 'a,
{ {
let mut hook_ptr = core::ptr::null_mut(); let mut hook_id = ptr::null_mut();
let mut user_data = Box::new(ffi::UcHook { let mut user_data = Box::new(ffi::UcHook {
callback, callback,
uc: Rc::downgrade(&self.inner), uc: Rc::downgrade(&self.inner),
@@ -633,7 +637,7 @@ impl<'a, D> Unicorn<'a, D> {
let err = unsafe { let err = unsafe {
ffi::uc_hook_add( ffi::uc_hook_add(
self.get_handle(), self.get_handle(),
&mut hook_ptr, &mut hook_id,
HookType::CODE, HookType::CODE,
ffi::code_hook_proxy::<D, F> as _, ffi::code_hook_proxy::<D, F> as _,
user_data.as_mut() as *mut _ as _, user_data.as_mut() as *mut _ as _,
@@ -641,20 +645,21 @@ impl<'a, D> Unicorn<'a, D> {
end, end,
) )
}; };
let hook_id = UcHookId(hook_id);
if err == uc_error::OK { if err == uc_error::OK {
self.inner_mut().hooks.push((hook_ptr, user_data)); self.inner_mut().hooks.push((hook_id, user_data));
Ok(hook_ptr) Ok(hook_id)
} else { } else {
Err(err) Err(err)
} }
} }
/// Add a block hook. /// Add a block hook.
pub fn add_block_hook<F: 'a>(&mut self, callback: F) -> Result<ffi::uc_hook, uc_error> pub fn add_block_hook<F: 'a>(&mut self, callback: F) -> Result<UcHookId, uc_error>
where where
F: FnMut(&mut Unicorn<D>, u64, u32), F: FnMut(&mut Unicorn<D>, u64, u32),
{ {
let mut hook_ptr = core::ptr::null_mut(); let mut hook_id = core::ptr::null_mut();
let mut user_data = Box::new(ffi::UcHook { let mut user_data = Box::new(ffi::UcHook {
callback, callback,
uc: Rc::downgrade(&self.inner), uc: Rc::downgrade(&self.inner),
@@ -663,7 +668,7 @@ impl<'a, D> Unicorn<'a, D> {
let err = unsafe { let err = unsafe {
ffi::uc_hook_add( ffi::uc_hook_add(
self.get_handle(), self.get_handle(),
&mut hook_ptr, &mut hook_id,
HookType::BLOCK, HookType::BLOCK,
ffi::block_hook_proxy::<D, F> as _, ffi::block_hook_proxy::<D, F> as _,
user_data.as_mut() as *mut _ as _, user_data.as_mut() as *mut _ as _,
@@ -671,10 +676,11 @@ impl<'a, D> Unicorn<'a, D> {
0, 0,
) )
}; };
let hook_id = UcHookId(hook_id);
if err == uc_error::OK { if err == uc_error::OK {
self.inner_mut().hooks.push((hook_ptr, user_data)); self.inner_mut().hooks.push((hook_id, user_data));
Ok(hook_ptr) Ok(hook_id)
} else { } else {
Err(err) Err(err)
} }
@@ -687,7 +693,7 @@ impl<'a, D> Unicorn<'a, D> {
begin: u64, begin: u64,
end: u64, end: u64,
callback: F, callback: F,
) -> Result<ffi::uc_hook, uc_error> ) -> Result<UcHookId, uc_error>
where where
F: FnMut(&mut Unicorn<D>, MemType, u64, usize, i64) -> bool, F: FnMut(&mut Unicorn<D>, MemType, u64, usize, i64) -> bool,
{ {
@@ -695,7 +701,7 @@ impl<'a, D> Unicorn<'a, D> {
return Err(uc_error::ARG); return Err(uc_error::ARG);
} }
let mut hook_ptr = core::ptr::null_mut(); let mut hook_id = core::ptr::null_mut();
let mut user_data = Box::new(ffi::UcHook { let mut user_data = Box::new(ffi::UcHook {
callback, callback,
uc: Rc::downgrade(&self.inner), uc: Rc::downgrade(&self.inner),
@@ -704,7 +710,7 @@ impl<'a, D> Unicorn<'a, D> {
let err = unsafe { let err = unsafe {
ffi::uc_hook_add( ffi::uc_hook_add(
self.get_handle(), self.get_handle(),
&mut hook_ptr, &mut hook_id,
hook_type, hook_type,
ffi::mem_hook_proxy::<D, F> as _, ffi::mem_hook_proxy::<D, F> as _,
user_data.as_mut() as *mut _ as _, user_data.as_mut() as *mut _ as _,
@@ -712,21 +718,22 @@ impl<'a, D> Unicorn<'a, D> {
end, end,
) )
}; };
let hook_id = UcHookId(hook_id);
if err == uc_error::OK { if err == uc_error::OK {
self.inner_mut().hooks.push((hook_ptr, user_data)); self.inner_mut().hooks.push((hook_id, user_data));
Ok(hook_ptr) Ok(hook_id)
} else { } else {
Err(err) Err(err)
} }
} }
/// Add an interrupt hook. /// Add an interrupt hook.
pub fn add_intr_hook<F: 'a>(&mut self, callback: F) -> Result<ffi::uc_hook, uc_error> pub fn add_intr_hook<F: 'a>(&mut self, callback: F) -> Result<UcHookId, uc_error>
where where
F: FnMut(&mut Unicorn<D>, u32), F: FnMut(&mut Unicorn<D>, u32),
{ {
let mut hook_ptr = core::ptr::null_mut(); let mut hook_id = core::ptr::null_mut();
let mut user_data = Box::new(ffi::UcHook { let mut user_data = Box::new(ffi::UcHook {
callback, callback,
uc: Rc::downgrade(&self.inner), uc: Rc::downgrade(&self.inner),
@@ -735,7 +742,7 @@ impl<'a, D> Unicorn<'a, D> {
let err = unsafe { let err = unsafe {
ffi::uc_hook_add( ffi::uc_hook_add(
self.get_handle(), self.get_handle(),
&mut hook_ptr, &mut hook_id,
HookType::INTR, HookType::INTR,
ffi::intr_hook_proxy::<D, F> as _, ffi::intr_hook_proxy::<D, F> as _,
user_data.as_mut() as *mut _ as _, user_data.as_mut() as *mut _ as _,
@@ -743,21 +750,22 @@ impl<'a, D> Unicorn<'a, D> {
0, 0,
) )
}; };
let hook_id = UcHookId(hook_id);
if err == uc_error::OK { if err == uc_error::OK {
self.inner_mut().hooks.push((hook_ptr, user_data)); self.inner_mut().hooks.push((hook_id, user_data));
Ok(hook_ptr) Ok(hook_id)
} else { } else {
Err(err) Err(err)
} }
} }
/// Add hook for invalid instructions /// Add hook for invalid instructions
pub fn add_insn_invalid_hook<F: 'a>(&mut self, callback: F) -> Result<ffi::uc_hook, uc_error> pub fn add_insn_invalid_hook<F: 'a>(&mut self, callback: F) -> Result<UcHookId, uc_error>
where where
F: FnMut(&mut Unicorn<D>) -> bool, F: FnMut(&mut Unicorn<D>) -> bool,
{ {
let mut hook_ptr = core::ptr::null_mut(); let mut hook_id = core::ptr::null_mut();
let mut user_data = Box::new(ffi::UcHook { let mut user_data = Box::new(ffi::UcHook {
callback, callback,
uc: Rc::downgrade(&self.inner), uc: Rc::downgrade(&self.inner),
@@ -766,7 +774,7 @@ impl<'a, D> Unicorn<'a, D> {
let err = unsafe { let err = unsafe {
ffi::uc_hook_add( ffi::uc_hook_add(
self.get_handle(), self.get_handle(),
&mut hook_ptr, &mut hook_id,
HookType::INSN_INVALID, HookType::INSN_INVALID,
ffi::insn_invalid_hook_proxy::<D, F> as _, ffi::insn_invalid_hook_proxy::<D, F> as _,
user_data.as_mut() as *mut _ as _, user_data.as_mut() as *mut _ as _,
@@ -774,21 +782,22 @@ impl<'a, D> Unicorn<'a, D> {
0, 0,
) )
}; };
let hook_id = UcHookId(hook_id);
if err == uc_error::OK { if err == uc_error::OK {
self.inner_mut().hooks.push((hook_ptr, user_data)); self.inner_mut().hooks.push((hook_id, user_data));
Ok(hook_ptr) Ok(hook_id)
} else { } else {
Err(err) Err(err)
} }
} }
/// Add hook for x86 IN instruction. /// Add hook for x86 IN instruction.
pub fn add_insn_in_hook<F: 'a>(&mut self, callback: F) -> Result<ffi::uc_hook, uc_error> pub fn add_insn_in_hook<F: 'a>(&mut self, callback: F) -> Result<UcHookId, uc_error>
where where
F: FnMut(&mut Unicorn<D>, u32, usize) -> u32, F: FnMut(&mut Unicorn<D>, u32, usize) -> u32,
{ {
let mut hook_ptr = core::ptr::null_mut(); let mut hook_id = core::ptr::null_mut();
let mut user_data = Box::new(ffi::UcHook { let mut user_data = Box::new(ffi::UcHook {
callback, callback,
uc: Rc::downgrade(&self.inner), uc: Rc::downgrade(&self.inner),
@@ -797,7 +806,7 @@ impl<'a, D> Unicorn<'a, D> {
let err = unsafe { let err = unsafe {
ffi::uc_hook_add( ffi::uc_hook_add(
self.get_handle(), self.get_handle(),
&mut hook_ptr, &mut hook_id,
HookType::INSN, HookType::INSN,
ffi::insn_in_hook_proxy::<D, F> as _, ffi::insn_in_hook_proxy::<D, F> as _,
user_data.as_mut() as *mut _ as _, user_data.as_mut() as *mut _ as _,
@@ -806,21 +815,22 @@ impl<'a, D> Unicorn<'a, D> {
x86::InsnX86::IN, x86::InsnX86::IN,
) )
}; };
let hook_id = UcHookId(hook_id);
if err == uc_error::OK { if err == uc_error::OK {
self.inner_mut().hooks.push((hook_ptr, user_data)); self.inner_mut().hooks.push((hook_id, user_data));
Ok(hook_ptr) Ok(hook_id)
} else { } else {
Err(err) Err(err)
} }
} }
/// Add hook for x86 OUT instruction. /// Add hook for x86 OUT instruction.
pub fn add_insn_out_hook<F: 'a>(&mut self, callback: F) -> Result<ffi::uc_hook, uc_error> pub fn add_insn_out_hook<F: 'a>(&mut self, callback: F) -> Result<UcHookId, uc_error>
where where
F: FnMut(&mut Unicorn<D>, u32, usize, u32), F: FnMut(&mut Unicorn<D>, u32, usize, u32),
{ {
let mut hook_ptr = core::ptr::null_mut(); let mut hook_id = core::ptr::null_mut();
let mut user_data = Box::new(ffi::UcHook { let mut user_data = Box::new(ffi::UcHook {
callback, callback,
uc: Rc::downgrade(&self.inner), uc: Rc::downgrade(&self.inner),
@@ -829,7 +839,7 @@ impl<'a, D> Unicorn<'a, D> {
let err = unsafe { let err = unsafe {
ffi::uc_hook_add( ffi::uc_hook_add(
self.get_handle(), self.get_handle(),
&mut hook_ptr, &mut hook_id,
HookType::INSN, HookType::INSN,
ffi::insn_out_hook_proxy::<D, F> as _, ffi::insn_out_hook_proxy::<D, F> as _,
user_data.as_mut() as *mut _ as _, user_data.as_mut() as *mut _ as _,
@@ -838,10 +848,11 @@ impl<'a, D> Unicorn<'a, D> {
x86::InsnX86::OUT, x86::InsnX86::OUT,
) )
}; };
let hook_id = UcHookId(hook_id);
if err == uc_error::OK { if err == uc_error::OK {
self.inner_mut().hooks.push((hook_ptr, user_data)); self.inner_mut().hooks.push((hook_id, user_data));
Ok(hook_ptr) Ok(hook_id)
} else { } else {
Err(err) Err(err)
} }
@@ -854,11 +865,11 @@ impl<'a, D> Unicorn<'a, D> {
begin: u64, begin: u64,
end: u64, end: u64,
callback: F, callback: F,
) -> Result<ffi::uc_hook, uc_error> ) -> Result<UcHookId, uc_error>
where where
F: FnMut(&mut Unicorn<D>) + 'a, F: FnMut(&mut Unicorn<D>) + 'a,
{ {
let mut hook_ptr = core::ptr::null_mut(); let mut hook_id = core::ptr::null_mut();
let mut user_data = Box::new(ffi::UcHook { let mut user_data = Box::new(ffi::UcHook {
callback, callback,
uc: Rc::downgrade(&self.inner), uc: Rc::downgrade(&self.inner),
@@ -867,7 +878,7 @@ impl<'a, D> Unicorn<'a, D> {
let err = unsafe { let err = unsafe {
ffi::uc_hook_add( ffi::uc_hook_add(
self.get_handle(), self.get_handle(),
&mut hook_ptr, &mut hook_id,
HookType::INSN, HookType::INSN,
ffi::insn_sys_hook_proxy::<D, F> as _, ffi::insn_sys_hook_proxy::<D, F> as _,
user_data.as_mut() as *mut _ as _, user_data.as_mut() as *mut _ as _,
@@ -876,37 +887,39 @@ impl<'a, D> Unicorn<'a, D> {
insn_type, insn_type,
) )
}; };
let hook_id = UcHookId(hook_id);
if err == uc_error::OK { if err == uc_error::OK {
self.inner_mut().hooks.push((hook_ptr, user_data)); self.inner_mut().hooks.push((hook_id, user_data));
Ok(hook_ptr) Ok(hook_id)
} else { } else {
Err(err) Err(err)
} }
} }
pub fn add_tlb_hook<F>(&mut self, begin: u64, end: u64, callback: F) -> Result<ffi::uc_hook, uc_error> pub fn add_tlb_hook<F>(&mut self, begin: u64, end: u64, callback: F) -> Result<UcHookId, uc_error>
where where
F: FnMut(&mut crate::Unicorn<D>, u64, MemType) -> Option<TlbEntry> + 'a, F: FnMut(&mut crate::Unicorn<D>, u64, MemType) -> Option<TlbEntry> + 'a,
{ {
let mut hook_ptr = core::ptr::null_mut(); let mut hook_id = core::ptr::null_mut();
let mut user_data = Box::new(ffi::UcHook { let mut user_data = Box::new(ffi::UcHook {
callback, callback,
uc: Rc::downgrade(&self.inner), uc: Rc::downgrade(&self.inner),
}); });
let err = unsafe { let err = unsafe {
ffi::uc_hook_add(self.get_handle(), ffi::uc_hook_add(self.get_handle(),
&mut hook_ptr, &mut hook_id,
HookType::TLB, HookType::TLB,
ffi::tlb_lookup_hook_proxy::<D, F> as _, ffi::tlb_lookup_hook_proxy::<D, F> as _,
user_data.as_mut() as *mut _ as _, user_data.as_mut() as *mut _ as _,
begin, begin,
end, end,
) )
}; };
let hook_id = UcHookId(hook_id);
if err == uc_error::OK { if err == uc_error::OK {
self.inner_mut().hooks.push((hook_ptr, user_data)); self.inner_mut().hooks.push((hook_id, user_data));
Ok(hook_ptr) Ok(hook_id)
} else { } else {
Err(err) Err(err)
} }
@@ -914,16 +927,15 @@ impl<'a, D> Unicorn<'a, D> {
/// Remove a hook. /// Remove a hook.
/// ///
/// `hook` is the value returned by `add_*_hook` functions. /// `hook_id` is the value returned by `add_*_hook` functions.
#[allow(clippy::not_unsafe_ptr_arg_deref)] pub fn remove_hook(&mut self, hook_id: UcHookId) -> Result<(), uc_error> {
pub fn remove_hook(&mut self, hook: ffi::uc_hook) -> Result<(), uc_error> {
// drop the hook // drop the hook
let inner = self.inner_mut(); let inner = self.inner_mut();
inner inner
.hooks .hooks
.retain(|(hook_ptr, _hook_impl)| hook_ptr != &hook); .retain(|(id, _)| id != &hook_id);
let err: uc_error = unsafe { ffi::uc_hook_del(inner.handle, hook) }; let err: uc_error = unsafe { ffi::uc_hook_del(inner.handle, hook_id.0) };
if err == uc_error::OK { if err == uc_error::OK {
Ok(()) Ok(())