Expose x86 instruction encoding #147
Conversation
|
Thanks for jumping in with the contribution! I'll follow up with some review comments. |
| @@ -105,6 +105,11 @@ impl<'a> X86InsnDetail<'a> { | |||
| &self.0.opcode | |||
| } | |||
|
|
|||
| /// Instruction encoding information, e.g. displacement offset, size. | |||
| pub fn encoding(&self) -> cs_x86_encoding { | |||
There was a problem hiding this comment.
We don't want to expose the capstone-sys types with the C naming convention. Also, the actual C type is not very "Rusty" since just uses the convention "0 when irrelevant":
capstone-rs/capstone-sys/capstone/include/capstone/x86.h
Lines 299 to 310 in 7c9a51f
Instead, we want to provide a better interface taking advantage of the Rust type system.
Here's an example of how it could look. I'm guessing at the semantics of the fields--you are going to need to do some experiements. Feel free to use it as a starting point; apply with git apply:
diff --git a/capstone-rs/src/arch/mod.rs b/capstone-rs/src/arch/mod.rs
index a2e5834..9cc097a 100644
--- a/capstone-rs/src/arch/mod.rs
+++ b/capstone-rs/src/arch/mod.rs
@@ -12,6 +12,11 @@ use crate::capstone::Capstone;
use crate::constants::Endian;
use crate::error::CsResult;
+pub struct InsnOffsetSpan {
+ pub offset: u8,
+ pub size: u8,
+}
+
macro_rules! define_subset_enum {
( [
$subset_enum:ident = $base_enum:ident
diff --git a/capstone-rs/src/arch/x86.rs b/capstone-rs/src/arch/x86.rs
index 20866ef..21118ff 100644
--- a/capstone-rs/src/arch/x86.rs
+++ b/capstone-rs/src/arch/x86.rs
@@ -22,6 +22,8 @@ pub use crate::arch::arch_builder::x86::*;
use crate::arch::DetailsArchInsn;
use crate::instruction::{RegAccessType, RegId, RegIdInt};
+use super::InsnOffsetSpan;
+
/// Contains X86-specific details for an instruction
pub struct X86InsnDetail<'a>(pub(crate) &'a cs_x86);
@@ -81,6 +83,18 @@ pub enum X86OperandType {
#[derive(Debug, Copy, Clone)]
pub struct X86OpMem(pub(crate) x86_op_mem);
+pub struct X86Encoding {
+ pub modrm_offset: u8,
+ pub disp: Option<InsnOffsetSpan>,
+ pub imm: Option<InsnOffsetSpan>,
+}
+
+impl From<cs_x86_encoding> for X86Encoding {
+ fn from(value: cs_x86_encoding) -> Self {
+ todo!()
+ }
+}
+
impl<'a> X86InsnDetail<'a> {
/// Instruction prefix, which can be up to 4 bytes.
/// A prefix byte gets value 0 when irrelevant.
@@ -106,8 +120,8 @@ impl<'a> X86InsnDetail<'a> {
}
/// Instruction encoding information, e.g. displacement offset, size.
- pub fn encoding(&self) -> cs_x86_encoding {
- self.0.encoding
+ pub fn encoding(&self) -> X86Encoding {
+ self.0.encoding.into()
}
/// REX prefix: only a non-zero value is relevant for x86_64
| pub fn encoding(&self) -> cs_x86_encoding { | ||
| self.0.encoding | ||
| } | ||
|
|
There was a problem hiding this comment.
Please also add a test for the new method below in the test module.
Please try to create examples where some of the offset values are zero and others are non-zero.
Closes #145