dr_ir_opnd.h File Reference

Functions and defines to create and manipulate instruction operands. More...

Defines
#define	DR_REG_XAX DR_REG_RAX
#define	DR_REG_XCX DR_REG_RCX
#define	DR_REG_XDX DR_REG_RDX
#define	DR_REG_XBX DR_REG_RBX
#define	DR_REG_XSP DR_REG_RSP
#define	DR_REG_XBP DR_REG_RBP
#define	DR_REG_XSI DR_REG_RSI
#define	DR_REG_XDI DR_REG_RDI
#define	DR_REG_START_64 DR_REG_RAX
#define	DR_REG_STOP_64 DR_REG_R15
#define	DR_REG_START_32 DR_REG_EAX
#define	DR_REG_STOP_32 DR_REG_R15D
#define	DR_REG_START_16 DR_REG_AX
#define	DR_REG_STOP_16 DR_REG_R15W
#define	DR_REG_START_8 DR_REG_AL
#define	DR_REG_STOP_8 DR_REG_DIL
#define	DR_REG_START_8HL DR_REG_AL
#define	DR_REG_STOP_8HL DR_REG_BH
#define	DR_REG_START_x86_8 DR_REG_AH
#define	DR_REG_STOP_x86_8 DR_REG_BH
#define	DR_REG_START_x64_8 DR_REG_SPL
#define	DR_REG_STOP_x64_8 DR_REG_DIL
#define	DR_REG_START_MMX DR_REG_MM0
#define	DR_REG_STOP_MMX DR_REG_MM7
#define	DR_REG_START_XMM DR_REG_XMM0
#define	DR_REG_STOP_XMM DR_REG_XMM15
#define	DR_REG_START_YMM DR_REG_YMM0
#define	DR_REG_STOP_YMM DR_REG_YMM15
#define	DR_REG_START_FLOAT DR_REG_ST0
#define	DR_REG_STOP_FLOAT DR_REG_ST7
#define	DR_REG_START_SEGMENT DR_SEG_ES
#define	DR_REG_STOP_SEGMENT DR_SEG_GS
#define	DR_REG_START_DR DR_REG_DR0
#define	DR_REG_STOP_DR DR_REG_DR15
#define	DR_REG_START_CR DR_REG_CR0
#define	DR_REG_STOP_CR DR_REG_CR15
#define	DR_REG_LAST_VALID_ENUM DR_REG_YMM15
#define	DR_REG_LAST_ENUM DR_REG_YMM15
#define	OPSZ_PTR OPSZ_8
#define	OPSZ_STACK OPSZ_8
#define	OPSZ_VARSTACK OPSZ_4x8_short2
#define	OPSZ_ret OPSZ_4x8_short2xi8
#define	OPSZ_call OPSZ_ret
#define	OPSZ_lea OPSZ_0
#define	OPSZ_invlpg OPSZ_0
#define	OPSZ_xlat OPSZ_1
#define	OPSZ_clflush OPSZ_1
#define	OPSZ_prefetch OPSZ_1
#define	OPSZ_lgdt OPSZ_6x10
#define	OPSZ_sgdt OPSZ_6x10
#define	OPSZ_lidt OPSZ_6x10
#define	OPSZ_sidt OPSZ_6x10
#define	OPSZ_bound OPSZ_8_short4
#define	OPSZ_maskmovq OPSZ_8
#define	OPSZ_maskmovdqu OPSZ_16
#define	OPSZ_fldenv OPSZ_28_short14
#define	OPSZ_fnstenv OPSZ_28_short14
#define	OPSZ_fnsave OPSZ_108_short94
#define	OPSZ_frstor OPSZ_108_short94
#define	OPSZ_fxsave OPSZ_512
#define	OPSZ_fxrstor OPSZ_512
Enumerations
enum	{ DR_REG_NULL, DR_REG_RAX, DR_REG_RCX, DR_REG_RDX, DR_REG_RBX, DR_REG_RSP, DR_REG_RBP, DR_REG_RSI, DR_REG_RDI, DR_REG_R8, DR_REG_R9, DR_REG_R10, DR_REG_R11, DR_REG_R12, DR_REG_R13, DR_REG_R14, DR_REG_R15, DR_REG_EAX, DR_REG_ECX, DR_REG_EDX, DR_REG_EBX, DR_REG_ESP, DR_REG_EBP, DR_REG_ESI, DR_REG_EDI, DR_REG_R8D, DR_REG_R9D, DR_REG_R10D, DR_REG_R11D, DR_REG_R12D, DR_REG_R13D, DR_REG_R14D, DR_REG_R15D, DR_REG_AX, DR_REG_CX, DR_REG_DX, DR_REG_BX, DR_REG_SP, DR_REG_BP, DR_REG_SI, DR_REG_DI, DR_REG_R8W, DR_REG_R9W, DR_REG_R10W, DR_REG_R11W, DR_REG_R12W, DR_REG_R13W, DR_REG_R14W, DR_REG_R15W, DR_REG_AL, DR_REG_CL, DR_REG_DL, DR_REG_BL, DR_REG_AH, DR_REG_CH, DR_REG_DH, DR_REG_BH, DR_REG_R8L, DR_REG_R9L, DR_REG_R10L, DR_REG_R11L, DR_REG_R12L, DR_REG_R13L, DR_REG_R14L, DR_REG_R15L, DR_REG_SPL, DR_REG_BPL, DR_REG_SIL, DR_REG_DIL, DR_REG_MM0, DR_REG_MM1, DR_REG_MM2, DR_REG_MM3, DR_REG_MM4, DR_REG_MM5, DR_REG_MM6, DR_REG_MM7, DR_REG_XMM0, DR_REG_XMM1, DR_REG_XMM2, DR_REG_XMM3, DR_REG_XMM4, DR_REG_XMM5, DR_REG_XMM6, DR_REG_XMM7, DR_REG_XMM8, DR_REG_XMM9, DR_REG_XMM10, DR_REG_XMM11, DR_REG_XMM12, DR_REG_XMM13, DR_REG_XMM14, DR_REG_XMM15, DR_REG_ST0, DR_REG_ST1, DR_REG_ST2, DR_REG_ST3, DR_REG_ST4, DR_REG_ST5, DR_REG_ST6, DR_REG_ST7, DR_SEG_ES, DR_SEG_CS, DR_SEG_SS, DR_SEG_DS, DR_SEG_FS, DR_SEG_GS, DR_REG_DR0, DR_REG_DR1, DR_REG_DR2, DR_REG_DR3, DR_REG_DR4, DR_REG_DR5, DR_REG_DR6, DR_REG_DR7, DR_REG_DR8, DR_REG_DR9, DR_REG_DR10, DR_REG_DR11, DR_REG_DR12, DR_REG_DR13, DR_REG_DR14, DR_REG_DR15, DR_REG_CR0, DR_REG_CR1, DR_REG_CR2, DR_REG_CR3, DR_REG_CR4, DR_REG_CR5, DR_REG_CR6, DR_REG_CR7, DR_REG_CR8, DR_REG_CR9, DR_REG_CR10, DR_REG_CR11, DR_REG_CR12, DR_REG_CR13, DR_REG_CR14, DR_REG_CR15, DR_REG_INVALID, DR_REG_YMM0, DR_REG_YMM1, DR_REG_YMM2, DR_REG_YMM3, DR_REG_YMM4, DR_REG_YMM5, DR_REG_YMM6, DR_REG_YMM7, DR_REG_YMM8, DR_REG_YMM9, DR_REG_YMM10, DR_REG_YMM11, DR_REG_YMM12, DR_REG_YMM13, DR_REG_YMM14, DR_REG_YMM15 }
enum	{ OPSZ_NA = DR_REG_INVALID+1 , OPSZ_0, OPSZ_1, OPSZ_2, OPSZ_4, OPSZ_6, OPSZ_8, OPSZ_10, OPSZ_16, OPSZ_14, OPSZ_28, OPSZ_94, OPSZ_108, OPSZ_512, OPSZ_2_short1, OPSZ_4_short2, OPSZ_4_rex8_short2, OPSZ_4_rex8, OPSZ_6_irex10_short4, OPSZ_8_short2, OPSZ_8_short4, OPSZ_28_short14, OPSZ_108_short94, OPSZ_4x8, OPSZ_6x10, OPSZ_4x8_short2, OPSZ_4x8_short2xi8, OPSZ_4_short2xi4, OPSZ_1_reg4, OPSZ_2_reg4, OPSZ_4_reg16, OPSZ_xsave, OPSZ_12, OPSZ_32, OPSZ_40, OPSZ_32_short16, OPSZ_8_rex16, OPSZ_8_rex16_short4, OPSZ_12_rex40_short6, OPSZ_16_vex32 }
Functions
opnd_t	opnd_create_null (void)
opnd_t	opnd_create_reg (reg_id_t r)
opnd_t	opnd_create_immed_int (ptr_int_t i, opnd_size_t data_size)
opnd_t	opnd_create_immed_float (float f)
opnd_t	opnd_create_pc (app_pc pc)
opnd_t	opnd_create_far_pc (ushort seg_selector, app_pc pc)
opnd_t	opnd_create_instr (instr_t *instr)
opnd_t	opnd_create_far_instr (ushort seg_selector, instr_t *instr)
opnd_t	opnd_create_base_disp (reg_id_t base_reg, reg_id_t index_reg, int scale, int disp, opnd_size_t data_size)
opnd_t	opnd_create_base_disp_ex (reg_id_t base_reg, reg_id_t index_reg, int scale, int disp, opnd_size_t size, bool encode_zero_disp, bool force_full_disp, bool disp_short_addr)
opnd_t	opnd_create_far_base_disp (reg_id_t seg, reg_id_t base_reg, reg_id_t index_reg, int scale, int disp, opnd_size_t data_size)
opnd_t	opnd_create_far_base_disp_ex (reg_id_t seg, reg_id_t base_reg, reg_id_t index_reg, int scale, int disp, opnd_size_t size, bool encode_zero_disp, bool force_full_disp, bool disp_short_addr)
opnd_t	opnd_create_abs_addr (void *addr, opnd_size_t data_size)
opnd_t	opnd_create_far_abs_addr (reg_id_t seg, void *addr, opnd_size_t data_size)
opnd_t	opnd_create_rel_addr (void *addr, opnd_size_t data_size)
opnd_t	opnd_create_far_rel_addr (reg_id_t seg, void *addr, opnd_size_t data_size)
bool	opnd_is_null (opnd_t opnd)
bool	opnd_is_reg (opnd_t opnd)
bool	opnd_is_immed (opnd_t opnd)
bool	opnd_is_immed_int (opnd_t opnd)
bool	opnd_is_immed_float (opnd_t opnd)
bool	opnd_is_pc (opnd_t opnd)
bool	opnd_is_near_pc (opnd_t opnd)
bool	opnd_is_far_pc (opnd_t opnd)
bool	opnd_is_instr (opnd_t opnd)
bool	opnd_is_near_instr (opnd_t opnd)
bool	opnd_is_far_instr (opnd_t opnd)
bool	opnd_is_base_disp (opnd_t opnd)
bool	opnd_is_near_base_disp (opnd_t opnd)
bool	opnd_is_far_base_disp (opnd_t opnd)
bool	opnd_is_abs_addr (opnd_t opnd)
bool	opnd_is_near_abs_addr (opnd_t opnd)
bool	opnd_is_far_abs_addr (opnd_t opnd)
bool	opnd_is_rel_addr (opnd_t opnd)
bool	opnd_is_near_rel_addr (opnd_t opnd)
bool	opnd_is_far_rel_addr (opnd_t opnd)
bool	opnd_is_memory_reference (opnd_t opnd)
bool	opnd_is_far_memory_reference (opnd_t opnd)
bool	opnd_is_near_memory_reference (opnd_t opnd)
opnd_size_t	opnd_get_size (opnd_t opnd)
void	opnd_set_size (opnd_t *opnd, opnd_size_t newsize)
reg_id_t	opnd_get_reg (opnd_t opnd)
float	opnd_get_immed_float (opnd_t opnd)
app_pc	opnd_get_pc (opnd_t opnd)
ushort	opnd_get_segment_selector (opnd_t opnd)
instr_t *	opnd_get_instr (opnd_t opnd)
reg_id_t	opnd_get_base (opnd_t opnd)
int	opnd_get_disp (opnd_t opnd)
bool	opnd_is_disp_encode_zero (opnd_t opnd)
bool	opnd_is_disp_force_full (opnd_t opnd)
bool	opnd_is_disp_short_addr (opnd_t opnd)
reg_id_t	opnd_get_index (opnd_t opnd)
int	opnd_get_scale (opnd_t opnd)
reg_id_t	opnd_get_segment (opnd_t opnd)
void *	opnd_get_addr (opnd_t opnd)
int	opnd_num_regs_used (opnd_t opnd)
reg_id_t	opnd_get_reg_used (opnd_t opnd, int index)
const char *	get_register_name (reg_id_t reg)
reg_id_t	reg_32_to_16 (reg_id_t reg)
reg_id_t	reg_32_to_8 (reg_id_t reg)
reg_id_t	reg_32_to_64 (reg_id_t reg)
reg_id_t	reg_64_to_32 (reg_id_t reg)
bool	reg_is_extended (reg_id_t reg)
reg_id_t	reg_32_to_opsz (reg_id_t reg, opnd_size_t sz)
int	reg_parameter_num (reg_id_t reg)
bool	reg_is_gpr (reg_id_t reg)
bool	reg_is_segment (reg_id_t reg)
bool	reg_is_xmm (reg_id_t reg)
bool	reg_is_ymm (reg_id_t reg)
bool	reg_is_mmx (reg_id_t reg)
bool	reg_is_fp (reg_id_t reg)
bool	reg_is_32bit (reg_id_t reg)
bool	opnd_is_reg_32bit (opnd_t opnd)
bool	reg_is_64bit (reg_id_t reg)
bool	opnd_is_reg_64bit (opnd_t opnd)
bool	reg_is_pointer_sized (reg_id_t reg)
reg_id_t	reg_to_pointer_sized (reg_id_t reg)
bool	opnd_is_reg_pointer_sized (opnd_t opnd)
bool	reg_overlap (reg_id_t r1, reg_id_t r2)
byte	reg_get_bits (reg_id_t reg)
opnd_size_t	reg_get_size (reg_id_t reg)
bool	opnd_uses_reg (opnd_t opnd, reg_id_t reg)
void	opnd_set_disp (opnd_t *opnd, int disp)
void	opnd_set_disp_ex (opnd_t *opnd, int disp, bool encode_zero_disp, bool force_full_disp, bool disp_short_addr)
bool	opnd_replace_reg (opnd_t *opnd, reg_id_t old_reg, reg_id_t new_reg)
bool	opnd_same (opnd_t op1, opnd_t op2)
bool	opnd_same_address (opnd_t op1, opnd_t op2)
bool	opnd_share_reg (opnd_t op1, opnd_t op2)
bool	opnd_defines_use (opnd_t def, opnd_t use)
uint	opnd_size_in_bytes (opnd_size_t size)
opnd_t	opnd_shrink_to_16_bits (opnd_t opnd)
opnd_t	opnd_shrink_to_32_bits (opnd_t opnd)
reg_t	reg_get_value (reg_id_t reg, dr_mcontext_t *mc)
void	reg_set_value (reg_id_t reg, dr_mcontext_t *mc, reg_t value)
app_pc	opnd_compute_address (opnd_t opnd, dr_mcontext_t *mc)
void	opnd_disassemble (void *drcontext, opnd_t opnd, file_t outfile)
size_t	opnd_disassemble_to_buffer (void drcontext, opnd_t opnd, char buf, size_t bufsz)

