blob: 04bc615b27bd61223da183c54ce3c0cf16f22277 [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 */
Axel 0vercl0k Souchet605faf12014-05-09 20:40:00 +01003#if defined (WIN32) || defined (WIN64) || defined (_WIN32) || defined (_WIN64)
4#pragma warning(disable:4996)
5#endif
Nguyen Anh Quynh4fe224b2013-12-24 16:49:36 +08006#include <stddef.h>
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +08007#include <stdio.h>
8#include <stdlib.h>
9#include <string.h>
10#include <capstone.h>
11
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +080012#include "utils.h"
Nguyen Anh Quynhc7404072014-01-05 11:35:47 +080013#include "MCRegisterInfo.h"
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +080014
Axel 0vercl0k Souchet84fecf22014-05-10 09:49:29 +010015#ifdef CAPSTONE_USE_SYS_DYN_MEM
Nguyen Anh Quynh472a4a42014-03-06 09:13:04 +080016#define INSN_CACHE_SIZE 32
Nguyen Anh Quynha836b752014-03-06 03:36:03 +080017#else
Nguyen Anh Quynh5ee2b452014-03-07 08:40:35 +080018// reduce stack variable size for kernel/firmware
Nguyen Anh Quynha836b752014-03-06 03:36:03 +080019#define INSN_CACHE_SIZE 8
20#endif
Nguyen Anh Quynhc34959b2014-01-22 09:46:42 +080021
Nguyen Anh Quynhd3ffe372014-04-09 23:49:30 +080022// default SKIPDATA mnemonic
Nguyen Anh Quynhc75a9092014-04-10 10:26:49 +080023#define SKIPDATA_MNEM ".byte"
Nguyen Anh Quynhd3ffe372014-04-09 23:49:30 +080024
Nguyen Anh Quynh42c6b1a2013-12-30 00:15:25 +080025cs_err (*arch_init[MAX_ARCH])(cs_struct *) = { NULL };
Nguyen Anh Quynhee143c82014-01-03 21:51:59 +080026cs_err (*arch_option[MAX_ARCH]) (cs_struct *, cs_opt_type, size_t value) = { NULL };
27void (*arch_destroy[MAX_ARCH]) (cs_struct *) = { NULL };
Nguyen Anh Quynhf1851802013-12-21 12:16:47 +080028
Nguyen Anh Quynhc272e9d2014-01-19 12:03:22 +080029extern void ARM_enable(void);
30extern void AArch64_enable(void);
31extern void Mips_enable(void);
32extern void X86_enable(void);
33extern void PPC_enable(void);
Nguyen Anh Quynh05e27132014-03-10 11:58:57 +080034extern void Sparc_enable(void);
Nguyen Anh Quynh48a14ca2014-03-23 08:35:45 +080035extern void SystemZ_enable(void);
Nguyen Anh Quynhc80d8402014-05-26 23:02:48 +080036extern void XCore_enable(void);
danghvu701b8502014-01-09 11:06:44 +070037
Nguyen Anh Quynhc272e9d2014-01-19 12:03:22 +080038static void archs_enable(void)
Nguyen Anh Quynh625b5bc2014-01-09 14:33:56 +080039{
Nguyen Anh Quynhc272e9d2014-01-19 12:03:22 +080040 static bool initialized = false;
41
42 if (initialized)
43 return;
44
danghvub33bd2c2014-01-09 12:22:56 +070045#ifdef CAPSTONE_HAS_ARM
Nguyen Anh Quynhc272e9d2014-01-19 12:03:22 +080046 ARM_enable();
danghvub33bd2c2014-01-09 12:22:56 +070047#endif
48#ifdef CAPSTONE_HAS_ARM64
Nguyen Anh Quynhc272e9d2014-01-19 12:03:22 +080049 AArch64_enable();
danghvub33bd2c2014-01-09 12:22:56 +070050#endif
51#ifdef CAPSTONE_HAS_MIPS
Nguyen Anh Quynhc272e9d2014-01-19 12:03:22 +080052 Mips_enable();
danghvub33bd2c2014-01-09 12:22:56 +070053#endif
danghvub33bd2c2014-01-09 12:22:56 +070054#ifdef CAPSTONE_HAS_POWERPC
Nguyen Anh Quynhc272e9d2014-01-19 12:03:22 +080055 PPC_enable();
danghvub33bd2c2014-01-09 12:22:56 +070056#endif
Nguyen Anh Quynh05e27132014-03-10 11:58:57 +080057#ifdef CAPSTONE_HAS_SPARC
58 Sparc_enable();
59#endif
Nguyen Anh Quynh48a14ca2014-03-23 08:35:45 +080060#ifdef CAPSTONE_HAS_SYSZ
61 SystemZ_enable();
62#endif
Nguyen Anh Quynh05e27132014-03-10 11:58:57 +080063#ifdef CAPSTONE_HAS_X86
64 X86_enable();
65#endif
Nguyen Anh Quynhc80d8402014-05-26 23:02:48 +080066#ifdef CAPSTONE_HAS_XCORE
67 XCore_enable();
68#endif
69
Nguyen Anh Quynhc272e9d2014-01-19 12:03:22 +080070
71 initialized = true;
danghvub33bd2c2014-01-09 12:22:56 +070072}
73
Nguyen Anh Quynh39a42ed2013-12-22 10:40:58 +080074unsigned int all_arch = 0;
Nguyen Anh Quynhf1851802013-12-21 12:16:47 +080075
Axel 0vercl0k Souchet84fecf22014-05-10 09:49:29 +010076#ifdef CAPSTONE_USE_SYS_DYN_MEM
Nguyen Anh Quynha8eb7a52014-01-11 12:55:31 +080077cs_malloc_t cs_mem_malloc = malloc;
78cs_calloc_t cs_mem_calloc = calloc;
79cs_realloc_t cs_mem_realloc = realloc;
80cs_free_t cs_mem_free = free;
Nguyen Anh Quynhedeeb042014-01-15 20:44:03 +080081cs_vsnprintf_t cs_vsnprintf = vsnprintf;
Nguyen Anh Quynh59492c22014-01-05 23:41:31 +080082#else
Nguyen Anh Quynha8eb7a52014-01-11 12:55:31 +080083cs_malloc_t cs_mem_malloc = NULL;
84cs_calloc_t cs_mem_calloc = NULL;
85cs_realloc_t cs_mem_realloc = NULL;
86cs_free_t cs_mem_free = NULL;
Nguyen Anh Quynhedeeb042014-01-15 20:44:03 +080087cs_vsnprintf_t cs_vsnprintf = NULL;
Nguyen Anh Quynh59492c22014-01-05 23:41:31 +080088#endif
Nguyen Anh Quynhb8806782013-12-22 15:20:07 +080089
Nguyen Anh Quynh07c36932014-06-03 18:33:15 +080090CAPSTONE_EXPORT
Nguyen Anh Quynhb90cb992013-12-28 13:59:09 +080091unsigned int cs_version(int *major, int *minor)
Nguyen Anh Quynh36df4bb2013-12-10 13:31:20 +080092{
Nguyen Anh Quynhc46c35d2014-03-05 00:21:53 +080093 archs_enable();
94
Nguyen Anh Quynh08777472013-12-22 14:16:28 +080095 if (major != NULL && minor != NULL) {
96 *major = CS_API_MAJOR;
97 *minor = CS_API_MINOR;
98 }
Nguyen Anh Quynh39a42ed2013-12-22 10:40:58 +080099
100 return (CS_API_MAJOR << 8) + CS_API_MINOR;
101}
102
Nguyen Anh Quynh07c36932014-06-03 18:33:15 +0800103CAPSTONE_EXPORT
Nguyen Anh Quynhb2870e42014-02-22 23:41:16 +0800104bool cs_support(int query)
Nguyen Anh Quynh39a42ed2013-12-22 10:40:58 +0800105{
Nguyen Anh Quynhc46c35d2014-03-05 00:21:53 +0800106 archs_enable();
107
Nguyen Anh Quynhb2870e42014-02-22 23:41:16 +0800108 if (query == CS_ARCH_ALL)
Nguyen Anh Quynh39a42ed2013-12-22 10:40:58 +0800109 return all_arch == ((1 << CS_ARCH_ARM) | (1 << CS_ARCH_ARM64) |
Nguyen Anh Quynh42c6b1a2013-12-30 00:15:25 +0800110 (1 << CS_ARCH_MIPS) | (1 << CS_ARCH_X86) |
Nguyen Anh Quynh48a14ca2014-03-23 08:35:45 +0800111 (1 << CS_ARCH_PPC) | (1 << CS_ARCH_SPARC) |
Nguyen Anh Quynhc80d8402014-05-26 23:02:48 +0800112 (1 << CS_ARCH_SYSZ) | (1 << CS_ARCH_XCORE));
Nguyen Anh Quynh39a42ed2013-12-22 10:40:58 +0800113
Nguyen Anh Quynh48d58322014-02-27 13:54:28 +0800114 if ((unsigned int)query < CS_ARCH_MAX)
Nguyen Anh Quynhb2870e42014-02-22 23:41:16 +0800115 return all_arch & (1 << query);
116
117 if (query == CS_SUPPORT_DIET) {
118#ifdef CAPSTONE_DIET
119 return true;
120#else
121 return false;
122#endif
123 }
124
Nguyen Anh Quynh59b54892014-03-27 10:54:44 +0800125 if (query == CS_SUPPORT_X86_REDUCE) {
126#if defined(CAPSTONE_HAS_X86) && defined(CAPSTONE_X86_REDUCE)
Nguyen Anh Quynh95181482014-03-25 23:20:41 +0800127 return true;
128#else
129 return false;
130#endif
131 }
132
Nguyen Anh Quynhb2870e42014-02-22 23:41:16 +0800133 // unsupported query
134 return false;
Nguyen Anh Quynh36df4bb2013-12-10 13:31:20 +0800135}
136
Nguyen Anh Quynh07c36932014-06-03 18:33:15 +0800137CAPSTONE_EXPORT
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +0800138cs_err cs_errno(csh handle)
139{
Nguyen Anh Quynhbb0744d2014-05-12 13:41:49 +0800140 struct cs_struct *ud;
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +0800141 if (!handle)
142 return CS_ERR_CSH;
143
Axel 0vercl0k Souchet779d4c72014-05-08 23:44:49 +0100144 ud = (struct cs_struct *)(uintptr_t)handle;
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +0800145
Nguyen Anh Quynh3eb9ac92013-11-27 15:24:47 +0800146 return ud->errnum;
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +0800147}
148
Nguyen Anh Quynh07c36932014-06-03 18:33:15 +0800149CAPSTONE_EXPORT
Nguyen Anh Quynh34f96382014-01-03 22:49:07 +0800150const char *cs_strerror(cs_err code)
151{
152 switch(code) {
153 default:
154 return "Unknown error code";
155 case CS_ERR_OK:
156 return "OK (CS_ERR_OK)";
157 case CS_ERR_MEM:
158 return "Out of memory (CS_ERR_MEM)";
159 case CS_ERR_ARCH:
160 return "Invalid architecture (CS_ERR_ARCH)";
161 case CS_ERR_HANDLE:
162 return "Invalid handle (CS_ERR_HANDLE)";
163 case CS_ERR_CSH:
164 return "Invalid csh (CS_ERR_CSH)";
165 case CS_ERR_MODE:
166 return "Invalid mode (CS_ERR_MODE)";
167 case CS_ERR_OPTION:
168 return "Invalid option (CS_ERR_OPTION)";
169 case CS_ERR_DETAIL:
170 return "Details are unavailable (CS_ERR_DETAIL)";
Nguyen Anh Quynhc52352d2014-01-06 09:06:30 +0800171 case CS_ERR_MEMSETUP:
172 return "Dynamic memory management uninitialized (CS_ERR_MEMSETUP)";
Nguyen Anh Quynh4f220282014-02-09 00:19:15 +0800173 case CS_ERR_VERSION:
174 return "Different API version between core & binding (CS_ERR_VERSION)";
Nguyen Anh Quynhf7cdbdf2014-02-24 16:47:36 +0800175 case CS_ERR_DIET:
176 return "Information irrelevant in diet engine (CS_ERR_DIET)";
Nguyen Anh Quynh11ec8812014-04-10 17:20:01 +0800177 case CS_ERR_SKIPDATA:
178 return "Information irrelevant for 'data' instruction in SKIPDATA mode (CS_ERR_SKIPDATA)";
Nguyen Anh Quynh34f96382014-01-03 22:49:07 +0800179 }
180}
181
Nguyen Anh Quynh07c36932014-06-03 18:33:15 +0800182CAPSTONE_EXPORT
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +0800183cs_err cs_open(cs_arch arch, cs_mode mode, csh *handle)
184{
Nguyen Anh Quynh42706a32014-05-09 07:33:35 +0800185 cs_err err;
Nguyen Anh Quynhbb0744d2014-05-12 13:41:49 +0800186 struct cs_struct *ud;
Nguyen Anh Quynhedeeb042014-01-15 20:44:03 +0800187 if (!cs_mem_malloc || !cs_mem_calloc || !cs_mem_realloc || !cs_mem_free || !cs_vsnprintf)
Nguyen Anh Quynhc52352d2014-01-06 09:06:30 +0800188 // Error: before cs_open(), dynamic memory management must be initialized
189 // with cs_option(CS_OPT_MEM)
190 return CS_ERR_MEMSETUP;
191
Nguyen Anh Quynhc272e9d2014-01-19 12:03:22 +0800192 archs_enable();
193
Nguyen Anh Quynh8f7ab492014-01-06 09:52:57 +0800194 if (arch < CS_ARCH_MAX && arch_init[arch]) {
Nguyen Anh Quynha8eb7a52014-01-11 12:55:31 +0800195 ud = cs_mem_calloc(1, sizeof(*ud));
Nguyen Anh Quynh8f7ab492014-01-06 09:52:57 +0800196 if (!ud) {
197 // memory insufficient
198 return CS_ERR_MEM;
199 }
200
Nguyen Anh Quynh9a197b32013-12-22 13:41:38 +0800201 ud->errnum = CS_ERR_OK;
202 ud->arch = arch;
203 ud->mode = mode;
204 ud->big_endian = mode & CS_MODE_BIG_ENDIAN;
Nguyen Anh Quynh39b812d2014-01-07 23:36:26 +0800205 // by default, do not break instruction into details
206 ud->detail = CS_OPT_OFF;
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +0800207
Nguyen Anh Quynhd3ffe372014-04-09 23:49:30 +0800208 // default skipdata setup
209 ud->skipdata_setup.mnemonic = SKIPDATA_MNEM;
210
Axel 0vercl0k Souchet779d4c72014-05-08 23:44:49 +0100211 err = arch_init[ud->arch](ud);
Nguyen Anh Quynh06b3c052014-01-21 15:26:02 +0800212 if (err) {
213 cs_mem_free(ud);
214 *handle = 0;
215 return err;
216 }
Nguyen Anh Quynh8f7ab492014-01-06 09:52:57 +0800217
218 *handle = (uintptr_t)ud;
219
220 return CS_ERR_OK;
Nguyen Anh Quynh9a197b32013-12-22 13:41:38 +0800221 } else {
222 *handle = 0;
223 return CS_ERR_ARCH;
224 }
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +0800225}
226
Nguyen Anh Quynh07c36932014-06-03 18:33:15 +0800227CAPSTONE_EXPORT
Nguyen Anh Quynh226d7dc2014-02-27 22:20:39 +0800228cs_err cs_close(csh *handle)
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +0800229{
Nguyen Anh Quynhbb0744d2014-05-12 13:41:49 +0800230 struct cs_struct *ud;
231
Nguyen Anh Quynhef3d04d2014-02-27 23:42:49 +0800232 if (*handle == 0)
Nguyen Anh Quynh226d7dc2014-02-27 22:20:39 +0800233 // invalid handle
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +0800234 return CS_ERR_CSH;
235
Axel 0vercl0k Souchet779d4c72014-05-08 23:44:49 +0100236 ud = (struct cs_struct *)(*handle);
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +0800237
Nguyen Anh Quynhfbe10a52014-02-27 23:59:08 +0800238 if (ud->printer_info)
239 cs_mem_free(ud->printer_info);
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +0800240
Nguyen Anh Quynha8eb7a52014-01-11 12:55:31 +0800241 cs_mem_free(ud->insn_cache);
Nguyen Anh Quynh0a2eca72014-10-11 00:36:16 +0800242
Nguyen Anh Quynhee143c82014-01-03 21:51:59 +0800243 memset(ud, 0, sizeof(*ud));
Nguyen Anh Quynha8eb7a52014-01-11 12:55:31 +0800244 cs_mem_free(ud);
Nguyen Anh Quynhee143c82014-01-03 21:51:59 +0800245
Nguyen Anh Quynhc8e07852014-02-28 09:38:11 +0800246 // invalidate this handle by ZERO out its value.
247 // this is to make sure it is unusable after cs_close()
Nguyen Anh Quynh226d7dc2014-02-27 22:20:39 +0800248 *handle = 0;
249
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +0800250 return CS_ERR_OK;
251}
252
253// fill insn with mnemonic & operands info
Nguyen Anh Quynha82a0892014-01-23 23:42:40 +0800254static void fill_insn(struct cs_struct *handle, cs_insn *insn, char *buffer, MCInst *mci,
Nguyen Anh Quynh4fe224b2013-12-24 16:49:36 +0800255 PostPrinter_t postprinter, const uint8_t *code)
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +0800256{
Nguyen Anh Quynh8c2e2db2014-05-14 07:32:56 +0800257#ifndef CAPSTONE_DIET
Nguyen Anh Quynh5329a6f2014-06-08 23:35:52 +0700258 char *sp, *mnem;
Nguyen Anh Quynh8c2e2db2014-05-14 07:32:56 +0800259#endif
Nguyen Anh Quynh6c0dd632014-10-30 20:34:22 +0800260 unsigned int copy_size = MIN(sizeof(insn->bytes), insn->size);
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +0800261
Nguyen Anh Quynh6c0dd632014-10-30 20:34:22 +0800262 // fill the instruction bytes.
263 // we might skip some redundant bytes in front in the case of X86
264 memcpy(insn->bytes, code + insn->size - copy_size, copy_size);
265 insn->size = copy_size;
Nguyen Anh Quynh4fe224b2013-12-24 16:49:36 +0800266
Nguyen Anh Quynh4d3e8522013-12-14 10:45:09 +0800267 // alias instruction might have ID saved in OpcodePub
268 if (MCInst_getOpcodePub(mci))
269 insn->id = MCInst_getOpcodePub(mci);
270
271 // post printer handles some corner cases (hacky)
Nguyen Anh Quynh4fe224b2013-12-24 16:49:36 +0800272 if (postprinter)
Nguyen Anh Quynh64564812014-05-19 16:46:31 +0800273 postprinter((csh)handle, insn, buffer, mci);
Nguyen Anh Quynh4d3e8522013-12-14 10:45:09 +0800274
Nguyen Anh Quynhfc83a432014-02-22 23:26:27 +0800275#ifndef CAPSTONE_DIET
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +0800276 // fill in mnemonic & operands
Nguyen Anh Quynhdefb9bc2013-12-12 14:00:12 +0800277 // find first space or tab
Axel 0vercl0k Souchet779d4c72014-05-08 23:44:49 +0100278 sp = buffer;
Nguyen Anh Quynh7566a2d2014-06-08 22:09:31 +0800279 mnem = insn->mnemonic;
Nguyen Anh Quynh25b7f762014-07-02 12:22:39 +0800280 for (sp = buffer; *sp; sp++) {
281 if (*sp == ' '|| *sp == '\t')
282 break;
283 if (*sp == '|') // lock|rep prefix for x86
284 *sp = ' ';
285 // copy to @mnemonic
286 *mnem = *sp;
287 mnem++;
Nguyen Anh Quynha5ffdc32014-05-07 08:25:24 +0800288 }
289
Nguyen Anh Quynh7566a2d2014-06-08 22:09:31 +0800290 *mnem = '\0';
291
292 // copy @op_str
Nguyen Anh Quynhdefb9bc2013-12-12 14:00:12 +0800293 if (*sp) {
Nguyen Anh Quynh86dc3932013-12-12 14:43:39 +0800294 // find the next non-space char
295 sp++;
296 for (; ((*sp == ' ') || (*sp == '\t')); sp++);
297 strncpy(insn->op_str, sp, sizeof(insn->op_str) - 1);
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +0800298 insn->op_str[sizeof(insn->op_str) - 1] = '\0';
299 } else
300 insn->op_str[0] = '\0';
Nguyen Anh Quynhfc83a432014-02-22 23:26:27 +0800301#endif
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +0800302}
303
Nguyen Anh Quynhd3ffe372014-04-09 23:49:30 +0800304// how many bytes will we skip when encountering data (CS_OPT_SKIPDATA)?
Nguyen Anh Quynha89383e2014-04-10 11:53:46 +0800305// this very much depends on instruction alignment requirement of each arch.
Nguyen Anh Quynhd3ffe372014-04-09 23:49:30 +0800306static uint8_t skipdata_size(cs_struct *handle)
307{
308 switch(handle->arch) {
309 default:
310 // should never reach
311 return -1;
312 case CS_ARCH_ARM:
Nguyen Anh Quynha89383e2014-04-10 11:53:46 +0800313 // skip 2 bytes on Thumb mode.
314 if (handle->mode & CS_MODE_THUMB)
315 return 2;
316 // otherwise, skip 4 bytes
317 return 4;
Nguyen Anh Quynhd3ffe372014-04-09 23:49:30 +0800318 case CS_ARCH_ARM64:
319 case CS_ARCH_MIPS:
320 case CS_ARCH_PPC:
321 case CS_ARCH_SPARC:
Nguyen Anh Quynha89383e2014-04-10 11:53:46 +0800322 // skip 4 bytes
323 return 4;
Nguyen Anh Quynhd3ffe372014-04-09 23:49:30 +0800324 case CS_ARCH_SYSZ:
Nguyen Anh Quynha89383e2014-04-10 11:53:46 +0800325 // SystemZ instruction's length can be 2, 4 or 6 bytes,
326 // so we just skip 2 bytes
Nguyen Anh Quynhd3ffe372014-04-09 23:49:30 +0800327 return 2;
328 case CS_ARCH_X86:
329 // X86 has no restriction on instruction alignment
330 return 1;
Nguyen Anh Quynhc80d8402014-05-26 23:02:48 +0800331 case CS_ARCH_XCORE:
332 // XCore instruction's length can be 2 or 4 bytes,
333 // so we just skip 2 bytes
334 return 2;
Nguyen Anh Quynhd3ffe372014-04-09 23:49:30 +0800335 }
336}
337
Nguyen Anh Quynh07c36932014-06-03 18:33:15 +0800338CAPSTONE_EXPORT
Nguyen Anh Quynhda8adad2013-12-04 09:44:07 +0800339cs_err cs_option(csh ud, cs_opt_type type, size_t value)
Nguyen Anh Quynh01aba002013-12-03 21:00:09 +0800340{
Nguyen Anh Quynhbb0744d2014-05-12 13:41:49 +0800341 struct cs_struct *handle;
Nguyen Anh Quynhc46c35d2014-03-05 00:21:53 +0800342 archs_enable();
343
Nguyen Anh Quynh24bf0d92014-01-05 11:19:04 +0800344 // cs_option() can be called with NULL handle just for CS_OPT_MEM
345 // This is supposed to be executed before all other APIs (even cs_open())
346 if (type == CS_OPT_MEM) {
347 cs_opt_mem *mem = (cs_opt_mem *)value;
348
Nguyen Anh Quynha8eb7a52014-01-11 12:55:31 +0800349 cs_mem_malloc = mem->malloc;
350 cs_mem_calloc = mem->calloc;
351 cs_mem_realloc = mem->realloc;
352 cs_mem_free = mem->free;
Nguyen Anh Quynhedeeb042014-01-15 20:44:03 +0800353 cs_vsnprintf = mem->vsnprintf;
Nguyen Anh Quynh24bf0d92014-01-05 11:19:04 +0800354
355 return CS_ERR_OK;
356 }
357
Axel 0vercl0k Souchet779d4c72014-05-08 23:44:49 +0100358 handle = (struct cs_struct *)(uintptr_t)ud;
danghvu2b192962013-12-19 22:40:28 -0600359 if (!handle)
360 return CS_ERR_CSH;
Nguyen Anh Quynh01aba002013-12-03 21:00:09 +0800361
Nguyen Anh Quynhd3ffe372014-04-09 23:49:30 +0800362 switch(type) {
363 default:
364 break;
365 case CS_OPT_DETAIL:
366 handle->detail = value;
367 return CS_ERR_OK;
368 case CS_OPT_SKIPDATA:
369 handle->skipdata = (value == CS_OPT_ON);
370 if (handle->skipdata) {
371 if (handle->skipdata_size == 0) {
372 // set the default skipdata size
373 handle->skipdata_size = skipdata_size(handle);
374 }
375 }
376 return CS_ERR_OK;
377 case CS_OPT_SKIPDATA_SETUP:
378 if (value)
379 handle->skipdata_setup = *((cs_opt_skipdata *)value);
380 return CS_ERR_OK;
Nguyen Anh Quynh7d02c922013-12-21 09:59:31 +0800381 }
Nguyen Anh Quynha209e672013-12-14 00:23:41 +0800382
Nguyen Anh Quynhd3458392013-12-22 11:10:56 +0800383 return arch_option[handle->arch](handle, type, value);
Nguyen Anh Quynh01aba002013-12-03 21:00:09 +0800384}
385
Nguyen Anh Quynh07ffd642014-04-10 14:36:08 +0800386// generate @op_str for data instruction of SKIPDATA
Nguyen Anh Quynhd3ffe372014-04-09 23:49:30 +0800387static void skipdata_opstr(char *opstr, const uint8_t *buffer, size_t size)
388{
389 char *p = opstr;
390 int len;
391 size_t i;
392
393 if (!size) {
394 opstr[0] = '\0';
395 return;
396 }
397
398 len = sprintf(p, "0x%02x", buffer[0]);
399 p+= len;
400
401 for(i = 1; i < size; i++) {
402 len = sprintf(p, ", 0x%02x", buffer[i]);
403 p+= len;
404 }
405}
406
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +0800407// dynamicly allocate memory to contain disasm insn
408// NOTE: caller must free() the allocated memory itself to avoid memory leaking
Nguyen Anh Quynh07c36932014-06-03 18:33:15 +0800409CAPSTONE_EXPORT
Nguyen Anh Quynh0beb0d42014-08-27 22:55:29 +0800410size_t cs_disasm(csh ud, const uint8_t *buffer, size_t size, uint64_t offset, size_t count, cs_insn **insn)
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +0800411{
Nguyen Anh Quynh0a2eca72014-10-11 00:36:16 +0800412 struct cs_struct *handle;
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +0800413 MCInst mci;
414 uint16_t insn_size;
Nguyen Anh Quynh6c182ae2014-06-18 21:50:25 +0800415 size_t c = 0, i;
Nguyen Anh Quynh4d3ccf42014-10-03 00:39:56 +0800416 unsigned int f = 0; // index of the next instruction in the cache
417 cs_insn *insn_cache; // cache contains disassembled instructions
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +0800418 void *total = NULL;
Nguyen Anh Quynh4d3ccf42014-10-03 00:39:56 +0800419 size_t total_size = 0; // total size of output buffer containing all insns
Nguyen Anh Quynh034a7482014-03-06 22:40:08 +0800420 bool r;
Nguyen Anh Quynhd3ffe372014-04-09 23:49:30 +0800421 void *tmp;
422 size_t skipdata_bytes;
Nguyen Anh Quynh523ca992014-10-01 10:46:37 +0800423 uint64_t offset_org; // save all the original info of the buffer
Nguyen Anh Quynh0df7e932014-07-10 15:42:16 +0800424 size_t size_org;
425 const uint8_t *buffer_org;
Nguyen Anh Quynhac98ca02014-09-30 13:17:36 +0800426 unsigned int cache_size = INSN_CACHE_SIZE;
danghvu0d1aad12014-10-01 23:12:18 -0500427 size_t next_offset;
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +0800428
Nguyen Anh Quynh0a2eca72014-10-11 00:36:16 +0800429 handle = (struct cs_struct *)(uintptr_t)ud;
Nguyen Anh Quynh5848aaa2014-02-27 11:10:41 +0800430 if (!handle) {
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +0800431 // FIXME: how to handle this case:
Nguyen Anh Quynh3eb9ac92013-11-27 15:24:47 +0800432 // handle->errnum = CS_ERR_HANDLE;
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +0800433 return 0;
434 }
435
Nguyen Anh Quynh3eb9ac92013-11-27 15:24:47 +0800436 handle->errnum = CS_ERR_OK;
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +0800437
Nguyen Anh Quynh50eeba22014-09-30 13:28:02 +0800438#ifdef CAPSTONE_USE_SYS_DYN_MEM
Nguyen Anh Quynh16f330c2014-10-02 10:09:59 +0800439 if (count > 0 && count <= INSN_CACHE_SIZE)
flyingsymbolsd91f9642014-10-22 03:21:43 -0400440 cache_size = (unsigned int) count;
Nguyen Anh Quynh50eeba22014-09-30 13:28:02 +0800441#endif
Nguyen Anh Quynhac98ca02014-09-30 13:17:36 +0800442
Nguyen Anh Quynh2cff6f62014-04-28 11:19:44 +0800443 // save the original offset for SKIPDATA
Nguyen Anh Quynh0df7e932014-07-10 15:42:16 +0800444 buffer_org = buffer;
Nguyen Anh Quynh07ffd642014-04-10 14:36:08 +0800445 offset_org = offset;
Nguyen Anh Quynh0df7e932014-07-10 15:42:16 +0800446 size_org = size;
Nguyen Anh Quynh523ca992014-10-01 10:46:37 +0800447
448 total_size = sizeof(cs_insn) * cache_size;
Nguyen Anh Quynhee583942014-06-09 00:13:31 +0700449 total = cs_mem_malloc(total_size);
450 insn_cache = total;
Nguyen Anh Quynh2cff6f62014-04-28 11:19:44 +0800451
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +0800452 while (size > 0) {
Nguyen Anh Quynh495295e2014-06-16 15:54:32 +0800453 MCInst_Init(&mci);
Nguyen Anh Quynh42c6b1a2013-12-30 00:15:25 +0800454 mci.csh = handle;
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +0800455
Nguyen Anh Quynh5329a6f2014-06-08 23:35:52 +0700456 // relative branches need to know the address & size of current insn
457 mci.address = offset;
458
459 if (handle->detail) {
460 // allocate memory for @detail pointer
Nguyen Anh Quynhee583942014-06-09 00:13:31 +0700461 insn_cache->detail = cs_mem_malloc(sizeof(cs_detail));
Nguyen Anh Quynh5329a6f2014-06-08 23:35:52 +0700462 } else {
Nguyen Anh Quynhee583942014-06-09 00:13:31 +0700463 insn_cache->detail = NULL;
Nguyen Anh Quynh5329a6f2014-06-08 23:35:52 +0700464 }
465
466 // save all the information for non-detailed mode
Nguyen Anh Quynhee583942014-06-09 00:13:31 +0700467 mci.flat_insn = insn_cache;
Nguyen Anh Quynh5329a6f2014-06-08 23:35:52 +0700468 mci.flat_insn->address = offset;
Nguyen Anh Quynh0c07cc92014-08-27 22:31:54 +0800469#ifdef CAPSTONE_DIET
470 // zero out mnemonic & op_str
471 mci.flat_insn->mnemonic[0] = '\0';
472 mci.flat_insn->op_str[0] = '\0';
473#endif
Nguyen Anh Quynh5329a6f2014-06-08 23:35:52 +0700474
Nguyen Anh Quynha5ffdc32014-05-07 08:25:24 +0800475 r = handle->disasm(ud, buffer, size, &mci, &insn_size, offset, handle->getinsn_info);
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +0800476 if (r) {
477 SStream ss;
478 SStream_Init(&ss);
479
Nguyen Anh Quynh5329a6f2014-06-08 23:35:52 +0700480 mci.flat_insn->size = insn_size;
Nguyen Anh Quynhff7bba32014-11-03 16:32:06 +0800481
482 // map internal instruction opcode to public insn ID
483 handle->insn_id(handle, insn_cache, mci.Opcode);
484
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +0800485 handle->printer(&mci, &ss, handle->printer_info);
Nguyen Anh Quynhff7bba32014-11-03 16:32:06 +0800486
Nguyen Anh Quynhee583942014-06-09 00:13:31 +0700487 fill_insn(handle, insn_cache, ss.buffer, &mci, handle->post_printer, buffer);
Nguyen Anh Quynha209e672013-12-14 00:23:41 +0800488
danghvu0d1aad12014-10-01 23:12:18 -0500489 next_offset = insn_size;
Nguyen Anh Quynh8f13f3c2013-12-04 22:57:04 +0800490 } else {
Nguyen Anh Quynhf9d8a892014-10-02 12:37:32 +0800491 // encounter a broken instruction
492
493 // free memory of @detail pointer
Nguyen Anh Quynh6c182ae2014-06-18 21:50:25 +0800494 if (handle->detail) {
Nguyen Anh Quynh6c182ae2014-06-18 21:50:25 +0800495 cs_mem_free(insn_cache->detail);
496 }
497
Nguyen Anh Quynhd3ffe372014-04-09 23:49:30 +0800498 // if there is no request to skip data, or remaining data is too small,
499 // then bail out
500 if (!handle->skipdata || handle->skipdata_size > size)
501 break;
502
503 if (handle->skipdata_setup.callback) {
Nguyen Anh Quynh0df7e932014-07-10 15:42:16 +0800504 skipdata_bytes = handle->skipdata_setup.callback(buffer_org, size_org,
Nguyen Anh Quynh4b6b15f2014-08-26 15:57:04 +0800505 (size_t)(offset - offset_org), handle->skipdata_setup.user_data);
Nguyen Anh Quynhd3ffe372014-04-09 23:49:30 +0800506 if (skipdata_bytes > size)
507 // remaining data is not enough
508 break;
509
510 if (!skipdata_bytes)
511 // user requested not to skip data, so bail out
512 break;
513 } else
514 skipdata_bytes = handle->skipdata_size;
515
516 // we have to skip some amount of data, depending on arch & mode
Nguyen Anh Quynhee583942014-06-09 00:13:31 +0700517 insn_cache->id = 0; // invalid ID for this "data" instruction
518 insn_cache->address = offset;
Nguyen Anh Quynh0a2eca72014-10-11 00:36:16 +0800519 insn_cache->size = (uint16_t)skipdata_bytes;
Nguyen Anh Quynhee583942014-06-09 00:13:31 +0700520 memcpy(insn_cache->bytes, buffer, skipdata_bytes);
521 strncpy(insn_cache->mnemonic, handle->skipdata_setup.mnemonic,
522 sizeof(insn_cache->mnemonic) - 1);
523 skipdata_opstr(insn_cache->op_str, buffer, skipdata_bytes);
524 insn_cache->detail = NULL;
Nguyen Anh Quynhd3ffe372014-04-09 23:49:30 +0800525
danghvu0d1aad12014-10-01 23:12:18 -0500526 next_offset = skipdata_bytes;
527 }
Nguyen Anh Quynhf9d8a892014-10-02 12:37:32 +0800528
danghvu0d1aad12014-10-01 23:12:18 -0500529 // one more instruction entering the cache
530 f++;
Nguyen Anh Quynhf9d8a892014-10-02 12:37:32 +0800531
danghvu0d1aad12014-10-01 23:12:18 -0500532 // one more instruction disassembled
533 c++;
534 if (count > 0 && c == count)
Nguyen Anh Quynh4d3ccf42014-10-03 00:39:56 +0800535 // already got requested number of instructions
danghvu0d1aad12014-10-01 23:12:18 -0500536 break;
Nguyen Anh Quynhf9d8a892014-10-02 12:37:32 +0800537
danghvu0d1aad12014-10-01 23:12:18 -0500538 if (f == cache_size) {
Nguyen Anh Quynh4d3ccf42014-10-03 00:39:56 +0800539 // full cache, so expand the cache to contain incoming insns
danghvu2fb7c8e2014-10-02 07:38:24 -0500540 cache_size = cache_size * 8 / 5; // * 1.6 ~ golden ratio
danghvu0d1aad12014-10-01 23:12:18 -0500541 total_size += (sizeof(cs_insn) * cache_size);
542 tmp = cs_mem_realloc(total, total_size);
543 if (tmp == NULL) { // insufficient memory
544 if (handle->detail) {
545 insn_cache = (cs_insn *)total;
546 for (i = 0; i < c; i++, insn_cache++)
547 cs_mem_free(insn_cache->detail);
Nguyen Anh Quynhd3ffe372014-04-09 23:49:30 +0800548 }
549
danghvu0d1aad12014-10-01 23:12:18 -0500550 cs_mem_free(total);
551 *insn = NULL;
552 handle->errnum = CS_ERR_MEM;
553 return 0;
554 }
Nguyen Anh Quynhd3ffe372014-04-09 23:49:30 +0800555
danghvu0d1aad12014-10-01 23:12:18 -0500556 total = tmp;
Nguyen Anh Quynh4d3ccf42014-10-03 00:39:56 +0800557 // continue to fill in the cache after the last instruction
558 insn_cache = (cs_insn *)((char *)total + sizeof(cs_insn) * c);
Nguyen Anh Quynhd3ffe372014-04-09 23:49:30 +0800559
Nguyen Anh Quynh4d3ccf42014-10-03 00:39:56 +0800560 // reset f back to 0, so we fill in the cache from begining
danghvu0d1aad12014-10-01 23:12:18 -0500561 f = 0;
562 } else
563 insn_cache++;
564
565 buffer += next_offset;
566 size -= next_offset;
567 offset += next_offset;
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +0800568 }
569
Nguyen Anh Quynh27a4a082014-10-02 10:31:37 +0800570 if (!c) {
Nguyen Anh Quynhf9d8a892014-10-02 12:37:32 +0800571 // we did not disassemble any instruction
Nguyen Anh Quynh27a4a082014-10-02 10:31:37 +0800572 cs_mem_free(total);
573 total = NULL;
574 } else if (f != cache_size) {
Nguyen Anh Quynhf9d8a892014-10-02 12:37:32 +0800575 // total did not fully use the last cache, so downsize it
Nguyen Anh Quynhac98ca02014-09-30 13:17:36 +0800576 void *tmp = cs_mem_realloc(total, total_size - (cache_size - f) * sizeof(*insn_cache));
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +0800577 if (tmp == NULL) { // insufficient memory
Nguyen Anh Quynh6c182ae2014-06-18 21:50:25 +0800578 // free all detail pointers
579 if (handle->detail) {
580 insn_cache = (cs_insn *)total;
581 for (i = 0; i < c; i++, insn_cache++)
582 cs_mem_free(insn_cache->detail);
583 }
584
Nguyen Anh Quynha8eb7a52014-01-11 12:55:31 +0800585 cs_mem_free(total);
Nguyen Anh Quynhdab17fd2014-06-19 11:15:18 +0800586 *insn = NULL;
Nguyen Anh Quynh6c182ae2014-06-18 21:50:25 +0800587
Nguyen Anh Quynh3eb9ac92013-11-27 15:24:47 +0800588 handle->errnum = CS_ERR_MEM;
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +0800589 return 0;
590 }
591
592 total = tmp;
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +0800593 }
594
595 *insn = total;
596
597 return c;
598}
599
Nguyen Anh Quynh07c36932014-06-03 18:33:15 +0800600CAPSTONE_EXPORT
Nguyen Anh Quynh0beb0d42014-08-27 22:55:29 +0800601CAPSTONE_DEPRECATED
602size_t cs_disasm_ex(csh ud, const uint8_t *buffer, size_t size, uint64_t offset, size_t count, cs_insn **insn)
603{
604 return cs_disasm(ud, buffer, size, offset, count, insn);
605}
606
607CAPSTONE_EXPORT
Nguyen Anh Quynh4fe224b2013-12-24 16:49:36 +0800608void cs_free(cs_insn *insn, size_t count)
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +0800609{
Nguyen Anh Quynh4fe224b2013-12-24 16:49:36 +0800610 size_t i;
611
612 // free all detail pointers
613 for (i = 0; i < count; i++)
Nguyen Anh Quynha8eb7a52014-01-11 12:55:31 +0800614 cs_mem_free(insn[i].detail);
Nguyen Anh Quynh4fe224b2013-12-24 16:49:36 +0800615
616 // then free pointer to cs_insn array
Nguyen Anh Quynha8eb7a52014-01-11 12:55:31 +0800617 cs_mem_free(insn);
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +0800618}
619
Nguyen Anh Quynh0a2eca72014-10-11 00:36:16 +0800620CAPSTONE_EXPORT
621cs_insn *cs_malloc(csh ud)
622{
623 cs_insn *insn;
624 struct cs_struct *handle = (struct cs_struct *)(uintptr_t)ud;
625
626 insn = cs_mem_malloc(sizeof(cs_insn));
627 if (!insn) {
628 // insufficient memory
629 handle->errnum = CS_ERR_MEM;
630 return NULL;
631 } else {
632 if (handle->detail) {
633 // allocate memory for @detail pointer
634 insn->detail = cs_mem_malloc(sizeof(cs_detail));
635 if (insn->detail == NULL) { // insufficient memory
636 cs_mem_free(insn);
637 handle->errnum = CS_ERR_MEM;
638 return NULL;
639 }
640 } else
641 insn->detail = NULL;
642 }
643
644 return insn;
645}
646
hlide993f3622014-10-05 18:14:40 +0200647// iterator for instruction "single-stepping"
648CAPSTONE_EXPORT
Nguyen Anh Quynh0a2eca72014-10-11 00:36:16 +0800649bool cs_disasm_iter(csh ud, const uint8_t **code, size_t *size,
650 uint64_t *address, cs_insn *insn)
hlide993f3622014-10-05 18:14:40 +0200651{
652 struct cs_struct *handle;
hlide993f3622014-10-05 18:14:40 +0200653 uint16_t insn_size;
654 MCInst mci;
655 bool r;
656
657 handle = (struct cs_struct *)(uintptr_t)ud;
Nguyen Anh Quynh0a2eca72014-10-11 00:36:16 +0800658 if (!handle) {
Nguyen Anh Quynh29ce6c32014-10-12 15:28:34 +0800659 return false;
hlide993f3622014-10-05 18:14:40 +0200660 }
661
662 handle->errnum = CS_ERR_OK;
663
hlide993f3622014-10-05 18:14:40 +0200664 MCInst_Init(&mci);
665 mci.csh = handle;
666
667 // relative branches need to know the address & size of current insn
668 mci.address = *address;
669
670 // save all the information for non-detailed mode
Nguyen Anh Quynh0a2eca72014-10-11 00:36:16 +0800671 mci.flat_insn = insn;
hlide993f3622014-10-05 18:14:40 +0200672 mci.flat_insn->address = *address;
673#ifdef CAPSTONE_DIET
674 // zero out mnemonic & op_str
675 mci.flat_insn->mnemonic[0] = '\0';
676 mci.flat_insn->op_str[0] = '\0';
677#endif
678
679 r = handle->disasm(ud, *code, *size, &mci, &insn_size, *address, handle->getinsn_info);
Nguyen Anh Quynh0a2eca72014-10-11 00:36:16 +0800680 if (r) {
hlide993f3622014-10-05 18:14:40 +0200681 SStream ss;
682 SStream_Init(&ss);
683
684 mci.flat_insn->size = insn_size;
Nguyen Anh Quynhff7bba32014-11-03 16:32:06 +0800685
686 // map internal instruction opcode to public insn ID
687 handle->insn_id(handle, insn, mci.Opcode);
688
hlide993f3622014-10-05 18:14:40 +0200689 handle->printer(&mci, &ss, handle->printer_info);
Nguyen Anh Quynhff7bba32014-11-03 16:32:06 +0800690
Nguyen Anh Quynh0a2eca72014-10-11 00:36:16 +0800691 fill_insn(handle, insn, ss.buffer, &mci, handle->post_printer, *code);
Nguyen Anh Quynhff7bba32014-11-03 16:32:06 +0800692
hlide993f3622014-10-05 18:14:40 +0200693 *code += insn_size;
694 *size -= insn_size;
695 *address += insn_size;
Nguyen Anh Quynh0a2eca72014-10-11 00:36:16 +0800696 } else { // encounter a broken instruction
697 size_t skipdata_bytes;
698
699 // if there is no request to skip data, or remaining data is too small,
700 // then bail out
701 if (!handle->skipdata || handle->skipdata_size > *size)
702 return false;
703
704 if (handle->skipdata_setup.callback) {
705 skipdata_bytes = handle->skipdata_setup.callback(*code, *size,
706 0, handle->skipdata_setup.user_data);
707 if (skipdata_bytes > *size)
708 // remaining data is not enough
709 return false;
710
711 if (!skipdata_bytes)
712 // user requested not to skip data, so bail out
713 return false;
714 } else
715 skipdata_bytes = handle->skipdata_size;
716
717 // we have to skip some amount of data, depending on arch & mode
718 insn->id = 0; // invalid ID for this "data" instruction
719 insn->address = *address;
720 insn->size = (uint16_t)skipdata_bytes;
721 memcpy(insn->bytes, *code, skipdata_bytes);
722 strncpy(insn->mnemonic, handle->skipdata_setup.mnemonic,
723 sizeof(insn->mnemonic) - 1);
724 skipdata_opstr(insn->op_str, *code, skipdata_bytes);
725
Nguyen Anh Quynh0a2eca72014-10-11 00:36:16 +0800726 *code += skipdata_bytes;
727 *size -= skipdata_bytes;
728 *address += skipdata_bytes;
hlide993f3622014-10-05 18:14:40 +0200729 }
Nguyen Anh Quynh0a2eca72014-10-11 00:36:16 +0800730
731 return true;
hlide993f3622014-10-05 18:14:40 +0200732}
733
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +0800734// return friendly name of regiser in a string
Nguyen Anh Quynh07c36932014-06-03 18:33:15 +0800735CAPSTONE_EXPORT
pancakef0e4eed2013-12-11 22:14:42 +0100736const char *cs_reg_name(csh ud, unsigned int reg)
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +0800737{
Nguyen Anh Quynha82a0892014-01-23 23:42:40 +0800738 struct cs_struct *handle = (struct cs_struct *)(uintptr_t)ud;
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +0800739
740 if (!handle || handle->reg_name == NULL) {
741 return NULL;
742 }
743
Nguyen Anh Quynha253c7a2013-12-09 10:26:18 +0800744 return handle->reg_name(ud, reg);
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +0800745}
746
Nguyen Anh Quynh07c36932014-06-03 18:33:15 +0800747CAPSTONE_EXPORT
pancakef0e4eed2013-12-11 22:14:42 +0100748const char *cs_insn_name(csh ud, unsigned int insn)
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +0800749{
Nguyen Anh Quynha82a0892014-01-23 23:42:40 +0800750 struct cs_struct *handle = (struct cs_struct *)(uintptr_t)ud;
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +0800751
752 if (!handle || handle->insn_name == NULL) {
753 return NULL;
754 }
755
Nguyen Anh Quynha253c7a2013-12-09 10:26:18 +0800756 return handle->insn_name(ud, insn);
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +0800757}
758
Nguyen Anh Quynh650f96c2014-07-08 08:59:27 +0800759CAPSTONE_EXPORT
760const char *cs_group_name(csh ud, unsigned int group)
761{
762 struct cs_struct *handle = (struct cs_struct *)(uintptr_t)ud;
763
764 if (!handle || handle->group_name == NULL) {
765 return NULL;
766 }
767
768 return handle->group_name(ud, group);
769}
770
Nguyen Anh Quynh70083562013-12-20 22:02:20 +0800771static bool arr_exist(unsigned char *arr, unsigned char max, unsigned int id)
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +0800772{
773 int i;
774
775 for (i = 0; i < max; i++) {
776 if (arr[i] == id)
777 return true;
778 }
779
780 return false;
781}
782
Nguyen Anh Quynh07c36932014-06-03 18:33:15 +0800783CAPSTONE_EXPORT
obs876b6b62014-08-21 00:57:04 +0200784bool cs_insn_group(csh ud, const cs_insn *insn, unsigned int group_id)
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +0800785{
Nguyen Anh Quynhbb0744d2014-05-12 13:41:49 +0800786 struct cs_struct *handle;
Nguyen Anh Quynh4fe224b2013-12-24 16:49:36 +0800787 if (!ud)
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +0800788 return false;
789
Axel 0vercl0k Souchet779d4c72014-05-08 23:44:49 +0100790 handle = (struct cs_struct *)(uintptr_t)ud;
Giovanni Condelloa715df12014-05-07 17:25:38 +0200791
Nguyen Anh Quynh4fe224b2013-12-24 16:49:36 +0800792 if (!handle->detail) {
793 handle->errnum = CS_ERR_DETAIL;
794 return false;
795 }
796
Giovanni Condello95657e02014-05-07 17:31:27 +0200797 if(!insn->id) {
798 handle->errnum = CS_ERR_SKIPDATA;
799 return false;
800 }
Giovanni Condelloa715df12014-05-07 17:25:38 +0200801
Giovanni Condello95657e02014-05-07 17:31:27 +0200802 if(!insn->detail) {
803 handle->errnum = CS_ERR_DETAIL;
804 return false;
805 }
Giovanni Condelloa715df12014-05-07 17:25:38 +0200806
Nguyen Anh Quynh4fe224b2013-12-24 16:49:36 +0800807 return arr_exist(insn->detail->groups, insn->detail->groups_count, group_id);
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +0800808}
809
Nguyen Anh Quynh07c36932014-06-03 18:33:15 +0800810CAPSTONE_EXPORT
obs876b6b62014-08-21 00:57:04 +0200811bool cs_reg_read(csh ud, const cs_insn *insn, unsigned int reg_id)
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +0800812{
Nguyen Anh Quynhbb0744d2014-05-12 13:41:49 +0800813 struct cs_struct *handle;
Nguyen Anh Quynh4fe224b2013-12-24 16:49:36 +0800814 if (!ud)
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +0800815 return false;
816
Axel 0vercl0k Souchet779d4c72014-05-08 23:44:49 +0100817 handle = (struct cs_struct *)(uintptr_t)ud;
Giovanni Condelloa715df12014-05-07 17:25:38 +0200818
Nguyen Anh Quynh4fe224b2013-12-24 16:49:36 +0800819 if (!handle->detail) {
820 handle->errnum = CS_ERR_DETAIL;
821 return false;
822 }
823
Giovanni Condello95657e02014-05-07 17:31:27 +0200824 if(!insn->id) {
825 handle->errnum = CS_ERR_SKIPDATA;
826 return false;
827 }
Giovanni Condelloa715df12014-05-07 17:25:38 +0200828
Giovanni Condello95657e02014-05-07 17:31:27 +0200829 if(!insn->detail) {
830 handle->errnum = CS_ERR_DETAIL;
831 return false;
832 }
Giovanni Condelloa715df12014-05-07 17:25:38 +0200833
Nguyen Anh Quynh4fe224b2013-12-24 16:49:36 +0800834 return arr_exist(insn->detail->regs_read, insn->detail->regs_read_count, reg_id);
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +0800835}
836
Nguyen Anh Quynh07c36932014-06-03 18:33:15 +0800837CAPSTONE_EXPORT
obs876b6b62014-08-21 00:57:04 +0200838bool cs_reg_write(csh ud, const cs_insn *insn, unsigned int reg_id)
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +0800839{
Nguyen Anh Quynhbb0744d2014-05-12 13:41:49 +0800840 struct cs_struct *handle;
Nguyen Anh Quynh4fe224b2013-12-24 16:49:36 +0800841 if (!ud)
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +0800842 return false;
843
Axel 0vercl0k Souchet779d4c72014-05-08 23:44:49 +0100844 handle = (struct cs_struct *)(uintptr_t)ud;
Giovanni Condello95657e02014-05-07 17:31:27 +0200845
Nguyen Anh Quynh4fe224b2013-12-24 16:49:36 +0800846 if (!handle->detail) {
847 handle->errnum = CS_ERR_DETAIL;
848 return false;
849 }
850
Giovanni Condello95657e02014-05-07 17:31:27 +0200851 if(!insn->id) {
852 handle->errnum = CS_ERR_SKIPDATA;
853 return false;
854 }
Giovanni Condelloa715df12014-05-07 17:25:38 +0200855
Giovanni Condello95657e02014-05-07 17:31:27 +0200856 if(!insn->detail) {
857 handle->errnum = CS_ERR_DETAIL;
858 return false;
859 }
Giovanni Condelloa715df12014-05-07 17:25:38 +0200860
Nguyen Anh Quynh4fe224b2013-12-24 16:49:36 +0800861 return arr_exist(insn->detail->regs_write, insn->detail->regs_write_count, reg_id);
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +0800862}
863
Nguyen Anh Quynh07c36932014-06-03 18:33:15 +0800864CAPSTONE_EXPORT
obs876b6b62014-08-21 00:57:04 +0200865int cs_op_count(csh ud, const cs_insn *insn, unsigned int op_type)
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +0800866{
Nguyen Anh Quynhbb0744d2014-05-12 13:41:49 +0800867 struct cs_struct *handle;
868 unsigned int count = 0, i;
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +0800869 if (!ud)
870 return -1;
871
Axel 0vercl0k Souchet779d4c72014-05-08 23:44:49 +0100872 handle = (struct cs_struct *)(uintptr_t)ud;
Giovanni Condelloa715df12014-05-07 17:25:38 +0200873
Nguyen Anh Quynh24e12272014-01-15 21:27:23 +0800874 if (!handle->detail) {
875 handle->errnum = CS_ERR_DETAIL;
876 return -1;
877 }
878
Giovanni Condello95657e02014-05-07 17:31:27 +0200879 if(!insn->id) {
880 handle->errnum = CS_ERR_SKIPDATA;
881 return -1;
882 }
Giovanni Condelloa715df12014-05-07 17:25:38 +0200883
Giovanni Condello95657e02014-05-07 17:31:27 +0200884 if(!insn->detail) {
885 handle->errnum = CS_ERR_DETAIL;
886 return -1;
887 }
Giovanni Condelloa715df12014-05-07 17:25:38 +0200888
Nguyen Anh Quynh3eb9ac92013-11-27 15:24:47 +0800889 handle->errnum = CS_ERR_OK;
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +0800890
891 switch (handle->arch) {
892 default:
Nguyen Anh Quynh3eb9ac92013-11-27 15:24:47 +0800893 handle->errnum = CS_ERR_HANDLE;
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +0800894 return -1;
895 case CS_ARCH_ARM:
Nguyen Anh Quynh4fe224b2013-12-24 16:49:36 +0800896 for (i = 0; i < insn->detail->arm.op_count; i++)
Alex Ionescu46018db2014-01-22 09:45:00 -0800897 if (insn->detail->arm.operands[i].type == (arm_op_type)op_type)
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +0800898 count++;
899 break;
900 case CS_ARCH_ARM64:
Nguyen Anh Quynh4fe224b2013-12-24 16:49:36 +0800901 for (i = 0; i < insn->detail->arm64.op_count; i++)
Alex Ionescu46018db2014-01-22 09:45:00 -0800902 if (insn->detail->arm64.operands[i].type == (arm64_op_type)op_type)
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +0800903 count++;
904 break;
905 case CS_ARCH_X86:
Nguyen Anh Quynh4fe224b2013-12-24 16:49:36 +0800906 for (i = 0; i < insn->detail->x86.op_count; i++)
Alex Ionescu46018db2014-01-22 09:45:00 -0800907 if (insn->detail->x86.operands[i].type == (x86_op_type)op_type)
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +0800908 count++;
909 break;
910 case CS_ARCH_MIPS:
Nguyen Anh Quynh4fe224b2013-12-24 16:49:36 +0800911 for (i = 0; i < insn->detail->mips.op_count; i++)
Alex Ionescu46018db2014-01-22 09:45:00 -0800912 if (insn->detail->mips.operands[i].type == (mips_op_type)op_type)
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +0800913 count++;
914 break;
Nguyen Anh Quynh42c6b1a2013-12-30 00:15:25 +0800915 case CS_ARCH_PPC:
916 for (i = 0; i < insn->detail->ppc.op_count; i++)
Alex Ionescu46018db2014-01-22 09:45:00 -0800917 if (insn->detail->ppc.operands[i].type == (ppc_op_type)op_type)
Nguyen Anh Quynh42c6b1a2013-12-30 00:15:25 +0800918 count++;
919 break;
Nguyen Anh Quynh05e27132014-03-10 11:58:57 +0800920 case CS_ARCH_SPARC:
921 for (i = 0; i < insn->detail->sparc.op_count; i++)
922 if (insn->detail->sparc.operands[i].type == (sparc_op_type)op_type)
923 count++;
924 break;
Nguyen Anh Quynh48a14ca2014-03-23 08:35:45 +0800925 case CS_ARCH_SYSZ:
926 for (i = 0; i < insn->detail->sysz.op_count; i++)
927 if (insn->detail->sysz.operands[i].type == (sysz_op_type)op_type)
928 count++;
929 break;
Nguyen Anh Quynhc80d8402014-05-26 23:02:48 +0800930 case CS_ARCH_XCORE:
931 for (i = 0; i < insn->detail->xcore.op_count; i++)
932 if (insn->detail->xcore.operands[i].type == (xcore_op_type)op_type)
933 count++;
934 break;
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +0800935 }
936
937 return count;
938}
939
Nguyen Anh Quynh07c36932014-06-03 18:33:15 +0800940CAPSTONE_EXPORT
obs876b6b62014-08-21 00:57:04 +0200941int cs_op_index(csh ud, const cs_insn *insn, unsigned int op_type,
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +0800942 unsigned int post)
943{
Nguyen Anh Quynhbb0744d2014-05-12 13:41:49 +0800944 struct cs_struct *handle;
945 unsigned int count = 0, i;
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +0800946 if (!ud)
947 return -1;
948
Axel 0vercl0k Souchet779d4c72014-05-08 23:44:49 +0100949 handle = (struct cs_struct *)(uintptr_t)ud;
Giovanni Condelloa715df12014-05-07 17:25:38 +0200950
Nguyen Anh Quynh24e12272014-01-15 21:27:23 +0800951 if (!handle->detail) {
952 handle->errnum = CS_ERR_DETAIL;
953 return -1;
954 }
955
Giovanni Condello95657e02014-05-07 17:31:27 +0200956 if(!insn->id) {
957 handle->errnum = CS_ERR_SKIPDATA;
958 return -1;
959 }
Giovanni Condelloa715df12014-05-07 17:25:38 +0200960
Giovanni Condello95657e02014-05-07 17:31:27 +0200961 if(!insn->detail) {
962 handle->errnum = CS_ERR_DETAIL;
963 return -1;
964 }
Giovanni Condelloa715df12014-05-07 17:25:38 +0200965
Nguyen Anh Quynh3eb9ac92013-11-27 15:24:47 +0800966 handle->errnum = CS_ERR_OK;
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +0800967
968 switch (handle->arch) {
969 default:
Nguyen Anh Quynh3eb9ac92013-11-27 15:24:47 +0800970 handle->errnum = CS_ERR_HANDLE;
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +0800971 return -1;
972 case CS_ARCH_ARM:
Nguyen Anh Quynh4fe224b2013-12-24 16:49:36 +0800973 for (i = 0; i < insn->detail->arm.op_count; i++) {
Alex Ionescu46018db2014-01-22 09:45:00 -0800974 if (insn->detail->arm.operands[i].type == (arm_op_type)op_type)
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +0800975 count++;
976 if (count == post)
977 return i;
978 }
979 break;
980 case CS_ARCH_ARM64:
Nguyen Anh Quynh4fe224b2013-12-24 16:49:36 +0800981 for (i = 0; i < insn->detail->arm64.op_count; i++) {
Alex Ionescu46018db2014-01-22 09:45:00 -0800982 if (insn->detail->arm64.operands[i].type == (arm64_op_type)op_type)
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +0800983 count++;
984 if (count == post)
985 return i;
986 }
987 break;
988 case CS_ARCH_X86:
Nguyen Anh Quynh4fe224b2013-12-24 16:49:36 +0800989 for (i = 0; i < insn->detail->x86.op_count; i++) {
Alex Ionescu46018db2014-01-22 09:45:00 -0800990 if (insn->detail->x86.operands[i].type == (x86_op_type)op_type)
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +0800991 count++;
992 if (count == post)
993 return i;
994 }
995 break;
996 case CS_ARCH_MIPS:
Nguyen Anh Quynh4fe224b2013-12-24 16:49:36 +0800997 for (i = 0; i < insn->detail->mips.op_count; i++) {
Alex Ionescu46018db2014-01-22 09:45:00 -0800998 if (insn->detail->mips.operands[i].type == (mips_op_type)op_type)
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +0800999 count++;
1000 if (count == post)
1001 return i;
1002 }
1003 break;
Nguyen Anh Quynh42c6b1a2013-12-30 00:15:25 +08001004 case CS_ARCH_PPC:
1005 for (i = 0; i < insn->detail->ppc.op_count; i++) {
Alex Ionescu46018db2014-01-22 09:45:00 -08001006 if (insn->detail->ppc.operands[i].type == (ppc_op_type)op_type)
Nguyen Anh Quynh42c6b1a2013-12-30 00:15:25 +08001007 count++;
1008 if (count == post)
1009 return i;
1010 }
1011 break;
Nguyen Anh Quynh05e27132014-03-10 11:58:57 +08001012 case CS_ARCH_SPARC:
1013 for (i = 0; i < insn->detail->sparc.op_count; i++) {
1014 if (insn->detail->sparc.operands[i].type == (sparc_op_type)op_type)
1015 count++;
1016 if (count == post)
1017 return i;
1018 }
1019 break;
Nguyen Anh Quynh48a14ca2014-03-23 08:35:45 +08001020 case CS_ARCH_SYSZ:
1021 for (i = 0; i < insn->detail->sysz.op_count; i++) {
1022 if (insn->detail->sysz.operands[i].type == (sysz_op_type)op_type)
1023 count++;
1024 if (count == post)
1025 return i;
1026 }
1027 break;
Nguyen Anh Quynhc80d8402014-05-26 23:02:48 +08001028 case CS_ARCH_XCORE:
1029 for (i = 0; i < insn->detail->xcore.op_count; i++) {
1030 if (insn->detail->xcore.operands[i].type == (xcore_op_type)op_type)
1031 count++;
1032 if (count == post)
1033 return i;
1034 }
1035 break;
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +08001036 }
1037
1038 return -1;
1039}