capstone_git/

capstone.rs

use alloc::boxed::Box;
use alloc::string::String;
use core::convert::From;
use core::ffi::{c_int, c_uint, c_void, CStr};
use core::marker::PhantomData;
use core::mem::MaybeUninit;
#[cfg(feature = "std")]
use std::ffi::CString;

use capstone_sys::cs_opt_value::*;
use capstone_sys::*;

use crate::arch::CapstoneBuilder;
use crate::constants::{Arch, Endian, ExtraMode, Mode, OptValue, Syntax};
use crate::instruction::{Insn, InsnDetail, InsnGroupId, InsnId, Instructions, RegId};
use crate::{error::*, PartialInitRegsAccess};

use {crate::ffi::str_from_cstr_ptr, alloc::string::ToString};

/// Length of `cs_regs`
pub(crate) const REGS_ACCESS_BUF_LEN: usize = 64;

// todo(tmfink) When MSRV is 1.75 or later, can use:
//pub(crate) const REGS_ACCESS_BUF_LEN: usize = unsafe { core::mem::zeroed::<cs_regs>() }.len();

/// Equivalent to `MaybeUninit<cs_regs>`
pub(crate) type RegsAccessBuf = [MaybeUninit<RegId>; REGS_ACCESS_BUF_LEN];

static_assertions::assert_eq_size!(RegId, u16);
static_assertions::assert_eq_size!(RegsAccessBuf, cs_regs);
static_assertions::assert_type_eq_all!([u16; REGS_ACCESS_BUF_LEN], cs_regs);

/// An instance of the capstone disassembler
///
/// Create with an instance with [`.new()`](Self::new) and disassemble bytes with [`.disasm_all()`](Self::disasm_all).
#[derive(Debug)]
pub struct Capstone {
    /// Opaque handle to cs_engine
    /// Stored as a pointer to ensure `Capstone` is `!Send`/`!Sync`
    csh: *mut c_void,

    /// Internal mode bitfield
    mode: cs_mode,

    /// Internal endian bitfield
    endian: cs_mode,

    /// Syntax
    syntax: cs_opt_value::Type,

    /// Internal extra mode bitfield
    extra_mode: cs_mode,

    /// Whether to get extra details when disassembling
    detail_enabled: bool,

    /// Whether to skipdata when disassembling
    skipdata_enabled: bool,

    /// Whether to print unsigned immediate
    unsigned_enabled: bool,

    /// We *must* set `mode`, `extra_mode`, and `endian` at once because `capstone`
    /// handles them inside the arch-specific handler. We store the bitwise OR of these flags that
    /// can be passed directly to `cs_option()`.
    raw_mode: cs_mode,

    /// Architecture
    arch: Arch,
}

/// Defines a setter on `Capstone` that speculatively changes the arch-specific mode (which
/// includes `mode`, `endian`, and `extra_mode`). The setter takes a `capstone-rs` type and changes
/// the internal `capstone-sys` type.
macro_rules! define_set_mode {
    (
        $( #[$func_attr:meta] )*
        => $($visibility:ident)*, $fn_name:ident,
            $opt_type:ident, $param_name:ident : $param_type:ident ;
        $cs_base_type:ident
    ) => {
        $( #[$func_attr] )*
        $($visibility)* fn $fn_name(&mut self, $param_name: $param_type) -> CsResult<()> {
            let old_val = self.$param_name;
            self.$param_name = $cs_base_type::from($param_name);

            let old_raw_mode = self.raw_mode;
            let new_raw_mode = self.update_raw_mode();

            let result = self._set_cs_option(
                cs_opt_type::$opt_type,
                new_raw_mode.0 as usize,
            );

            if result.is_err() {
                // On error, restore old values
                self.raw_mode = old_raw_mode;
                self.$param_name = old_val;
            }

            result
        }
    }
}

/// Represents that no extra modes are enabled. Can be passed to `Capstone::new_raw()` as the
/// `extra_mode` argument.
pub static NO_EXTRA_MODE: EmptyExtraModeIter = EmptyExtraModeIter(PhantomData);

/// Represents an empty set of `ExtraMode`.
#[derive(Copy, Clone, Debug, Eq, Hash, PartialEq)]
pub struct EmptyExtraModeIter(PhantomData<()>);

impl Iterator for EmptyExtraModeIter {
    type Item = ExtraMode;

    fn next(&mut self) -> Option<Self::Item> {
        None
    }
}

#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
pub struct RegAccessRef<'a> {
    pub(crate) read: &'a [RegId],
    pub(crate) write: &'a [RegId],
}

impl RegAccessRef<'_> {
    pub fn read(&self) -> &[RegId] {
        self.read
    }

    pub fn write(&self) -> &[RegId] {
        self.write
    }
}