Detailed Description

Functions and defines to create and manipulate instruction operands.

Define Documentation

#define DR_REG_LAST_ENUM DR_REG_YMM15

Last value of register enums

#define DR_REG_LAST_VALID_ENUM DR_REG_YMM15

Last valid register enum value. Note: DR_REG_INVALID is now smaller than this value.

#define DR_REG_START_16 DR_REG_AX

Start of 16-bit general register enum values

#define DR_REG_START_32 DR_REG_EAX

Start of 32-bit general register enum values

#define DR_REG_START_64 DR_REG_RAX

Start of 64-bit general register enum values

#define DR_REG_START_8 DR_REG_AL

Start of 8-bit general register enum values

#define DR_REG_START_8HL DR_REG_AL

Start of 8-bit high-low register enum values

#define DR_REG_START_CR DR_REG_CR0

Start of control register enum values

#define DR_REG_START_DR DR_REG_DR0

Start of debug register enum values

#define DR_REG_START_FLOAT DR_REG_ST0

Start of floating-point-register enum values

#define DR_REG_START_MMX DR_REG_MM0

Start of mmx register enum values

#define DR_REG_START_SEGMENT DR_SEG_ES

Start of segment register enum values

#define DR_REG_START_x64_8 DR_REG_SPL

Start of 8-bit x64-only register enum values

