opdis/opdis.h

Go to the documentation of this file.

#ifndef OPDIS_H
#define OPDIS_H

#include <dis-asm.h>            /* libopcodes (provided by binutils-dev) */

#include <opdis/types.h>
#include <opdis/insn_buf.h>
#include <opdis/model.h>
#include <opdis/tree.h>

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


#ifdef __cplusplus
extern "C"
{
#endif

/* ---------------------------------------------------------------------- */

typedef int (*OPDIS_HANDLER) ( const opdis_insn_t * i, void * arg );

int opdis_default_handler( const opdis_insn_t * i, void * arg );

typedef void (*OPDIS_DISPLAY) ( const opdis_insn_t * i, void * arg );

void opdis_default_display ( const opdis_insn_t * i, void * arg );

typedef int (*OPDIS_DECODER) ( const opdis_insn_buf_t in, 
                               opdis_insn_t * out,
                               const opdis_byte_t * buf, 
                               opdis_off_t offset,
                               opdis_vma_t vma,
                               opdis_off_t length,
                               void * arg );

int opdis_default_decoder( const opdis_insn_buf_t in, opdis_insn_t * out,
                           const opdis_byte_t * buf, opdis_off_t,
                           opdis_vma_t vma, opdis_off_t length,
                           void * arg );

typedef opdis_vma_t (*OPDIS_RESOLVER) ( const opdis_insn_t * i, void * arg );

opdis_vma_t opdis_default_resolver( const opdis_insn_t * i, void * arg );

enum opdis_error_t { opdis_error_unknown, 
                     opdis_error_bounds,        
                     opdis_error_invalid_insn,  
                     opdis_error_decode_insn,   
                     opdis_error_bfd,           
                     opdis_error_max_items      
                   };

typedef void (*OPDIS_ERROR) ( enum opdis_error_t error, const char * msg,
                              void * arg );

void opdis_default_error_reporter( enum opdis_error_t error, const char * msg,
                              void * arg );

/* ---------------------------------------------------------------------- */

typedef struct {
        disassemble_info config;

        disassembler_ftype disassembler;

        OPDIS_ERROR error_reporter;
        void * error_reporter_arg;

        OPDIS_DISPLAY display;
        void * display_arg;

        OPDIS_HANDLER handler;
        void * handler_arg;

        OPDIS_RESOLVER resolver;
        void * resolver_arg;

        OPDIS_DECODER decoder;
        void * decoder_arg;

        opdis_insn_buf_t buf;


        opdis_vma_tree_t visited_addr;

        int debug;
} opdis_info_t;

typedef opdis_info_t * opdis_t;

/* ---------------------------------------------------------------------- */

opdis_t LIBCALL opdis_init( void );


opdis_t LIBCALL opdis_init_from_bfd( bfd * target );

void LIBCALL opdis_term( opdis_t o );


void LIBCALL opdis_set_defaults( opdis_t o );

enum opdis_x86_syntax_t { 
        opdis_x86_syntax_intel,         
        opdis_x86_syntax_att            
};

void LIBCALL opdis_set_x86_syntax( opdis_t o, enum opdis_x86_syntax_t syntax );

void LIBCALL opdis_set_arch( opdis_t o, enum bfd_architecture arch, 
                             unsigned long mach, disassembler_ftype fn );

void LIBCALL opdis_set_disassembler_options( opdis_t o, const char * options );

void LIBCALL opdis_set_display( opdis_t o, OPDIS_DISPLAY fn, void * arg );

void LIBCALL opdis_set_handler( opdis_t o, OPDIS_HANDLER fn, void * arg );

void LIBCALL opdis_set_decoder( opdis_t o, OPDIS_DECODER fn, void * arg );

void LIBCALL opdis_set_resolver( opdis_t o, OPDIS_RESOLVER fn, void * arg );

void LIBCALL opdis_set_error_reporter( opdis_t o, OPDIS_ERROR fn, void * arg );

unsigned int LIBCALL opdis_disasm_insn_size( opdis_t o, opdis_buf_t buf, 
                                             opdis_vma_t vma );

// TODO: opdis_disam_invariant
//       * wraps decoder
//       * after decode, find addr arguments in insns bytes (search backwards
//         from end) and wildcard them out of bytes to create signature
unsigned int LIBCALL opdis_disasm_insn( opdis_t o, opdis_buf_t buf, 
                                        opdis_vma_t vma, 
                                        opdis_insn_t * insn );

int LIBCALL opdis_disasm_linear( opdis_t o, opdis_buf_t buf, opdis_vma_t vma,
                                 opdis_off_t length );
int LIBCALL opdis_disasm_cflow( opdis_t o, opdis_buf_t buf, 
                                opdis_vma_t vma );
int LIBCALL opdis_disasm_bfd_linear( opdis_t o, bfd * abfd, opdis_vma_t vma,
                                     opdis_off_t length );
int LIBCALL opdis_disasm_bfd_cflow( opdis_t o, bfd * abfd, opdis_vma_t vma );

int LIBCALL opdis_disasm_bfd_section( opdis_t o, asection * sec );

int LIBCALL opdis_disasm_bfd_symbol( opdis_t o, asymbol * sym );

int LIBCALL opdis_disasm_bfd_entry( opdis_t o, bfd * abfd );

void LIBCALL opdis_error( opdis_t o, enum opdis_error_t error, 
                          const char * msg );

void LIBCALL opdis_debug( opdis_t o, int min_level, const char * format, ... );

#ifdef __cplusplus
}
#endif

#endif

---