This repository has been archived by the owner on Apr 22, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 31
/
lib.rs
1040 lines (934 loc) · 32.2 KB
/
lib.rs
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
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
//! Bindings for the Unicorn emulator.
//!
//! You most likely want to use one of the Cpu structs (`CpuX86`, `CpuARM`, etc.).
//!
//! # Example use
//!
//! ```rust
//! extern crate unicorn;
//!
//! use unicorn::{Cpu, CpuX86, uc_handle};
//!
//! fn main() {
//! let x86_code32 : Vec<u8> = vec![0x41, 0x4a]; // INC ecx; DEC edx
//!
//! let mut emu = CpuX86::new(unicorn::Mode::MODE_32).expect("failed to instantiate emulator");
//! emu.mem_map(0x1000, 0x4000, unicorn::Protection::ALL);
//! emu.mem_write(0x1000, &x86_code32);
//! emu.reg_write_i32(unicorn::RegisterX86::ECX, -10);
//! emu.reg_write_i32(unicorn::RegisterX86::EDX, -50);
//!
//! emu.emu_start(0x1000, (0x1000 + x86_code32.len()) as u64, 10 * unicorn::SECOND_SCALE, 1000);
//! assert_eq!(emu.reg_read_i32(unicorn::RegisterX86::ECX), Ok((-9)));
//! assert_eq!(emu.reg_read_i32(unicorn::RegisterX86::EDX), Ok((-51)));
//! }
//! ```
//!
use libunicorn_sys as ffi;
mod arm64_const;
mod arm_const;
mod m68k_const;
mod mips_const;
mod sparc_const;
mod x86_const;
#[macro_use]
mod macros;
use std::{cell::RefCell, collections::HashMap, marker::PhantomData, mem};
pub use crate::{
arm64_const::*,
arm_const::*,
ffi::{unicorn_const::*, *},
m68k_const::*,
mips_const::*,
sparc_const::*,
x86_const::*,
};
type Result<T> = std::result::Result<T, Error>;
#[derive(Debug)]
pub struct Context {
context: uc_context,
}
impl Context {
pub fn new() -> Self {
Context { context: 0 }
}
pub fn is_initialized(&self) -> bool {
self.context != 0
}
}
impl Drop for Context {
fn drop(&mut self) {
unsafe { uc_free(self.context) };
}
}
pub trait Register {
fn to_i32(&self) -> i32;
}
implement_register!(RegisterARM);
implement_register!(RegisterARM64);
implement_register!(RegisterM68K);
implement_register!(RegisterMIPS);
implement_register!(RegisterSPARC);
implement_register!(RegisterX86);
pub trait Cpu<'a> {
type Reg: Register;
fn emu(&self) -> &Unicorn<'a>;
/// Read an unsigned value from a register.
fn reg_read(&self, reg: Self::Reg) -> Result<u64> {
self.emu().reg_read(reg.to_i32())
}
/// Read a signed 32-bit value from a register.
fn reg_read_i32(&self, reg: Self::Reg) -> Result<i32> {
self.emu().reg_read_i32(reg.to_i32())
}
/// Write a generic type to a register.
unsafe fn reg_write_generic<T: Sized>(&self, reg: Self::Reg, value: T) -> Result<()> {
self.emu().reg_write_generic(reg.to_i32(), value)
}
/// Write an unsigned value register.
fn reg_write(&self, reg: Self::Reg, value: u64) -> Result<()> {
self.emu().reg_write(reg.to_i32(), value)
}
/// Write a signed 32-bit value to a register.
fn reg_write_i32(&self, reg: Self::Reg, value: i32) -> Result<()> {
self.emu().reg_write_i32(reg.to_i32(), value)
}
/// Map a memory region in the emulator at the specified address.
///
/// `address` must be aligned to 4kb or this will return `Error::ARG`.
/// `size` must be a multiple of 4kb or this will return `Error::ARG`.
fn mem_map(&self, address: u64, size: libc::size_t, perms: Protection) -> Result<()> {
self.emu().mem_map(address, size, perms)
}
/// Map an existing memory region in the emulator at the specified address.
///
/// This function is marked unsafe because it is the responsibility of the caller to
/// ensure that `size` matches the size of the passed buffer, an invalid `size` value will
/// likely cause a crash in unicorn.
///
/// `address` must be aligned to 4kb or this will return `Error::ARG`.
///
/// `size` must be a multiple of 4kb or this will return `Error::ARG`.
///
/// `ptr` is a pointer to the provided memory region that will be used by the emulator.
unsafe fn mem_map_ptr<T>(
&self,
address: u64,
size: libc::size_t,
perms: Protection,
ptr: *mut T,
) -> Result<()> {
self.emu().mem_map_ptr(address, size, perms, ptr)
}
/// Unmap a memory region.
///
/// `address` must be aligned to 4kb or this will return `Error::ARG`.
/// `size` must be a multiple of 4kb or this will return `Error::ARG`.
fn mem_unmap(&self, address: u64, size: libc::size_t) -> Result<()> {
self.emu().mem_unmap(address, size)
}
/// Write a range of bytes to memory at the specified address.
fn mem_write(&self, address: u64, bytes: &[u8]) -> Result<()> {
self.emu().mem_write(address, bytes)
}
/// Read a range of bytes from memory at the specified address.
fn mem_read(&self, address: u64, bytes: &mut [u8]) -> Result<()> {
self.emu().mem_read(address, bytes)
}
/// Read a range of bytes from memory at the specified address; return the bytes read as a
/// `Vec`.
fn mem_read_as_vec(&self, address: u64, size: usize) -> Result<Vec<u8>> {
self.emu().mem_read_as_vec(address, size)
}
/// Set the memory permissions for an existing memory region.
///
/// `address` must be aligned to 4kb or this will return `Error::ARG`.
/// `size` must be a multiple of 4kb or this will return `Error::ARG`.
fn mem_protect(&self, address: u64, size: usize, perms: Protection) -> Result<()> {
self.emu().mem_protect(address, size, perms)
}
/// Returns a vector with the memory regions that are mapped in the emulator.
fn mem_regions(&self) -> Result<Vec<MemRegion>> {
self.emu().mem_regions()
}
/// Emulate machine code for a specified duration.
///
/// `begin` is the address where to start the emulation. The emulation stops if `until`
/// is hit. `timeout` specifies a duration in microseconds after which the emulation is
/// stopped (infinite execution if set to 0). `count` is the maximum number of instructions
/// to emulate (emulate all the available instructions if set to 0).
fn emu_start(&self, begin: u64, until: u64, timeout: u64, count: usize) -> Result<()> {
self.emu().emu_start(begin, until, timeout, count)
}
/// Stop the emulation.
///
/// This is usually called from callback function in hooks.
/// NOTE: For now, this will stop the execution only after the current block.
fn emu_stop(&self) -> Result<()> {
self.emu().emu_stop()
}
/// Add a code hook.
fn add_code_hook<F>(
&self,
hook_type: CodeHookType,
begin: u64,
end: u64,
callback: F,
) -> Result<uc_hook>
where
F: 'a + FnMut(&'a Unicorn<'a>, u64, u32) -> (),
{
self.emu().add_code_hook(hook_type, begin, end, callback)
}
/// Add an interrupt hook.
fn add_intr_hook<F>(&self, callback: F) -> Result<uc_hook>
where
F: 'a + FnMut(&Unicorn, u32),
{
self.emu().add_intr_hook(callback)
}
/// Add a memory hook.
fn add_mem_hook<F>(
&self,
hook_type: MemHookType,
begin: u64,
end: u64,
callback: F,
) -> Result<uc_hook>
where
F: 'a + FnMut(&'a Unicorn<'a>, MemType, u64, usize, i64) -> bool,
{
self.emu().add_mem_hook(hook_type, begin, end, callback)
}
/// Add an "in" instruction hook.
fn add_insn_in_hook<F>(&self, callback: F) -> Result<uc_hook>
where
F: 'a + FnMut(&'a Unicorn<'a>, u32, usize) -> u32,
{
self.emu().add_insn_in_hook(callback)
}
/// Add an "out" instruction hook.
fn add_insn_out_hook<F>(&self, callback: F) -> Result<uc_hook>
where
F: 'a + FnMut(&'a Unicorn<'a>, u32, usize, u32),
{
self.emu().add_insn_out_hook(callback)
}
/// Add a "syscall" or "sysenter" instruction hook.
fn add_insn_sys_hook<F>(
&self,
insn_type: InsnSysX86,
begin: u64,
end: u64,
callback: F,
) -> Result<uc_hook>
where
F: 'a + FnMut(&'a Unicorn<'a>),
{
self.emu()
.add_insn_sys_hook(insn_type, begin, end, callback)
}
/// Remove a hook.
///
/// `hook` is the value returned by either `add_code_hook` or `add_mem_hook`.
fn remove_hook(&self, hook: uc_hook) -> Result<()> {
self.emu().remove_hook(hook)
}
/// Return the last error code when an API function failed.
///
/// Like glibc errno(), this function might not retain its old value once accessed.
fn errno(&self) -> Error {
self.emu().errno()
}
/// Query the internal status of the engine.
///
/// Supported queries :
///
/// - `Query::PAGE_SIZE` : the page size used by the emulator.
/// - `Query::MODE` : the current hardware mode.
fn query(&self, query: Query) -> Result<usize> {
self.emu().query(query)
}
/// Save the CPU context into an opaque struct.
fn context_save(&self) -> Result<Context> {
self.emu().context_save()
}
fn context_restore(&self, context: &Context) -> Result<()> {
self.emu().context_restore(context)
}
}
implement_emulator!(
doc = "An ARM emulator instance.",
doc = "Create an ARM emulator instance for the specified hardware mode.",
CpuARM,
Arch::ARM,
RegisterARM
);
implement_emulator!(
doc = "An ARM64 emulator instance.",
doc = "Create an ARM64 emulator instance for the specified hardware mode.",
CpuARM64,
Arch::ARM64,
RegisterARM64
);
implement_emulator!(
doc = "A M68K emulator instance.",
doc = "Create a M68K emulator instance for the specified hardware mode.",
CpuM68K,
Arch::M68K,
RegisterM68K
);
implement_emulator!(
doc = "A MIPS emulator instance.",
doc = "Create an MIPS emulator instance for the specified hardware mode.",
CpuMIPS,
Arch::MIPS,
RegisterMIPS
);
implement_emulator!(
doc = "A SPARC emulator instance.",
doc = "Create a SPARC emulator instance for the specified hardware mode.",
CpuSPARC,
Arch::SPARC,
RegisterSPARC
);
implement_emulator!(
doc = "An X86 emulator instance.",
doc = "Create an X86 emulator instance for the specified hardware mode.",
CpuX86,
Arch::X86,
RegisterX86
);
/// Struct to bind a unicorn instance to a callback.
pub struct UnicornHook<'a, F: 'a> {
unicorn: *const Unicorn<'a>,
callback: F,
}
extern "C" fn code_hook_proxy(_: uc_handle, address: u64, size: u32, user_data: *mut CodeHook) {
let (unicorn, callback) = destructure_hook!(CodeHook, user_data);
callback(unicorn, address, size)
}
extern "C" fn intr_hook_proxy(_: uc_handle, intno: u32, user_data: *mut IntrHook) {
let (unicorn, callback) = destructure_hook!(IntrHook, user_data);
callback(unicorn, intno)
}
extern "C" fn mem_hook_proxy(
_: uc_handle,
mem_type: MemType,
address: u64,
size: usize,
value: i64,
user_data: *mut MemHook,
) -> bool {
let (unicorn, callback) = destructure_hook!(MemHook, user_data);
callback(unicorn, mem_type, address, size, value)
}
extern "C" fn insn_in_hook_proxy(
_: uc_handle,
port: u32,
size: usize,
user_data: *mut InsnInHook,
) -> u32 {
let (unicorn, callback) = destructure_hook!(InsnInHook, user_data);
callback(unicorn, port, size)
}
extern "C" fn insn_out_hook_proxy(
_: uc_handle,
port: u32,
size: usize,
value: u32,
user_data: *mut InsnOutHook,
) {
let (unicorn, callback) = destructure_hook!(InsnOutHook, user_data);
callback(unicorn, port, size, value)
}
extern "C" fn insn_sys_hook_proxy(_: uc_handle, user_data: *mut InsnSysHook) {
let (unicorn, callback) = destructure_hook!(InsnSysHook, user_data);
callback(unicorn)
}
type CodeHook<'a> = UnicornHook<'a, Box<'a + FnMut(&'a Unicorn<'a>, u64, u32)>>;
type IntrHook<'a> = UnicornHook<'a, Box<'a + FnMut(&'a Unicorn<'a>, u32)>>;
type MemHook<'a> =
UnicornHook<'a, Box<'a + FnMut(&'a Unicorn<'a>, MemType, u64, usize, i64) -> bool>>;
type InsnInHook<'a> = UnicornHook<'a, Box<'a + FnMut(&'a Unicorn<'a>, u32, usize) -> u32>>;
type InsnOutHook<'a> = UnicornHook<'a, Box<'a + FnMut(&'a Unicorn<'a>, u32, usize, u32)>>;
type InsnSysHook<'a> = UnicornHook<'a, Box<'a + FnMut(&'a Unicorn<'a>)>>;
/// Internal : A Unicorn emulator instance, use one of the Cpu structs instead.
pub struct Unicorn<'a> {
handle: libc::size_t, // Opaque handle to uc_engine
code_callbacks: RefCell<HashMap<uc_hook, Box<CodeHook<'a>>>>,
intr_callbacks: RefCell<HashMap<uc_hook, Box<IntrHook<'a>>>>,
mem_callbacks: RefCell<HashMap<uc_hook, Box<MemHook<'a>>>>,
insn_in_callbacks: RefCell<HashMap<uc_hook, Box<InsnInHook<'a>>>>,
insn_out_callbacks: RefCell<HashMap<uc_hook, Box<InsnOutHook<'a>>>>,
insn_sys_callbacks: RefCell<HashMap<uc_hook, Box<InsnSysHook<'a>>>>,
phantom: PhantomData<&'a libc::size_t>,
}
/// Returns a tuple `(major, minor)` for the bindings version number.
pub fn bindings_version() -> (u32, u32) {
(BINDINGS_MAJOR, BINDINGS_MINOR)
}
/// Returns a tuple `(major, minor)` for the unicorn version number.
pub fn unicorn_version() -> (u32, u32) {
let mut major: u32 = Default::default();
let mut minor: u32 = Default::default();
let p_major: *mut _ = &mut major;
let p_minor: *mut _ = &mut minor;
unsafe {
uc_version(p_major, p_minor);
}
(major, minor)
}
/// Returns `true` if the architecture is supported by this build of unicorn.
pub fn arch_supported(arch: Arch) -> bool {
unsafe { uc_arch_supported(arch) }
}
impl<'a> Unicorn<'a> {
/// Create a new instance of the unicorn engine for the specified architecture
/// and hardware mode.
pub fn new(arch: Arch, mode: Mode) -> Result<Box<Self>> {
// Verify bindings compatibility with the core before going further.
let (major, minor) = unicorn_version();
if major != BINDINGS_MAJOR || minor != BINDINGS_MINOR {
return Err(Error::VERSION);
}
let mut handle: libc::size_t = Default::default();
let err = unsafe { uc_open(arch, mode, &mut handle) };
if err == Error::OK {
Ok(Box::new(Unicorn {
handle,
code_callbacks: Default::default(),
intr_callbacks: Default::default(),
mem_callbacks: Default::default(),
insn_in_callbacks: Default::default(),
insn_out_callbacks: Default::default(),
insn_sys_callbacks: Default::default(),
phantom: PhantomData,
}))
} else {
Err(err)
}
}
/// Write a generic type to a register.
///
/// This is required in some special cases, such as when writing `X86Mmr` to
/// the GDTR register in x86.
pub unsafe fn reg_write_generic<T: Sized>(&self, regid: i32, value: T) -> Result<()> {
let p_value: *const T = &value;
let err = uc_reg_write(self.handle, regid, p_value as *const libc::c_void);
if err == Error::OK {
Ok(())
} else {
Err(err)
}
}
/// Write an unsigned value register.
///
/// Note : The register is defined as an i32 to be able to support the
/// different register types (`RegisterX86`, `RegisterARM`, `RegisterMIPS` etc.).
/// You need to cast the register with `as i32`.
pub fn reg_write(&self, regid: i32, value: u64) -> Result<()> {
unsafe { Self::reg_write_generic::<_>(&self, regid, value) }
}
/// Write a signed 32-bit value to a register.
///
/// Note : The register is defined as an i32 to be able to support the
/// different register types (`RegisterX86`, `RegisterARM`, `RegisterMIPS` etc.).
/// You need to cast the register with `as i32`.
pub fn reg_write_i32(&self, regid: i32, value: i32) -> Result<()> {
unsafe { Self::reg_write_generic::<_>(&self, regid, value) }
}
unsafe fn reg_read_generic<T: Sized>(&self, regid: i32) -> Result<T> {
// deprecating in Rust 2.0.0: use mem::MaybeUninit::zeroed() instead
let mut value: T = mem::zeroed();
let err = uc_reg_read(
self.handle,
regid as libc::c_int,
&mut value as *mut _ as *mut libc::c_void,
);
if err == Error::OK {
Ok(value)
} else {
Err(err)
}
}
/// Read an unsigned value from a register.
///
/// Note : The register is defined as an i32 to be able to support the
/// different register types (`RegisterX86`, `RegisterARM`, `RegisterMIPS` etc.).
/// You need to cast the register with `as i32`.
pub fn reg_read(&self, regid: i32) -> Result<u64> {
unsafe { Self::reg_read_generic::<_>(&self, regid) }
}
/// Read a signed 32-bit value from a register.
///
/// Note : The register is defined as an i32 to be able to support the
/// different register types (`RegisterX86`, `RegisterARM`, `RegisterMIPS` etc.).
/// You need to cast the register with `as i32`.
pub fn reg_read_i32(&self, regid: i32) -> Result<i32> {
unsafe { Self::reg_read_generic::<_>(&self, regid) }
}
/// Map a memory region in the emulator at the specified address.
///
/// `address` must be aligned to 4kb or this will return `Error::ARG`.
/// `size` must be a multiple of 4kb or this will return `Error::ARG`.
pub fn mem_map(&self, address: u64, size: libc::size_t, perms: Protection) -> Result<()> {
let err = unsafe { uc_mem_map(self.handle, address, size, perms.bits()) };
if err == Error::OK {
Ok(())
} else {
Err(err)
}
}
/// Map an existing memory region in the emulator at the specified address.
///
/// This function is marked unsafe because it is the responsibility of the caller to
/// ensure that `size` matches the size of the passed buffer, an invalid `size` value will
/// likely cause a crash in unicorn.
///
/// `address` must be aligned to 4kb or this will return `Error::ARG`.
///
/// `size` must be a multiple of 4kb or this will return `Error::ARG`.
///
/// `ptr` is a pointer to the provided memory region that will be used by the emulator.
pub unsafe fn mem_map_ptr<T>(
&self,
address: u64,
size: libc::size_t,
perms: Protection,
ptr: *mut T,
) -> Result<()> {
let err = uc_mem_map_ptr(
self.handle,
address,
size,
perms.bits(),
ptr as *mut libc::c_void,
);
if err == Error::OK {
Ok(())
} else {
Err(err)
}
}
/// Unmap a memory region.
///
/// `address` must be aligned to 4kb or this will return `Error::ARG`.
/// `size` must be a multiple of 4kb or this will return `Error::ARG`.
pub fn mem_unmap(&self, address: u64, size: libc::size_t) -> Result<()> {
let err = unsafe { uc_mem_unmap(self.handle, address, size) };
if err == Error::OK {
Ok(())
} else {
Err(err)
}
}
/// Write a range of bytes to memory at the specified address.
pub fn mem_write(&self, address: u64, bytes: &[u8]) -> Result<()> {
let err = unsafe {
uc_mem_write(
self.handle,
address,
bytes.as_ptr(),
bytes.len() as libc::size_t,
)
};
if err == Error::OK {
Ok(())
} else {
Err(err)
}
}
/// Read a range of bytes from memory at the specified address.
pub fn mem_read(&self, address: u64, bytes: &mut [u8]) -> Result<()> {
let err = unsafe { uc_mem_read(self.handle, address, bytes.as_mut_ptr(), bytes.len()) };
if err == Error::OK {
Ok(())
} else {
Err(err)
}
}
/// Read a range of bytes from memory at the specified address; return the bytes read as a
/// `Vec`.
pub fn mem_read_as_vec(&self, address: u64, size: usize) -> Result<Vec<u8>> {
let mut bytes: Vec<u8> = Vec::with_capacity(size);
unsafe { self.mem_read(address, bytes.get_unchecked_mut(0..size)) }.map(|()| unsafe {
bytes.set_len(size);
bytes
})
}
/// Set the memory permissions for an existing memory region.
///
/// `address` must be aligned to 4kb or this will return `Error::ARG`.
/// `size` must be a multiple of 4kb or this will return `Error::ARG`.
pub fn mem_protect(&self, address: u64, size: usize, perms: Protection) -> Result<()> {
let err =
unsafe { uc_mem_protect(self.handle, address, size as libc::size_t, perms.bits()) };
if err == Error::OK {
Ok(())
} else {
Err(err)
}
}
/// Returns a vector with the memory regions that are mapped in the emulator.
pub fn mem_regions(&self) -> Result<Vec<MemRegion>> {
// We make a copy of the MemRegion structs that are returned by uc_mem_regions()
// as they have to be freed to the caller. It is simpler to make a copy and free()
// the originals right away.
let mut nb_regions: u32 = 0;
let p_nb_regions: *mut u32 = &mut nb_regions;
let p_regions: *const MemRegion = std::ptr::null();
let pp_regions: *const *const MemRegion = &p_regions;
let err = unsafe { uc_mem_regions(self.handle, pp_regions, p_nb_regions) };
if err == Error::OK {
let mut regions: Vec<MemRegion> = Vec::new();
let mut i: isize = 0;
while i < nb_regions as isize {
unsafe {
let region: MemRegion = mem::transmute_copy(&*p_regions.offset(i));
regions.push(region);
}
i += 1;
}
unsafe { libc::free(*pp_regions as *mut libc::c_void) };
Ok(regions)
} else {
Err(err)
}
}
/// Emulate machine code for a specified duration.
///
/// `begin` is the address where to start the emulation. The emulation stops if `until`
/// is hit. `timeout` specifies a duration in microseconds after which the emulation is
/// stopped (infinite execution if set to 0). `count` is the maximum number of instructions
/// to emulate (emulate all the available instructions if set to 0).
pub fn emu_start(&self, begin: u64, until: u64, timeout: u64, count: usize) -> Result<()> {
let err =
unsafe { uc_emu_start(self.handle, begin, until, timeout, count as libc::size_t) };
if err == Error::OK {
Ok(())
} else {
Err(err)
}
}
/// Stop the emulation.
///
/// This is usually called from callback function in hooks.
/// NOTE: For now, this will stop the execution only after the current block.
pub fn emu_stop(&self) -> Result<()> {
let err = unsafe { uc_emu_stop(self.handle) };
if err == Error::OK {
Ok(())
} else {
Err(err)
}
}
/// Add a code hook.
pub fn add_code_hook<F>(
&self,
hook_type: CodeHookType,
begin: u64,
end: u64,
callback: F,
) -> Result<uc_hook>
where
F: 'a + FnMut(&'a Unicorn<'a>, u64, u32),
{
let mut hook: uc_hook = 0;
let p_hook: *mut libc::size_t = &mut hook;
let user_data = Box::new(CodeHook {
unicorn: self,
callback: Box::new(callback),
});
let p_user_data: *mut libc::size_t = unsafe { mem::transmute(&*user_data) };
let _callback: libc::size_t = code_hook_proxy as usize;
let err = unsafe {
uc_hook_add(
self.handle,
p_hook,
mem::transmute(hook_type),
_callback,
p_user_data,
begin,
end,
)
};
if err == Error::OK {
self.code_callbacks.borrow_mut().insert(hook, user_data);
Ok(hook)
} else {
Err(err)
}
}
/// Add an interrupt hook.
pub fn add_intr_hook<F>(&self, callback: F) -> Result<uc_hook>
where
F: 'a + FnMut(&'a Unicorn<'a>, u32),
{
let mut hook: uc_hook = 0;
let p_hook: *mut libc::size_t = &mut hook;
let user_data = Box::new(IntrHook {
unicorn: self,
callback: Box::new(callback),
});
let p_user_data: *mut libc::size_t = unsafe { mem::transmute(&*user_data) };
let _callback: libc::size_t = intr_hook_proxy as usize;
let err = unsafe {
uc_hook_add(
self.handle,
p_hook,
HookType::INTR,
_callback,
p_user_data,
0,
0,
)
};
if err == Error::OK {
self.intr_callbacks.borrow_mut().insert(hook, user_data);
Ok(hook)
} else {
Err(err)
}
}
/// Add a memory hook.
pub fn add_mem_hook<F>(
&self,
hook_type: MemHookType,
begin: u64,
end: u64,
callback: F,
) -> Result<uc_hook>
where
F: 'a + FnMut(&'a Unicorn<'a>, MemType, u64, usize, i64) -> bool,
{
let mut hook: uc_hook = 0;
let p_hook: *mut libc::size_t = &mut hook;
let user_data = Box::new(MemHook {
unicorn: self,
callback: Box::new(callback),
});
let p_user_data: *mut libc::size_t = unsafe { mem::transmute(&*user_data) };
let _callback: libc::size_t = mem_hook_proxy as usize;
let err = unsafe {
uc_hook_add(
self.handle,
p_hook,
mem::transmute(hook_type),
_callback,
p_user_data,
begin,
end,
)
};
if err == Error::OK {
self.mem_callbacks.borrow_mut().insert(hook, user_data);
Ok(hook)
} else {
Err(err)
}
}
/// Add an "in" instruction hook.
pub fn add_insn_in_hook<F>(&self, callback: F) -> Result<uc_hook>
where
F: 'a + FnMut(&'a Unicorn<'a>, u32, usize) -> u32,
{
let mut hook: uc_hook = 0;
let p_hook: *mut libc::size_t = &mut hook;
let user_data = Box::new(InsnInHook {
unicorn: self,
callback: Box::new(callback),
});
let p_user_data: *mut libc::size_t = unsafe { mem::transmute(&*user_data) };
let _callback: libc::size_t = insn_in_hook_proxy as usize;
let err = unsafe {
uc_hook_add(
self.handle,
p_hook,
HookType::INSN,
_callback,
p_user_data,
0,
0,
x86_const::InsnX86::IN,
)
};
if err == Error::OK {
self.insn_in_callbacks.borrow_mut().insert(hook, user_data);
Ok(hook)
} else {
Err(err)
}
}
/// Add an "out" instruction hook.
pub fn add_insn_out_hook<F>(&self, callback: F) -> Result<uc_hook>
where
F: 'a + FnMut(&'a Unicorn<'a>, u32, usize, u32),
{
let mut hook: uc_hook = 0;
let p_hook: *mut libc::size_t = &mut hook;
let user_data = Box::new(InsnOutHook {
unicorn: self,
callback: Box::new(callback),
});
let p_user_data: *mut libc::size_t = unsafe { mem::transmute(&*user_data) };
let _callback: libc::size_t = insn_out_hook_proxy as usize;
let err = unsafe {
uc_hook_add(
self.handle,
p_hook,
HookType::INSN,
_callback,
p_user_data,
0,
0,
x86_const::InsnX86::OUT,
)
};
if err == Error::OK {
self.insn_out_callbacks.borrow_mut().insert(hook, user_data);
Ok(hook)
} else {
Err(err)
}
}
// (Currently only supports x86 architectures. TODO: Add support for ARM.)
/// Add a "syscall" or "sysenter" instruction hook.
pub fn add_insn_sys_hook<F>(
&self,
insn_type: InsnSysX86,
begin: u64,
end: u64,
callback: F,
) -> Result<uc_hook>
where
F: 'a + FnMut(&'a Unicorn<'a>),
{
let mut hook: uc_hook = 0;
let p_hook: *mut libc::size_t = &mut hook;
let user_data = Box::new(InsnSysHook {
unicorn: self,
callback: Box::new(callback),
});
let p_user_data: *mut libc::size_t = unsafe { mem::transmute(user_data.as_ref()) };
let _callback: libc::size_t = insn_sys_hook_proxy as usize;
let err = unsafe {
uc_hook_add(
self.handle,
p_hook,
HookType::INSN,
_callback,
p_user_data,
begin,
end,
insn_type,
)
};
if err == Error::OK {
self.insn_sys_callbacks.borrow_mut().insert(hook, user_data);
Ok(hook)
} else {
Err(err)
}
}
/// Remove a hook.
///
/// `hook` is the value returned by either `add_code_hook` or `add_mem_hook`.
pub fn remove_hook(&self, hook: uc_hook) -> Result<()> {
let err = unsafe { uc_hook_del(self.handle, hook) } as Error;
// Check in all maps to find which one has the hook.
macro_rules! ignore {
() => {
|_| ()
};
};
self.code_callbacks
.borrow_mut()
.remove(&hook)
.map(ignore!())
.or_else(|| {
self.intr_callbacks
.borrow_mut()
.remove(&hook)
.map(ignore!())
})
.or_else(|| self.mem_callbacks.borrow_mut().remove(&hook).map(ignore!()))
.or_else(|| {
self.insn_in_callbacks
.borrow_mut()
.remove(&hook)
.map(ignore!())
})
.or_else(|| {
self.insn_out_callbacks
.borrow_mut()
.remove(&hook)
.map(ignore!())
})
.or_else(|| {
self.insn_sys_callbacks
.borrow_mut()
.remove(&hook)
.map(ignore!())
});
if err == Error::OK {
Ok(())
} else {
Err(err)
}
}
/// Return the last error code when an API function failed.
///
/// Like glibc errno(), this function might not retain its old value once accessed.
pub fn errno(&self) -> Error {
unsafe { uc_errno(self.handle) }
}
/// Query the internal status of the engine.
///
/// Supported queries :
///
/// - `Query::PAGE_SIZE` : the page size used by the emulator.
/// - `Query::MODE` : the current hardware mode.
pub fn query(&self, query: Query) -> Result<usize> {
let mut result: libc::size_t = 0;
let p_result: *mut libc::size_t = &mut result;
let err = unsafe { uc_query(self.handle, query, p_result) };
if err == Error::OK {
Ok(result)
} else {
Err(err)