#define DR_REG_START_x86_8 DR_REG_AH

Start of 8-bit x86-only register enum values

#define DR_REG_START_XMM DR_REG_XMM0

Start of xmm register enum values

#define DR_REG_START_YMM DR_REG_YMM0

Start of ymm register enum values

#define DR_REG_STOP_16 DR_REG_R15W

End of 16-bit general register enum values

#define DR_REG_STOP_32 DR_REG_R15D

End of 32-bit general register enum values

#define DR_REG_STOP_64 DR_REG_R15

End of 64-bit general register enum values

#define DR_REG_STOP_8 DR_REG_DIL

End of 8-bit general register enum values

#define DR_REG_STOP_8HL DR_REG_BH

End of 8-bit high-low register enum values

#define DR_REG_STOP_CR DR_REG_CR15

End of control register enum values

#define DR_REG_STOP_DR DR_REG_DR15

End of debug register enum values

#define DR_REG_STOP_FLOAT DR_REG_ST7

End of floating-point-register enum values

#define DR_REG_STOP_MMX DR_REG_MM7

End of mmx register enum values

#define DR_REG_STOP_SEGMENT DR_SEG_GS

End of segment register enum values

#define DR_REG_STOP_x64_8 DR_REG_DIL

Stop of 8-bit x64-only register enum values

#define DR_REG_STOP_x86_8 DR_REG_BH

Stop of 8-bit x86-only register enum values

#define DR_REG_STOP_XMM DR_REG_XMM15

End of xmm register enum values

#define DR_REG_STOP_YMM DR_REG_YMM15

End of ymm register enum values

#define DR_REG_XAX DR_REG_RAX

Platform-independent way to refer to rax/eax.

#define DR_REG_XBP DR_REG_RBP

Platform-independent way to refer to rbp/ebp.

#define DR_REG_XBX DR_REG_RBX

Platform-independent way to refer to rbx/ebx.

#define DR_REG_XCX DR_REG_RCX

Platform-independent way to refer to rcx/ecx.

#define DR_REG_XDI DR_REG_RDI

Platform-independent way to refer to rdi/edi.

#define DR_REG_XDX DR_REG_RDX

Platform-independent way to refer to rdx/edx.

#define DR_REG_XSI DR_REG_RSI

Platform-independent way to refer to rsi/esi.

#define DR_REG_XSP DR_REG_RSP

Platform-independent way to refer to rsp/esp.

#define OPSZ_bound OPSZ_8_short4

Operand size for bound memory reference.

#define OPSZ_call OPSZ_ret

Operand size for push portion of call.

#define OPSZ_clflush OPSZ_1

Operand size for clflush memory reference.

#define OPSZ_fldenv OPSZ_28_short14

Operand size for fldenv memory reference.

#define OPSZ_fnsave OPSZ_108_short94

Operand size for fnsave memory reference.

#define OPSZ_fnstenv OPSZ_28_short14

Operand size for fnstenv memory reference.

#define OPSZ_frstor OPSZ_108_short94

Operand size for frstor memory reference.

#define OPSZ_fxrstor OPSZ_512

Operand size for fxrstor memory reference.

#define OPSZ_fxsave OPSZ_512

Operand size for fxsave memory reference.

#define OPSZ_invlpg OPSZ_0

Operand size for invlpg memory reference.

#define OPSZ_lea OPSZ_0

Operand size for lea memory reference.

#define OPSZ_lgdt OPSZ_6x10

Operand size for lgdt memory reference.

#define OPSZ_lidt OPSZ_6x10

Operand size for lidt memory reference.

#define OPSZ_maskmovdqu OPSZ_16

Operand size for maskmovdqu memory reference.

#define OPSZ_maskmovq OPSZ_8

Operand size for maskmovq memory reference.

#define OPSZ_prefetch OPSZ_1

Operand size for prefetch memory references.

#define OPSZ_PTR OPSZ_8

Operand size for pointer values.

#define OPSZ_ret OPSZ_4x8_short2xi8

Operand size for ret instruction.

#define OPSZ_sgdt OPSZ_6x10

Operand size for sgdt memory reference.

#define OPSZ_sidt OPSZ_6x10

Operand size for sidt memory reference.

#define OPSZ_STACK OPSZ_8

Operand size for stack push/pop operand sizes.

#define OPSZ_VARSTACK OPSZ_4x8_short2

