Virtualization
/
capstone
mirror of https://gitlab.com/qemu-project/capstone.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Use doxygen style comments. (#1249) 

This converts various documentation comments to use Doxygen-style
syntax so that other tools can pick up and process these comments.
This commit is contained in:
Bruce Mitchener 2018-09-17 19:59:47 +07:00 committed by Nguyen Anh Quynh
parent e8b234d237
commit 1d40b9ee0a
1 changed files with 210 additions and 210 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

420
include/capstone/capstone.h
View File

@ -60,30 +60,30 @@ extern "C" {
#define CS_VERSION_MINOR CS_API_MINOR #define CS_VERSION_MINOR CS_API_MINOR
#define CS_VERSION_EXTRA 0 #define CS_VERSION_EXTRA 0
// Macro to create combined version which can be compared to /// Macro to create combined version which can be compared to
// result of cs_version() API. /// result of cs_version() API.
#define CS_MAKE_VERSION(major, minor) ((major << 8) + minor) #define CS_MAKE_VERSION(major, minor) ((major << 8) + minor)
// Maximum size of an instruction mnemonic string. /// Maximum size of an instruction mnemonic string.
#define CS_MNEMONIC_SIZE 32 #define CS_MNEMONIC_SIZE 32
// Handle using with all API // Handle using with all API
typedef size_t csh; typedef size_t csh;
// Architecture type /// Architecture type
typedef enum cs_arch { typedef enum cs_arch {
CS_ARCH_ARM = 0, // ARM architecture (including Thumb, Thumb-2) CS_ARCH_ARM = 0, ///< ARM architecture (including Thumb, Thumb-2)
CS_ARCH_ARM64, // ARM-64, also called AArch64 CS_ARCH_ARM64, ///< ARM-64, also called AArch64
CS_ARCH_MIPS, // Mips architecture CS_ARCH_MIPS, ///< Mips architecture
CS_ARCH_X86, // X86 architecture (including x86 & x86-64) CS_ARCH_X86, ///< X86 architecture (including x86 & x86-64)
CS_ARCH_PPC, // PowerPC architecture CS_ARCH_PPC, ///< PowerPC architecture
CS_ARCH_SPARC, // Sparc architecture CS_ARCH_SPARC, ///< Sparc architecture
CS_ARCH_SYSZ, // SystemZ architecture CS_ARCH_SYSZ, ///< SystemZ architecture
CS_ARCH_XCORE, // XCore architecture CS_ARCH_XCORE, ///< XCore architecture
CS_ARCH_M68K, // 68K architecture CS_ARCH_M68K, ///< 68K architecture
CS_ARCH_TMS320C64X, // TMS320C64x architecture CS_ARCH_TMS320C64X, ///< TMS320C64x architecture
CS_ARCH_M680X, // 680X architecture CS_ARCH_M680X, ///< 680X architecture
CS_ARCH_EVM, // Ethereum architecture CS_ARCH_EVM, ///< Ethereum architecture
CS_ARCH_MAX, CS_ARCH_MAX,
CS_ARCH_ALL = 0xFFFF, // All architectures - for cs_support() CS_ARCH_ALL = 0xFFFF, // All architectures - for cs_support()
} cs_arch; } cs_arch;
@ -98,42 +98,42 @@ typedef enum cs_arch {
// in X86 reduce mode. // in X86 reduce mode.
#define CS_SUPPORT_X86_REDUCE (CS_ARCH_ALL + 2) #define CS_SUPPORT_X86_REDUCE (CS_ARCH_ALL + 2)
// Mode type /// Mode type
typedef enum cs_mode { typedef enum cs_mode {
CS_MODE_LITTLE_ENDIAN = 0, // little-endian mode (default mode) CS_MODE_LITTLE_ENDIAN = 0, ///< little-endian mode (default mode)
CS_MODE_ARM = 0, // 32-bit ARM CS_MODE_ARM = 0, ///< 32-bit ARM
CS_MODE_16 = 1 << 1, // 16-bit mode (X86) CS_MODE_16 = 1 << 1, ///< 16-bit mode (X86)
CS_MODE_32 = 1 << 2, // 32-bit mode (X86) CS_MODE_32 = 1 << 2, ///< 32-bit mode (X86)
CS_MODE_64 = 1 << 3, // 64-bit mode (X86, PPC) CS_MODE_64 = 1 << 3, ///< 64-bit mode (X86, PPC)
CS_MODE_THUMB = 1 << 4, // ARM's Thumb mode, including Thumb-2 CS_MODE_THUMB = 1 << 4, ///< ARM's Thumb mode, including Thumb-2
CS_MODE_MCLASS = 1 << 5, // ARM's Cortex-M series CS_MODE_MCLASS = 1 << 5, ///< ARM's Cortex-M series
CS_MODE_V8 = 1 << 6, // ARMv8 A32 encodings for ARM CS_MODE_V8 = 1 << 6, ///< ARMv8 A32 encodings for ARM
CS_MODE_MICRO = 1 << 4, // MicroMips mode (MIPS) CS_MODE_MICRO = 1 << 4, ///< MicroMips mode (MIPS)
CS_MODE_MIPS3 = 1 << 5, // Mips III ISA CS_MODE_MIPS3 = 1 << 5, ///< Mips III ISA
CS_MODE_MIPS32R6 = 1 << 6, // Mips32r6 ISA CS_MODE_MIPS32R6 = 1 << 6, ///< Mips32r6 ISA
CS_MODE_MIPS2 = 1 << 7, // Mips II ISA CS_MODE_MIPS2 = 1 << 7, ///< Mips II ISA
CS_MODE_V9 = 1 << 4, // SparcV9 mode (Sparc) CS_MODE_V9 = 1 << 4, ///< SparcV9 mode (Sparc)
CS_MODE_QPX = 1 << 4, // Quad Processing eXtensions mode (PPC) CS_MODE_QPX = 1 << 4, ///< Quad Processing eXtensions mode (PPC)
CS_MODE_M68K_000 = 1 << 1, // M68K 68000 mode CS_MODE_M68K_000 = 1 << 1, ///< M68K 68000 mode
CS_MODE_M68K_010 = 1 << 2, // M68K 68010 mode CS_MODE_M68K_010 = 1 << 2, ///< M68K 68010 mode
CS_MODE_M68K_020 = 1 << 3, // M68K 68020 mode CS_MODE_M68K_020 = 1 << 3, ///< M68K 68020 mode
CS_MODE_M68K_030 = 1 << 4, // M68K 68030 mode CS_MODE_M68K_030 = 1 << 4, ///< M68K 68030 mode
CS_MODE_M68K_040 = 1 << 5, // M68K 68040 mode CS_MODE_M68K_040 = 1 << 5, ///< M68K 68040 mode
CS_MODE_M68K_060 = 1 << 6, // M68K 68060 mode CS_MODE_M68K_060 = 1 << 6, ///< M68K 68060 mode
CS_MODE_BIG_ENDIAN = 1 << 31, // big-endian mode CS_MODE_BIG_ENDIAN = 1 << 31, ///< big-endian mode
CS_MODE_MIPS32 = CS_MODE_32, // Mips32 ISA (Mips) CS_MODE_MIPS32 = CS_MODE_32, ///< Mips32 ISA (Mips)
CS_MODE_MIPS64 = CS_MODE_64, // Mips64 ISA (Mips) CS_MODE_MIPS64 = CS_MODE_64, ///< Mips64 ISA (Mips)
CS_MODE_M680X_6301 = 1 << 1, // M680X Hitachi 6301,6303 mode CS_MODE_M680X_6301 = 1 << 1, ///< M680X Hitachi 6301,6303 mode
CS_MODE_M680X_6309 = 1 << 2, // M680X Hitachi 6309 mode CS_MODE_M680X_6309 = 1 << 2, ///< M680X Hitachi 6309 mode
CS_MODE_M680X_6800 = 1 << 3, // M680X Motorola 6800,6802 mode CS_MODE_M680X_6800 = 1 << 3, ///< M680X Motorola 6800,6802 mode
CS_MODE_M680X_6801 = 1 << 4, // M680X Motorola 6801,6803 mode CS_MODE_M680X_6801 = 1 << 4, ///< M680X Motorola 6801,6803 mode
CS_MODE_M680X_6805 = 1 << 5, // M680X Motorola/Freescale 6805 mode CS_MODE_M680X_6805 = 1 << 5, ///< M680X Motorola/Freescale 6805 mode
CS_MODE_M680X_6808 = 1 << 6, // M680X Motorola/Freescale/NXP 68HC08 mode CS_MODE_M680X_6808 = 1 << 6, ///< M680X Motorola/Freescale/NXP 68HC08 mode
CS_MODE_M680X_6809 = 1 << 7, // M680X Motorola 6809 mode CS_MODE_M680X_6809 = 1 << 7, ///< M680X Motorola 6809 mode
CS_MODE_M680X_6811 = 1 << 8, // M680X Motorola/Freescale/NXP 68HC11 mode CS_MODE_M680X_6811 = 1 << 8, ///< M680X Motorola/Freescale/NXP 68HC11 mode
CS_MODE_M680X_CPU12 = 1 << 9, // M680X Motorola/Freescale/NXP CPU12 CS_MODE_M680X_CPU12 = 1 << 9, ///< M680X Motorola/Freescale/NXP CPU12
// used on M68HC12/HCS12 ///< used on M68HC12/HCS12
CS_MODE_M680X_HCS08 = 1 << 10, // M680X Freescale/NXP HCS08 mode CS_MODE_M680X_HCS08 = 1 << 10, ///< M680X Freescale/NXP HCS08 mode
} cs_mode; } cs_mode;
typedef void* (CAPSTONE_API *cs_malloc_t)(size_t size); typedef void* (CAPSTONE_API *cs_malloc_t)(size_t size);
@ -143,8 +143,8 @@ typedef void (CAPSTONE_API *cs_free_t)(void *ptr);
typedef int (CAPSTONE_API *cs_vsnprintf_t)(char *str, size_t size, const char *format, va_list ap); typedef int (CAPSTONE_API *cs_vsnprintf_t)(char *str, size_t size, const char *format, va_list ap);
// User-defined dynamic memory related functions: malloc/calloc/realloc/free/vsnprintf() /// User-defined dynamic memory related functions: malloc/calloc/realloc/free/vsnprintf()
// By default, Capstone uses system's malloc(), calloc(), realloc(), free() & vsnprintf(). /// By default, Capstone uses system's malloc(), calloc(), realloc(), free() & vsnprintf().
typedef struct cs_opt_mem { typedef struct cs_opt_mem {
cs_malloc_t malloc; cs_malloc_t malloc;
cs_calloc_t calloc; cs_calloc_t calloc;
@ -153,71 +153,71 @@ typedef struct cs_opt_mem {
cs_vsnprintf_t vsnprintf; cs_vsnprintf_t vsnprintf;
} cs_opt_mem; } cs_opt_mem;
// Customize mnemonic for instructions with alternative name. /// Customize mnemonic for instructions with alternative name.
// To reset existing customized instruction to its default mnemonic, /// To reset existing customized instruction to its default mnemonic,
// call cs_option(CS_OPT_MNEMONIC) again with the same @id and NULL value /// call cs_option(CS_OPT_MNEMONIC) again with the same @id and NULL value
// for @mnemonic. /// for @mnemonic.
typedef struct cs_opt_mnem { typedef struct cs_opt_mnem {
// ID of instruction to be customized. /// ID of instruction to be customized.
unsigned int id; unsigned int id;
// Customized instruction mnemonic. /// Customized instruction mnemonic.
const char *mnemonic; const char *mnemonic;
} cs_opt_mnem; } cs_opt_mnem;
// Runtime option for the disassembled engine /// Runtime option for the disassembled engine
typedef enum cs_opt_type { typedef enum cs_opt_type {
CS_OPT_INVALID = 0, // No option specified CS_OPT_INVALID = 0, ///< No option specified
CS_OPT_SYNTAX, // Assembly output syntax CS_OPT_SYNTAX, ///< Assembly output syntax
CS_OPT_DETAIL, // Break down instruction structure into details CS_OPT_DETAIL, ///< Break down instruction structure into details
CS_OPT_MODE, // Change engine's mode at run-time CS_OPT_MODE, ///< Change engine's mode at run-time
CS_OPT_MEM, // User-defined dynamic memory related functions CS_OPT_MEM, ///< User-defined dynamic memory related functions
CS_OPT_SKIPDATA, // Skip data when disassembling. Then engine is in SKIPDATA mode. CS_OPT_SKIPDATA, ///< Skip data when disassembling. Then engine is in SKIPDATA mode.
CS_OPT_SKIPDATA_SETUP, // Setup user-defined function for SKIPDATA option CS_OPT_SKIPDATA_SETUP, ///< Setup user-defined function for SKIPDATA option
CS_OPT_MNEMONIC, // Customize instruction mnemonic CS_OPT_MNEMONIC, ///< Customize instruction mnemonic
CS_OPT_UNSIGNED, // print immediate operands in unsigned form CS_OPT_UNSIGNED, ///< print immediate operands in unsigned form
} cs_opt_type; } cs_opt_type;
// Runtime option value (associated with option type above) /// Runtime option value (associated with option type above)
typedef enum cs_opt_value { typedef enum cs_opt_value {
CS_OPT_OFF = 0, // Turn OFF an option - default for CS_OPT_DETAIL, CS_OPT_SKIPDATA, CS_OPT_UNSIGNED. CS_OPT_OFF = 0, ///< Turn OFF an option - default for CS_OPT_DETAIL, CS_OPT_SKIPDATA, CS_OPT_UNSIGNED.
CS_OPT_ON = 3, // Turn ON an option (CS_OPT_DETAIL, CS_OPT_SKIPDATA). CS_OPT_ON = 3, ///< Turn ON an option (CS_OPT_DETAIL, CS_OPT_SKIPDATA).
CS_OPT_SYNTAX_DEFAULT = 0, // Default asm syntax (CS_OPT_SYNTAX). CS_OPT_SYNTAX_DEFAULT = 0, ///< Default asm syntax (CS_OPT_SYNTAX).
CS_OPT_SYNTAX_INTEL, // X86 Intel asm syntax - default on X86 (CS_OPT_SYNTAX). CS_OPT_SYNTAX_INTEL, ///< X86 Intel asm syntax - default on X86 (CS_OPT_SYNTAX).
CS_OPT_SYNTAX_ATT, // X86 ATT asm syntax (CS_OPT_SYNTAX). CS_OPT_SYNTAX_ATT, ///< X86 ATT asm syntax (CS_OPT_SYNTAX).
CS_OPT_SYNTAX_NOREGNAME, // Prints register name with only number (CS_OPT_SYNTAX) CS_OPT_SYNTAX_NOREGNAME, ///< Prints register name with only number (CS_OPT_SYNTAX)
CS_OPT_SYNTAX_MASM, // X86 Intel Masm syntax (CS_OPT_SYNTAX). CS_OPT_SYNTAX_MASM, ///< X86 Intel Masm syntax (CS_OPT_SYNTAX).
} cs_opt_value; } cs_opt_value;
//> Common instruction operand types - to be consistent across all architectures. /// Common instruction operand types - to be consistent across all architectures.
typedef enum cs_op_type { typedef enum cs_op_type {
CS_OP_INVALID = 0, // uninitialized/invalid operand. CS_OP_INVALID = 0, ///< uninitialized/invalid operand.
CS_OP_REG, // Register operand. CS_OP_REG, ///< Register operand.
CS_OP_IMM, // Immediate operand. CS_OP_IMM, ///< Immediate operand.
CS_OP_MEM, // Memory operand. CS_OP_MEM, ///< Memory operand.
CS_OP_FP, // Floating-Point operand. CS_OP_FP, ///< Floating-Point operand.
} cs_op_type; } cs_op_type;
//> Common instruction operand access types - to be consistent across all architectures. /// Common instruction operand access types - to be consistent across all architectures.
//> It is possible to combine access types, for example: CS_AC_READ | CS_AC_WRITE /// It is possible to combine access types, for example: CS_AC_READ | CS_AC_WRITE
typedef enum cs_ac_type { typedef enum cs_ac_type {
CS_AC_INVALID = 0, // Uninitialized/invalid access type. CS_AC_INVALID = 0, ///< Uninitialized/invalid access type.
CS_AC_READ = 1 << 0, // Operand read from memory or register. CS_AC_READ = 1 << 0, ///< Operand read from memory or register.
CS_AC_WRITE = 1 << 1, // Operand write to memory or register. CS_AC_WRITE = 1 << 1, ///< Operand write to memory or register.
} cs_ac_type; } cs_ac_type;
//> Common instruction groups - to be consistent across all architectures. /// Common instruction groups - to be consistent across all architectures.
typedef enum cs_group_type { typedef enum cs_group_type {
CS_GRP_INVALID = 0, // uninitialized/invalid group. CS_GRP_INVALID = 0, ///< uninitialized/invalid group.
CS_GRP_JUMP, // all jump instructions (conditional+direct+indirect jumps) CS_GRP_JUMP, ///< all jump instructions (conditional+direct+indirect jumps)
CS_GRP_CALL, // all call instructions CS_GRP_CALL, ///< all call instructions
CS_GRP_RET, // all return instructions CS_GRP_RET, ///< all return instructions
CS_GRP_INT, // all interrupt instructions (int+syscall) CS_GRP_INT, ///< all interrupt instructions (int+syscall)
CS_GRP_IRET, // all interrupt return instructions CS_GRP_IRET, ///< all interrupt return instructions
CS_GRP_PRIVILEGE, // all privileged instructions CS_GRP_PRIVILEGE, ///< all privileged instructions
CS_GRP_BRANCH_RELATIVE, // all relative branching instructions CS_GRP_BRANCH_RELATIVE, ///< all relative branching instructions
} cs_group_type; } cs_group_type;
/* /**
User-defined callback function for SKIPDATA option. User-defined callback function for SKIPDATA option.
See tests/test_skipdata.c for sample code demonstrating this API. See tests/test_skipdata.c for sample code demonstrating this API.
@ -233,33 +233,33 @@ typedef enum cs_group_type {
*/ */
typedef size_t (CAPSTONE_API *cs_skipdata_cb_t)(const uint8_t *code, size_t code_size, size_t offset, void *user_data); typedef size_t (CAPSTONE_API *cs_skipdata_cb_t)(const uint8_t *code, size_t code_size, size_t offset, void *user_data);
// User-customized setup for SKIPDATA option /// User-customized setup for SKIPDATA option
typedef struct cs_opt_skipdata { typedef struct cs_opt_skipdata {
// Capstone considers data to skip as special "instructions". /// Capstone considers data to skip as special "instructions".
// User can specify the string for this instruction's "mnemonic" here. /// User can specify the string for this instruction's "mnemonic" here.
// By default (if @mnemonic is NULL), Capstone use ".byte". /// By default (if @mnemonic is NULL), Capstone use ".byte".
const char *mnemonic; const char *mnemonic;
// User-defined callback function to be called when Capstone hits data. /// User-defined callback function to be called when Capstone hits data.
// If the returned value from this callback is positive (>0), Capstone /// If the returned value from this callback is positive (>0), Capstone
// will skip exactly that number of bytes & continue. Otherwise, if /// will skip exactly that number of bytes & continue. Otherwise, if
// the callback returns 0, Capstone stops disassembling and returns /// the callback returns 0, Capstone stops disassembling and returns
// immediately from cs_disasm() /// immediately from cs_disasm()
// NOTE: if this callback pointer is NULL, Capstone would skip a number /// NOTE: if this callback pointer is NULL, Capstone would skip a number
// of bytes depending on architectures, as following: /// of bytes depending on architectures, as following:
// Arm: 2 bytes (Thumb mode) or 4 bytes. /// Arm: 2 bytes (Thumb mode) or 4 bytes.
// Arm64: 4 bytes. /// Arm64: 4 bytes.
// Mips: 4 bytes. /// Mips: 4 bytes.
// M680x: 1 byte. /// M680x: 1 byte.
// PowerPC: 4 bytes. /// PowerPC: 4 bytes.
// Sparc: 4 bytes. /// Sparc: 4 bytes.
// SystemZ: 2 bytes. /// SystemZ: 2 bytes.
// X86: 1 bytes. /// X86: 1 bytes.
// XCore: 2 bytes. /// XCore: 2 bytes.
// EVM: 1 bytes. /// EVM: 1 bytes.
cs_skipdata_cb_t callback; // default value is NULL cs_skipdata_cb_t callback; // default value is NULL
// User-defined data to be passed to @callback function pointer. /// User-defined data to be passed to @callback function pointer.
void *user_data; void *user_data;
} cs_opt_skipdata; } cs_opt_skipdata;
@ -277,106 +277,106 @@ typedef struct cs_opt_skipdata {
#include "m680x.h" #include "m680x.h"
#include "evm.h" #include "evm.h"
// NOTE: All information in cs_detail is only available when CS_OPT_DETAIL = CS_OPT_ON /// NOTE: All information in cs_detail is only available when CS_OPT_DETAIL = CS_OPT_ON
// Initialized as memset(., 0, offsetof(cs_detail, ARCH)+sizeof(cs_ARCH)) /// Initialized as memset(., 0, offsetof(cs_detail, ARCH)+sizeof(cs_ARCH))
// by ARCH_getInstruction in arch/ARCH/ARCHDisassembler.c /// by ARCH_getInstruction in arch/ARCH/ARCHDisassembler.c
// if cs_detail changes, in particular if a field is added after the union, /// if cs_detail changes, in particular if a field is added after the union,
// then update arch/ARCH/ARCHDisassembler.c accordingly /// then update arch/ARCH/ARCHDisassembler.c accordingly
typedef struct cs_detail { typedef struct cs_detail {
uint16_t regs_read[12]; // list of implicit registers read by this insn uint16_t regs_read[12]; ///< list of implicit registers read by this insn
uint8_t regs_read_count; // number of implicit registers read by this insn uint8_t regs_read_count; ///< number of implicit registers read by this insn
uint16_t regs_write[20]; // list of implicit registers modified by this insn uint16_t regs_write[20]; ///< list of implicit registers modified by this insn
uint8_t regs_write_count; // number of implicit registers modified by this insn uint8_t regs_write_count; ///< number of implicit registers modified by this insn
uint8_t groups[8]; // list of group this instruction belong to uint8_t groups[8]; ///< list of group this instruction belong to
uint8_t groups_count; // number of groups this insn belongs to uint8_t groups_count; ///< number of groups this insn belongs to
// Architecture-specific instruction info /// Architecture-specific instruction info
union { union {
cs_x86 x86; // X86 architecture, including 16-bit, 32-bit & 64-bit mode cs_x86 x86; ///< X86 architecture, including 16-bit, 32-bit & 64-bit mode
cs_arm64 arm64; // ARM64 architecture (aka AArch64) cs_arm64 arm64; ///< ARM64 architecture (aka AArch64)
cs_arm arm; // ARM architecture (including Thumb/Thumb2) cs_arm arm; ///< ARM architecture (including Thumb/Thumb2)
cs_m68k m68k; // M68K architecture cs_m68k m68k; ///< M68K architecture
cs_mips mips; // MIPS architecture cs_mips mips; ///< MIPS architecture
cs_ppc ppc; // PowerPC architecture cs_ppc ppc; ///< PowerPC architecture
cs_sparc sparc; // Sparc architecture cs_sparc sparc; ///< Sparc architecture
cs_sysz sysz; // SystemZ architecture cs_sysz sysz; ///< SystemZ architecture
cs_xcore xcore; // XCore architecture cs_xcore xcore; ///< XCore architecture
cs_tms320c64x tms320c64x; // TMS320C64x architecture cs_tms320c64x tms320c64x; ///< TMS320C64x architecture
cs_m680x m680x; // M680X architecture cs_m680x m680x; ///< M680X architecture
cs_evm evm; // Ethereum architecture cs_evm evm; ///< Ethereum architecture
}; };
} cs_detail; } cs_detail;
// Detail information of disassembled instruction /// Detail information of disassembled instruction
typedef struct cs_insn { typedef struct cs_insn {
// Instruction ID (basically a numeric ID for the instruction mnemonic) /// Instruction ID (basically a numeric ID for the instruction mnemonic)
// Find the instruction id in the '[ARCH]_insn' enum in the header file /// Find the instruction id in the '[ARCH]_insn' enum in the header file
// of corresponding architecture, such as 'arm_insn' in arm.h for ARM, /// of corresponding architecture, such as 'arm_insn' in arm.h for ARM,
// 'x86_insn' in x86.h for X86, etc... /// 'x86_insn' in x86.h for X86, etc...
// This information is available even when CS_OPT_DETAIL = CS_OPT_OFF /// This information is available even when CS_OPT_DETAIL = CS_OPT_OFF
// NOTE: in Skipdata mode, "data" instruction has 0 for this id field. /// NOTE: in Skipdata mode, "data" instruction has 0 for this id field.
unsigned int id; unsigned int id;
// Address (EIP) of this instruction /// Address (EIP) of this instruction
// This information is available even when CS_OPT_DETAIL = CS_OPT_OFF /// This information is available even when CS_OPT_DETAIL = CS_OPT_OFF
uint64_t address; uint64_t address;
// Size of this instruction /// Size of this instruction
// This information is available even when CS_OPT_DETAIL = CS_OPT_OFF /// This information is available even when CS_OPT_DETAIL = CS_OPT_OFF
uint16_t size; uint16_t size;
// Machine bytes of this instruction, with number of bytes indicated by @size above /// Machine bytes of this instruction, with number of bytes indicated by @size above
// This information is available even when CS_OPT_DETAIL = CS_OPT_OFF /// This information is available even when CS_OPT_DETAIL = CS_OPT_OFF
uint8_t bytes[16]; uint8_t bytes[16];
// Ascii text of instruction mnemonic /// Ascii text of instruction mnemonic
// This information is available even when CS_OPT_DETAIL = CS_OPT_OFF /// This information is available even when CS_OPT_DETAIL = CS_OPT_OFF
char mnemonic[CS_MNEMONIC_SIZE]; char mnemonic[CS_MNEMONIC_SIZE];
// Ascii text of instruction operands /// Ascii text of instruction operands
// This information is available even when CS_OPT_DETAIL = CS_OPT_OFF /// This information is available even when CS_OPT_DETAIL = CS_OPT_OFF
char op_str[160]; char op_str[160];
// Pointer to cs_detail. /// Pointer to cs_detail.
// NOTE: detail pointer is only valid when both requirements below are met: /// NOTE: detail pointer is only valid when both requirements below are met:
// (1) CS_OP_DETAIL = CS_OPT_ON /// (1) CS_OP_DETAIL = CS_OPT_ON
// (2) Engine is not in Skipdata mode (CS_OP_SKIPDATA option set to CS_OPT_ON) /// (2) Engine is not in Skipdata mode (CS_OP_SKIPDATA option set to CS_OPT_ON)
// ///
// NOTE 2: when in Skipdata mode, or when detail mode is OFF, even if this pointer /// NOTE 2: when in Skipdata mode, or when detail mode is OFF, even if this pointer
// is not NULL, its content is still irrelevant. /// is not NULL, its content is still irrelevant.
cs_detail *detail; cs_detail *detail;
} cs_insn; } cs_insn;
// Calculate the offset of a disassembled instruction in its buffer, given its position /// Calculate the offset of a disassembled instruction in its buffer, given its position
// in its array of disassembled insn /// in its array of disassembled insn
// NOTE: this macro works with position (>=1), not index /// NOTE: this macro works with position (>=1), not index
#define CS_INSN_OFFSET(insns, post) (insns[post - 1].address - insns[0].address) #define CS_INSN_OFFSET(insns, post) (insns[post - 1].address - insns[0].address)
// All type of errors encountered by Capstone API. /// All type of errors encountered by Capstone API.
// These are values returned by cs_errno() /// These are values returned by cs_errno()
typedef enum cs_err { typedef enum cs_err {
CS_ERR_OK = 0, // No error: everything was fine CS_ERR_OK = 0, ///< No error: everything was fine
CS_ERR_MEM, // Out-Of-Memory error: cs_open(), cs_disasm(), cs_disasm_iter() CS_ERR_MEM, ///< Out-Of-Memory error: cs_open(), cs_disasm(), cs_disasm_iter()
CS_ERR_ARCH, // Unsupported architecture: cs_open() CS_ERR_ARCH, ///< Unsupported architecture: cs_open()
CS_ERR_HANDLE, // Invalid handle: cs_op_count(), cs_op_index() CS_ERR_HANDLE, ///< Invalid handle: cs_op_count(), cs_op_index()
CS_ERR_CSH, // Invalid csh argument: cs_close(), cs_errno(), cs_option() CS_ERR_CSH, ///< Invalid csh argument: cs_close(), cs_errno(), cs_option()
CS_ERR_MODE, // Invalid/unsupported mode: cs_open() CS_ERR_MODE, ///< Invalid/unsupported mode: cs_open()
CS_ERR_OPTION, // Invalid/unsupported option: cs_option() CS_ERR_OPTION, ///< Invalid/unsupported option: cs_option()
CS_ERR_DETAIL, // Information is unavailable because detail option is OFF CS_ERR_DETAIL, ///< Information is unavailable because detail option is OFF
CS_ERR_MEMSETUP, // Dynamic memory management uninitialized (see CS_OPT_MEM) CS_ERR_MEMSETUP, ///< Dynamic memory management uninitialized (see CS_OPT_MEM)
CS_ERR_VERSION, // Unsupported version (bindings) CS_ERR_VERSION, ///< Unsupported version (bindings)
CS_ERR_DIET, // Access irrelevant data in "diet" engine CS_ERR_DIET, ///< Access irrelevant data in "diet" engine
CS_ERR_SKIPDATA, // Access irrelevant data for "data" instruction in SKIPDATA mode CS_ERR_SKIPDATA, ///< Access irrelevant data for "data" instruction in SKIPDATA mode
CS_ERR_X86_ATT, // X86 AT&T syntax is unsupported (opt-out at compile time) CS_ERR_X86_ATT, ///< X86 AT&T syntax is unsupported (opt-out at compile time)
CS_ERR_X86_INTEL, // X86 Intel syntax is unsupported (opt-out at compile time) CS_ERR_X86_INTEL, ///< X86 Intel syntax is unsupported (opt-out at compile time)
CS_ERR_X86_MASM, // X86 Intel syntax is unsupported (opt-out at compile time) CS_ERR_X86_MASM, ///< X86 Intel syntax is unsupported (opt-out at compile time)
} cs_err; } cs_err;
/* /**
Return combined API version & major and minor version numbers. Return combined API version & major and minor version numbers.
@major: major number of API version @major: major number of API version
@ -397,7 +397,7 @@ CAPSTONE_EXPORT
unsigned int CAPSTONE_API cs_version(int *major, int *minor); unsigned int CAPSTONE_API cs_version(int *major, int *minor);
/* /**
This API can be used to either ask for archs supported by this library, This API can be used to either ask for archs supported by this library,
or check to see if the library was compile with 'diet' option (or called or check to see if the library was compile with 'diet' option (or called
in 'diet' mode). in 'diet' mode).
@ -413,7 +413,7 @@ unsigned int CAPSTONE_API cs_version(int *major, int *minor);
CAPSTONE_EXPORT CAPSTONE_EXPORT
bool CAPSTONE_API cs_support(int query); bool CAPSTONE_API cs_support(int query);
/* /**
Initialize CS handle: this must be done before any usage of CS. Initialize CS handle: this must be done before any usage of CS.
@arch: architecture type (CS_ARCH_*) @arch: architecture type (CS_ARCH_*)
@ -426,7 +426,7 @@ bool CAPSTONE_API cs_support(int query);
CAPSTONE_EXPORT CAPSTONE_EXPORT
cs_err CAPSTONE_API cs_open(cs_arch arch, cs_mode mode, csh *handle); cs_err CAPSTONE_API cs_open(cs_arch arch, cs_mode mode, csh *handle);
/* /**
Close CS handle: MUST do to release the handle when it is not used anymore. Close CS handle: MUST do to release the handle when it is not used anymore.
NOTE: this must be only called when there is no longer usage of Capstone, NOTE: this must be only called when there is no longer usage of Capstone,
not even access to cs_insn array. The reason is the this API releases some not even access to cs_insn array. The reason is the this API releases some
@ -443,7 +443,7 @@ cs_err CAPSTONE_API cs_open(cs_arch arch, cs_mode mode, csh *handle);
CAPSTONE_EXPORT CAPSTONE_EXPORT
cs_err CAPSTONE_API cs_close(csh *handle); cs_err CAPSTONE_API cs_close(csh *handle);
/* /**
Set option for disassembling engine at runtime Set option for disassembling engine at runtime
@handle: handle returned by cs_open() @handle: handle returned by cs_open()
@ -460,7 +460,7 @@ cs_err CAPSTONE_API cs_close(csh *handle);
CAPSTONE_EXPORT CAPSTONE_EXPORT
cs_err CAPSTONE_API cs_option(csh handle, cs_opt_type type, size_t value); cs_err CAPSTONE_API cs_option(csh handle, cs_opt_type type, size_t value);
/* /**
Report the last error number when some API function fail. Report the last error number when some API function fail.
Like glibc's errno, cs_errno might not retain its old value once accessed. Like glibc's errno, cs_errno might not retain its old value once accessed.
@ -472,7 +472,7 @@ CAPSTONE_EXPORT
cs_err CAPSTONE_API cs_errno(csh handle); cs_err CAPSTONE_API cs_errno(csh handle);
/* /**
Return a string describing given error code. Return a string describing given error code.
@code: error code (see CS_ERR_* above) @code: error code (see CS_ERR_* above)
@ -483,7 +483,7 @@ cs_err CAPSTONE_API cs_errno(csh handle);
CAPSTONE_EXPORT CAPSTONE_EXPORT
const char * CAPSTONE_API cs_strerror(cs_err code); const char * CAPSTONE_API cs_strerror(cs_err code);
/* /**
Disassemble binary code, given the code buffer, size, address and number Disassemble binary code, given the code buffer, size, address and number
of instructions to be decoded. of instructions to be decoded.
This API dynamically allocate memory to contain disassembled instruction. This API dynamically allocate memory to contain disassembled instruction.
@ -523,7 +523,7 @@ size_t CAPSTONE_API cs_disasm(csh handle,
size_t count, size_t count,
cs_insn **insn); cs_insn **insn);
/* /**
Deprecated function - to be retired in the next version! Deprecated function - to be retired in the next version!
Use cs_disasm() instead of cs_disasm_ex() Use cs_disasm() instead of cs_disasm_ex()
*/ */
@ -535,7 +535,7 @@ size_t CAPSTONE_API cs_disasm_ex(csh handle,
size_t count, size_t count,
cs_insn **insn); cs_insn **insn);
/* /**
Free memory allocated by cs_malloc() or cs_disasm() (argument @insn) Free memory allocated by cs_malloc() or cs_disasm() (argument @insn)
@insn: pointer returned by @insn argument in cs_disasm() or cs_malloc() @insn: pointer returned by @insn argument in cs_disasm() or cs_malloc()
@ -546,7 +546,7 @@ CAPSTONE_EXPORT
void CAPSTONE_API cs_free(cs_insn *insn, size_t count); void CAPSTONE_API cs_free(cs_insn *insn, size_t count);
/* /**
Allocate memory for 1 instruction to be used by cs_disasm_iter(). Allocate memory for 1 instruction to be used by cs_disasm_iter().
@handle: handle returned by cs_open() @handle: handle returned by cs_open()
@ -557,7 +557,7 @@ void CAPSTONE_API cs_free(cs_insn *insn, size_t count);
CAPSTONE_EXPORT CAPSTONE_EXPORT
cs_insn * CAPSTONE_API cs_malloc(csh handle); cs_insn * CAPSTONE_API cs_malloc(csh handle);
/* /**
Fast API to disassemble binary code, given the code buffer, size, address Fast API to disassemble binary code, given the code buffer, size, address
and number of instructions to be decoded. and number of instructions to be decoded.
This API puts the resulting instruction into a given cache in @insn. This API puts the resulting instruction into a given cache in @insn.
@ -597,7 +597,7 @@ bool CAPSTONE_API cs_disasm_iter(csh handle,
const uint8_t **code, size_t *size, const uint8_t **code, size_t *size,
uint64_t *address, cs_insn *insn); uint64_t *address, cs_insn *insn);
/* /**
Return friendly name of register in a string. Return friendly name of register in a string.
Find the instruction id from header file of corresponding architecture (arm.h for ARM, Find the instruction id from header file of corresponding architecture (arm.h for ARM,
x86.h for X86, ...) x86.h for X86, ...)
@ -613,7 +613,7 @@ bool CAPSTONE_API cs_disasm_iter(csh handle,
CAPSTONE_EXPORT CAPSTONE_EXPORT
const char * CAPSTONE_API cs_reg_name(csh handle, unsigned int reg_id); const char * CAPSTONE_API cs_reg_name(csh handle, unsigned int reg_id);
/* /**
Return friendly name of an instruction in a string. Return friendly name of an instruction in a string.
Find the instruction id from header file of corresponding architecture (arm.h for ARM, x86.h for X86, ...) Find the instruction id from header file of corresponding architecture (arm.h for ARM, x86.h for X86, ...)
@ -628,7 +628,7 @@ const char * CAPSTONE_API cs_reg_name(csh handle, unsigned int reg_id);
CAPSTONE_EXPORT CAPSTONE_EXPORT
const char * CAPSTONE_API cs_insn_name(csh handle, unsigned int insn_id); const char * CAPSTONE_API cs_insn_name(csh handle, unsigned int insn_id);
/* /**
Return friendly name of a group id (that an instruction can belong to) Return friendly name of a group id (that an instruction can belong to)
Find the group id from header file of corresponding architecture (arm.h for ARM, x86.h for X86, ...) Find the group id from header file of corresponding architecture (arm.h for ARM, x86.h for X86, ...)
@ -643,7 +643,7 @@ const char * CAPSTONE_API cs_insn_name(csh handle, unsigned int insn_id);
CAPSTONE_EXPORT CAPSTONE_EXPORT
const char * CAPSTONE_API cs_group_name(csh handle, unsigned int group_id); const char * CAPSTONE_API cs_group_name(csh handle, unsigned int group_id);
/* /**
Check if a disassembled instruction belong to a particular group. Check if a disassembled instruction belong to a particular group.
Find the group id from header file of corresponding architecture (arm.h for ARM, x86.h for X86, ...) Find the group id from header file of corresponding architecture (arm.h for ARM, x86.h for X86, ...)
Internally, this simply verifies if @group_id matches any member of insn->groups array. Internally, this simply verifies if @group_id matches any member of insn->groups array.
@ -662,7 +662,7 @@ const char * CAPSTONE_API cs_group_name(csh handle, unsigned int group_id);
CAPSTONE_EXPORT CAPSTONE_EXPORT
bool CAPSTONE_API cs_insn_group(csh handle, const cs_insn *insn, unsigned int group_id); bool CAPSTONE_API cs_insn_group(csh handle, const cs_insn *insn, unsigned int group_id);
/* /**
Check if a disassembled instruction IMPLICITLY used a particular register. Check if a disassembled instruction IMPLICITLY used a particular register.
Find the register id from header file of corresponding architecture (arm.h for ARM, x86.h for X86, ...) Find the register id from header file of corresponding architecture (arm.h for ARM, x86.h for X86, ...)
Internally, this simply verifies if @reg_id matches any member of insn->regs_read array. Internally, this simply verifies if @reg_id matches any member of insn->regs_read array.
@ -680,7 +680,7 @@ bool CAPSTONE_API cs_insn_group(csh handle, const cs_insn *insn, unsigned int gr
CAPSTONE_EXPORT CAPSTONE_EXPORT
bool CAPSTONE_API cs_reg_read(csh handle, const cs_insn *insn, unsigned int reg_id); bool CAPSTONE_API cs_reg_read(csh handle, const cs_insn *insn, unsigned int reg_id);
/* /**
Check if a disassembled instruction IMPLICITLY modified a particular register. Check if a disassembled instruction IMPLICITLY modified a particular register.
Find the register id from header file of corresponding architecture (arm.h for ARM, x86.h for X86, ...) Find the register id from header file of corresponding architecture (arm.h for ARM, x86.h for X86, ...)
Internally, this simply verifies if @reg_id matches any member of insn->regs_write array. Internally, this simply verifies if @reg_id matches any member of insn->regs_write array.
@ -698,7 +698,7 @@ bool CAPSTONE_API cs_reg_read(csh handle, const cs_insn *insn, unsigned int reg_
CAPSTONE_EXPORT CAPSTONE_EXPORT
bool CAPSTONE_API cs_reg_write(csh handle, const cs_insn *insn, unsigned int reg_id); bool CAPSTONE_API cs_reg_write(csh handle, const cs_insn *insn, unsigned int reg_id);
/* /**
Count the number of operands of a given type. Count the number of operands of a given type.
Find the operand type in header file of corresponding architecture (arm.h for ARM, x86.h for X86, ...) Find the operand type in header file of corresponding architecture (arm.h for ARM, x86.h for X86, ...)
@ -714,7 +714,7 @@ bool CAPSTONE_API cs_reg_write(csh handle, const cs_insn *insn, unsigned int reg
CAPSTONE_EXPORT CAPSTONE_EXPORT
int CAPSTONE_API cs_op_count(csh handle, const cs_insn *insn, unsigned int op_type); int CAPSTONE_API cs_op_count(csh handle, const cs_insn *insn, unsigned int op_type);
/* /**
Retrieve the position of operand of given type in <arch>.operands[] array. Retrieve the position of operand of given type in <arch>.operands[] array.
Later, the operand can be accessed using the returned position. Later, the operand can be accessed using the returned position.
Find the operand type in header file of corresponding architecture (arm.h for ARM, x86.h for X86, ...) Find the operand type in header file of corresponding architecture (arm.h for ARM, x86.h for X86, ...)
@ -734,10 +734,10 @@ CAPSTONE_EXPORT
int CAPSTONE_API cs_op_index(csh handle, const cs_insn *insn, unsigned int op_type, int CAPSTONE_API cs_op_index(csh handle, const cs_insn *insn, unsigned int op_type,
unsigned int position); unsigned int position);
// Type of array to keep the list of registers /// Type of array to keep the list of registers
typedef uint16_t cs_regs[64]; typedef uint16_t cs_regs[64];
/* /**
Retrieve all the registers accessed by an instruction, either explicitly or Retrieve all the registers accessed by an instruction, either explicitly or
implicitly. implicitly.