1 /* radare - LGPL - Copyright 2009-2020 - nibble, pancake */ 2 3 #ifndef R2_ASM_H 4 #define R2_ASM_H 5 6 #include <r_types.h> 7 #include <r_bin.h> // only for binding, no hard dep required 8 #include <r_util.h> 9 #include <r_parse.h> 10 #include <r_bind.h> 11 12 #ifdef __cplusplus 13 extern "C" { 14 #endif 15 16 R_LIB_VERSION_HEADER(r_asm); 17 18 /* backward compatibility */ 19 #define R_ASM_ARCH_NONE R_SYS_ARCH_NONE 20 #define R_ASM_ARCH_X86 R_SYS_ARCH_X86 21 #define R_ASM_ARCH_ARM R_SYS_ARCH_ARM 22 #define R_ASM_ARCH_PPC R_SYS_ARCH_PPC 23 #define R_ASM_ARCH_M68K R_SYS_ARCH_M68K 24 #define R_ASM_ARCH_JAVA R_SYS_ARCH_JAVA 25 #define R_ASM_ARCH_LM32 R_SYS_ARCH_LM32 26 #define R_ASM_ARCH_MIPS R_SYS_ARCH_MIPS 27 #define R_ASM_ARCH_SPARC R_SYS_ARCH_SPARC 28 #define R_ASM_ARCH_XAP R_SYS_ARCH_XAP 29 #define R_ASM_ARCH_MSIL R_SYS_ARCH_MSIL 30 #define R_ASM_ARCH_OBJD R_SYS_ARCH_OBJD 31 #define R_ASM_ARCH_BF R_SYS_ARCH_BF 32 #define R_ASM_ARCH_SH R_SYS_ARCH_SH 33 #define R_ASM_ARCH_Z80 R_SYS_ARCH_Z80 34 #define R_ASM_ARCH_I8080 R_SYS_ARCH_I8080 35 #define R_ASM_ARCH_ARC R_SYS_ARCH_ARC 36 #define R_ASM_ARCH_HPPA R_SYS_ARCH_HPPA 37 38 #define R_ASM_GET_OFFSET(x,y,z) \ 39 (x && x->binb.bin && x->binb.get_offset)? \ 40 x->binb.get_offset (x->binb.bin, y, z): -1 41 42 #define R_ASM_GET_NAME(x,y,z) \ 43 (x && x->binb.bin && x->binb.get_name)? \ 44 x->binb.get_name (x->binb.bin, y, z, x->pseudo): NULL 45 46 enum { 47 R_ASM_SYNTAX_NONE = 0, 48 R_ASM_SYNTAX_INTEL, 49 R_ASM_SYNTAX_ATT, 50 R_ASM_SYNTAX_MASM, 51 R_ASM_SYNTAX_REGNUM, // alias for capstone's NOREGNAME 52 R_ASM_SYNTAX_JZ, // hack to use jz instead of je on x86 53 }; 54 55 enum { 56 R_ASM_MOD_RAWVALUE = 'r', 57 R_ASM_MOD_VALUE = 'v', 58 R_ASM_MOD_DSTREG = 'd', 59 R_ASM_MOD_SRCREG0 = '0', 60 R_ASM_MOD_SRCREG1 = '1', 61 R_ASM_MOD_SRCREG2 = '2' 62 }; 63 64 typedef struct r_asm_op_t { 65 int size; // instruction size (must be deprecated. just use buf.len 66 int bitsize; // instruction size in bits (or 0 if fits in 8bit bytes) // wtf why dupe this field? :D 67 int payload; // size of payload (opsize = (size-payload)) 68 // But this is pretty slow..so maybe we should add some accessors 69 RStrBuf buf; 70 RStrBuf buf_asm; 71 RBuffer *buf_inc; // must die 72 } RAsmOp; 73 74 typedef struct r_asm_code_t { 75 #if 1 76 int len; 77 ut8 *bytes; 78 char *assembly; 79 #else 80 RAsmOp op; // we have those fields already inside RAsmOp 81 #endif 82 RList *equs; // TODO: must be a hash 83 ut64 code_offset; 84 ut64 data_offset; 85 int code_align; 86 } RAsmCode; 87 88 // TODO: Must use Hashtable instead of this hack 89 typedef struct { 90 char *key; 91 char *value; 92 } RAsmEqu; 93 94 #define _RAsmPlugin struct r_asm_plugin_t 95 typedef struct r_asm_t { 96 char *cpu; 97 int bits; 98 int big_endian; 99 int syntax; 100 ut64 pc; 101 void *user; 102 _RAsmPlugin *cur; 103 _RAsmPlugin *acur; 104 RList *plugins; 105 RBinBind binb; 106 RParse *ifilter; 107 RParse *ofilter; 108 Sdb *pair; 109 RSyscall *syscall; 110 RNum *num; 111 char *features; 112 int invhex; // invalid instructions displayed in hex 113 int pcalign; 114 int dataalign; 115 int bitshift; 116 bool immdisp; // Display immediates with # symbol (for arm stuff). 117 HtPP *flags; 118 int seggrn; 119 bool pseudo; 120 } RAsm; 121 122 typedef bool (*RAsmModifyCallback)(RAsm *a, ut8 *buf, int field, ut64 val); 123 124 typedef struct r_asm_plugin_t { 125 const char *name; 126 const char *arch; 127 const char *author; 128 const char *version; 129 const char *cpus; 130 const char *desc; 131 const char *license; 132 void *user; // user data pointer 133 int bits; 134 int endian; 135 bool (*init)(void *user); 136 bool (*fini)(void *user); 137 int (*disassemble)(RAsm *a, RAsmOp *op, const ut8 *buf, int len); 138 int (*assemble)(RAsm *a, RAsmOp *op, const char *buf); 139 RAsmModifyCallback modify; 140 char *(*mnemonics)(RAsm *a, int id, bool json); 141 const char *features; 142 } RAsmPlugin; 143 144 #ifdef R_API 145 /* asm.c */ 146 R_API RAsm *r_asm_new(void); 147 R_API void r_asm_free(RAsm *a); 148 R_API bool r_asm_modify(RAsm *a, ut8 *buf, int field, ut64 val); 149 R_API char *r_asm_mnemonics(RAsm *a, int id, bool json); 150 R_API int r_asm_mnemonics_byname(RAsm *a, const char *name); 151 R_API void r_asm_set_user_ptr(RAsm *a, void *user); 152 R_API bool r_asm_add(RAsm *a, RAsmPlugin *foo); 153 R_API bool r_asm_setup(RAsm *a, const char *arch, int bits, int big_endian); 154 R_API bool r_asm_is_valid(RAsm *a, const char *name); 155 R_API bool r_asm_use(RAsm *a, const char *name); 156 R_API bool r_asm_use_assembler(RAsm *a, const char *name); 157 R_API bool r_asm_set_arch(RAsm *a, const char *name, int bits); 158 R_API int r_asm_set_bits(RAsm *a, int bits); 159 R_API void r_asm_set_cpu(RAsm *a, const char *cpu); 160 R_API bool r_asm_set_big_endian(RAsm *a, bool big_endian); 161 R_API bool r_asm_set_syntax(RAsm *a, int syntax); 162 R_API int r_asm_syntax_from_string(const char *name); 163 R_API int r_asm_set_pc(RAsm *a, ut64 pc); 164 R_API int r_asm_disassemble(RAsm *a, RAsmOp *op, const ut8 *buf, int len); 165 R_API int r_asm_assemble(RAsm *a, RAsmOp *op, const char *buf); 166 R_API RAsmCode* r_asm_mdisassemble(RAsm *a, const ut8 *buf, int len); 167 R_API RAsmCode* r_asm_mdisassemble_hexstr(RAsm *a, RParse *p, const char *hexstr); 168 R_API RAsmCode* r_asm_massemble(RAsm *a, const char *buf); 169 R_API RAsmCode* r_asm_rasm_assemble(RAsm *a, const char *buf, bool use_spp); 170 R_API char *r_asm_to_string(RAsm *a, ut64 addr, const ut8 *b, int l); 171 /* to ease the use of the native bindings (not used in r2) */ 172 R_API ut8 *r_asm_from_string(RAsm *a, ut64 addr, const char *b, int *l); 173 R_API int r_asm_sub_names_input(RAsm *a, const char *f); 174 R_API int r_asm_sub_names_output(RAsm *a, const char *f); 175 R_API char *r_asm_describe(RAsm *a, const char* str); 176 R_API RList* r_asm_get_plugins(RAsm *a); 177 R_API void r_asm_list_directives(void); 178 179 /* code.c */ 180 R_API RAsmCode *r_asm_code_new(void); 181 R_API void* r_asm_code_free(RAsmCode *acode); 182 R_API void r_asm_equ_item_free(RAsmEqu *equ); 183 R_API bool r_asm_code_set_equ(RAsmCode *code, const char *key, const char *value); 184 R_API char *r_asm_code_equ_replace(RAsmCode *code, char *str); 185 R_API char* r_asm_code_get_hex(RAsmCode *acode); 186 187 /* op.c */ 188 R_API RAsmOp *r_asm_op_new(void); 189 R_API void r_asm_op_init(RAsmOp *op); 190 R_API void r_asm_op_free(RAsmOp *op); 191 R_API void r_asm_op_fini(RAsmOp *op); 192 R_API char *r_asm_op_get_hex(RAsmOp *op); 193 R_API char *r_asm_op_get_asm(RAsmOp *op); 194 R_API int r_asm_op_get_size(RAsmOp *op); 195 R_API void r_asm_op_set_asm(RAsmOp *op, const char *str); 196 R_API int r_asm_op_set_hex(RAsmOp *op, const char *str); 197 R_API int r_asm_op_set_hexbuf(RAsmOp *op, const ut8 *buf, int len); 198 R_API void r_asm_op_set_buf(RAsmOp *op, const ut8 *str, int len); 199 R_API ut8 *r_asm_op_get_buf(RAsmOp *op); 200 201 /* plugin pointers */ 202 extern RAsmPlugin r_asm_plugin_6502; 203 extern RAsmPlugin r_asm_plugin_6502_cs; 204 extern RAsmPlugin r_asm_plugin_8051; 205 extern RAsmPlugin r_asm_plugin_amd29k; 206 extern RAsmPlugin r_asm_plugin_arc; 207 extern RAsmPlugin r_asm_plugin_arm_as; 208 extern RAsmPlugin r_asm_plugin_arm_cs; 209 extern RAsmPlugin r_asm_plugin_arm_gnu; 210 extern RAsmPlugin r_asm_plugin_arm_winedbg; 211 extern RAsmPlugin r_asm_plugin_avr; 212 extern RAsmPlugin r_asm_plugin_bf; 213 extern RAsmPlugin r_asm_plugin_null; 214 extern RAsmPlugin r_asm_plugin_chip8; 215 extern RAsmPlugin r_asm_plugin_cr16; 216 extern RAsmPlugin r_asm_plugin_cris_gnu; 217 extern RAsmPlugin r_asm_plugin_dalvik; 218 extern RAsmPlugin r_asm_plugin_dcpu16; 219 extern RAsmPlugin r_asm_plugin_ebc; 220 extern RAsmPlugin r_asm_plugin_gb; 221 extern RAsmPlugin r_asm_plugin_h8300; 222 extern RAsmPlugin r_asm_plugin_hexagon; 223 extern RAsmPlugin r_asm_plugin_hexagon_gnu; 224 extern RAsmPlugin r_asm_plugin_hppa_gnu; 225 extern RAsmPlugin r_asm_plugin_i4004; 226 extern RAsmPlugin r_asm_plugin_i8080; 227 extern RAsmPlugin r_asm_plugin_java; 228 extern RAsmPlugin r_asm_plugin_lanai_gnu; 229 extern RAsmPlugin r_asm_plugin_lh5801; 230 extern RAsmPlugin r_asm_plugin_lm32; 231 extern RAsmPlugin r_asm_plugin_m68k_cs; 232 extern RAsmPlugin r_asm_plugin_m680x_cs; 233 extern RAsmPlugin r_asm_plugin_malbolge; 234 extern RAsmPlugin r_asm_plugin_mcore; 235 extern RAsmPlugin r_asm_plugin_mcs96; 236 extern RAsmPlugin r_asm_plugin_mips_cs; 237 extern RAsmPlugin r_asm_plugin_mips_gnu; 238 extern RAsmPlugin r_asm_plugin_msp430; 239 extern RAsmPlugin r_asm_plugin_nios2; 240 extern RAsmPlugin r_asm_plugin_or1k; 241 extern RAsmPlugin r_asm_plugin_pic; 242 extern RAsmPlugin r_asm_plugin_ppc_as; 243 extern RAsmPlugin r_asm_plugin_ppc_cs; 244 extern RAsmPlugin r_asm_plugin_ppc_gnu; 245 extern RAsmPlugin r_asm_plugin_propeller; 246 extern RAsmPlugin r_asm_plugin_riscv; 247 extern RAsmPlugin r_asm_plugin_riscv_cs; 248 extern RAsmPlugin r_asm_plugin_rsp; 249 extern RAsmPlugin r_asm_plugin_sh; 250 extern RAsmPlugin r_asm_plugin_snes; 251 extern RAsmPlugin r_asm_plugin_sparc_cs; 252 extern RAsmPlugin r_asm_plugin_sparc_gnu; 253 extern RAsmPlugin r_asm_plugin_sysz; 254 extern RAsmPlugin r_asm_plugin_tms320; 255 extern RAsmPlugin r_asm_plugin_tms320c64x; 256 extern RAsmPlugin r_asm_plugin_tricore; 257 extern RAsmPlugin r_asm_plugin_v810; 258 extern RAsmPlugin r_asm_plugin_v850; 259 extern RAsmPlugin r_asm_plugin_v850_gnu; 260 extern RAsmPlugin r_asm_plugin_vax; 261 extern RAsmPlugin r_asm_plugin_wasm; 262 extern RAsmPlugin r_asm_plugin_ws; 263 extern RAsmPlugin r_asm_plugin_x86_as; 264 extern RAsmPlugin r_asm_plugin_x86_cs; 265 extern RAsmPlugin r_asm_plugin_x86_nasm; 266 extern RAsmPlugin r_asm_plugin_x86_nz; 267 extern RAsmPlugin r_asm_plugin_xap; 268 extern RAsmPlugin r_asm_plugin_xcore_cs; 269 extern RAsmPlugin r_asm_plugin_xtensa; 270 extern RAsmPlugin r_asm_plugin_z80; 271 extern RAsmPlugin r_asm_plugin_pyc; 272 273 #endif 274 275 #ifdef __cplusplus 276 } 277 #endif 278 279 #endif 280