Operand size for prefix-varying stack push/pop operand sizes.

#define OPSZ_xlat OPSZ_1

Operand size for xlat memory reference.

Enumeration Type Documentation

anonymous enum

Enumerator:

DR_REG_NULL	Sentinel value indicating no register, for address modes.
DR_REG_RAX	The "rax" register.
DR_REG_RCX	The "rcx" register.
DR_REG_RDX	The "rdx" register.
DR_REG_RBX	The "rbx" register.
DR_REG_RSP	The "rsp" register.
DR_REG_RBP	The "rbp" register.
DR_REG_RSI	The "rsi" register.
DR_REG_RDI	The "rdi" register.
DR_REG_R8	The "r8" register.
DR_REG_R9	The "r9" register.
DR_REG_R10	The "r10" register.
DR_REG_R11	The "r11" register.
DR_REG_R12	The "r12" register.
DR_REG_R13	The "r13" register.
DR_REG_R14	The "r14" register.
DR_REG_R15	The "r15" register.
DR_REG_EAX	The "eax" register.
DR_REG_ECX	The "ecx" register.
DR_REG_EDX	The "edx" register.
DR_REG_EBX	The "ebx" register.
DR_REG_ESP	The "esp" register.
DR_REG_EBP	The "ebp" register.
DR_REG_ESI	The "esi" register.
DR_REG_EDI	The "edi" register.
DR_REG_R8D	The "r8d" register.
DR_REG_R9D	The "r9d" register.
DR_REG_R10D	The "r10d" register.
DR_REG_R11D	The "r11d" register.
DR_REG_R12D	The "r12d" register.
DR_REG_R13D	The "r13d" register.
DR_REG_R14D	The "r14d" register.
DR_REG_R15D	The "r15d" register.
DR_REG_AX	The "ax" register.
DR_REG_CX	The "cx" register.
DR_REG_DX	The "dx" register.
DR_REG_BX	The "bx" register.
DR_REG_SP	The "sp" register.
DR_REG_BP	The "bp" register.
DR_REG_SI	The "si" register.
DR_REG_DI	The "di" register.
DR_REG_R8W	The "r8w" register.
DR_REG_R9W	The "r9w" register.
DR_REG_R10W	The "r10w" register.
DR_REG_R11W	The "r11w" register.
DR_REG_R12W	The "r12w" register.
DR_REG_R13W	The "r13w" register.
DR_REG_R14W	The "r14w" register.
DR_REG_R15W	The "r15w" register.
DR_REG_AL	The "al" register.
DR_REG_CL	The "cl" register.
DR_REG_DL	The "dl" register.
DR_REG_BL	The "bl" register.
DR_REG_AH	The "ah" register.
DR_REG_CH	The "ch" register.
DR_REG_DH	The "dh" register.
DR_REG_BH	The "bh" register.
DR_REG_R8L	The "r8l" register.
DR_REG_R9L	The "r9l" register.
DR_REG_R10L	The "r10l" register.
DR_REG_R11L	The "r11l" register.
DR_REG_R12L	The "r12l" register.
DR_REG_R13L	The "r13l" register.
DR_REG_R14L	The "r14l" register.
DR_REG_R15L	The "r15l" register.
DR_REG_SPL	The "spl" register.
DR_REG_BPL	The "bpl" register.
DR_REG_SIL	The "sil" register.
DR_REG_DIL	The "dil" register.
DR_REG_MM0	The "mm0" register.
DR_REG_MM1	The "mm1" register.
DR_REG_MM2	The "mm2" register.
DR_REG_MM3	The "mm3" register.
DR_REG_MM4	The "mm4" register.
DR_REG_MM5	The "mm5" register.
DR_REG_MM6	The "mm6" register.
DR_REG_MM7	The "mm7" register.
DR_REG_XMM0	The "xmm0" register.
DR_REG_XMM1	The "xmm1" register.
DR_REG_XMM2	The "xmm2" register.
DR_REG_XMM3	The "xmm3" register.
DR_REG_XMM4	The "xmm4" register.
DR_REG_XMM5	The "xmm5" register.
DR_REG_XMM6	The "xmm6" register.
DR_REG_XMM7	The "xmm7" register.
DR_REG_XMM8	The "xmm8" register.
DR_REG_XMM9	The "xmm9" register.
DR_REG_XMM10	The "xmm10" register.
DR_REG_XMM11	The "xmm11" register.
DR_REG_XMM12	The "xmm12" register.
DR_REG_XMM13	The "xmm13" register.
DR_REG_XMM14	The "xmm14" register.
DR_REG_XMM15	The "xmm15" register.
DR_REG_ST0	The "st0" register.
DR_REG_ST1	The "st1" register.
DR_REG_ST2	The "st2" register.
DR_REG_ST3	The "st3" register.
DR_REG_ST4	The "st4" register.
DR_REG_ST5	The "st5" register.
DR_REG_ST6	The "st6" register.
DR_REG_ST7	The "st7" register.
DR_SEG_ES	The "es" register.
DR_SEG_CS	The "cs" register.
DR_SEG_SS	The "ss" register.
DR_SEG_DS	The "ds" register.
DR_SEG_FS	The "fs" register.
DR_SEG_GS	The "gs" register.
DR_REG_DR0	The "dr0" register.
DR_REG_DR1	The "dr1" register.
DR_REG_DR2	The "dr2" register.
DR_REG_DR3	The "dr3" register.
DR_REG_DR4	The "dr4" register.
DR_REG_DR5	The "dr5" register.
DR_REG_DR6	The "dr6" register.
DR_REG_DR7	The "dr7" register.
DR_REG_DR8	The "dr8" register.
DR_REG_DR9	The "dr9" register.
DR_REG_DR10	The "dr10" register.
DR_REG_DR11	The "dr11" register.
DR_REG_DR12	The "dr12" register.
DR_REG_DR13	The "dr13" register.
DR_REG_DR14	The "dr14" register.
DR_REG_DR15	The "dr15" register.
DR_REG_CR0	The "cr0" register.
DR_REG_CR1	The "cr1" register.
DR_REG_CR2	The "cr2" register.
DR_REG_CR3	The "cr3" register.
DR_REG_CR4	The "cr4" register.
DR_REG_CR5	The "cr5" register.
DR_REG_CR6	The "cr6" register.
DR_REG_CR7	The "cr7" register.
DR_REG_CR8	The "cr8" register.
DR_REG_CR9	The "cr9" register.
DR_REG_CR10	The "cr10" register.
DR_REG_CR11	The "cr11" register.
DR_REG_CR12	The "cr12" register.
DR_REG_CR13	The "cr13" register.
DR_REG_CR14	The "cr14" register.
DR_REG_CR15	The "cr15" register.
DR_REG_INVALID	Sentinel value indicating an invalid register.
DR_REG_YMM0	The "ymm0" register.
DR_REG_YMM1	The "ymm1" register.
DR_REG_YMM2	The "ymm2" register.
DR_REG_YMM3	The "ymm3" register.
DR_REG_YMM4	The "ymm4" register.
DR_REG_YMM5	The "ymm5" register.
DR_REG_YMM6	The "ymm6" register.
DR_REG_YMM7	The "ymm7" register.
DR_REG_YMM8	The "ymm8" register.
DR_REG_YMM9	The "ymm9" register.
DR_REG_YMM10	The "ymm10" register.
DR_REG_YMM11	The "ymm11" register.
DR_REG_YMM12	The "ymm12" register.
DR_REG_YMM13	The "ymm13" register.
DR_REG_YMM14	The "ymm14" register.
DR_REG_YMM15	The "ymm15" register.

