blob: a66af4387354eca37e0012d72a0f3a2a610a242b [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 Quynh9fac5122014-01-07 10:56:04 +0800241 // arch_destroy[ud->arch](ud);
Nguyen Anh Quynhb2654062014-01-03 17:08:58 +0800242
Nguyen Anh Quynha8eb7a52014-01-11 12:55:31 +0800243 cs_mem_free(ud->insn_cache);
Nguyen Anh Quynhee143c82014-01-03 21:51:59 +0800244 memset(ud, 0, sizeof(*ud));
Nguyen Anh Quynha8eb7a52014-01-11 12:55:31 +0800245 cs_mem_free(ud);
Nguyen Anh Quynhee143c82014-01-03 21:51:59 +0800246
Nguyen Anh Quynhc8e07852014-02-28 09:38:11 +0800247 // invalidate this handle by ZERO out its value.
248 // this is to make sure it is unusable after cs_close()
Nguyen Anh Quynh226d7dc2014-02-27 22:20:39 +0800249 *handle = 0;
250
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +0800251 return CS_ERR_OK;
252}
253
254// fill insn with mnemonic & operands info
Nguyen Anh Quynha82a0892014-01-23 23:42:40 +0800255static void fill_insn(struct cs_struct *handle, cs_insn *insn, char *buffer, MCInst *mci,
Nguyen Anh Quynh4fe224b2013-12-24 16:49:36 +0800256 PostPrinter_t postprinter, const uint8_t *code)
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +0800257{
Nguyen Anh Quynh8c2e2db2014-05-14 07:32:56 +0800258#ifndef CAPSTONE_DIET
Nguyen Anh Quynh5329a6f2014-06-08 23:35:52 +0700259 char *sp, *mnem;
Nguyen Anh Quynh8c2e2db2014-05-14 07:32:56 +0800260#endif
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +0800261
Nguyen Anh Quynh4fe224b2013-12-24 16:49:36 +0800262 // fill the instruction bytes
263 memcpy(insn->bytes, code, MIN(sizeof(insn->bytes), insn->size));
264
Nguyen Anh Quynh4d3e8522013-12-14 10:45:09 +0800265 // map internal instruction opcode to public insn ID
Nguyen Anh Quynh07e84a22014-06-08 19:27:22 +0800266 handle->insn_id(handle, insn, MCInst_getOpcode(mci));
Nguyen Anh Quynh4d3e8522013-12-14 10:45:09 +0800267
268 // alias instruction might have ID saved in OpcodePub
269 if (MCInst_getOpcodePub(mci))
270 insn->id = MCInst_getOpcodePub(mci);
271
272 // post printer handles some corner cases (hacky)
Nguyen Anh Quynh4fe224b2013-12-24 16:49:36 +0800273 if (postprinter)
Nguyen Anh Quynh64564812014-05-19 16:46:31 +0800274 postprinter((csh)handle, insn, buffer, mci);
Nguyen Anh Quynh4d3e8522013-12-14 10:45:09 +0800275
Nguyen Anh Quynhfc83a432014-02-22 23:26:27 +0800276#ifndef CAPSTONE_DIET
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +0800277 // fill in mnemonic & operands
Nguyen Anh Quynhdefb9bc2013-12-12 14:00:12 +0800278 // find first space or tab
Axel 0vercl0k Souchet779d4c72014-05-08 23:44:49 +0100279 sp = buffer;
Nguyen Anh Quynh7566a2d2014-06-08 22:09:31 +0800280 mnem = insn->mnemonic;
Nguyen Anh Quynh25b7f762014-07-02 12:22:39 +0800281 for (sp = buffer; *sp; sp++) {
282 if (*sp == ' '|| *sp == '\t')
283 break;
284 if (*sp == '|') // lock|rep prefix for x86
285 *sp = ' ';
286 // copy to @mnemonic
287 *mnem = *sp;
288 mnem++;
Nguyen Anh Quynha5ffdc32014-05-07 08:25:24 +0800289 }
290
Nguyen Anh Quynh7566a2d2014-06-08 22:09:31 +0800291 *mnem = '\0';
292
293 // copy @op_str
Nguyen Anh Quynhdefb9bc2013-12-12 14:00:12 +0800294 if (*sp) {
295 *sp = '\0';
Nguyen Anh Quynh86dc3932013-12-12 14:43:39 +0800296 // find the next non-space char
297 sp++;
298 for (; ((*sp == ' ') || (*sp == '\t')); sp++);
299 strncpy(insn->op_str, sp, sizeof(insn->op_str) - 1);
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +0800300 insn->op_str[sizeof(insn->op_str) - 1] = '\0';
301 } else
302 insn->op_str[0] = '\0';
Nguyen Anh Quynhfc83a432014-02-22 23:26:27 +0800303#endif
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +0800304}
305
Nguyen Anh Quynhd3ffe372014-04-09 23:49:30 +0800306// how many bytes will we skip when encountering data (CS_OPT_SKIPDATA)?
Nguyen Anh Quynha89383e2014-04-10 11:53:46 +0800307// this very much depends on instruction alignment requirement of each arch.
Nguyen Anh Quynhd3ffe372014-04-09 23:49:30 +0800308static uint8_t skipdata_size(cs_struct *handle)
309{
310 switch(handle->arch) {
311 default:
312 // should never reach
313 return -1;
314 case CS_ARCH_ARM:
Nguyen Anh Quynha89383e2014-04-10 11:53:46 +0800315 // skip 2 bytes on Thumb mode.
316 if (handle->mode & CS_MODE_THUMB)
317 return 2;
318 // otherwise, skip 4 bytes
319 return 4;
Nguyen Anh Quynhd3ffe372014-04-09 23:49:30 +0800320 case CS_ARCH_ARM64:
321 case CS_ARCH_MIPS:
322 case CS_ARCH_PPC:
323 case CS_ARCH_SPARC:
Nguyen Anh Quynha89383e2014-04-10 11:53:46 +0800324 // skip 4 bytes
325 return 4;
Nguyen Anh Quynhd3ffe372014-04-09 23:49:30 +0800326 case CS_ARCH_SYSZ:
Nguyen Anh Quynha89383e2014-04-10 11:53:46 +0800327 // SystemZ instruction's length can be 2, 4 or 6 bytes,
328 // so we just skip 2 bytes
Nguyen Anh Quynhd3ffe372014-04-09 23:49:30 +0800329 return 2;
330 case CS_ARCH_X86:
331 // X86 has no restriction on instruction alignment
332 return 1;
Nguyen Anh Quynhc80d8402014-05-26 23:02:48 +0800333 case CS_ARCH_XCORE:
334 // XCore instruction's length can be 2 or 4 bytes,
335 // so we just skip 2 bytes
336 return 2;
Nguyen Anh Quynhd3ffe372014-04-09 23:49:30 +0800337 }
338}
339
Nguyen Anh Quynh07c36932014-06-03 18:33:15 +0800340CAPSTONE_EXPORT
Nguyen Anh Quynhda8adad2013-12-04 09:44:07 +0800341cs_err cs_option(csh ud, cs_opt_type type, size_t value)
Nguyen Anh Quynh01aba002013-12-03 21:00:09 +0800342{
Nguyen Anh Quynhbb0744d2014-05-12 13:41:49 +0800343 struct cs_struct *handle;
Nguyen Anh Quynhc46c35d2014-03-05 00:21:53 +0800344 archs_enable();
345
Nguyen Anh Quynh24bf0d92014-01-05 11:19:04 +0800346 // cs_option() can be called with NULL handle just for CS_OPT_MEM
347 // This is supposed to be executed before all other APIs (even cs_open())
348 if (type == CS_OPT_MEM) {
349 cs_opt_mem *mem = (cs_opt_mem *)value;
350
Nguyen Anh Quynha8eb7a52014-01-11 12:55:31 +0800351 cs_mem_malloc = mem->malloc;
352 cs_mem_calloc = mem->calloc;
353 cs_mem_realloc = mem->realloc;
354 cs_mem_free = mem->free;
Nguyen Anh Quynhedeeb042014-01-15 20:44:03 +0800355 cs_vsnprintf = mem->vsnprintf;
Nguyen Anh Quynh24bf0d92014-01-05 11:19:04 +0800356
357 return CS_ERR_OK;
358 }
359
Axel 0vercl0k Souchet779d4c72014-05-08 23:44:49 +0100360 handle = (struct cs_struct *)(uintptr_t)ud;
danghvu2b192962013-12-19 22:40:28 -0600361 if (!handle)
362 return CS_ERR_CSH;
Nguyen Anh Quynh01aba002013-12-03 21:00:09 +0800363
Nguyen Anh Quynhd3ffe372014-04-09 23:49:30 +0800364 switch(type) {
365 default:
366 break;
367 case CS_OPT_DETAIL:
368 handle->detail = value;
369 return CS_ERR_OK;
370 case CS_OPT_SKIPDATA:
371 handle->skipdata = (value == CS_OPT_ON);
372 if (handle->skipdata) {
373 if (handle->skipdata_size == 0) {
374 // set the default skipdata size
375 handle->skipdata_size = skipdata_size(handle);
376 }
377 }
378 return CS_ERR_OK;
379 case CS_OPT_SKIPDATA_SETUP:
380 if (value)
381 handle->skipdata_setup = *((cs_opt_skipdata *)value);
382 return CS_ERR_OK;
Nguyen Anh Quynh7d02c922013-12-21 09:59:31 +0800383 }
Nguyen Anh Quynha209e672013-12-14 00:23:41 +0800384
Nguyen Anh Quynhd3458392013-12-22 11:10:56 +0800385 return arch_option[handle->arch](handle, type, value);
Nguyen Anh Quynh01aba002013-12-03 21:00:09 +0800386}
387
Nguyen Anh Quynh07ffd642014-04-10 14:36:08 +0800388// generate @op_str for data instruction of SKIPDATA
Nguyen Anh Quynhd3ffe372014-04-09 23:49:30 +0800389static void skipdata_opstr(char *opstr, const uint8_t *buffer, size_t size)
390{
391 char *p = opstr;
392 int len;
393 size_t i;
394
395 if (!size) {
396 opstr[0] = '\0';
397 return;
398 }
399
400 len = sprintf(p, "0x%02x", buffer[0]);
401 p+= len;
402
403 for(i = 1; i < size; i++) {
404 len = sprintf(p, ", 0x%02x", buffer[i]);
405 p+= len;
406 }
407}
408
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +0800409// dynamicly allocate memory to contain disasm insn
410// NOTE: caller must free() the allocated memory itself to avoid memory leaking
Nguyen Anh Quynh07c36932014-06-03 18:33:15 +0800411CAPSTONE_EXPORT
Nguyen Anh Quynh0beb0d42014-08-27 22:55:29 +0800412size_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 +0800413{
Nguyen Anh Quynha82a0892014-01-23 23:42:40 +0800414 struct cs_struct *handle = (struct cs_struct *)(uintptr_t)ud;
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +0800415 MCInst mci;
416 uint16_t insn_size;
Nguyen Anh Quynh6c182ae2014-06-18 21:50:25 +0800417 size_t c = 0, i;
Nguyen Anh Quynh7772d852014-01-21 11:49:25 +0800418 unsigned int f = 0;
Nguyen Anh Quynhee583942014-06-09 00:13:31 +0700419 cs_insn *insn_cache;
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +0800420 void *total = NULL;
Nguyen Anh Quynhb42a6572013-11-29 17:40:07 +0800421 size_t total_size = 0;
Nguyen Anh Quynh034a7482014-03-06 22:40:08 +0800422 bool r;
Nguyen Anh Quynhd3ffe372014-04-09 23:49:30 +0800423 void *tmp;
424 size_t skipdata_bytes;
Nguyen Anh Quynh0df7e932014-07-10 15:42:16 +0800425 // save all the original info of the buffer
Nguyen Anh Quynh07ffd642014-04-10 14:36:08 +0800426 uint64_t offset_org;
Nguyen Anh Quynh0df7e932014-07-10 15:42:16 +0800427 size_t size_org;
428 const uint8_t *buffer_org;
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +0800429
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 Quynh2cff6f62014-04-28 11:19:44 +0800438 // save the original offset for SKIPDATA
Nguyen Anh Quynh0df7e932014-07-10 15:42:16 +0800439 buffer_org = buffer;
Nguyen Anh Quynh07ffd642014-04-10 14:36:08 +0800440 offset_org = offset;
Nguyen Anh Quynh0df7e932014-07-10 15:42:16 +0800441 size_org = size;
Nguyen Anh Quynhee583942014-06-09 00:13:31 +0700442 total_size = (sizeof(cs_insn) * INSN_CACHE_SIZE);
443 total = cs_mem_malloc(total_size);
444 insn_cache = total;
Nguyen Anh Quynh2cff6f62014-04-28 11:19:44 +0800445
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +0800446 while (size > 0) {
Nguyen Anh Quynh495295e2014-06-16 15:54:32 +0800447 MCInst_Init(&mci);
Nguyen Anh Quynh42c6b1a2013-12-30 00:15:25 +0800448 mci.csh = handle;
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +0800449
Nguyen Anh Quynh5329a6f2014-06-08 23:35:52 +0700450 // relative branches need to know the address & size of current insn
451 mci.address = offset;
452
453 if (handle->detail) {
454 // allocate memory for @detail pointer
Nguyen Anh Quynhee583942014-06-09 00:13:31 +0700455 insn_cache->detail = cs_mem_malloc(sizeof(cs_detail));
Nguyen Anh Quynh5329a6f2014-06-08 23:35:52 +0700456 } else {
Nguyen Anh Quynhee583942014-06-09 00:13:31 +0700457 insn_cache->detail = NULL;
Nguyen Anh Quynh5329a6f2014-06-08 23:35:52 +0700458 }
459
460 // save all the information for non-detailed mode
Nguyen Anh Quynhee583942014-06-09 00:13:31 +0700461 mci.flat_insn = insn_cache;
Nguyen Anh Quynh5329a6f2014-06-08 23:35:52 +0700462 mci.flat_insn->address = offset;
Nguyen Anh Quynh0c07cc92014-08-27 22:31:54 +0800463#ifdef CAPSTONE_DIET
464 // zero out mnemonic & op_str
465 mci.flat_insn->mnemonic[0] = '\0';
466 mci.flat_insn->op_str[0] = '\0';
467#endif
Nguyen Anh Quynh5329a6f2014-06-08 23:35:52 +0700468
Nguyen Anh Quynha5ffdc32014-05-07 08:25:24 +0800469 r = handle->disasm(ud, buffer, size, &mci, &insn_size, offset, handle->getinsn_info);
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +0800470 if (r) {
471 SStream ss;
472 SStream_Init(&ss);
473
Nguyen Anh Quynh5329a6f2014-06-08 23:35:52 +0700474 mci.flat_insn->size = insn_size;
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +0800475 handle->printer(&mci, &ss, handle->printer_info);
Nguyen Anh Quynhee583942014-06-09 00:13:31 +0700476 fill_insn(handle, insn_cache, ss.buffer, &mci, handle->post_printer, buffer);
Nguyen Anh Quynha209e672013-12-14 00:23:41 +0800477
Nguyen Anh Quynha5ffdc32014-05-07 08:25:24 +0800478 f++;
Nguyen Anh Quynhee583942014-06-09 00:13:31 +0700479 if (f == INSN_CACHE_SIZE) {
Nguyen Anh Quynha5ffdc32014-05-07 08:25:24 +0800480 // resize total to contain newly disasm insns
481 total_size += (sizeof(cs_insn) * INSN_CACHE_SIZE);
482 tmp = cs_mem_realloc(total, total_size);
483 if (tmp == NULL) { // insufficient memory
Nguyen Anh Quynh6c182ae2014-06-18 21:50:25 +0800484 if (handle->detail) {
485 insn_cache = (cs_insn *)total;
486 for (i = 0; i < c; i++, insn_cache++)
487 cs_mem_free(insn_cache->detail);
488 }
489
Nguyen Anh Quynha5ffdc32014-05-07 08:25:24 +0800490 cs_mem_free(total);
Nguyen Anh Quynhdab17fd2014-06-19 11:15:18 +0800491 *insn = NULL;
Nguyen Anh Quynha5ffdc32014-05-07 08:25:24 +0800492 handle->errnum = CS_ERR_MEM;
493 return 0;
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +0800494 }
495
Nguyen Anh Quynha5ffdc32014-05-07 08:25:24 +0800496 total = tmp;
Nguyen Anh Quynhcae09bf2014-06-17 14:58:39 +0800497 insn_cache = (cs_insn *)((char *)total + total_size - (sizeof(cs_insn) * INSN_CACHE_SIZE));
Nguyen Anh Quynha5ffdc32014-05-07 08:25:24 +0800498
499 // reset f back to 0
500 f = 0;
Nguyen Anh Quynhc88d9922014-06-09 01:59:00 +0800501 } else
502 insn_cache++;
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +0800503
Nguyen Anh Quynha5ffdc32014-05-07 08:25:24 +0800504 c++;
Nguyen Anh Quynha5ffdc32014-05-07 08:25:24 +0800505 if (count > 0 && c == count)
506 break;
Nguyen Anh Quynhee583942014-06-09 00:13:31 +0700507
508 buffer += insn_size;
509 size -= insn_size;
510 offset += insn_size;
Nguyen Anh Quynh8f13f3c2013-12-04 22:57:04 +0800511 } else {
Nguyen Anh Quynh6c182ae2014-06-18 21:50:25 +0800512 if (handle->detail) {
513 // free memory of @detail pointer
514 cs_mem_free(insn_cache->detail);
515 }
516
Nguyen Anh Quynh8f13f3c2013-12-04 22:57:04 +0800517 // encounter a broken instruction
Nguyen Anh Quynhd3ffe372014-04-09 23:49:30 +0800518 // if there is no request to skip data, or remaining data is too small,
519 // then bail out
520 if (!handle->skipdata || handle->skipdata_size > size)
521 break;
522
523 if (handle->skipdata_setup.callback) {
Nguyen Anh Quynh0df7e932014-07-10 15:42:16 +0800524 skipdata_bytes = handle->skipdata_setup.callback(buffer_org, size_org,
Nguyen Anh Quynh4b6b15f2014-08-26 15:57:04 +0800525 (size_t)(offset - offset_org), handle->skipdata_setup.user_data);
Nguyen Anh Quynhd3ffe372014-04-09 23:49:30 +0800526 if (skipdata_bytes > size)
527 // remaining data is not enough
528 break;
529
530 if (!skipdata_bytes)
531 // user requested not to skip data, so bail out
532 break;
533 } else
534 skipdata_bytes = handle->skipdata_size;
535
536 // we have to skip some amount of data, depending on arch & mode
Nguyen Anh Quynhee583942014-06-09 00:13:31 +0700537 insn_cache->id = 0; // invalid ID for this "data" instruction
538 insn_cache->address = offset;
flyingsymbols298d4132014-06-30 01:45:40 -0400539 insn_cache->size = (uint16_t) skipdata_bytes;
Nguyen Anh Quynhee583942014-06-09 00:13:31 +0700540 memcpy(insn_cache->bytes, buffer, skipdata_bytes);
541 strncpy(insn_cache->mnemonic, handle->skipdata_setup.mnemonic,
542 sizeof(insn_cache->mnemonic) - 1);
543 skipdata_opstr(insn_cache->op_str, buffer, skipdata_bytes);
544 insn_cache->detail = NULL;
Nguyen Anh Quynhd3ffe372014-04-09 23:49:30 +0800545
546 f++;
Nguyen Anh Quynhee583942014-06-09 00:13:31 +0700547 if (f == INSN_CACHE_SIZE) {
Nguyen Anh Quynhd3ffe372014-04-09 23:49:30 +0800548 // resize total to contain newly disasm insns
549
550 total_size += (sizeof(cs_insn) * INSN_CACHE_SIZE);
551 tmp = cs_mem_realloc(total, total_size);
552 if (tmp == NULL) { // insufficient memory
Nguyen Anh Quynh6c182ae2014-06-18 21:50:25 +0800553 if (handle->detail) {
554 insn_cache = (cs_insn *)total;
555 for (i = 0; i < c; i++, insn_cache++)
556 cs_mem_free(insn_cache->detail);
557 }
558
Nguyen Anh Quynhd3ffe372014-04-09 23:49:30 +0800559 cs_mem_free(total);
Nguyen Anh Quynhdab17fd2014-06-19 11:15:18 +0800560 *insn = NULL;
Nguyen Anh Quynhd3ffe372014-04-09 23:49:30 +0800561 handle->errnum = CS_ERR_MEM;
562 return 0;
563 }
564
565 total = tmp;
Nguyen Anh Quynh6c182ae2014-06-18 21:50:25 +0800566 insn_cache = (cs_insn *)((char *)total + total_size - (sizeof(cs_insn) * INSN_CACHE_SIZE));
Nguyen Anh Quynhd3ffe372014-04-09 23:49:30 +0800567
568 // reset f back to 0
569 f = 0;
Nguyen Anh Quynh6c182ae2014-06-18 21:50:25 +0800570 } else
571 insn_cache++;
Nguyen Anh Quynhd3ffe372014-04-09 23:49:30 +0800572
573 buffer += skipdata_bytes;
574 size -= skipdata_bytes;
575 offset += skipdata_bytes;
576 c++;
Nguyen Anh Quynh8f13f3c2013-12-04 22:57:04 +0800577 }
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +0800578 }
579
580 if (f) {
581 // resize total to contain newly disasm insns
Nguyen Anh Quynhee583942014-06-09 00:13:31 +0700582 void *tmp = cs_mem_realloc(total, total_size - (INSN_CACHE_SIZE - f) * sizeof(*insn_cache));
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +0800583 if (tmp == NULL) { // insufficient memory
Nguyen Anh Quynh6c182ae2014-06-18 21:50:25 +0800584 // free all detail pointers
585 if (handle->detail) {
586 insn_cache = (cs_insn *)total;
587 for (i = 0; i < c; i++, insn_cache++)
588 cs_mem_free(insn_cache->detail);
589 }
590
Nguyen Anh Quynha8eb7a52014-01-11 12:55:31 +0800591 cs_mem_free(total);
Nguyen Anh Quynhdab17fd2014-06-19 11:15:18 +0800592 *insn = NULL;
Nguyen Anh Quynh6c182ae2014-06-18 21:50:25 +0800593
Nguyen Anh Quynh3eb9ac92013-11-27 15:24:47 +0800594 handle->errnum = CS_ERR_MEM;
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +0800595 return 0;
596 }
597
598 total = tmp;
Nguyen Anh Quynh6c182ae2014-06-18 21:50:25 +0800599 } else if (!c) {
600 cs_mem_free(total);
601 total = NULL;
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +0800602 }
603
604 *insn = total;
605
606 return c;
607}
608
Nguyen Anh Quynh07c36932014-06-03 18:33:15 +0800609CAPSTONE_EXPORT
Nguyen Anh Quynh0beb0d42014-08-27 22:55:29 +0800610CAPSTONE_DEPRECATED
611size_t cs_disasm_ex(csh ud, const uint8_t *buffer, size_t size, uint64_t offset, size_t count, cs_insn **insn)
612{
613 return cs_disasm(ud, buffer, size, offset, count, insn);
614}
615
616CAPSTONE_EXPORT
Nguyen Anh Quynh4fe224b2013-12-24 16:49:36 +0800617void cs_free(cs_insn *insn, size_t count)
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +0800618{
Nguyen Anh Quynh4fe224b2013-12-24 16:49:36 +0800619 size_t i;
620
621 // free all detail pointers
622 for (i = 0; i < count; i++)
Nguyen Anh Quynha8eb7a52014-01-11 12:55:31 +0800623 cs_mem_free(insn[i].detail);
Nguyen Anh Quynh4fe224b2013-12-24 16:49:36 +0800624
625 // then free pointer to cs_insn array
Nguyen Anh Quynha8eb7a52014-01-11 12:55:31 +0800626 cs_mem_free(insn);
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +0800627}
628
629// return friendly name of regiser in a string
Nguyen Anh Quynh07c36932014-06-03 18:33:15 +0800630CAPSTONE_EXPORT
pancakef0e4eed2013-12-11 22:14:42 +0100631const char *cs_reg_name(csh ud, unsigned int reg)
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +0800632{
Nguyen Anh Quynha82a0892014-01-23 23:42:40 +0800633 struct cs_struct *handle = (struct cs_struct *)(uintptr_t)ud;
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +0800634
635 if (!handle || handle->reg_name == NULL) {
636 return NULL;
637 }
638
Nguyen Anh Quynha253c7a2013-12-09 10:26:18 +0800639 return handle->reg_name(ud, reg);
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +0800640}
641
Nguyen Anh Quynh07c36932014-06-03 18:33:15 +0800642CAPSTONE_EXPORT
pancakef0e4eed2013-12-11 22:14:42 +0100643const char *cs_insn_name(csh ud, unsigned int insn)
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +0800644{
Nguyen Anh Quynha82a0892014-01-23 23:42:40 +0800645 struct cs_struct *handle = (struct cs_struct *)(uintptr_t)ud;
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +0800646
647 if (!handle || handle->insn_name == NULL) {
648 return NULL;
649 }
650
Nguyen Anh Quynha253c7a2013-12-09 10:26:18 +0800651 return handle->insn_name(ud, insn);
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +0800652}
653
Nguyen Anh Quynh650f96c2014-07-08 08:59:27 +0800654CAPSTONE_EXPORT
655const char *cs_group_name(csh ud, unsigned int group)
656{
657 struct cs_struct *handle = (struct cs_struct *)(uintptr_t)ud;
658
659 if (!handle || handle->group_name == NULL) {
660 return NULL;
661 }
662
663 return handle->group_name(ud, group);
664}
665
Nguyen Anh Quynh70083562013-12-20 22:02:20 +0800666static bool arr_exist(unsigned char *arr, unsigned char max, unsigned int id)
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +0800667{
668 int i;
669
670 for (i = 0; i < max; i++) {
671 if (arr[i] == id)
672 return true;
673 }
674
675 return false;
676}
677
Nguyen Anh Quynh07c36932014-06-03 18:33:15 +0800678CAPSTONE_EXPORT
obs876b6b62014-08-21 00:57:04 +0200679bool cs_insn_group(csh ud, const cs_insn *insn, unsigned int group_id)
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +0800680{
Nguyen Anh Quynhbb0744d2014-05-12 13:41:49 +0800681 struct cs_struct *handle;
Nguyen Anh Quynh4fe224b2013-12-24 16:49:36 +0800682 if (!ud)
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +0800683 return false;
684
Axel 0vercl0k Souchet779d4c72014-05-08 23:44:49 +0100685 handle = (struct cs_struct *)(uintptr_t)ud;
Giovanni Condelloa715df12014-05-07 17:25:38 +0200686
Nguyen Anh Quynh4fe224b2013-12-24 16:49:36 +0800687 if (!handle->detail) {
688 handle->errnum = CS_ERR_DETAIL;
689 return false;
690 }
691
Giovanni Condello95657e02014-05-07 17:31:27 +0200692 if(!insn->id) {
693 handle->errnum = CS_ERR_SKIPDATA;
694 return false;
695 }
Giovanni Condelloa715df12014-05-07 17:25:38 +0200696
Giovanni Condello95657e02014-05-07 17:31:27 +0200697 if(!insn->detail) {
698 handle->errnum = CS_ERR_DETAIL;
699 return false;
700 }
Giovanni Condelloa715df12014-05-07 17:25:38 +0200701
Nguyen Anh Quynh4fe224b2013-12-24 16:49:36 +0800702 return arr_exist(insn->detail->groups, insn->detail->groups_count, group_id);
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +0800703}
704
Nguyen Anh Quynh07c36932014-06-03 18:33:15 +0800705CAPSTONE_EXPORT
obs876b6b62014-08-21 00:57:04 +0200706bool cs_reg_read(csh ud, const cs_insn *insn, unsigned int reg_id)
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +0800707{
Nguyen Anh Quynhbb0744d2014-05-12 13:41:49 +0800708 struct cs_struct *handle;
Nguyen Anh Quynh4fe224b2013-12-24 16:49:36 +0800709 if (!ud)
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +0800710 return false;
711
Axel 0vercl0k Souchet779d4c72014-05-08 23:44:49 +0100712 handle = (struct cs_struct *)(uintptr_t)ud;
Giovanni Condelloa715df12014-05-07 17:25:38 +0200713
Nguyen Anh Quynh4fe224b2013-12-24 16:49:36 +0800714 if (!handle->detail) {
715 handle->errnum = CS_ERR_DETAIL;
716 return false;
717 }
718
Giovanni Condello95657e02014-05-07 17:31:27 +0200719 if(!insn->id) {
720 handle->errnum = CS_ERR_SKIPDATA;
721 return false;
722 }
Giovanni Condelloa715df12014-05-07 17:25:38 +0200723
Giovanni Condello95657e02014-05-07 17:31:27 +0200724 if(!insn->detail) {
725 handle->errnum = CS_ERR_DETAIL;
726 return false;
727 }
Giovanni Condelloa715df12014-05-07 17:25:38 +0200728
Nguyen Anh Quynh4fe224b2013-12-24 16:49:36 +0800729 return arr_exist(insn->detail->regs_read, insn->detail->regs_read_count, reg_id);
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +0800730}
731
Nguyen Anh Quynh07c36932014-06-03 18:33:15 +0800732CAPSTONE_EXPORT
obs876b6b62014-08-21 00:57:04 +0200733bool cs_reg_write(csh ud, const cs_insn *insn, unsigned int reg_id)
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +0800734{
Nguyen Anh Quynhbb0744d2014-05-12 13:41:49 +0800735 struct cs_struct *handle;
Nguyen Anh Quynh4fe224b2013-12-24 16:49:36 +0800736 if (!ud)
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +0800737 return false;
738
Axel 0vercl0k Souchet779d4c72014-05-08 23:44:49 +0100739 handle = (struct cs_struct *)(uintptr_t)ud;
Giovanni Condello95657e02014-05-07 17:31:27 +0200740
Nguyen Anh Quynh4fe224b2013-12-24 16:49:36 +0800741 if (!handle->detail) {
742 handle->errnum = CS_ERR_DETAIL;
743 return false;
744 }
745
Giovanni Condello95657e02014-05-07 17:31:27 +0200746 if(!insn->id) {
747 handle->errnum = CS_ERR_SKIPDATA;
748 return false;
749 }
Giovanni Condelloa715df12014-05-07 17:25:38 +0200750
Giovanni Condello95657e02014-05-07 17:31:27 +0200751 if(!insn->detail) {
752 handle->errnum = CS_ERR_DETAIL;
753 return false;
754 }
Giovanni Condelloa715df12014-05-07 17:25:38 +0200755
Nguyen Anh Quynh4fe224b2013-12-24 16:49:36 +0800756 return arr_exist(insn->detail->regs_write, insn->detail->regs_write_count, reg_id);
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +0800757}
758
Nguyen Anh Quynh07c36932014-06-03 18:33:15 +0800759CAPSTONE_EXPORT
obs876b6b62014-08-21 00:57:04 +0200760int cs_op_count(csh ud, const cs_insn *insn, unsigned int op_type)
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +0800761{
Nguyen Anh Quynhbb0744d2014-05-12 13:41:49 +0800762 struct cs_struct *handle;
763 unsigned int count = 0, i;
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +0800764 if (!ud)
765 return -1;
766
Axel 0vercl0k Souchet779d4c72014-05-08 23:44:49 +0100767 handle = (struct cs_struct *)(uintptr_t)ud;
Giovanni Condelloa715df12014-05-07 17:25:38 +0200768
Nguyen Anh Quynh24e12272014-01-15 21:27:23 +0800769 if (!handle->detail) {
770 handle->errnum = CS_ERR_DETAIL;
771 return -1;
772 }
773
Giovanni Condello95657e02014-05-07 17:31:27 +0200774 if(!insn->id) {
775 handle->errnum = CS_ERR_SKIPDATA;
776 return -1;
777 }
Giovanni Condelloa715df12014-05-07 17:25:38 +0200778
Giovanni Condello95657e02014-05-07 17:31:27 +0200779 if(!insn->detail) {
780 handle->errnum = CS_ERR_DETAIL;
781 return -1;
782 }
Giovanni Condelloa715df12014-05-07 17:25:38 +0200783
Nguyen Anh Quynh3eb9ac92013-11-27 15:24:47 +0800784 handle->errnum = CS_ERR_OK;
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +0800785
786 switch (handle->arch) {
787 default:
Nguyen Anh Quynh3eb9ac92013-11-27 15:24:47 +0800788 handle->errnum = CS_ERR_HANDLE;
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +0800789 return -1;
790 case CS_ARCH_ARM:
Nguyen Anh Quynh4fe224b2013-12-24 16:49:36 +0800791 for (i = 0; i < insn->detail->arm.op_count; i++)
Alex Ionescu46018db2014-01-22 09:45:00 -0800792 if (insn->detail->arm.operands[i].type == (arm_op_type)op_type)
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +0800793 count++;
794 break;
795 case CS_ARCH_ARM64:
Nguyen Anh Quynh4fe224b2013-12-24 16:49:36 +0800796 for (i = 0; i < insn->detail->arm64.op_count; i++)
Alex Ionescu46018db2014-01-22 09:45:00 -0800797 if (insn->detail->arm64.operands[i].type == (arm64_op_type)op_type)
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +0800798 count++;
799 break;
800 case CS_ARCH_X86:
Nguyen Anh Quynh4fe224b2013-12-24 16:49:36 +0800801 for (i = 0; i < insn->detail->x86.op_count; i++)
Alex Ionescu46018db2014-01-22 09:45:00 -0800802 if (insn->detail->x86.operands[i].type == (x86_op_type)op_type)
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +0800803 count++;
804 break;
805 case CS_ARCH_MIPS:
Nguyen Anh Quynh4fe224b2013-12-24 16:49:36 +0800806 for (i = 0; i < insn->detail->mips.op_count; i++)
Alex Ionescu46018db2014-01-22 09:45:00 -0800807 if (insn->detail->mips.operands[i].type == (mips_op_type)op_type)
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +0800808 count++;
809 break;
Nguyen Anh Quynh42c6b1a2013-12-30 00:15:25 +0800810 case CS_ARCH_PPC:
811 for (i = 0; i < insn->detail->ppc.op_count; i++)
Alex Ionescu46018db2014-01-22 09:45:00 -0800812 if (insn->detail->ppc.operands[i].type == (ppc_op_type)op_type)
Nguyen Anh Quynh42c6b1a2013-12-30 00:15:25 +0800813 count++;
814 break;
Nguyen Anh Quynh05e27132014-03-10 11:58:57 +0800815 case CS_ARCH_SPARC:
816 for (i = 0; i < insn->detail->sparc.op_count; i++)
817 if (insn->detail->sparc.operands[i].type == (sparc_op_type)op_type)
818 count++;
819 break;
Nguyen Anh Quynh48a14ca2014-03-23 08:35:45 +0800820 case CS_ARCH_SYSZ:
821 for (i = 0; i < insn->detail->sysz.op_count; i++)
822 if (insn->detail->sysz.operands[i].type == (sysz_op_type)op_type)
823 count++;
824 break;
Nguyen Anh Quynhc80d8402014-05-26 23:02:48 +0800825 case CS_ARCH_XCORE:
826 for (i = 0; i < insn->detail->xcore.op_count; i++)
827 if (insn->detail->xcore.operands[i].type == (xcore_op_type)op_type)
828 count++;
829 break;
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +0800830 }
831
832 return count;
833}
834
Nguyen Anh Quynh07c36932014-06-03 18:33:15 +0800835CAPSTONE_EXPORT
obs876b6b62014-08-21 00:57:04 +0200836int cs_op_index(csh ud, const cs_insn *insn, unsigned int op_type,
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +0800837 unsigned int post)
838{
Nguyen Anh Quynhbb0744d2014-05-12 13:41:49 +0800839 struct cs_struct *handle;
840 unsigned int count = 0, i;
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +0800841 if (!ud)
842 return -1;
843
Axel 0vercl0k Souchet779d4c72014-05-08 23:44:49 +0100844 handle = (struct cs_struct *)(uintptr_t)ud;
Giovanni Condelloa715df12014-05-07 17:25:38 +0200845
Nguyen Anh Quynh24e12272014-01-15 21:27:23 +0800846 if (!handle->detail) {
847 handle->errnum = CS_ERR_DETAIL;
848 return -1;
849 }
850
Giovanni Condello95657e02014-05-07 17:31:27 +0200851 if(!insn->id) {
852 handle->errnum = CS_ERR_SKIPDATA;
853 return -1;
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 -1;
859 }
Giovanni Condelloa715df12014-05-07 17:25:38 +0200860
Nguyen Anh Quynh3eb9ac92013-11-27 15:24:47 +0800861 handle->errnum = CS_ERR_OK;
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +0800862
863 switch (handle->arch) {
864 default:
Nguyen Anh Quynh3eb9ac92013-11-27 15:24:47 +0800865 handle->errnum = CS_ERR_HANDLE;
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +0800866 return -1;
867 case CS_ARCH_ARM:
Nguyen Anh Quynh4fe224b2013-12-24 16:49:36 +0800868 for (i = 0; i < insn->detail->arm.op_count; i++) {
Alex Ionescu46018db2014-01-22 09:45:00 -0800869 if (insn->detail->arm.operands[i].type == (arm_op_type)op_type)
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +0800870 count++;
871 if (count == post)
872 return i;
873 }
874 break;
875 case CS_ARCH_ARM64:
Nguyen Anh Quynh4fe224b2013-12-24 16:49:36 +0800876 for (i = 0; i < insn->detail->arm64.op_count; i++) {
Alex Ionescu46018db2014-01-22 09:45:00 -0800877 if (insn->detail->arm64.operands[i].type == (arm64_op_type)op_type)
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +0800878 count++;
879 if (count == post)
880 return i;
881 }
882 break;
883 case CS_ARCH_X86:
Nguyen Anh Quynh4fe224b2013-12-24 16:49:36 +0800884 for (i = 0; i < insn->detail->x86.op_count; i++) {
Alex Ionescu46018db2014-01-22 09:45:00 -0800885 if (insn->detail->x86.operands[i].type == (x86_op_type)op_type)
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +0800886 count++;
887 if (count == post)
888 return i;
889 }
890 break;
891 case CS_ARCH_MIPS:
Nguyen Anh Quynh4fe224b2013-12-24 16:49:36 +0800892 for (i = 0; i < insn->detail->mips.op_count; i++) {
Alex Ionescu46018db2014-01-22 09:45:00 -0800893 if (insn->detail->mips.operands[i].type == (mips_op_type)op_type)
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +0800894 count++;
895 if (count == post)
896 return i;
897 }
898 break;
Nguyen Anh Quynh42c6b1a2013-12-30 00:15:25 +0800899 case CS_ARCH_PPC:
900 for (i = 0; i < insn->detail->ppc.op_count; i++) {
Alex Ionescu46018db2014-01-22 09:45:00 -0800901 if (insn->detail->ppc.operands[i].type == (ppc_op_type)op_type)
Nguyen Anh Quynh42c6b1a2013-12-30 00:15:25 +0800902 count++;
903 if (count == post)
904 return i;
905 }
906 break;
Nguyen Anh Quynh05e27132014-03-10 11:58:57 +0800907 case CS_ARCH_SPARC:
908 for (i = 0; i < insn->detail->sparc.op_count; i++) {
909 if (insn->detail->sparc.operands[i].type == (sparc_op_type)op_type)
910 count++;
911 if (count == post)
912 return i;
913 }
914 break;
Nguyen Anh Quynh48a14ca2014-03-23 08:35:45 +0800915 case CS_ARCH_SYSZ:
916 for (i = 0; i < insn->detail->sysz.op_count; i++) {
917 if (insn->detail->sysz.operands[i].type == (sysz_op_type)op_type)
918 count++;
919 if (count == post)
920 return i;
921 }
922 break;
Nguyen Anh Quynhc80d8402014-05-26 23:02:48 +0800923 case CS_ARCH_XCORE:
924 for (i = 0; i < insn->detail->xcore.op_count; i++) {
925 if (insn->detail->xcore.operands[i].type == (xcore_op_type)op_type)
926 count++;
927 if (count == post)
928 return i;
929 }
930 break;
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +0800931 }
932
933 return -1;
934}