impl Capstone {
    /// Create a new instance of the decompiler using the builder pattern interface.
    /// This is the recommended interface to `Capstone`.
    ///
    /// ```
    /// use capstone::prelude::*;
    /// let cs = Capstone::new().x86().mode(arch::x86::ArchMode::Mode32).build();
    /// ```
    #[allow(clippy::new_ret_no_self)]
    pub fn new() -> CapstoneBuilder {
        CapstoneBuilder::new()
    }

    /// Create a new instance of the decompiler using the "raw" interface.
    /// The user must ensure that only sensible `Arch`/`Mode` combinations are used.
    ///
    /// ```
    /// use capstone::{Arch, Capstone, NO_EXTRA_MODE, Mode};
    /// let cs = Capstone::new_raw(Arch::X86, Mode::Mode64, NO_EXTRA_MODE, None);
    /// assert!(cs.is_ok());
    /// ```
    pub fn new_raw<T: Iterator<Item = ExtraMode>>(
        arch: Arch,
        mode: Mode,
        extra_mode: T,
        endian: Option<Endian>,
    ) -> CsResult<Capstone> {
        let mut handle: csh = 0;
        let csarch: cs_arch = arch.into();
        let csmode: cs_mode = mode.into();

        // todo(tmfink): test valid modes at run time (or modify upstream capstone)

        let endian = match endian {
            Some(endian) => cs_mode::from(endian),
            None => cs_mode(0),
        };
        let extra_mode = Self::extra_mode_value(extra_mode);

        let combined_mode = csmode | endian | extra_mode;
        let err = unsafe { cs_open(csarch, combined_mode, &mut handle) };

        if cs_err::CS_ERR_OK == err {
            let syntax = CS_OPT_SYNTAX_DEFAULT;
            let raw_mode = cs_mode(0);
            let detail_enabled = false;
            let skipdata_enabled = false;
            let unsigned_enabled = false;

            let mut cs = Capstone {
                csh: handle as *mut c_void,
                syntax,
                endian,
                mode: csmode,
                extra_mode,
                detail_enabled,
                skipdata_enabled,
                unsigned_enabled,
                raw_mode,
                arch,
            };
            cs.update_raw_mode();
            Ok(cs)
        } else {
            Err(err.into())
        }
    }

    /// Disassemble and iterate instructions from user-provided buffer `code` using `cs_disasm_iter`.
    /// The disassembled address of the buffer is assumed to be `addr`.
    /// It uses less memory and reduces memory allocations.
    ///
    /// # Examples
    ///
    /// ```
    /// # use capstone::prelude::*;
    /// # let cs = Capstone::new().x86().mode(arch::x86::ArchMode::Mode32).build().unwrap();
    /// let mut iter = cs.disasm_iter(b"\x90", 0x1000).unwrap();
    /// assert_eq!(iter.next().unwrap().mnemonic(), Some("nop"));
    /// assert!(iter.next().is_none());
    /// ```
    ///
    /// # Errors
    ///
    /// If `cs_malloc` failed due to OOM, [`Err(Error::OutOfMemory)`](Error::OutOfMemory) is returned.
    pub fn disasm_iter<'a, 'b>(
        &'a self,
        code: &'b [u8],
        addr: u64,
    ) -> CsResult<DisasmIter<'a, 'b>> {
        let insn = unsafe { cs_malloc(self.csh()) };
        if insn.is_null() {
            return Err(Error::OutOfMemory);
        }
        Ok(DisasmIter {
            insn,
            csh: self.csh,
            code: code.as_ptr(),
            size: code.len(),
            addr,
            _data1: PhantomData,
            _data2: PhantomData,
        })
    }