anonymous enum

Enumerator:

OPSZ_NA	Sentinel value: not a valid size.
OPSZ_0	Intel 'm': "sizeless": used for both start addresses (lea, invlpg) and implicit constants (rol, fldl2e, etc.)
OPSZ_1	Intel 'b': 1 byte
OPSZ_2	Intel 'w': 2 bytes
OPSZ_4	Intel 'd','si': 4 bytes
OPSZ_6	Intel 'p','s': 6 bytes
OPSZ_8	Intel 'q','pi': 8 bytes
OPSZ_10	Intel 's' 64-bit, or double extended precision floating point (latter used by fld, fstp, fbld, fbstp)
OPSZ_16	Intel 'dq','ps','pd','ss','sd': 16 bytes
OPSZ_14	FPU operating environment with short data size (fldenv, fnstenv)
OPSZ_28	FPU operating environment with normal data size (fldenv, fnstenv)
OPSZ_94	FPU state with short data size (fnsave, frstor)
OPSZ_108	FPU state with normal data size (fnsave, frstor)
OPSZ_512	FPU, MMX, XMM state (fxsave, fxrstor)
OPSZ_2_short1	The following sizes (OPSZ__short) vary according to the cs segment and the operand size prefix. This IR assumes that the cs segment is set to the default operand size. The operand size prefix then functions to shrink the size. The IR does not explicitly mark the prefix; rather, a shortened size is requested in the operands themselves, with the IR adding the prefix at encode time. Normally the fixed sizes above should be used rather than these variable sizes, which are used internally by the IR and should only be externally specified when building an operand in order to be flexible and allow other operands to decide the size for the instruction (the prefix applies to the entire instruction). Intel 'c': 2/1 bytes ("2/1" means 2 bytes normally, but if another operand requests a short size then this size can accommodate by shifting to its short size, which is 1 byte).
OPSZ_4_short2	Intel 'z': 4/2 bytes
OPSZ_4_rex8_short2	Intel 'v': 8/4/2 bytes
OPSZ_4_rex8	Intel 'd/q' (like 'v' but never 2 bytes).
OPSZ_6_irex10_short4	Intel 'p': On Intel processors this is 10/6/4 bytes for segment selector + address. On AMD processors this is 6/4 bytes for segment selector + address (rex is ignored).
OPSZ_8_short2	partially resolved 4x8_short2
OPSZ_8_short4	Intel 'a': pair of 4_short2 (bound)
OPSZ_28_short14	FPU operating env variable data size (fldenv, fnstenv)
OPSZ_108_short94	FPU state with variable data size (fnsave, frstor)
OPSZ_4x8	Varies by 32-bit versus 64-bit processor mode. Full register size with no variation by prefix. Used for control and debug register moves.
OPSZ_6x10	Intel 's': 6-byte (10-byte for 64-bit mode) table base + limit
OPSZ_4x8_short2	Stack operands not only vary by operand size specifications but also by 32-bit versus 64-bit processor mode. Intel 'v'/'d64' for stack operations. Also 64-bit address-size specified operands, which are short4 rather than short2 in 64-bit mode (but short2 in 32-bit mode). Note that this IR does not distinguish extra stack operations performed by OP_enter w/ non-zero immed.
OPSZ_4x8_short2xi8	Intel 'f64': 4_short2 for 32-bit, 8_short2 for 64-bit AMD, always 8 for 64-bit Intel
OPSZ_4_short2xi4	Intel 'f64': 4_short2 for 32-bit or 64-bit AMD, always 4 for 64-bit Intel
OPSZ_1_reg4	The following 3 sizes differ based on whether the modrm chooses a register or memory. Intel Rd/Mb: zero-extends if reg; used by pextrb
OPSZ_2_reg4	Intel Rd/Mw: zero-extends if reg; used by pextrw
OPSZ_4_reg16	Intel Udq/Md: sub-xmm but we consider that whole xmm; used by insertps.
OPSZ_xsave	Size is > 512 bytes: use cpuid to determine. Used for FPU, MMX, XMM, etc. state by xsave and xrstor.
OPSZ_12	12 bytes: 32-bit iret
OPSZ_32	32 bytes: pusha/popa Also Intel 'qq','pd','ps','x': 32 bytes (256 bits)
OPSZ_40	40 bytes: 64-bit iret
OPSZ_32_short16	unresolved pusha/popa
OPSZ_8_rex16	cmpxcgh8b/cmpxchg16b
OPSZ_8_rex16_short4	Intel 'v' * 2 (far call/ret)
OPSZ_12_rex40_short6	unresolved iret
OPSZ_16_vex32	16 or 32 bytes depending on VEX.L

Function Documentation

const char* get_register_name ( reg_id_t reg )

Assumes that reg is a DR_REG_ 32-bit register constant. Returns the string name for reg.

app_pc opnd_compute_address	(	opnd_t	opnd,
		dr_mcontext_t *	mc
	)

Returns the effective address of opnd, computed using the passed-in register values. If opnd is a far address, ignores that aspect except for TLS references on Windows (fs: for 32-bit, gs: for 64-bit) or typical fs: or gs: references on Linux. For far addresses the calling thread's segment selector is used. mc->flags must include DR_MC_CONTROL and DR_MC_INTEGER.

opnd_t opnd_create_abs_addr	(	void *	addr,
		opnd_size_t	data_size
	)

Returns a memory reference operand that refers to the address addr. The operand has data size data_size (must be a OPSZ_ constant).

If addr <= 2^32 (which is always true in 32-bit mode), this routine is equivalent to opnd_create_base_disp(DR_REG_NULL, DR_REG_NULL, 0, (int)addr, data_size).

Otherwise, this routine creates a separate operand type with an absolute 64-bit memory address. Note that such an operand can only be used as a load or store from or to the rax register.

opnd_t opnd_create_base_disp	(	reg_id_t	base_reg,
		reg_id_t	index_reg,
		int	scale,
		int	disp,
		opnd_size_t	data_size
	)

Returns a memory reference operand that refers to the address:

disp(base_reg, index_reg, scale)

or, in other words,

base_reg + index_reg*scale + disp

The operand has data size data_size (must be a OPSZ_ constant). Both base_reg and index_reg must be DR_REG_ constants. scale must be either 1, 2, 4, or 8.

opnd_t opnd_create_base_disp_ex	(	reg_id_t	base_reg,
		reg_id_t	index_reg,
		int	scale,
		int	disp,
		opnd_size_t	size,
		bool	encode_zero_disp,
		bool	force_full_disp,
		bool	disp_short_addr
	)

Returns a memory reference operand that refers to the address:

disp(base_reg, index_reg, scale)

or, in other words,

base_reg + index_reg*scale + disp

