1 /* By Nguyen Anh Quynh <aquynh@gmail.com>, 2013> */
2 
3 #include <stdio.h>
4 #include <stdlib.h>
5 
6 #include <capstone/capstone.h>
7 
8 void print_insn_detail_x86(csh ud, cs_mode mode, cs_insn *ins);
9 
10 void print_string_hex(const char *comment, unsigned char *str, size_t len);
11 
get_eflag_name(uint64_t flag)12 static const char *get_eflag_name(uint64_t flag)
13 {
14 	switch(flag) {
15 		default:
16 			return NULL;
17 		case X86_EFLAGS_UNDEFINED_OF:
18 			return "UNDEF_OF";
19 		case X86_EFLAGS_UNDEFINED_SF:
20 			return "UNDEF_SF";
21 		case X86_EFLAGS_UNDEFINED_ZF:
22 			return "UNDEF_ZF";
23 		case X86_EFLAGS_MODIFY_AF:
24 			return "MOD_AF";
25 		case X86_EFLAGS_UNDEFINED_PF:
26 			return "UNDEF_PF";
27 		case X86_EFLAGS_MODIFY_CF:
28 			return "MOD_CF";
29 		case X86_EFLAGS_MODIFY_SF:
30 			return "MOD_SF";
31 		case X86_EFLAGS_MODIFY_ZF:
32 			return "MOD_ZF";
33 		case X86_EFLAGS_UNDEFINED_AF:
34 			return "UNDEF_AF";
35 		case X86_EFLAGS_MODIFY_PF:
36 			return "MOD_PF";
37 		case X86_EFLAGS_UNDEFINED_CF:
38 			return "UNDEF_CF";
39 		case X86_EFLAGS_MODIFY_OF:
40 			return "MOD_OF";
41 		case X86_EFLAGS_RESET_OF:
42 			return "RESET_OF";
43 		case X86_EFLAGS_RESET_CF:
44 			return "RESET_CF";
45 		case X86_EFLAGS_RESET_DF:
46 			return "RESET_DF";
47 		case X86_EFLAGS_RESET_IF:
48 			return "RESET_IF";
49 		case X86_EFLAGS_RESET_ZF:
50 			return "RESET_ZF";
51 		case X86_EFLAGS_TEST_OF:
52 			return "TEST_OF";
53 		case X86_EFLAGS_TEST_SF:
54 			return "TEST_SF";
55 		case X86_EFLAGS_TEST_ZF:
56 			return "TEST_ZF";
57 		case X86_EFLAGS_TEST_PF:
58 			return "TEST_PF";
59 		case X86_EFLAGS_TEST_CF:
60 			return "TEST_CF";
61 		case X86_EFLAGS_RESET_SF:
62 			return "RESET_SF";
63 		case X86_EFLAGS_RESET_AF:
64 			return "RESET_AF";
65 		case X86_EFLAGS_RESET_TF:
66 			return "RESET_TF";
67 		case X86_EFLAGS_RESET_NT:
68 			return "RESET_NT";
69 		case X86_EFLAGS_PRIOR_OF:
70 			return "PRIOR_OF";
71 		case X86_EFLAGS_PRIOR_SF:
72 			return "PRIOR_SF";
73 		case X86_EFLAGS_PRIOR_ZF:
74 			return "PRIOR_ZF";
75 		case X86_EFLAGS_PRIOR_AF:
76 			return "PRIOR_AF";
77 		case X86_EFLAGS_PRIOR_PF:
78 			return "PRIOR_PF";
79 		case X86_EFLAGS_PRIOR_CF:
80 			return "PRIOR_CF";
81 		case X86_EFLAGS_PRIOR_TF:
82 			return "PRIOR_TF";
83 		case X86_EFLAGS_PRIOR_IF:
84 			return "PRIOR_IF";
85 		case X86_EFLAGS_PRIOR_DF:
86 			return "PRIOR_DF";
87 		case X86_EFLAGS_TEST_NT:
88 			return "TEST_NT";
89 		case X86_EFLAGS_TEST_DF:
90 			return "TEST_DF";
91 		case X86_EFLAGS_RESET_PF:
92 			return "RESET_PF";
93 		case X86_EFLAGS_PRIOR_NT:
94 			return "PRIOR_NT";
95 		case X86_EFLAGS_MODIFY_TF:
96 			return "MOD_TF";
97 		case X86_EFLAGS_MODIFY_IF:
98 			return "MOD_IF";
99 		case X86_EFLAGS_MODIFY_DF:
100 			return "MOD_DF";
101 		case X86_EFLAGS_MODIFY_NT:
102 			return "MOD_NT";
103 		case X86_EFLAGS_MODIFY_RF:
104 			return "MOD_RF";
105 		case X86_EFLAGS_SET_CF:
106 			return "SET_CF";
107 		case X86_EFLAGS_SET_DF:
108 			return "SET_DF";
109 		case X86_EFLAGS_SET_IF:
110 			return "SET_IF";
111 		case X86_EFLAGS_SET_OF:
112 			return "SET_OF";
113 		case X86_EFLAGS_SET_SF:
114 			return "SET_SF";
115 		case X86_EFLAGS_SET_ZF:
116 			return "SET_ZF";
117 		case X86_EFLAGS_SET_AF:
118 			return "SET_AF";
119 		case X86_EFLAGS_SET_PF:
120 			return "SET_PF";
121 		case X86_EFLAGS_TEST_AF:
122 			return "TEST_AF";
123 		case X86_EFLAGS_TEST_TF:
124 			return "TEST_TF";
125 		case X86_EFLAGS_TEST_RF:
126 			return "TEST_RF";
127 		case X86_EFLAGS_RESET_0F:
128 			return "RESET_0F";
129 		case X86_EFLAGS_RESET_AC:
130 			return "RESET_AC";
131 	}
132 }
133 
get_fpu_flag_name(uint64_t flag)134 static const char *get_fpu_flag_name(uint64_t flag)
135 {
136 	switch (flag) {
137 		default:
138 			return NULL;
139 		case X86_FPU_FLAGS_MODIFY_C0:
140 			return "MOD_C0";
141 		case X86_FPU_FLAGS_MODIFY_C1:
142 			return "MOD_C1";
143 		case X86_FPU_FLAGS_MODIFY_C2:
144 			return "MOD_C2";
145 		case X86_FPU_FLAGS_MODIFY_C3:
146 			return "MOD_C3";
147 		case X86_FPU_FLAGS_RESET_C0:
148 			return "RESET_C0";
149 		case X86_FPU_FLAGS_RESET_C1:
150 			return "RESET_C1";
151 		case X86_FPU_FLAGS_RESET_C2:
152 			return "RESET_C2";
153 		case X86_FPU_FLAGS_RESET_C3:
154 			return "RESET_C3";
155 		case X86_FPU_FLAGS_SET_C0:
156 			return "SET_C0";
157 		case X86_FPU_FLAGS_SET_C1:
158 			return "SET_C1";
159 		case X86_FPU_FLAGS_SET_C2:
160 			return "SET_C2";
161 		case X86_FPU_FLAGS_SET_C3:
162 			return "SET_C3";
163 		case X86_FPU_FLAGS_UNDEFINED_C0:
164 			return "UNDEF_C0";
165 		case X86_FPU_FLAGS_UNDEFINED_C1:
166 			return "UNDEF_C1";
167 		case X86_FPU_FLAGS_UNDEFINED_C2:
168 			return "UNDEF_C2";
169 		case X86_FPU_FLAGS_UNDEFINED_C3:
170 			return "UNDEF_C3";
171 		case X86_FPU_FLAGS_TEST_C0:
172 			return "TEST_C0";
173 		case X86_FPU_FLAGS_TEST_C1:
174 			return "TEST_C1";
175 		case X86_FPU_FLAGS_TEST_C2:
176 			return "TEST_C2";
177 		case X86_FPU_FLAGS_TEST_C3:
178 			return "TEST_C3";
179 	}
180 }
181 
print_insn_detail_x86(csh ud,cs_mode mode,cs_insn * ins)182 void print_insn_detail_x86(csh ud, cs_mode mode, cs_insn *ins)
183 {
184 	int count, i;
185 	cs_x86 *x86;
186 	cs_regs regs_read, regs_write;
187 	uint8_t regs_read_count, regs_write_count;
188 
189 	// detail can be NULL on "data" instruction if SKIPDATA option is turned ON
190 	if (ins->detail == NULL)
191 		return;
192 
193 	x86 = &(ins->detail->x86);
194 
195 	print_string_hex("\tPrefix:", x86->prefix, 4);
196 	print_string_hex("\tOpcode:", x86->opcode, 4);
197 	printf("\trex: 0x%x\n", x86->rex);
198 	printf("\taddr_size: %u\n", x86->addr_size);
199 	printf("\tmodrm: 0x%x\n", x86->modrm);
200 	printf("\tdisp: 0x%" PRIx64 "\n", x86->disp);
201 
202 	// SIB is not available in 16-bit mode
203 	if ((mode & CS_MODE_16) == 0) {
204 		printf("\tsib: 0x%x\n", x86->sib);
205 		if (x86->sib_base != X86_REG_INVALID)
206 			printf("\t\tsib_base: %s\n", cs_reg_name(ud, x86->sib_base));
207 		if (x86->sib_index != X86_REG_INVALID)
208 			printf("\t\tsib_index: %s\n", cs_reg_name(ud, x86->sib_index));
209 		if (x86->sib_scale != 0)
210 			printf("\t\tsib_scale: %d\n", x86->sib_scale);
211 	}
212 
213 	// XOP code condition
214 	if (x86->xop_cc != X86_XOP_CC_INVALID) {
215 		printf("\txop_cc: %u\n", x86->xop_cc);
216 	}
217 
218 	// SSE code condition
219 	if (x86->sse_cc != X86_SSE_CC_INVALID) {
220 		printf("\tsse_cc: %u\n", x86->sse_cc);
221 	}
222 
223 	// AVX code condition
224 	if (x86->avx_cc != X86_AVX_CC_INVALID) {
225 		printf("\tavx_cc: %u\n", x86->avx_cc);
226 	}
227 
228 	// AVX Suppress All Exception
229 	if (x86->avx_sae) {
230 		printf("\tavx_sae: %u\n", x86->avx_sae);
231 	}
232 
233 	// AVX Rounding Mode
234 	if (x86->avx_rm != X86_AVX_RM_INVALID) {
235 		printf("\tavx_rm: %u\n", x86->avx_rm);
236 	}
237 
238 	// Print out all immediate operands
239 	count = cs_op_count(ud, ins, X86_OP_IMM);
240 	if (count > 0) {
241 		printf("\timm_count: %u\n", count);
242 		for (i = 1; i < count + 1; i++) {
243 			int index = cs_op_index(ud, ins, X86_OP_IMM, i);
244 			printf("\t\timms[%u]: 0x%" PRIx64 "\n", i, x86->operands[index].imm);
245 		}
246 	}
247 
248 	if (x86->op_count)
249 		printf("\top_count: %u\n", x86->op_count);
250 
251 	// Print out all operands
252 	for (i = 0; i < x86->op_count; i++) {
253 		cs_x86_op *op = &(x86->operands[i]);
254 
255 		switch((int)op->type) {
256 			case X86_OP_REG:
257 				printf("\t\toperands[%u].type: REG = %s\n", i, cs_reg_name(ud, op->reg));
258 				break;
259 			case X86_OP_IMM:
260 				printf("\t\toperands[%u].type: IMM = 0x%" PRIx64 "\n", i, op->imm);
261 				break;
262 			case X86_OP_MEM:
263 				printf("\t\toperands[%u].type: MEM\n", i);
264 				if (op->mem.segment != X86_REG_INVALID)
265 					printf("\t\t\toperands[%u].mem.segment: REG = %s\n", i, cs_reg_name(ud, op->mem.segment));
266 				if (op->mem.base != X86_REG_INVALID)
267 					printf("\t\t\toperands[%u].mem.base: REG = %s\n", i, cs_reg_name(ud, op->mem.base));
268 				if (op->mem.index != X86_REG_INVALID)
269 					printf("\t\t\toperands[%u].mem.index: REG = %s\n", i, cs_reg_name(ud, op->mem.index));
270 				if (op->mem.scale != 1)
271 					printf("\t\t\toperands[%u].mem.scale: %u\n", i, op->mem.scale);
272 				if (op->mem.disp != 0)
273 					printf("\t\t\toperands[%u].mem.disp: 0x%" PRIx64 "\n", i, op->mem.disp);
274 				break;
275 			default:
276 				break;
277 		}
278 
279 		// AVX broadcast type
280 		if (op->avx_bcast != X86_AVX_BCAST_INVALID)
281 			printf("\t\toperands[%u].avx_bcast: %u\n", i, op->avx_bcast);
282 
283 		// AVX zero opmask {z}
284 		if (op->avx_zero_opmask != false)
285 			printf("\t\toperands[%u].avx_zero_opmask: TRUE\n", i);
286 
287 		printf("\t\toperands[%u].size: %u\n", i, op->size);
288 
289 		switch(op->access) {
290 			default:
291 				break;
292 			case CS_AC_READ:
293 				printf("\t\toperands[%u].access: READ\n", i);
294 				break;
295 			case CS_AC_WRITE:
296 				printf("\t\toperands[%u].access: WRITE\n", i);
297 				break;
298 			case CS_AC_READ | CS_AC_WRITE:
299 				printf("\t\toperands[%u].access: READ | WRITE\n", i);
300 				break;
301 		}
302 	}
303 
304 	// Print out all registers accessed by this instruction (either implicit or explicit)
305 	if (!cs_regs_access(ud, ins,
306 						regs_read, &regs_read_count,
307 						regs_write, &regs_write_count)) {
308 		if (regs_read_count) {
309 			printf("\tRegisters read:");
310 			for(i = 0; i < regs_read_count; i++) {
311 				printf(" %s", cs_reg_name(ud, regs_read[i]));
312 			}
313 			printf("\n");
314 		}
315 
316 		if (regs_write_count) {
317 			printf("\tRegisters modified:");
318 			for(i = 0; i < regs_write_count; i++) {
319 				printf(" %s", cs_reg_name(ud, regs_write[i]));
320 			}
321 			printf("\n");
322 		}
323 	}
324 
325 	if (x86->eflags || x86->fpu_flags) {
326 		for(i = 0; i < ins->detail->groups_count; i++) {
327 			if (ins->detail->groups[i] == X86_GRP_FPU) {
328 				printf("\tFPU_FLAGS:");
329 				for(i = 0; i <= 63; i++)
330 					if (x86->fpu_flags & ((uint64_t)1 << i)) {
331 						printf(" %s", get_fpu_flag_name((uint64_t)1 << i));
332 					}
333 				printf("\n");
334 				break;
335 			}
336 		}
337 
338 		if (i == ins->detail->groups_count) {
339 			printf("\tEFLAGS:");
340 			for(i = 0; i <= 63; i++)
341 				if (x86->eflags & ((uint64_t)1 << i)) {
342 					printf(" %s", get_eflag_name((uint64_t)1 << i));
343 				}
344 			printf("\n");
345 		}
346 	}
347 }
348