udbg 0.3.1

cross-platform library for binary debugging and memory hacking
Documentation 
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

#![doc = include_str!("../README.md")]
#![doc(html_logo_url = "https://avatars.githubusercontent.com/u/61437564?s=200&v=4")]
#![feature(lazy_cell)]
#![feature(trait_alias)]
#![feature(ptr_metadata)]
#![feature(min_specialization)]
#![feature(stmt_expr_attributes)]
#![feature(associated_type_defaults)]
#![feature(closure_lifetime_binder)]
#![allow(rustdoc::bare_urls)]
#![allow(unused_variables)]
#![allow(unused_must_use)]
#![allow(dead_code)]
#![allow(non_snake_case)]
#![allow(non_camel_case_types)]
#![allow(non_upper_case_globals)]

#[macro_use]
extern crate alloc;
#[macro_use]
extern crate cfg_if;
#[macro_use]
extern crate bitflags;
#[macro_use]
extern crate derive_more;
#[macro_use]
extern crate serde;
#[macro_use]
extern crate log;

pub mod breakpoint;
#[cfg(feature = "capstone")]
pub mod capstone;
pub mod elf;
pub mod error;
pub mod event;
#[cfg(feature = "ezlua")]
pub mod lua;
pub mod memory;
pub mod minidump;
pub mod os;
pub mod pdbfile;
pub mod pe;
pub mod prelude;
pub mod range;
pub mod register;
pub mod shell;
pub mod string;
pub mod symbol;
pub mod target;

/// Constants for current environment
pub mod consts {
    #[cfg(any(target_arch = "x86", target_arch = "x86_64"))]
    pub const MAX_INSN_SIZE: usize = 16;

    #[cfg(any(target_arch = "arm", target_arch = "aarch64"))]
    pub const MAX_INSN_SIZE: usize = 4;

    pub const ARCH_X86: u32 = 0;
    pub const ARCH_X64: u32 = 1;
    pub const ARCH_ARM: u32 = 2;
    pub const ARCH_ARM64: u32 = 3;

    #[cfg(target_arch = "x86_64")]
    pub const UDBG_ARCH: u32 = ARCH_X64;
    #[cfg(target_arch = "x86")]
    pub const UDBG_ARCH: u32 = ARCH_X86;
    #[cfg(target_arch = "arm")]
    pub const UDBG_ARCH: u32 = ARCH_ARM;
    #[cfg(target_arch = "aarch64")]
    pub const UDBG_ARCH: u32 = ARCH_ARM64;

    pub const IS_ARCH_ARM: bool = cfg!(target_arch = "arm");
    pub const IS_ARCH_ARM64: bool = cfg!(target_arch = "aarch64");
    pub const IS_ARM: bool = IS_ARCH_ARM || IS_ARCH_ARM64;
    pub const IS_ARCH_X86: bool = cfg!(target_arch = "x86");
    pub const IS_ARCH_X64: bool = cfg!(target_arch = "x86_64");
    pub const IS_X86: bool = IS_ARCH_X86 || IS_ARCH_X64;
}

/// Fragmented utilities
pub mod util {
    use memmap2::Mmap;

    use alloc::sync::{Arc, Weak};
    use std::io::{BufRead, BufReader, Result as IoResult};
    use std::path::Path;

    /// Fragmented utilities code
    pub struct Utils;

    impl Utils {
        pub fn mapfile(path: &str) -> anyhow::Result<Mmap> {
            std::fs::File::open(path)
                .and_then(|f| unsafe { Mmap::map(&f) })
                .map_err(Into::into)
        }

        pub fn file_lines<P: AsRef<Path>>(path: P) -> IoResult<impl Iterator<Item = String>> {
            Ok(BufReader::new(std::fs::File::open(path)?)
                .lines()
                .map(|line| line.unwrap_or_default()))
        }

        /// Convert a reference to Weak<T>, please ensure the reference is from Arc<T>
        pub unsafe fn to_weak<T: ?Sized>(t: &T) -> Weak<T> {
            let t = Arc::from_raw(t);
            let result = Arc::downgrade(&t);
            Arc::into_raw(t);
            result
        }
    }
}