The operand has data size data_size (must be a OPSZ_ constant). Both base_reg and index_reg must be DR_REG_ constants. scale must be either 1, 2, 4, or 8. Gives control over encoding optimizations:

If encode_zero_disp, a zero value for disp will not be omitted;
If force_full_disp, a small value for disp will not occupy only one byte.
If disp_short_addr, short (16-bit for 32-bit mode, 32-bit for 64-bit mode) addressing will be used (note that this normally only needs to be specified for an absolute address; otherwise, simply use the desired short registers for base and/or index).

(Both of those are false when using opnd_create_base_disp()).

opnd_t opnd_create_far_abs_addr	(	reg_id_t	seg,
		void *	addr,
		opnd_size_t	data_size
	)

Returns a memory reference operand that refers to the address seg: addr. The operand has data size data_size (must be a OPSZ_ constant).

If addr <= 2^32 (which is always true in 32-bit mode), this routine is equivalent to opnd_create_far_base_disp(seg, DR_REG_NULL, DR_REG_NULL, 0, (int)addr, data_size).

Otherwise, this routine creates a separate operand type with an absolute 64-bit memory address. Note that such an operand can only be used as a load or store from or to the rax register.

opnd_t opnd_create_far_base_disp	(	reg_id_t	seg,
		reg_id_t	base_reg,
		reg_id_t	index_reg,
		int	scale,
		int	disp,
		opnd_size_t	data_size
	)

Returns a far memory reference operand that refers to the address:

seg : disp(base_reg, index_reg, scale)

or, in other words,

seg : base_reg + index_reg*scale + disp

The operand has data size data_size (must be a OPSZ_ constant). seg must be a DR_SEG_ constant. Both base_reg and index_reg must be DR_REG_ constants. scale must be either 1, 2, 4, or 8.

opnd_t opnd_create_far_base_disp_ex	(	reg_id_t	seg,
		reg_id_t	base_reg,
		reg_id_t	index_reg,
		int	scale,
		int	disp,
		opnd_size_t	size,
		bool	encode_zero_disp,
		bool	force_full_disp,
		bool	disp_short_addr
	)

Returns a far memory reference operand that refers to the address:

seg : disp(base_reg, index_reg, scale)

or, in other words,

seg : base_reg + index_reg*scale + disp

The operand has data size data_size (must be a OPSZ_ constant). seg must be a DR_SEG_ constant. Both base_reg and index_reg must be DR_REG_ constants. scale must be either 1, 2, 4, or 8. Gives control over encoding optimizations:

If encode_zero_disp, a zero value for disp will not be omitted;
If force_full_disp, a small value for disp will not occupy only one byte.
If disp_short_addr, short (16-bit for 32-bit mode, 32-bit for 64-bit mode) addressing will be used (note that this normally only needs to be specified for an absolute address; otherwise, simply use the desired short registers for base and/or index).

(Both of those are false when using opnd_create_far_base_disp()).

opnd_t opnd_create_far_instr	(	ushort	seg_selector,
		instr_t *	instr
	)

Returns a far instr_t pointer address with value seg_selector:instr. seg_selector is a segment selector, not a DR_SEG_ constant.

opnd_t opnd_create_far_pc	(	ushort	seg_selector,
		app_pc	pc
	)

Returns a far program address operand with value seg_selector:pc. seg_selector is a segment selector, not a DR_SEG_ constant.

opnd_t opnd_create_far_rel_addr	(	reg_id_t	seg,
		void *	addr,
		opnd_size_t	data_size
	)

Returns a memory reference operand that refers to the address seg : addr, but will be encoded as a pc-relative address. It is up to the caller to ensure that the resulting address is reachable via a 32-bit signed displacement from the next instruction at emit time.

DR guarantees that all of its code caches and heap are within the same 2GB memory region. DR also loads client libraries within 32-bit reachability of its code caches and heap. This means that any static data or code in a client library, or any data allocated using DR's API, is guaranteed to be reachable from code cache code.

The operand has data size data_size (must be a OPSZ_ constant).

To represent a 32-bit address (i.e., what an address size prefix indicates), simply zero out the top 32 bits of the address before passing it to this routine.

Note:: For 64-bit DR builds only.

opnd_t opnd_create_immed_float ( float f )

Returns an immediate float operand with value f. The caller's code should use proc_save_fpstate() or be inside a clean call that has requested to preserve the floating-point state.

opnd_t opnd_create_immed_int	(	ptr_int_t	i,
		opnd_size_t	data_size
	)

Returns an immediate integer operand with value i and size data_size; data_size must be a OPSZ_ constant.

opnd_t opnd_create_instr ( instr_t * instr )

Returns an instr_t pointer address with value instr.

opnd_t opnd_create_null ( void )

Returns an empty operand.

opnd_t opnd_create_pc ( app_pc pc )

Returns a program address operand with value pc.

opnd_t opnd_create_reg ( reg_id_t r )

Returns a register operand (r must be a DR_REG_ constant).

opnd_t opnd_create_rel_addr	(	void *	addr,
		opnd_size_t	data_size
	)

Returns a memory reference operand that refers to the address addr, but will be encoded as a pc-relative address. At emit time, if addr is out of reach of a 32-bit signed displacement from the next instruction, encoding will fail.

DR guarantees that all of its code caches and heap are within the same 2GB memory region. DR also loads client libraries within 32-bit reachability of its code caches and heap. This means that any static data or code in a client library, or any data allocated using DR's API, is guaranteed to be reachable from code cache code.

The operand has data size data_size (must be a OPSZ_ constant).

To represent a 32-bit address (i.e., what an address size prefix indicates), simply zero out the top 32 bits of the address before passing it to this routine.

Note:: For 64-bit DR builds only.

bool opnd_defines_use	(	opnd_t	def,
		opnd_t	use
	)

Returns true iff def, considered as a write, affects use. Is conservative, so if both def and use are memory references, will return true unless it can disambiguate them based on their registers and displacement.

void opnd_disassemble	(	void *	drcontext,
		opnd_t	opnd,
		file_t	outfile
	)

Prints the operand opnd to file outfile. The default is to use AT&T-style syntax, unless the -syntax_intel runtime option is specified.

size_t opnd_disassemble_to_buffer	(	void *	drcontext,
		opnd_t	opnd,
		char *	buf,
		size_t	bufsz
	)

Prints the operand opnd to the buffer buf. Always null-terminates, and will not print more than bufsz characters, which includes the final null character. Returns the number of characters printed, not including the final null. The default is to use AT&T-style syntax, unless the -syntax_intel runtime option is specified.

void* opnd_get_addr ( opnd_t opnd )

Assumes opnd is a (near or far) absolute or pc-relative memory reference, or a base+disp memory reference with no base or index register. Returns opnd's absolute address (which will be pc-relativized on encoding for pc-relative memory references).

reg_id_t opnd_get_base ( opnd_t opnd )

Assumes opnd is a (near or far) base+disp memory reference. Returns the base register (a DR_REG_ constant).

int opnd_get_disp ( opnd_t opnd )

Assumes opnd is a (near or far) base+disp memory reference. Returns the displacement.

float opnd_get_immed_float ( opnd_t opnd )