    /// Disassemble all instructions in buffer
    ///
    /// ```
    /// # use capstone::prelude::*;
    /// # let cs = Capstone::new().x86().mode(arch::x86::ArchMode::Mode32).build().unwrap();
    /// cs.disasm_all(b"\x90", 0x1000).unwrap();
    /// ```
    pub fn disasm_all<'a>(&'a self, code: &[u8], addr: u64) -> CsResult<Instructions<'a>> {
        self.disasm(code, addr, 0)
    }

    /// Disassemble `count` instructions in `code`
    pub fn disasm_count<'a>(
        &'a self,
        code: &[u8],
        addr: u64,
        count: usize,
    ) -> CsResult<Instructions<'a>> {
        if count == 0 {
            return Err(Error::CustomError("Invalid dissasemble count; must be > 0"));
        }
        self.disasm(code, addr, count)
    }

    /// Disassembles a `&[u8]` full of instructions.
    ///
    /// Pass `count = 0` to disassemble all instructions in the buffer.
    fn disasm<'a>(&'a self, code: &[u8], addr: u64, count: usize) -> CsResult<Instructions<'a>> {
        // SAFETY NOTE: `cs_disasm()` will write the error state into the
        // `struct cs_struct` (true form of the `self.csh`) `errnum` field.
        // CLAIM: since:
        // - `Capstone` is not `Send`/`Sync`
        // - The mutation is done through a `*mut c_void` (not through a const reference)
        // it *should* be safe to accept `&self` (instead of `&mut self`) in this method.

        let mut ptr: *mut cs_insn = core::ptr::null_mut();
        let insn_count =
            unsafe { cs_disasm(self.csh(), code.as_ptr(), code.len(), addr, count, &mut ptr) };
        if insn_count == 0 {
            match self.error_result() {
                Ok(_) => Ok(Instructions::new_empty()),
                Err(err) => Err(err),
            }
        } else {
            Ok(unsafe { Instructions::from_raw_parts(ptr, insn_count) })
        }
    }

    /// Returns csh handle
    #[inline]
    fn csh(&self) -> csh {
        self.csh as csh
    }

    /// Returns the raw mode value, which is useful for debugging
    #[allow(dead_code)]
    pub(crate) fn raw_mode(&self) -> cs_mode {
        self.raw_mode
    }

    /// Update `raw_mode` with the bitwise OR of `mode`, `extra_mode`, and `endian`.
    ///
    /// Returns the new `raw_mode`.
    fn update_raw_mode(&mut self) -> cs_mode {
        self.raw_mode = self.mode | self.extra_mode | self.endian;
        self.raw_mode
    }

    /// Return the integer value used by capstone to represent the set of extra modes
    fn extra_mode_value<T: Iterator<Item = ExtraMode>>(extra_mode: T) -> cs_mode {
        // Bitwise OR extra modes
        extra_mode.fold(cs_mode(0), |acc, x| acc | cs_mode::from(x))
    }

    /// Set extra modes in addition to normal `mode`
    pub fn set_extra_mode<T: Iterator<Item = ExtraMode>>(&mut self, extra_mode: T) -> CsResult<()> {
        let old_val = self.extra_mode;

        self.extra_mode = Self::extra_mode_value(extra_mode);

        let old_mode = self.raw_mode;
        let new_mode = self.update_raw_mode();
        let result = self._set_cs_option(cs_opt_type::CS_OPT_MODE, new_mode.0 as usize);

        if result.is_err() {
            // On error, restore old values
            self.raw_mode = old_mode;
            self.extra_mode = old_val;
        }

        result
    }

    /// Set the assembly syntax (has no effect on some platforms)
    pub fn set_syntax(&mut self, syntax: Syntax) -> CsResult<()> {
        // Todo(tmfink) check for valid syntax
        let syntax_int = cs_opt_value::Type::from(syntax);
        let result = self._set_cs_option(cs_opt_type::CS_OPT_SYNTAX, syntax_int as usize);

        if result.is_ok() {
            self.syntax = syntax_int;
        }

        result
    }

    define_set_mode!(
    /// Set the endianness (has no effect on some platforms).
    => pub, set_endian, CS_OPT_MODE, endian : Endian; cs_mode);
    define_set_mode!(
    /// Sets the engine's disassembly mode.
    /// Be careful, various combinations of modes aren't supported
    /// See the capstone-sys documentation for more information.
    => pub, set_mode, CS_OPT_MODE, mode : Mode; cs_mode);

    /// Returns a `CsResult` based on current `errno`.
    /// If the `errno` is `CS_ERR_OK`, then `Ok(())` is returned. Otherwise, the error is returned.
    fn error_result(&self) -> CsResult<()> {
        let errno = unsafe { cs_errno(self.csh()) };
        if errno == cs_err::CS_ERR_OK {
            Ok(())
        } else {
            Err(errno.into())
        }
    }

    /// Sets disassembling options at runtime.
    ///
    /// Acts as a safe wrapper around capstone's `cs_option`.
    fn _set_cs_option(&mut self, option_type: cs_opt_type, option_value: usize) -> CsResult<()> {
        let err = unsafe { cs_option(self.csh(), option_type, option_value) };

        if cs_err::CS_ERR_OK == err {
            Ok(())
        } else {
            Err(err.into())
        }
    }

    /// Controls whether to capstone will generate extra details about disassembled instructions.
    ///
    /// Pass `true` to enable detail or `false` to disable detail.
    pub fn set_detail(&mut self, enable_detail: bool) -> CsResult<()> {
        let option_value: usize = OptValue::from(enable_detail).0 as usize;
        let result = self._set_cs_option(cs_opt_type::CS_OPT_DETAIL, option_value);

        // Only update internal state on success
        if result.is_ok() {
            self.detail_enabled = enable_detail;
        }

        result
    }

    /// Controls whether capstone will skip over invalid or data instructions.
    ///
    /// Pass `true` to enable skipdata or `false` to disable skipdata.
    pub fn set_skipdata(&mut self, enable_skipdata: bool) -> CsResult<()> {
        let option_value: usize = OptValue::from(enable_skipdata).0 as usize;
        let result = self._set_cs_option(cs_opt_type::CS_OPT_SKIPDATA, option_value);

        // Only update internal state on success
        if result.is_ok() {
            self.skipdata_enabled = enable_skipdata;
        }

        result
    }

    /// Controls whether capstone will print immediate operands in unsigned form.
    ///
    /// Pass `true` to enable unsigned or `false` to disable unsigned.
    pub fn set_unsigned(&mut self, enable_unsigned: bool) -> CsResult<()> {
        let option_value: usize = OptValue::from(enable_unsigned).0 as usize;
        let result = self._set_cs_option(cs_opt_type::CS_OPT_UNSIGNED, option_value);

        // Only update internal state on success
        if result.is_ok() {
            self.unsigned_enabled = enable_unsigned;
        }

        result
    }

    /// Customize mnemonic for instructions with alternative name.
    ///
    /// Pass `Some(mnemonic)` to enable custom mnemonic or `None` to revert to default.
    #[cfg(feature = "std")]
    pub fn set_mnemonic(&mut self, insn_id: InsnId, mnemonic: Option<&str>) -> CsResult<()> {
        let mnemonic_cstr = match mnemonic {
            Some(s) => Some(CString::new(s).map_err(|_err| {
                Error::CustomError(
                    "Failed to convert mnemonic to C-String due to internal NUL characters",
                )
            })?),
            None => None,
        };
        self.set_mnemonic_cstr(insn_id, mnemonic_cstr.as_deref())
    }

    /// Customize mnemonic for instructions with alternative name, passing a core::ffi::CStr.
    ///
    /// Pass `Some(mnemonic)` to enable custom mnemonic or `None` to revert to default.
    pub fn set_mnemonic_cstr(
        &mut self,
        insn_id: InsnId,
        mnemonic_cstr: Option<&CStr>,
    ) -> CsResult<()> {
        let option_value: cs_opt_mnem = cs_opt_mnem {
            id: insn_id.0,
            mnemonic: mnemonic_cstr
                .map(|s| s.as_ptr())
                .unwrap_or(core::ptr::null()),
        };
        self._set_cs_option(
            cs_opt_type::CS_OPT_MNEMONIC,
            &option_value as *const cs_opt_mnem as usize,
        )
    }

    /// Converts a register id `reg_id` to a `String` containing the register name.
    /// Unavailable in Diet mode
    pub fn reg_name(&self, reg_id: RegId) -> Option<String> {
        if cfg!(feature = "full") {
            let reg_name = unsafe {
                let _reg_name = cs_reg_name(self.csh(), c_uint::from(reg_id.0));
                str_from_cstr_ptr(_reg_name)?.to_string()
            };
            Some(reg_name)
        } else {
            None
        }
    }

    /// Converts an instruction id `insn_id` to a `String` containing the instruction name.
    /// Unavailable in Diet mode.
    /// Note: This function ignores the current syntax and uses the default syntax.
    pub fn insn_name(&self, insn_id: InsnId) -> Option<String> {
        if cfg!(feature = "full") {
            let insn_name = unsafe {
                let _insn_name = cs_insn_name(self.csh(), insn_id.0 as c_uint);
                str_from_cstr_ptr(_insn_name)?.to_string()
            };

            Some(insn_name)
        } else {
            None
        }
    }

    /// Get the registers are which are read and written
    pub(crate) fn regs_access<'buf>(
        &self,
        insn: &Insn,
        regs_read: &'buf mut RegsAccessBuf,
        regs_write: &'buf mut RegsAccessBuf,
    ) -> CsResult<RegAccessRef<'buf>> {
        if cfg!(feature = "full") {
            let mut regs_read_count: u8 = 0;
            let mut regs_write_count: u8 = 0;

            let err = unsafe {
                cs_regs_access(
                    self.csh(),
                    &insn.insn as *const cs_insn,
                    regs_read.as_mut_ptr() as *mut cs_regs,
                    &mut regs_read_count as *mut _,
                    regs_write.as_mut_ptr() as *mut cs_regs,
                    &mut regs_write_count as *mut _,
                )
            };

            if err != cs_err::CS_ERR_OK {
                return Err(err.into());
            }

            // SAFETY: count indicates how many elements are initialized;
            let regs_read_slice: &[RegId] = unsafe {
                core::slice::from_raw_parts(
                    regs_read.as_mut_ptr() as *mut RegId,
                    regs_read_count as usize,
                )
            };

            // SAFETY: count indicates how many elements are initialized
            let regs_write_slice: &[RegId] = unsafe {
                core::slice::from_raw_parts(
                    regs_write.as_mut_ptr() as *mut RegId,
                    regs_write_count as usize,
                )
            };

            Ok(RegAccessRef {
                read: regs_read_slice,
                write: regs_write_slice,
            })
        } else {
            Err(Error::DetailOff)
        }
    }

    /// Converts a group id `group_id` to a `String` containing the group name.
    /// Unavailable in Diet mode
    pub fn group_name(&self, group_id: InsnGroupId) -> Option<String> {
        if cfg!(feature = "full") {
            let group_name = unsafe {
                let _group_name = cs_group_name(self.csh(), c_uint::from(group_id.0));
                str_from_cstr_ptr(_group_name)?.to_string()
            };

            Some(group_name)
        } else {
            None
        }
    }

    /// Returns `Detail` structure for a given instruction
    ///
    /// Requires:
    ///
    /// 1. Instruction was created with detail enabled
    /// 2. Skipdata is disabled
    pub fn insn_detail<'s, 'i: 's>(&'s self, insn: &'i Insn) -> CsResult<InsnDetail<'i>> {
        if !self.detail_enabled {
            Err(Error::DetailOff)
        } else if insn.id().0 == 0 {
            Err(Error::IrrelevantDataInSkipData)
        } else {
            // Call regs_access to get "extra" read/write registers for the instruction.
            // Capstone only supports this for some architectures, so ignore errors if there are
            // any.
            //
            // This *could* results in wasted effort if the read/write regs are not checked. As
            // an optimization, we could call regs_access() lazily (i.e. only if InsnDetail
            // regs_read()/regs_write() are called).
            let partial_init_regs_access = {
                let mut regs_buf = Box::new(crate::RWRegsAccessBuf::new());
                match self.regs_access(insn, &mut regs_buf.read_buf, &mut regs_buf.write_buf) {
                    Ok(regs_access) => {
                        let read_len = regs_access.read.len() as u16;
                        let write_len = regs_access.write.len() as u16;
                        Some(PartialInitRegsAccess {
                            regs_buf,
                            read_len,
                            write_len,
                        })
                    }
                    Err(_) => None,
                }
            };

            Ok(unsafe { insn.detail(self.arch, partial_init_regs_access) })
        }
    }

    /// Returns a tuple (major, minor) indicating the version of the capstone C library.
    pub fn lib_version() -> (u32, u32) {
        let mut major: c_int = 0;
        let mut minor: c_int = 0;
        let major_ptr: *mut c_int = &mut major;
        let minor_ptr: *mut c_int = &mut minor;

        // We can ignore the "hexical" version returned by capstone because we already have the
        // major and minor versions
        let _ = unsafe { cs_version(major_ptr, minor_ptr) };

        (major as u32, minor as u32)
    }

    /// Returns whether the capstone library supports a given architecture.
    pub fn supports_arch(arch: Arch) -> bool {
        unsafe { cs_support(cs_arch::from(arch) as c_int) }
    }

    /// Returns whether the capstone library was compiled in diet mode.
    pub fn is_diet() -> bool {
        unsafe { cs_support(CS_SUPPORT_DIET as c_int) }
    }
}

