blob: 9e32378e909becf70e40a77ce08cddcb56d4d5b8 [file] [log] [blame]
Nguyen Anh Quynh6023ef72014-04-29 11:21:04 +08001/* Capstone Disassembly Engine */
2/* By Nguyen Anh Quynh <aquynh@gmail.com>, 2013-2014 */
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +08003
Nguyen Anh Quynhae3649f2014-01-02 13:15:07 +08004#ifndef CS_PRIV_H
5#define CS_PRIV_H
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +08006
7#include <capstone.h>
8
9#include "MCInst.h"
10#include "SStream.h"
11
12typedef void (*Printer_t)(MCInst *MI, SStream *OS, void *info);
13
14// function to be called after Printer_t
15// this is the best time to gather insn's characteristics
Nguyen Anh Quynh64564812014-05-19 16:46:31 +080016typedef void (*PostPrinter_t)(csh handle, cs_insn *, char *mnem, MCInst *mci);
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +080017
Nguyen Anh Quynha5ffdc32014-05-07 08:25:24 +080018typedef bool (*Disasm_t)(csh handle, const uint8_t *code, size_t code_len, MCInst *instr, uint16_t *size, uint64_t address, void *info);
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +080019
Nguyen Anh Quynh650f96c2014-07-08 08:59:27 +080020typedef const char *(*GetName_t)(csh handle, unsigned int id);
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +080021
Nguyen Anh Quynh1acfd0b2014-01-06 10:56:59 +080022typedef void (*GetID_t)(cs_struct *h, cs_insn *insn, unsigned int id);
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +080023
Nguyen Anh Quynh2ff665a2014-03-11 00:18:50 +080024// return register name, given register ID
Richard Henderson22ead3e2017-10-21 17:45:40 -070025typedef const char *(*GetRegisterName_t)(unsigned RegNo);
Nguyen Anh Quynh2ff665a2014-03-11 00:18:50 +080026
Nguyen Anh Quynh7c7a8bc2013-12-02 13:16:44 +080027// for ARM only
28typedef struct ARM_ITStatus {
Nguyen Anh Quynh8bd0fdb2015-06-03 22:25:22 +080029 unsigned char ITStates[8];
Nguyen Anh Quynh7c7a8bc2013-12-02 13:16:44 +080030 unsigned int size;
31} ARM_ITStatus;
32
Nguyen Anh Quynh42c6b1a2013-12-30 00:15:25 +080033struct cs_struct {
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +080034 cs_arch arch;
35 cs_mode mode;
36 Printer_t printer; // asm printer
37 void *printer_info; // aux info for printer
38 Disasm_t disasm; // disassembler
39 void *getinsn_info; // auxiliary info for printer
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +080040 GetName_t reg_name;
41 GetName_t insn_name;
Nguyen Anh Quynh650f96c2014-07-08 08:59:27 +080042 GetName_t group_name;
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +080043 GetID_t insn_id;
44 PostPrinter_t post_printer;
Nguyen Anh Quynh3eb9ac92013-11-27 15:24:47 +080045 cs_err errnum;
Nguyen Anh Quynh7c7a8bc2013-12-02 13:16:44 +080046 ARM_ITStatus ITBlock; // for Arm only
Nguyen Anh Quynha209e672013-12-14 00:23:41 +080047 cs_opt_value detail;
Nguyen Anh Quynh2ff665a2014-03-11 00:18:50 +080048 int syntax; // asm syntax for simple printer such as ARM, Mips & PPC
Nguyen Anh Quynh19b0de32013-12-31 22:40:04 +080049 bool doing_mem; // handling memory operand in InstPrinter code
Nguyen Anh Quynh1acfd0b2014-01-06 10:56:59 +080050 unsigned short *insn_cache; // index caching for mapping.c
Nguyen Anh Quynh2ff665a2014-03-11 00:18:50 +080051 GetRegisterName_t get_regname;
Nguyen Anh Quynhd3ffe372014-04-09 23:49:30 +080052 bool skipdata; // set this to True if we skip data when disassembling
53 uint8_t skipdata_size; // how many bytes to skip
54 cs_opt_skipdata skipdata_setup; // user-defined skipdata setup
Richard Henderson22ead3e2017-10-21 17:45:40 -070055 const uint8_t *regsize_map; // map to register size (x86-only for now)
Nguyen Anh Quynh42c6b1a2013-12-30 00:15:25 +080056};
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +080057
Nguyen Anh Quynh07552822013-12-22 11:13:07 +080058#define MAX_ARCH 8
Nguyen Anh Quynhf1851802013-12-21 12:16:47 +080059
Travis Finkenauer8998a3a2017-10-20 08:33:24 -070060// Returns a bool (0 or 1) whether big endian is enabled for a mode
61#define MODE_IS_BIG_ENDIAN(mode) (((mode) & CS_MODE_BIG_ENDIAN) != 0)
62
Nguyen Anh Quynhd3458392013-12-22 11:10:56 +080063// constructor initialization for all archs
Nguyen Anh Quynh42c6b1a2013-12-30 00:15:25 +080064extern cs_err (*arch_init[MAX_ARCH]) (cs_struct *);
Nguyen Anh Quynhd3458392013-12-22 11:10:56 +080065
66// support cs_option() for all archs
67extern cs_err (*arch_option[MAX_ARCH]) (cs_struct*, cs_opt_type, size_t value);
Nguyen Anh Quynhf1851802013-12-21 12:16:47 +080068
Nguyen Anh Quynhb2654062014-01-03 17:08:58 +080069// deinitialized functions: to be called when cs_close() is called
70extern void (*arch_destroy[MAX_ARCH]) (cs_struct*);
71
Travis Finkenauer8998a3a2017-10-20 08:33:24 -070072// bitmask for finding disallowed modes for an arch:
73// to be called in cs_open()/cs_option()
74extern cs_mode arch_disallowed_mode_mask[MAX_ARCH];
75
Nguyen Anh Quynh39a42ed2013-12-22 10:40:58 +080076extern unsigned int all_arch;
Nguyen Anh Quynhf1851802013-12-21 12:16:47 +080077
Nguyen Anh Quynha8eb7a52014-01-11 12:55:31 +080078extern cs_malloc_t cs_mem_malloc;
79extern cs_calloc_t cs_mem_calloc;
80extern cs_realloc_t cs_mem_realloc;
81extern cs_free_t cs_mem_free;
Nguyen Anh Quynhedeeb042014-01-15 20:44:03 +080082extern cs_vsnprintf_t cs_vsnprintf;
Nguyen Anh Quynhc7404072014-01-05 11:35:47 +080083
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +080084#endif