Assumes opnd is an immediate float and returns its value. The caller's code should use proc_save_fpstate() or be inside a clean call that has requested to preserve the floating-point state.

reg_id_t opnd_get_index ( opnd_t opnd )

Assumes opnd is a (near or far) base+disp memory reference. Returns the index register (a DR_REG_ constant).

instr_t* opnd_get_instr ( opnd_t opnd )

Assumes opnd is an instr_t pointer, returns its value.

app_pc opnd_get_pc ( opnd_t opnd )

Assumes opnd is a (near or far) program address, returns its value.

reg_id_t opnd_get_reg ( opnd_t opnd )

Assumes opnd is a register operand. Returns the register it refers to (a DR_REG_ constant).

reg_id_t opnd_get_reg_used	(	opnd_t	opnd,
		int	index
	)

Used in conjunction with opnd_num_regs_used(), this routine can be used to iterate through all registers used by opnd. The index values begin with 0 and proceed through opnd_num_regs_used(opnd)-1.

int opnd_get_scale ( opnd_t opnd )

Assumes opnd is a (near or far) base+disp memory reference. Returns the scale.

reg_id_t opnd_get_segment ( opnd_t opnd )

Assumes opnd is a (near or far) memory reference of any type. Returns opnd's segment (a DR_SEG_ constant), or DR_REG_NULL if it is a near memory reference.

ushort opnd_get_segment_selector ( opnd_t opnd )

Assumes opnd is a far program address. Returns opnd's segment, a segment selector (not a DR_SEG_ constant).

opnd_size_t opnd_get_size ( opnd_t opnd )

Return the data size of opnd as a OPSZ_ constant. Assumes opnd is a register, immediate integer, or memory reference. If opnd is a register returns the result of opnd_reg_get_size() called on the DR_REG_ constant. Returns OPSZ_NA if opnd does not have a valid size.

bool opnd_is_abs_addr ( opnd_t opnd )

Returns true iff opnd is a (near or far) absolute address operand. Returns true for both base-disp operands with no base or index and 64-bit non-base-disp absolute address operands.

bool opnd_is_base_disp ( opnd_t opnd )

Returns true iff opnd is a (near or far) base+disp memory reference operand.

bool opnd_is_disp_encode_zero ( opnd_t opnd )

Assumes opnd is a (near or far) base+disp memory reference; returns whether encode_zero_disp has been specified for opnd.

bool opnd_is_disp_force_full ( opnd_t opnd )

Assumes opnd is a (near or far) base+disp memory reference; returns whether force_full_disp has been specified for opnd.

bool opnd_is_disp_short_addr ( opnd_t opnd )

Assumes opnd is a (near or far) base+disp memory reference; returns whether disp_short_addr has been specified for opnd.

bool opnd_is_far_abs_addr ( opnd_t opnd )

Returns true iff opnd is a far absolute address operand. Returns true for both base-disp operands with no base or index and 64-bit non-base-disp absolute address operands.

bool opnd_is_far_base_disp ( opnd_t opnd )

Returns true iff opnd is a far base+disp memory reference operand.

bool opnd_is_far_instr ( opnd_t opnd )

Returns true iff opnd is a far instr_t pointer address operand.

bool opnd_is_far_memory_reference ( opnd_t opnd )

Returns true iff opnd is a far memory reference operand of any type: base-disp, absolute address, or pc-relative address.

bool opnd_is_far_pc ( opnd_t opnd )

Returns true iff opnd is a far program address operand.

bool opnd_is_far_rel_addr ( opnd_t opnd )

Returns true iff opnd is a far pc-relative memory reference operand.

Note:: For 64-bit DR builds only.

bool opnd_is_immed ( opnd_t opnd )

Returns true iff opnd is an immediate (integer or float) operand.

bool opnd_is_immed_float ( opnd_t opnd )

Returns true iff opnd is an immediate float operand.

bool opnd_is_immed_int ( opnd_t opnd )

Returns true iff opnd is an immediate integer operand.

bool opnd_is_instr ( opnd_t opnd )

Returns true iff opnd is a (near or far) instr_t pointer address operand.

bool opnd_is_memory_reference ( opnd_t opnd )

Returns true iff opnd is a (near or far) memory reference operand of any type: base-disp, absolute address, or pc-relative address.

Note:: For 64-bit DR builds only.

bool opnd_is_near_abs_addr ( opnd_t opnd )

Returns true iff opnd is a near (i.e., default segment) absolute address operand. Returns true for both base-disp operands with no base or index and 64-bit non-base-disp absolute address operands.

bool opnd_is_near_base_disp ( opnd_t opnd )

Returns true iff opnd is a near (i.e., default segment) base+disp memory reference operand.

bool opnd_is_near_instr ( opnd_t opnd )

Returns true iff opnd is a near instr_t pointer address operand.

bool opnd_is_near_memory_reference ( opnd_t opnd )

Returns true iff opnd is a near memory reference operand of any type: base-disp, absolute address, or pc-relative address.

bool opnd_is_near_pc ( opnd_t opnd )

Returns true iff opnd is a near (i.e., default segment) program address operand.

bool opnd_is_near_rel_addr ( opnd_t opnd )

Returns true iff opnd is a near (i.e., default segment) pc-relative memory reference operand.

Note:: For 64-bit DR builds only.

bool opnd_is_null ( opnd_t opnd )

Returns true iff opnd is an empty operand.

bool opnd_is_pc ( opnd_t opnd )

Returns true iff opnd is a (near or far) program address operand.

bool opnd_is_reg ( opnd_t opnd )

Returns true iff opnd is a register operand.

bool opnd_is_reg_32bit ( opnd_t opnd )

Returns true iff opnd is a register operand that refers to a 32-bit general-purpose register.

bool opnd_is_reg_64bit ( opnd_t opnd )

Returns true iff opnd is a register operand that refers to a 64-bit general-purpose register.

bool opnd_is_reg_pointer_sized ( opnd_t opnd )

Returns true iff opnd is a register operand that refers to a pointer-sized general-purpose register.

bool opnd_is_rel_addr ( opnd_t opnd )

Returns true iff opnd is a (near or far) pc-relative memory reference operand.

Note:: For 64-bit DR builds only.

int opnd_num_regs_used ( opnd_t opnd )

Returns the number of registers referred to by opnd. This will only be non-zero for register operands and memory references.

bool opnd_replace_reg	(	opnd_t *	opnd,
		reg_id_t	old_reg,
		reg_id_t	new_reg
	)

Assumes that both old_reg and new_reg are DR_REG_ constants. Replaces all occurrences of old_reg in *opnd with new_reg.

bool opnd_same	(	opnd_t	op1,
		opnd_t	op2
	)

Returns true iff op1 and op2 are indistinguishable. If either uses variable operand sizes, the default size is assumed.

bool opnd_same_address	(	opnd_t	op1,
		opnd_t	op2
	)

Returns true iff op1 and op2 are both memory references and they are indistinguishable, ignoring data size.

void opnd_set_disp	(	opnd_t *	opnd,
		int	disp
	)

Set the displacement of a memory reference operand opnd to disp.

void opnd_set_disp_ex	(	opnd_t *	opnd,
		int	disp,
		bool	encode_zero_disp,
		bool	force_full_disp,
		bool	disp_short_addr
	)