impl Drop for Capstone {
    fn drop(&mut self) {
        unsafe { cs_close(&mut self.csh()) };
    }
}

/// Structure to handle iterative disassembly.
///
/// Create with a [`Capstone`](Capstone) instance: [`Capstone::disasm_iter()`](Capstone::disasm_iter).
///
/// # Lifetimes
///
/// `'cs` is the lifetime of the [`Capstone`](Capstone) instance.
/// `'buf` is the lifetime of the user provided code buffer in [`Capstone::disasm_iter()`](Capstone::disasm_iter).
///
pub struct DisasmIter<'cs, 'buf> {
    insn: *mut cs_insn,            // space for current instruction to be processed
    csh: *mut c_void,              // reference to the the capstone handle required by disasm_iter
    code: *const u8,               // pointer to the code buffer
    size: usize,                   // size of the code buffer
    addr: u64,                     // current address
    _data1: PhantomData<&'cs ()>, // used to make sure DisasmIter lifetime doesn't exceed Capstone's lifetime
    _data2: PhantomData<&'buf ()>, // used to make sure code lifetime doesn't exceed user provided array
}

impl<'cs, 'buf> Drop for DisasmIter<'cs, 'buf> {
    fn drop(&mut self) {
        unsafe { cs_free(self.insn, 1) };
    }
}

