Generate bindings w/ array_pointers_in_arguments

Ensures cs_regs_access arguments are more clearly pointers to fixed-size
arrays.

Author: tmfink

capstone-rs/src/capstone.rs

@@ -1,6 +1,7 @@
 use alloc::string::String;
 use core::convert::From;
 use core::marker::PhantomData;
+use core::mem::MaybeUninit;
 
 use libc::{c_int, c_void};
 
@@ -14,9 +15,6 @@ use crate::instruction::{Insn, InsnDetail, InsnGroupId, InsnId, Instructions, Re
 
 use {crate::ffi::str_from_cstr_ptr, alloc::string::ToString, libc::c_uint};
 
-/// taken from the [python bindings](https://github.com/capstone-engine/capstone/blob/5fb8a423d4455cade99b12912142fd3a0c10d957/bindings/python/capstone/__init__.py#L929)
-const MAX_NUM_REGISTERS: usize = 64;
-
 /// An instance of the capstone disassembler
 ///
 /// Create with an instance with [`.new()`](Self::new) and disassemble bytes with [`.disasm_all()`](Self::disasm_all).
@@ -405,16 +403,16 @@ impl Capstone {
             let mut regs_read_count: u8 = 0;
             let mut regs_write_count: u8 = 0;
 
-            let mut regs_write = [0u16; MAX_NUM_REGISTERS];
-            let mut regs_read = [0u16; MAX_NUM_REGISTERS];
+            let mut regs_write: MaybeUninit<cs_regs> = MaybeUninit::uninit();
+            let mut regs_read: MaybeUninit<cs_regs> = MaybeUninit::uninit();
 
             let err = unsafe {
                 cs_regs_access(
                     self.csh(),
                     &insn.insn as *const cs_insn,
-                    &mut regs_read as *mut _,
+                    regs_read.as_mut_ptr(),
                     &mut regs_read_count as *mut _,
-                    &mut regs_write as *mut _,
+                    regs_write.as_mut_ptr(),
                     &mut regs_write_count as *mut _,
                 )
             };
@@ -423,18 +421,23 @@ impl Capstone {
                 return Err(err.into());
             }
 
-            read.extend(
-                regs_read
-                    .iter()
-                    .take(regs_read_count as usize)
-                    .map(|x| RegId(*x)),
-            );
-            write.extend(
-                regs_write
-                    .iter()
-                    .take(regs_write_count as usize)
-                    .map(|x| RegId(*x)),
-            );
+            // SAFETY: count indicates how many elements are initialized;
+            let regs_read_slice: &[RegId] = unsafe {
+                std::slice::from_raw_parts(
+                    regs_read.as_mut_ptr() as *mut RegId,
+                    regs_read_count as usize,
+                )
+            };
+            read.extend_from_slice(regs_read_slice);
+
+            // SAFETY: count indicates how many elements are initialized
+            let regs_write_slice: &[RegId] = unsafe {
+                std::slice::from_raw_parts(
+                    regs_write.as_mut_ptr() as *mut RegId,
+                    regs_write_count as usize,
+                )
+            };
+            write.extend_from_slice(regs_write_slice);
 
             Ok(())
         } else {

capstone-sys/CHANGELOG.md

@@ -4,6 +4,11 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [UNRELEASED] - YYYY-MM-DD
+### Changed
+- change `cs_regs_access()` `regs_read`/`regs_write` args to take `*mut cs_regs` (instead of `*mut u16`)
+    - makes it more clear that args should be fixed size arrays
+
 ## [0.17.0] - 2025-02-04
 ### Fixed
 - Segfault when running on s390x (AKA SystemZ)
@@ -123,6 +128,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Removed
 - Dependency
 
+[UNRELEASED]: https://github.com/capstone-rust/capstone-rs/compare/capstone-sys-v0.17.0...master
 [0.17.0]: https://github.com/capstone-rust/capstone-rs/compare/capstone-sys-v0.16.0...capstone-sys-v0.17.0
 [0.16.0]: https://github.com/capstone-rust/capstone-rs/compare/capstone-sys-v0.15.0...capstone-sys-v0.16.0
 [0.15.0]: https://github.com/capstone-rust/capstone-rs/compare/capstone-sys-v0.14.0...capstone-sys-v0.15.0

capstone-sys/build.rs

@@ -261,6 +261,7 @@ fn write_bindgen_bindings(
         .constified_enum_module("cs_err|cs_group_type|cs_opt_value")
         .bitfield_enum("cs_mode|cs_ac_type")
         .rustified_enum(".*")
+        .array_pointers_in_arguments(true)
         .no_copy("cs_insn");
 
     // Whitelist cs_.* functions and types

capstone-sys/pre_generated/capstone.rs

@@ -271,7 +271,7 @@ pub type cs_vsnprintf_t = ::core::option::Option<
         str_: *mut libc::c_char,
         size: usize,
         format: *const libc::c_char,
-        ap: *mut __va_list_tag,
+        ap: *mut va_list,
     ) -> libc::c_int,
 >;
 #[doc = " User-defined dynamic memory related functions: malloc/calloc/realloc/free/vsnprintf()\n By default, Capstone uses system's malloc(), calloc(), realloc(), free() & vsnprintf()."]
@@ -15581,9 +15581,9 @@ extern "C" {
     pub fn cs_regs_access(
         handle: csh,
         insn: *const cs_insn,
-        regs_read: *mut u16,
+        regs_read: *mut cs_regs,
         regs_read_count: *mut u8,
-        regs_write: *mut u16,
+        regs_write: *mut cs_regs,
         regs_write_count: *mut u8,
     ) -> cs_err::Type;
 }