opdis/model.h

Go to the documentation of this file.

#ifndef OPDIS_MODEL_H
#define OPDIS_MODEL_H

#include <opdis/metadata.h>
#include <opdis/types.h>

#ifdef WIN32
        #define LIBCALL _stdcall
#else
        #define LIBCALL
#endif

enum opdis_insn_decode_t {
        opdis_decode_invalid = 0,       
        opdis_decode_basic = 1,         
        opdis_decode_mnem = 2,          
        opdis_decode_ops = 4,           
        opdis_decode_mnem_flags = 8,    
        opdis_decode_op_flags = 16      
};

/* ---------------------------------------------------------------------- */
/* OPERAND */

#define OPDIS_REG_NAME_SZ 16

typedef struct {
        char ascii[OPDIS_REG_NAME_SZ];  
        enum opdis_reg_flag_t flags;    
        unsigned char id;               
        unsigned char size;             
} opdis_reg_t;

typedef struct {
        opdis_reg_t segment;
        uint64_t offset;
} opdis_abs_addr_t;

enum opdis_addr_expr_elem_t {
        opdis_addr_expr_base = 1,       
        opdis_addr_expr_index = 2,      
        opdis_addr_expr_disp = 4,       
        opdis_addr_expr_disp_u = 8,     
        opdis_addr_expr_disp_s = 16,    
        opdis_addr_expr_disp_abs = 32   
};

enum opdis_addr_expr_shift_t {
        opdis_addr_expr_lsl,            
        opdis_addr_expr_lsr,            
        opdis_addr_expr_asl,            
        opdis_addr_expr_ror,            
        opdis_addr_expr_rrx             
};

typedef struct {
        enum opdis_addr_expr_elem_t elements;
        enum opdis_addr_expr_shift_t shift;
        char scale; 
        opdis_reg_t index;
        opdis_reg_t base;
        union {
                uint64_t u;
                int32_t s;
                opdis_abs_addr_t a;
        } displacement;
} opdis_addr_expr_t;

typedef struct {
        char * ascii;                   
        enum opdis_op_cat_t category;   
        enum opdis_op_flag_t flags;     
        union {
                opdis_reg_t reg;        
                opdis_addr_expr_t expr; 
                opdis_abs_addr_t abs;   
                union {
                        opdis_vma_t vma;
                        uint64_t u;     
                        int64_t s;      
                } immediate;            
        } value;                        
        unsigned char data_size;        
        /* fixed-size operand fields */
        unsigned char fixed_size;       
        unsigned char ascii_sz;         
} opdis_op_t;

/* ---------------------------------------------------------------------- */
/* INSTRUCTION */

typedef struct {
        enum opdis_insn_decode_t status;
        char * ascii;                   
        opdis_off_t offset;             
        opdis_vma_t vma;                
        opdis_off_t size;               
        opdis_byte_t * bytes;           
        /* instruction  */
        opdis_off_t num_prefixes;       
        char * prefixes;                
        char * mnemonic;                
        enum opdis_insn_cat_t category; 
        enum opdis_insn_subset_t isa;   
        union {
                enum opdis_cflow_flag_t cflow;  
                enum opdis_stack_flag_t stack;  
                enum opdis_io_flag_t io;        
                enum opdis_bit_flag_t bit;      
        } flags;                        
        char * comment;                 
        /* operands */
        opdis_off_t num_operands;       
        opdis_off_t alloc_operands;     
        opdis_op_t ** operands;         
        /* accessors for special operands */
        opdis_op_t * target;            
        opdis_op_t * dest;              
        opdis_op_t * src;               
        /* fixed-size instruction fields */
        unsigned char fixed_size;       
        unsigned char ascii_sz;         
        unsigned char mnemonic_sz;      
} opdis_insn_t;

/* ---------------------------------------------------------------------- */
#ifdef __cplusplus
extern "C"
{
#endif


opdis_insn_t * LIBCALL opdis_insn_alloc(  opdis_off_t num_operands );

opdis_insn_t * LIBCALL opdis_insn_alloc_fixed( size_t ascii_sz, 
                                size_t mnemonic_sz, size_t num_operands,
                                size_t op_ascii_sz );

opdis_insn_t * LIBCALL opdis_insn_dupe( const opdis_insn_t * i );

void LIBCALL opdis_insn_clear( opdis_insn_t * i );

void LIBCALL opdis_insn_free( opdis_insn_t * i );

void LIBCALL opdis_insn_set_ascii( opdis_insn_t * i, const char * ascii );

void LIBCALL opdis_insn_set_mnemonic( opdis_insn_t * i, const char * mnemonic );

void LIBCALL opdis_insn_add_prefix( opdis_insn_t * i, const char * prefix );

void LIBCALL opdis_insn_add_comment( opdis_insn_t * i, const char * cmt );

int LIBCALL opdis_insn_add_operand( opdis_insn_t * i, opdis_op_t * op );

opdis_op_t * LIBCALL opdis_insn_next_avail_op( opdis_insn_t * i );

int LIBCALL opdis_insn_is_branch( opdis_insn_t * insn );

int LIBCALL opdis_insn_fallthrough( opdis_insn_t * insn );

int LIBCALL opdis_insn_isa_str( const opdis_insn_t * i, char * buf, 
                                int buf_len );

int LIBCALL opdis_insn_cat_str( const opdis_insn_t * i, char * buf, 
                                int buf_len );

int LIBCALL opdis_insn_flags_str( const opdis_insn_t * i, char * buf, 
                                  int buf_len, const char * delim );

opdis_op_t * LIBCALL opdis_op_alloc( void );

opdis_op_t * LIBCALL opdis_op_alloc_fixed( size_t ascii_sz );

opdis_op_t * LIBCALL opdis_op_dupe(  opdis_op_t * op );

void LIBCALL opdis_op_clear( opdis_op_t * o );

void LIBCALL opdis_op_free( opdis_op_t * op );

void LIBCALL opdis_op_set_ascii( opdis_op_t * op, const char * ascii );

int LIBCALL opdis_op_cat_str( const opdis_op_t * op, char * buf, int buf_len );

int LIBCALL opdis_op_flags_str( const opdis_op_t * op, char * buf, int buf_len,
                                const char * delim );

int LIBCALL opdis_reg_flags_str( const opdis_reg_t * reg, char * buf, 
                                 int buf_len, const char * delim );
int LIBCALL opdis_addr_expr_shift_str( const opdis_addr_expr_t * exp, 
                                        char * buf, int buf_len );

#ifdef __cplusplus
}
#endif

#endif

---