idakit-sys 0.1.0

Raw FFI bindings to IDA Pro's idalib runtime and the idakit C++ facade
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

//! Raw FFI bindings to IDA's idalib runtime and the idakit C++ facade.
//!
//! The declarations are split into per-domain source modules (`runtime`, `function`, `bytes`,
//! `hexrays`, ...) that mirror the facade's translation units, but every item is re-exported
//! flat at the crate root, so the public surface is a single namespace
//! (`idakit_sys::idakit_get_bytes`, `idakit_sys::EmitVtbl`), not a module hierarchy. There are
//! no safe wrappers here; those belong in `idakit`.
//!
//! # Buffer conventions
//!
//! Functions that accept `(*mut c_char, cap: usize)` copy the value into the
//! caller-supplied buffer and NUL-terminate within `cap` bytes. The return value
//! is the full source length, which may exceed `cap` when the output was
//! truncated. A negative return value means the query failed (missing symbol,
//! null handle, etc.).
//!
//! # Owned handles
//!
//! `idakit_binpat_compile` returns an opaque `*mut c_void` handle owned by the caller,
//! released with its matching `idakit_binpat_free`. Passing a handle to any other function
//! after release is undefined behaviour.
#![deny(
    rustdoc::broken_intra_doc_links,
    rustdoc::private_intra_doc_links,
    rustdoc::invalid_codeblock_attributes,
    rustdoc::invalid_html_tags,
    rustdoc::invalid_rust_codeblocks,
    rustdoc::bare_urls,
    rustdoc::unescaped_backticks,
    rustdoc::redundant_explicit_links
)]

/// IDA's effective address (`ea_t`), compiled `__EA64__`.
pub type Address = u64;
/// The invalid-address sentinel (`BADADDR`); every `Address`-returning facade call uses it for
/// "no address".
pub const BADADDR: Address = u64::MAX;

mod bridge_cfg2;
#[cfg(feature = "test-shims")]
mod bridge_cfunc;
mod bridge_gen;
#[cfg(feature = "test-shims")]
mod bridge_probe;
#[cfg(feature = "test-shims")]
mod bridge_probe_ext;
mod bridge_qvec;
mod bridge_typewalk;
mod bytes;
mod cfg;
mod frame;
mod function;
mod hexrays;
mod instruction;
mod name;
mod runtime;
mod segment;
mod strings;
mod ty;
mod ty_build;

pub use bridge_cfg2::*;
#[cfg(feature = "test-shims")]
pub use bridge_cfunc::*;
pub use bridge_gen::*;
#[cfg(feature = "test-shims")]
pub use bridge_probe::*;
#[cfg(feature = "test-shims")]
pub use bridge_probe_ext::*;
pub use bridge_qvec::*;
pub use bridge_typewalk::*;
pub use bytes::*;
pub use cfg::*;
pub use frame::*;
pub use function::*;
pub use hexrays::*;
pub use instruction::*;
pub use name::*;
pub use runtime::*;
pub use segment::*;
pub use strings::*;
pub use ty::*;
pub use ty_build::*;