cs_priv.h

Go to the documentation of this file.

/* Capstone Disassembly Engine */
/* By Nguyen Anh Quynh <aquynh@gmail.com>, 2013-2015 */
 
#ifndef CS_PRIV_H
#define CS_PRIV_H
 
#ifdef CAPSTONE_DEBUG
#include <assert.h>
#endif
#include <capstone/capstone.h>
 
#include "MCInst.h"
#include "SStream.h"
 
typedef void (*Printer_t)(MCInst *MI, SStream *OS, void *info);
 
// function to be called after Printer_t
// this is the best time to gather insn's characteristics
typedef void (*PostPrinter_t)(csh handle, cs_insn *, char *mnem, MCInst *mci);
 
typedef bool (*Disasm_t)(csh handle, const uint8_t *code, size_t code_len, MCInst *instr, uint16_t *size, uint64_t address, void *info);
 
typedef const char *(*GetName_t)(csh handle, unsigned int id);
 
typedef void (*GetID_t)(cs_struct *h, cs_insn *insn, unsigned int id);
 
// return register name, given register ID
typedef const char *(*GetRegisterName_t)(unsigned RegNo);
 
// return registers accessed by instruction
typedef void (*GetRegisterAccess_t)(const cs_insn *insn,
        cs_regs regs_read, uint8_t *regs_read_count,
        cs_regs regs_write, uint8_t *regs_write_count);
 
// for ARM only
typedef struct ARM_ITStatus {
    unsigned char ITStates[8];
    unsigned int size;
} ARM_ITStatus;
 
// Customize mnemonic for instructions with alternative name.
struct customized_mnem {
    // ID of instruction to be customized.
    unsigned int id;
    // Customized instruction mnemonic.
    char mnemonic[CS_MNEMONIC_SIZE];
};
 
struct insn_mnem {
    struct customized_mnem insn;
    struct insn_mnem *next; // linked list of customized mnemonics
};
 
struct cs_struct {
    cs_arch arch;
    cs_mode mode;
    Printer_t printer;  // asm printer
    void *printer_info; // aux info for printer
    Disasm_t disasm;    // disassembler
    void *getinsn_info; // auxiliary info for printer
    GetName_t reg_name;
    GetName_t insn_name;
    GetName_t group_name;
    GetID_t insn_id;
    PostPrinter_t post_printer;
    cs_err errnum;
    ARM_ITStatus ITBlock;   // for Arm only
    cs_opt_value detail, imm_unsigned;
    int syntax; // asm syntax for simple printer such as ARM, Mips & PPC
    bool doing_mem; // handling memory operand in InstPrinter code
    unsigned short *insn_cache; // index caching for mapping.c
    GetRegisterName_t get_regname;
    bool skipdata;  // set this to True if we skip data when disassembling
    uint8_t skipdata_size;  // how many bytes to skip
    cs_opt_skipdata skipdata_setup; // user-defined skipdata setup
    const uint8_t *regsize_map; // map to register size (x86-only for now)
    GetRegisterAccess_t reg_access;
    struct insn_mnem *mnem_list;    // linked list of customized instruction mnemonic
};
 
#define MAX_ARCH CS_ARCH_MAX
 
// Returns a bool (0 or 1) whether big endian is enabled for a mode
#define MODE_IS_BIG_ENDIAN(mode) (((mode) & CS_MODE_BIG_ENDIAN) != 0)
 
extern cs_malloc_t cs_mem_malloc;
extern cs_calloc_t cs_mem_calloc;
extern cs_realloc_t cs_mem_realloc;
extern cs_free_t cs_mem_free;
extern cs_vsnprintf_t cs_vsnprintf;
 
// By defining CAPSTONE_DEBUG assertions can be used.
// For any release build CAPSTONE_DEBUG has to be undefined.
#ifdef CAPSTONE_DEBUG
#define CS_ASSERT(expr) assert(expr)
#else
#define CS_ASSERT(expr)
#endif
 
#endif