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

//! Function-level scalar accessors against a real database: `total_size`, `comment`,
//! `does_return`, and `bitness`. Read-only; opens `save = false`. Skips when no test database is
//! present.

use assert2::assert;
use idakit::prelude::*;
use idakit_runner_macros::kernel_test;

#[kernel_test(read_only)]
fn function_scalar_accessors_hold_across_the_corpus() {
    crate::common::with_canonical_db(run);
}

// total_size must never undercount the entry chunk alone; bitness must resolve for every real
// function (the regression guard for the bitness facade bug); does_return/comment are exercised
// end to end, cross-checked against is_noreturn and comment(true) where possible.
fn run(idb: &mut Database) {
    let mut checked = 0usize;
    let mut commented = 0usize;
    for f in idb.functions() {
        assert!(
            f.total_size() >= f.size(),
            "function {:#x}: total_size {} < entry size {}",
            f.address().get(),
            f.total_size(),
            f.size()
        );

        let bitness = f.bitness();
        assert!(
            matches!(
                bitness,
                Some(Bitness::Bits16 | Bitness::Bits32 | Bitness::Bits64)
            ),
            "function {:#x}: expected a recognized bitness, got {bitness:?}",
            f.address().get()
        );

        if !f.is_noreturn() {
            assert!(
                f.does_return(),
                "function {:#x}: not flagged noreturn but does_return() is false",
                f.address().get()
            );
        }

        if let Some(text) = f.comment(false) {
            assert!(!text.is_empty(), "a Some comment should be non-empty");
            commented += 1;
        }
        let _ = f.comment(true);

        checked += 1;
    }
    assert!(checked > 0, "expected at least one function");

    println!("function scalar accessors OK: {checked} funcs checked, {commented} commented");
}