jonesy 0.10.0

Jonesy is here to help you not panic!
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

//! Architecture-specific code for binary analysis.
//!
//! This module provides architecture-specific functionality for:
//! - Instruction disassembly and decoding
//! - Relocation type constants (MachO and ELF)
//! - PLT (Procedure Linkage Table) resolution
//!
//! # Supported Architectures
//!
//! Currently supported:
//! - **aarch64** (ARM64) - macOS and Linux
//!
//! # Adding New Architecture Support
//!
//! To add support for a new architecture (e.g., x86_64):
//!
//! 1. Create `arch/<arch>.rs` module with required functions
//! 2. Add `#[cfg(target_arch = "<arch>")]` block below
//! 3. Update compile_error check to include new architecture
//! 4. Implement architecture-specific constants and functions:
//!    - `INSN_SIZE` - instruction size in bytes
//!    - `decode_branch_target()` - decode branch/call instructions
//!    - `scan_branch_instructions()` - find call sites in code
//!    - Relocation constants for MachO and ELF
//!    - PLT resolution (if applicable for ELF shared libraries)
//!
//! # Architecture-Specific Assumptions
//!
//! Each architecture module documents its specific assumptions about:
//! - Instruction encoding (fixed-size vs variable-size ISA)
//! - Branch/call instruction formats
//! - Relocation types for linking
//! - PLT entry layout and size (ELF shared libraries)

// Compile-time error for unsupported architectures
#[cfg(not(any(target_arch = "aarch64", target_arch = "x86_64")))]
compile_error!("jonesy only supports aarch64 and x86_64 architectures");

// Architecture-specific modules
#[cfg(target_arch = "aarch64")]
pub mod aarch64;

#[cfg(target_arch = "x86_64")]
pub mod x86_64;

// Re-export the current architecture's functionality
#[cfg(target_arch = "aarch64")]
pub use self::aarch64::*;

#[cfg(target_arch = "x86_64")]
pub use self::x86_64::*;