idakit 0.2.0

Idiomatic Rust bindings for IDA Pro's idalib kernel
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
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

//! Enumerates a database's exports and reads them through the [`Export`] view.

use crate::Database;
use crate::address::Address;

impl Database {
    /// Iterate every export (entry point) in the database, in kernel order.
    #[inline]
    #[must_use]
    #[doc(alias("get_entry_qty"))]
    pub fn exports(&self) -> Exports<'_> {
        Exports::new(self)
    }
}

/// A borrowed view of one export (entry point), keyed by kernel index.
///
/// A pure re-export has no local [`address`](Self::address) and resolves through a
/// [`forwarder`](Self::forwarder) instead.
#[derive(Clone, Copy)]
#[doc(alias("get_entry"))]
pub struct Export<'db> {
    index: usize,
    db: &'db Database,
}

impl<'db> Export<'db> {
    #[inline]
    pub(crate) fn new(index: usize, db: &'db Database) -> Self {
        Self { index, db }
    }

    /// The export's position in the entry table (not its [`ordinal`](Self::ordinal)).
    #[inline]
    #[must_use]
    pub const fn index(&self) -> usize {
        self.index
    }

    /// The export's address, or `None` for a pure forwarder that resolves elsewhere.
    #[inline]
    #[must_use]
    #[doc(alias("get_entry"))]
    pub fn address(&self) -> Option<Address> {
        Address::try_new(self.db.export_ea(self.index))
    }

    /// The export's ordinal, or, for a name-only entry with no ordinal, its entry index.
    #[inline]
    #[must_use]
    #[doc(alias("get_entry_ordinal"))]
    pub fn ordinal(&self) -> u64 {
        self.db.export_ordinal(self.index)
    }

    /// The export's name, or `None` if it is unnamed.
    #[must_use]
    #[doc(alias("get_entry_name"))]
    pub fn name(&self) -> Option<String> {
        self.db.export_name(self.index)
    }

    /// The forward target (e.g. `"OTHERLIB.func"`), or `None` when the export is defined here.
    #[must_use]
    #[doc(alias("get_entry_forwarder"))]
    pub fn forwarder(&self) -> Option<String> {
        self.db.export_forwarder(self.index)
    }
}

impl std::fmt::Debug for Export<'_> {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.debug_struct("Export")
            .field("index", &self.index)
            .field("name", &self.name())
            .field("address", &self.address())
            .field("ordinal", &self.ordinal())
            .finish()
    }
}

key_identity!(Export, index, ord);

/// A lazy iterator over every export in the database, in kernel order, from
/// [`Database::exports`].
pub struct Exports<'db> {
    db: &'db Database,
    next: usize,
    count: usize,
}

impl<'db> Exports<'db> {
    #[inline]
    pub(crate) fn new(db: &'db Database) -> Self {
        Self {
            db,
            next: 0,
            count: db.export_qty(),
        }
    }
}

impl<'db> Iterator for Exports<'db> {
    type Item = Export<'db>;

    #[inline]
    fn next(&mut self) -> Option<Self::Item> {
        if self.next >= self.count {
            return None;
        }
        let export = Export::new(self.next, self.db);
        self.next += 1;
        Some(export)
    }

    #[inline]
    fn size_hint(&self) -> (usize, Option<usize>) {
        let rem = self.count - self.next;
        (rem, Some(rem))
    }
}

impl ExactSizeIterator for Exports<'_> {}

#[cfg(test)]
mod tests {
    use assert2::assert;

    use super::*;

    #[test]
    fn export_identity_compares_by_index() {
        let db = Database::new();
        assert!(Export::new(3, &db) == Export::new(3, &db));
        assert!(Export::new(3, &db) != Export::new(4, &db));
    }

    #[test]
    fn export_ord_sorts_by_index() {
        let db = Database::new();
        let mut exports = [
            Export::new(2, &db),
            Export::new(0, &db),
            Export::new(1, &db),
        ];
        exports.sort();
        let indices: Vec<usize> = exports.iter().map(Export::index).collect();
        assert!(indices == [0, 1, 2]);
    }
}