impl<'cs, 'buf> DisasmIter<'cs, 'buf> {
    /// Get next instruction if available.
    ///
    /// # Examples
    ///
    /// ```
    /// # use capstone::prelude::*;
    /// # let cs = Capstone::new().x86().mode(arch::x86::ArchMode::Mode32).build().unwrap();
    /// let code = b"\x90";
    /// let mut iter = cs.disasm_iter(code, 0x1000).unwrap();
    /// while let Some(insn) = iter.next() {
    ///     println!("{insn}");
    /// }
    /// ```
    ///
    /// At most one instruction can be accessed at the same time:
    ///
    /// ```compile_fail
    /// # use capstone::prelude::*;
    /// # let cs = Capstone::new().x86().mode(arch::x86::ArchMode::Mode32).build().unwrap();
    /// let code = b"\x90";
    /// let mut iter = cs.disasm_iter(code, 0x1000).unwrap();
    /// let insn1 = iter.next().unwrap();
    /// let insn2 = iter.next().unwrap();
    /// // fails with: cannot borrow `iter` as mutable more than once at a time,
    /// // `insn1` cannot be used after calling `iter.next()` again,
    /// // as `iter` is mutably borrowed during the second call to `next()`.
    /// println!("{insn1}");
    /// ```
    pub fn next<'iter>(&'iter mut self) -> Option<Insn<'iter>> {
        unsafe {
            if cs_disasm_iter(
                self.csh as csh,
                &mut self.code,
                &mut self.size,
                &mut self.addr,
                self.insn,
            ) {
                return Some(Insn::from_raw(self.insn));
            }
        }

        None
    }

    /// Get the slice of the code yet to be disassembled
    ///
    /// ```
    /// # use capstone::prelude::*;
    /// # let cs = Capstone::new().x86().mode(arch::x86::ArchMode::Mode32).build().unwrap();
    /// let code = b"\x90";
    /// let mut iter = cs.disasm_iter(code, 0x1000).unwrap();
    /// assert_eq!(iter.code(), code);
    /// iter.next();
    /// assert_eq!(iter.code(), b"");
    /// ```
    pub fn code(&self) -> &[u8] {
        unsafe { core::slice::from_raw_parts(self.code, self.size) }
    }

    /// Get the address of the next instruction to be disassembled
    ///
    /// ```
    /// # use capstone::prelude::*;
    /// # let cs = Capstone::new().x86().mode(arch::x86::ArchMode::Mode32).build().unwrap();
    /// let code = b"\x90";
    /// let mut iter = cs.disasm_iter(code, 0x1000).unwrap();
    /// assert_eq!(iter.addr(), 0x1000);
    /// iter.next();
    /// assert_eq!(iter.addr(), 0x1001);
    /// ```
    pub fn addr(&self) -> u64 {
        self.addr
    }

    /// Reset the iterator to disassemble in the specified code buffer
    ///
    /// ```
    /// # use capstone::prelude::*;
    /// # let cs = Capstone::new().x86().mode(arch::x86::ArchMode::Mode32).build().unwrap();
    /// let code = b"\x90";
    /// let mut iter = cs.disasm_iter(code, 0x1000).unwrap();
    /// assert_eq!(iter.addr(), 0x1000);
    /// assert_eq!(iter.code(), code);
    /// iter.next();
    /// assert_eq!(iter.addr(), 0x1001);
    /// assert_eq!(iter.code(), b"");
    /// let new_code = b"\xc3";
    /// iter.reset(new_code, 0x2000);
    /// assert_eq!(iter.addr(), 0x2000);
    /// assert_eq!(iter.code(), new_code);
    /// ```
    pub fn reset(&mut self, code: &'buf [u8], addr: u64) {
        self.code = code.as_ptr();
        self.size = code.len();
        self.addr = addr;
    }
}