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 151 152 153 154 155 156 157 158 159 160 161 162 163
//! Bindings to the [capstone library][upstream] disassembly framework. //! //! This crate is a wrapper around the //! [Capstone disassembly library](http://www.capstone-engine.org/), //! a "lightweight multi-platform, multi-architecture disassembly framework." //! //! The [`Capstone`](struct.Capstone.html) struct is the main interface to the library. //! //! ```rust //! extern crate capstone; //! //! use capstone::prelude::*; //! //! const X86_CODE: &'static [u8] = b"\x55\x48\x8b\x05\xb8\x13\x00\x00\xe9\x14\x9e\x08\x00\x45\x31\xe4"; //! //! /// Print register names //! fn reg_names<T, I>(cs: &Capstone, regs: T) -> String //! where //! T: Iterator<Item = I>, //! I: Into<RegId>, //! { //! let names: Vec<String> = regs.map(|x| cs.reg_name(x.into()).unwrap()).collect(); //! names.join(", ") //! } //! //! /// Print instruction group names //! fn group_names<T, I>(cs: &Capstone, regs: T) -> String //! where //! T: Iterator<Item = I>, //! I: Into<InsnGroupId>, //! { //! let names: Vec<String> = regs.map(|x| cs.group_name(x.into()).unwrap()).collect(); //! names.join(", ") //! } //! //! fn main() { //! let mut cs = Capstone::new() //! .x86() //! .mode(arch::x86::ArchMode::Mode64) //! .syntax(arch::x86::ArchSyntax::Att) //! .detail(true) //! .build() //! .expect("Failed to create Capstone object"); //! //! let insns = cs.disasm_all(X86_CODE, 0x1000) //! .expect("Failed to disassemble"); //! println!("Found {} instructions", insns.len()); //! for i in insns.iter() { //! println!(); //! println!("{}", i); //! //! let detail: InsnDetail = cs.insn_detail(&i).expect("Failed to get insn detail"); //! let arch_detail: ArchDetail = detail.arch_detail(); //! let ops = arch_detail.operands(); //! //! let output: &[(&str, String)] = &[ //! ("insn id:", format!("{:?}", i.id().0)), //! ("bytes:", format!("{:?}", i.bytes())), //! ("read regs:", reg_names(&cs, detail.regs_read())), //! ("write regs:", reg_names(&cs, detail.regs_write())), //! ("insn groups:", group_names(&cs, detail.groups())), //! ]; //! //! for &(ref name, ref message) in output.iter() { //! println!("{:4}{:12} {}", "", name, message); //! } //! //! println!("{:4}operands: {}", "", ops.len()); //! for op in ops { //! println!("{:8}{:?}", "", op); //! } //! } //! } //! ``` //! //! Produces: //! //! ```txt //! Found 4 instructions //! //! 0x1000: pushq %rbp //! insn id: 580 //! bytes: [85] //! read regs: rsp //! write regs: rsp //! insn groups: mode64 //! operands: 1 //! X86Operand(X86Operand { size: 8, avx_bcast: X86_AVX_BCAST_INVALID, avx_zero_opmask: false, op_type: Reg(RegId(36)) }) //! //! 0x1001: movq 0x13b8(%rip), %rax //! insn id: 442 //! bytes: [72, 139, 5, 184, 19, 0, 0] //! read regs: //! write regs: //! insn groups: //! operands: 2 //! X86Operand(X86Operand { size: 8, avx_bcast: X86_AVX_BCAST_INVALID, avx_zero_opmask: false, op_type: Mem(X86OpMem(x86_op_mem { segment: 0, base: 41, index: 0, scale: 1, disp: 5048 })) }) //! X86Operand(X86Operand { size: 8, avx_bcast: X86_AVX_BCAST_INVALID, avx_zero_opmask: false, op_type: Reg(RegId(35)) }) //! //! 0x1008: jmp 0x8ae21 //! insn id: 266 //! bytes: [233, 20, 158, 8, 0] //! read regs: //! write regs: //! insn groups: jump //! operands: 1 //! X86Operand(X86Operand { size: 8, avx_bcast: X86_AVX_BCAST_INVALID, avx_zero_opmask: false, op_type: Imm(568865) }) //! //! 0x100d: xorl %r12d, %r12d //! insn id: 327 //! bytes: [69, 49, 228] //! read regs: //! write regs: rflags //! insn groups: //! operands: 2 //! X86Operand(X86Operand { size: 4, avx_bcast: X86_AVX_BCAST_INVALID, avx_zero_opmask: false, op_type: Reg(RegId(222)) }) //! X86Operand(X86Operand { size: 4, avx_bcast: X86_AVX_BCAST_INVALID, avx_zero_opmask: false, op_type: Reg(RegId(222)) }) //! //! ``` //! //! [upstream]: http://capstone-engine.org/ //! extern crate capstone_sys; pub mod arch; mod capstone; mod constants; mod error; mod instruction; #[cfg(test)] mod test; pub use capstone::*; pub use constants::*; pub use error::*; pub use instruction::*; #[cfg(feature = "alloc_system")] use std::alloc::System; #[cfg(feature = "alloc_system")] #[global_allocator] static ALLOCATOR: System = System; /// Contains items that you probably want to always import /// /// For example: /// /// ``` /// use capstone::prelude::*; /// ``` pub mod prelude { pub use arch::{ self, ArchDetail, BuildsCapstone, BuildsCapstoneEndian, BuildsCapstoneExtraMode, BuildsCapstoneSyntax, DetailsArchInsn, }; pub use { Capstone, CsResult, InsnDetail, InsnGroupId, InsnGroupIdInt, InsnId, InsnIdInt, RegId, RegIdInt, }; }