Set the displacement and encoding controls of a memory reference operand:

If encode_zero_disp, a zero value for disp will not be omitted;
If force_full_disp, a small value for disp will not occupy only one byte.

If disp_short_addr, short (16-bit for 32-bit mode, 32-bit for 64-bit mode) addressing will be used (note that this normally only needs to be specified for an absolute address; otherwise, simply use the desired short registers for base and/or index).

void opnd_set_size	(	opnd_t *	opnd,
		opnd_size_t	newsize
	)

Sets the data size of opnd. Assumes opnd is an immediate integer or a memory reference.

bool opnd_share_reg	(	opnd_t	op1,
		opnd_t	op2
	)

Returns true iff there exists some register that is referred to (directly or overlapping) by both op1 and op2.

opnd_t opnd_shrink_to_16_bits ( opnd_t opnd )

Shrinks all 32-bit registers in opnd to their 16-bit versions. Also shrinks the size of immediate integers and memory references from OPSZ_4 to OPSZ_2.

opnd_t opnd_shrink_to_32_bits ( opnd_t opnd )

Shrinks all 64-bit registers in opnd to their 32-bit versions. Also shrinks the size of immediate integers and memory references from OPSZ_8 to OPSZ_4.

Note:: For 64-bit DR builds only.

uint opnd_size_in_bytes ( opnd_size_t size )

Assumes size is a OPSZ_ or a DR_REG_ constant. If size is a DR_REG_ constant, first calls reg_get_size(size) to get a OPSZ_ constant. Returns the number of bytes the OPSZ_ constant represents. If OPSZ_ is a variable-sized size, returns the default size, which may or may not match the actual size decided up on at encoding time (that final size depends on other operands).

bool opnd_uses_reg	(	opnd_t	opnd,
		reg_id_t	reg
	)

Assumes that reg is a DR_REG_ constant. Returns true iff opnd refers to reg directly or refers to a register that overlaps reg (e.g., DR_REG_AX overlaps DR_REG_EAX).

reg_id_t reg_32_to_16 ( reg_id_t reg )

Assumes that reg is a DR_REG_ 32-bit register constant. Returns the 16-bit version of reg.

reg_id_t reg_32_to_64 ( reg_id_t reg )

Assumes that reg is a DR_REG_ 32-bit register constant. Returns the 64-bit version of reg.

Note:: For 64-bit DR builds only.

reg_id_t reg_32_to_8 ( reg_id_t reg )

Assumes that reg is a DR_REG_ 32-bit register constant. Returns the 8-bit version of reg (the least significant byte: DR_REG_AL instead of DR_REG_AH if passed DR_REG_EAX, e.g.). For 32-bit DR builds, returns DR_REG_NULL if passed DR_REG_ESP, DR_REG_EBP, DR_REG_ESI, or DR_REG_EDI.

reg_id_t reg_32_to_opsz	(	reg_id_t	reg,
		opnd_size_t	sz
	)

Assumes that reg is a DR_REG_ 32-bit register constant. If sz == OPSZ_2, returns the 16-bit version of reg. For 64-bit versions of this library, if sz == OPSZ_8, returns the 64-bit version of reg.

reg_id_t reg_64_to_32 ( reg_id_t reg )

Assumes that reg is a DR_REG_ 64-bit register constant. Returns the 32-bit version of reg.

Note:: For 64-bit DR builds only.

byte reg_get_bits ( reg_id_t reg )

Assumes that reg is a DR_REG_ constant. Returns reg's representation as 3 bits in a modrm byte (the 3 bits are the lower-order bits in the return value).

opnd_size_t reg_get_size ( reg_id_t reg )

Assumes that reg is a DR_REG_ constant. Returns the OPSZ_ constant corresponding to the register size. Returns OPSZ_NA if reg is not a DR_REG_ constant.

reg_t reg_get_value	(	reg_id_t	reg,
		dr_mcontext_t *	mc
	)

Returns the value of the register reg, selected from the passed-in register values. Supports only general-purpose registers. mc->flags must include DR_MC_CONTROL and DR_MC_INTEGER.

bool reg_is_32bit ( reg_id_t reg )

Assumes that reg is a DR_REG_ constant. Returns true iff it refers to a 32-bit general-purpose register.

bool reg_is_64bit ( reg_id_t reg )

Assumes that reg is a DR_REG_ constant. Returns true iff it refers to a 64-bit general-purpose register.

bool reg_is_extended ( reg_id_t reg )

Returns true iff reg refers to an extended register only available in 64-bit mode and not in 32-bit mode (e.g., R8-R15, XMM8-XMM15, etc.)

Note:: For 64-bit DR builds only.

bool reg_is_fp ( reg_id_t reg )

Assumes that reg is a DR_REG_ constant. Returns true iff it refers to a floating-point register.

bool reg_is_gpr ( reg_id_t reg )

Assumes that reg is a DR_REG_ constant. Returns true iff it refers to a General Purpose Register, i.e., rax, rcx, rdx, rbx, rsp, rbp, rsi, rdi, or a subset.

bool reg_is_mmx ( reg_id_t reg )

Assumes that reg is a DR_REG_ constant. Returns true iff it refers to an mmx (64-bit) register.

bool reg_is_pointer_sized ( reg_id_t reg )

Assumes that reg is a DR_REG_ constant. Returns true iff it refers to a pointer-sized general-purpose register.

bool reg_is_segment ( reg_id_t reg )

Assumes that reg is a DR_REG_ constant. Returns true iff it refers to a segment (i.e., it's really a DR_SEG_ constant).

bool reg_is_xmm ( reg_id_t reg )

Assumes that reg is a DR_REG_ constant. Returns true iff it refers to an xmm (128-bit SSE/SSE2) register or a ymm (256-bit multimedia) register.

bool reg_is_ymm ( reg_id_t reg )

Assumes that reg is a DR_REG_ constant. Returns true iff it refers to a ymm (256-bit multimedia) register.

bool reg_overlap	(	reg_id_t	r1,
		reg_id_t	r2
	)

Assumes that r1 and r2 are both DR_REG_ constants. Returns true iff r1's register overlaps r2's register (e.g., if r1 == DR_REG_AX and r2 == DR_REG_EAX).

int reg_parameter_num ( reg_id_t reg )

Assumes that reg is a DR_REG_ register constant. If reg is used as part of the calling convention, returns which parameter ordinal it matches (0-based); otherwise, returns -1.

void reg_set_value	(	reg_id_t	reg,
		dr_mcontext_t *	mc,
		reg_t	value
	)

Sets the register reg in the passed in mcontext mc to value. mc->flags must include DR_MC_CONTROL and DR_MC_INTEGER.

Note:: Current release is limited to setting pointer-sized registers only (no sub-registers, and no non-general-purpose registers).

reg_id_t reg_to_pointer_sized ( reg_id_t reg )

Assumes that reg is a DR_REG_ 32-bit register constant. Returns the pointer-sized version of reg.

dr_ir_opnd.h File Reference

Defines

Enumerations

Functions

Detailed Description

Define Documentation

Enumeration Type Documentation

Function Documentation