1 | /** @file
|
---|
2 | * DIS - The VirtualBox Disassembler.
|
---|
3 | */
|
---|
4 |
|
---|
5 | /*
|
---|
6 | * Copyright (C) 2006-2007 Sun Microsystems, Inc.
|
---|
7 | *
|
---|
8 | * This file is part of VirtualBox Open Source Edition (OSE), as
|
---|
9 | * available from http://www.virtualbox.org. This file is free software;
|
---|
10 | * you can redistribute it and/or modify it under the terms of the GNU
|
---|
11 | * General Public License (GPL) as published by the Free Software
|
---|
12 | * Foundation, in version 2 as it comes in the "COPYING" file of the
|
---|
13 | * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
|
---|
14 | * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
|
---|
15 | *
|
---|
16 | * The contents of this file may alternatively be used under the terms
|
---|
17 | * of the Common Development and Distribution License Version 1.0
|
---|
18 | * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
|
---|
19 | * VirtualBox OSE distribution, in which case the provisions of the
|
---|
20 | * CDDL are applicable instead of those of the GPL.
|
---|
21 | *
|
---|
22 | * You may elect to license modified versions of this file under the
|
---|
23 | * terms and conditions of either the GPL or the CDDL or both.
|
---|
24 | *
|
---|
25 | * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
|
---|
26 | * Clara, CA 95054 USA or visit http://www.sun.com if you need
|
---|
27 | * additional information or have any questions.
|
---|
28 | */
|
---|
29 |
|
---|
30 | #ifndef ___VBox_disasm_h
|
---|
31 | #define ___VBox_disasm_h
|
---|
32 |
|
---|
33 | #include <VBox/cdefs.h>
|
---|
34 | #include <VBox/types.h>
|
---|
35 | #include <VBox/disopcode.h>
|
---|
36 |
|
---|
37 | #if defined(__L4ENV__)
|
---|
38 | #include <setjmp.h>
|
---|
39 | #endif
|
---|
40 |
|
---|
41 | __BEGIN_DECLS
|
---|
42 |
|
---|
43 |
|
---|
44 | /** CPU mode flags (DISCPUSTATE::mode).
|
---|
45 | * @{
|
---|
46 | */
|
---|
47 | typedef enum
|
---|
48 | {
|
---|
49 | CPUMODE_16BIT = 1,
|
---|
50 | CPUMODE_32BIT = 2,
|
---|
51 | CPUMODE_64BIT = 3,
|
---|
52 | /** hack forcing the size of the enum to 32-bits. */
|
---|
53 | CPUMODE_MAKE_32BIT_HACK = 0x7fffffff
|
---|
54 | } DISCPUMODE;
|
---|
55 | /** @} */
|
---|
56 |
|
---|
57 | /** Prefix byte flags
|
---|
58 | * @{
|
---|
59 | */
|
---|
60 | #define PREFIX_NONE 0
|
---|
61 | /** non-default address size. */
|
---|
62 | #define PREFIX_ADDRSIZE RT_BIT(0)
|
---|
63 | /** non-default operand size. */
|
---|
64 | #define PREFIX_OPSIZE RT_BIT(1)
|
---|
65 | /** lock prefix. */
|
---|
66 | #define PREFIX_LOCK RT_BIT(2)
|
---|
67 | /** segment prefix. */
|
---|
68 | #define PREFIX_SEG RT_BIT(3)
|
---|
69 | /** rep(e) prefix (not a prefix, but we'll treat is as one). */
|
---|
70 | #define PREFIX_REP RT_BIT(4)
|
---|
71 | /** rep(e) prefix (not a prefix, but we'll treat is as one). */
|
---|
72 | #define PREFIX_REPNE RT_BIT(5)
|
---|
73 | /** REX prefix (64 bits) */
|
---|
74 | #define PREFIX_REX RT_BIT(6)
|
---|
75 | /** @} */
|
---|
76 |
|
---|
77 | /** 64 bits prefix byte flags
|
---|
78 | * @{
|
---|
79 | */
|
---|
80 | #define PREFIX_REX_OP_2_FLAGS(a) (a - OP_PARM_REX_START)
|
---|
81 | #define PREFIX_REX_FLAGS PREFIX_REX_OP_2_FLAGS(OP_PARM_REX)
|
---|
82 | #define PREFIX_REX_FLAGS_B PREFIX_REX_OP_2_FLAGS(OP_PARM_REX_B)
|
---|
83 | #define PREFIX_REX_FLAGS_X PREFIX_REX_OP_2_FLAGS(OP_PARM_REX_X)
|
---|
84 | #define PREFIX_REX_FLAGS_XB PREFIX_REX_OP_2_FLAGS(OP_PARM_REX_XB)
|
---|
85 | #define PREFIX_REX_FLAGS_R PREFIX_REX_OP_2_FLAGS(OP_PARM_REX_R)
|
---|
86 | #define PREFIX_REX_FLAGS_RB PREFIX_REX_OP_2_FLAGS(OP_PARM_REX_RB)
|
---|
87 | #define PREFIX_REX_FLAGS_RX PREFIX_REX_OP_2_FLAGS(OP_PARM_REX_RX)
|
---|
88 | #define PREFIX_REX_FLAGS_RXB PREFIX_REX_OP_2_FLAGS(OP_PARM_REX_RXB)
|
---|
89 | #define PREFIX_REX_FLAGS_W PREFIX_REX_OP_2_FLAGS(OP_PARM_REX_W)
|
---|
90 | #define PREFIX_REX_FLAGS_WB PREFIX_REX_OP_2_FLAGS(OP_PARM_REX_WB)
|
---|
91 | #define PREFIX_REX_FLAGS_WX PREFIX_REX_OP_2_FLAGS(OP_PARM_REX_WX)
|
---|
92 | #define PREFIX_REX_FLAGS_WXB PREFIX_REX_OP_2_FLAGS(OP_PARM_REX_WXB)
|
---|
93 | #define PREFIX_REX_FLAGS_WR PREFIX_REX_OP_2_FLAGS(OP_PARM_REX_WR)
|
---|
94 | #define PREFIX_REX_FLAGS_WRB PREFIX_REX_OP_2_FLAGS(OP_PARM_REX_WRB)
|
---|
95 | #define PREFIX_REX_FLAGS_WRX PREFIX_REX_OP_2_FLAGS(OP_PARM_REX_WRX)
|
---|
96 | #define PREFIX_REX_FLAGS_WRXB PREFIX_REX_OP_2_FLAGS(OP_PARM_REX_WRXB)
|
---|
97 | /** @} */
|
---|
98 |
|
---|
99 | /**
|
---|
100 | * Operand type.
|
---|
101 | */
|
---|
102 | #define OPTYPE_INVALID RT_BIT(0)
|
---|
103 | #define OPTYPE_HARMLESS RT_BIT(1)
|
---|
104 | #define OPTYPE_CONTROLFLOW RT_BIT(2)
|
---|
105 | #define OPTYPE_POTENTIALLY_DANGEROUS RT_BIT(3)
|
---|
106 | #define OPTYPE_DANGEROUS RT_BIT(4)
|
---|
107 | #define OPTYPE_PORTIO RT_BIT(5)
|
---|
108 | #define OPTYPE_PRIVILEGED RT_BIT(6)
|
---|
109 | #define OPTYPE_PRIVILEGED_NOTRAP RT_BIT(7)
|
---|
110 | #define OPTYPE_UNCOND_CONTROLFLOW RT_BIT(8)
|
---|
111 | #define OPTYPE_RELATIVE_CONTROLFLOW RT_BIT(9)
|
---|
112 | #define OPTYPE_COND_CONTROLFLOW RT_BIT(10)
|
---|
113 | #define OPTYPE_INTERRUPT RT_BIT(11)
|
---|
114 | #define OPTYPE_ILLEGAL RT_BIT(12)
|
---|
115 | #define OPTYPE_RRM_DANGEROUS RT_BIT(14) /**< Some additional dangerouse ones when recompiling raw r0. */
|
---|
116 | #define OPTYPE_RRM_DANGEROUS_16 RT_BIT(15) /**< Some additional dangerouse ones when recompiling 16-bit raw r0. */
|
---|
117 | #define OPTYPE_RRM_MASK (OPTYPE_RRM_DANGEROUS | OPTYPE_RRM_DANGEROUS_16)
|
---|
118 | #define OPTYPE_INHIBIT_IRQS RT_BIT(16) /**< Will or can inhibit irqs (sti, pop ss, mov ss) */
|
---|
119 | #define OPTYPE_PORTIO_READ RT_BIT(17)
|
---|
120 | #define OPTYPE_PORTIO_WRITE RT_BIT(18)
|
---|
121 | #define OPTYPE_INVALID_64 RT_BIT(19) /**< Invalid in 64 bits mode */
|
---|
122 | #define OPTYPE_ONLY_64 RT_BIT(20) /**< Only valid in 64 bits mode */
|
---|
123 | #define OPTYPE_DEFAULT_64_OP_SIZE RT_BIT(21) /**< Default 64 bits operand size */
|
---|
124 | #define OPTYPE_FORCED_64_OP_SIZE RT_BIT(22) /**< Forced 64 bits operand size; regardless of prefix bytes */
|
---|
125 | #define OPTYPE_REXB_EXTENDS_OPREG RT_BIT(23) /**< REX.B extends the register field in the opcode byte */
|
---|
126 | #define OPTYPE_ALL (0xffffffff)
|
---|
127 |
|
---|
128 | /** Parameter usage flags.
|
---|
129 | * @{
|
---|
130 | */
|
---|
131 | #define USE_BASE RT_BIT_64(0)
|
---|
132 | #define USE_INDEX RT_BIT_64(1)
|
---|
133 | #define USE_SCALE RT_BIT_64(2)
|
---|
134 | #define USE_REG_GEN8 RT_BIT_64(3)
|
---|
135 | #define USE_REG_GEN16 RT_BIT_64(4)
|
---|
136 | #define USE_REG_GEN32 RT_BIT_64(5)
|
---|
137 | #define USE_REG_GEN64 RT_BIT_64(6)
|
---|
138 | #define USE_REG_FP RT_BIT_64(7)
|
---|
139 | #define USE_REG_MMX RT_BIT_64(8)
|
---|
140 | #define USE_REG_XMM RT_BIT_64(9)
|
---|
141 | #define USE_REG_CR RT_BIT_64(10)
|
---|
142 | #define USE_REG_DBG RT_BIT_64(11)
|
---|
143 | #define USE_REG_SEG RT_BIT_64(12)
|
---|
144 | #define USE_REG_TEST RT_BIT_64(13)
|
---|
145 | #define USE_DISPLACEMENT8 RT_BIT_64(14)
|
---|
146 | #define USE_DISPLACEMENT16 RT_BIT_64(15)
|
---|
147 | #define USE_DISPLACEMENT32 RT_BIT_64(16)
|
---|
148 | #define USE_DISPLACEMENT64 RT_BIT_64(17)
|
---|
149 | #define USE_RIPDISPLACEMENT32 RT_BIT_64(18)
|
---|
150 | #define USE_IMMEDIATE8 RT_BIT_64(19)
|
---|
151 | #define USE_IMMEDIATE8_REL RT_BIT_64(20)
|
---|
152 | #define USE_IMMEDIATE16 RT_BIT_64(21)
|
---|
153 | #define USE_IMMEDIATE16_REL RT_BIT_64(22)
|
---|
154 | #define USE_IMMEDIATE32 RT_BIT_64(23)
|
---|
155 | #define USE_IMMEDIATE32_REL RT_BIT_64(24)
|
---|
156 | #define USE_IMMEDIATE64 RT_BIT_64(25)
|
---|
157 | #define USE_IMMEDIATE_ADDR_0_32 RT_BIT_64(26)
|
---|
158 | #define USE_IMMEDIATE_ADDR_16_32 RT_BIT_64(27)
|
---|
159 | #define USE_IMMEDIATE_ADDR_0_16 RT_BIT_64(28)
|
---|
160 | #define USE_IMMEDIATE_ADDR_16_16 RT_BIT_64(29)
|
---|
161 | /** DS:ESI */
|
---|
162 | #define USE_POINTER_DS_BASED RT_BIT_64(30)
|
---|
163 | /** ES:EDI */
|
---|
164 | #define USE_POINTER_ES_BASED RT_BIT_64(31)
|
---|
165 | #define USE_IMMEDIATE16_SX8 RT_BIT_64(32)
|
---|
166 | #define USE_IMMEDIATE32_SX8 RT_BIT_64(33)
|
---|
167 |
|
---|
168 | #define USE_IMMEDIATE (USE_IMMEDIATE8|USE_IMMEDIATE16|USE_IMMEDIATE32|USE_IMMEDIATE64|USE_IMMEDIATE8_REL|USE_IMMEDIATE16_REL|USE_IMMEDIATE32_REL|USE_IMMEDIATE_ADDR_0_32|USE_IMMEDIATE_ADDR_16_32|USE_IMMEDIATE_ADDR_0_16|USE_IMMEDIATE_ADDR_16_16|USE_IMMEDIATE16_SX8|USE_IMMEDIATE32_SX8)
|
---|
169 |
|
---|
170 | /** @} */
|
---|
171 |
|
---|
172 | /** index in {"RAX", "RCX", "RDX", "RBX", "RSP", "RBP", "RSI", "RDI", "R8", "R9", "R10", "R11", "R12", "R13", "R14", "R15"}
|
---|
173 | * @{
|
---|
174 | */
|
---|
175 | #define USE_REG_RAX 0
|
---|
176 | #define USE_REG_RCX 1
|
---|
177 | #define USE_REG_RDX 2
|
---|
178 | #define USE_REG_RBX 3
|
---|
179 | #define USE_REG_RSP 4
|
---|
180 | #define USE_REG_RBP 5
|
---|
181 | #define USE_REG_RSI 6
|
---|
182 | #define USE_REG_RDI 7
|
---|
183 | #define USE_REG_R8 8
|
---|
184 | #define USE_REG_R9 9
|
---|
185 | #define USE_REG_R10 10
|
---|
186 | #define USE_REG_R11 11
|
---|
187 | #define USE_REG_R12 12
|
---|
188 | #define USE_REG_R13 13
|
---|
189 | #define USE_REG_R14 14
|
---|
190 | #define USE_REG_R15 15
|
---|
191 | /** @} */
|
---|
192 |
|
---|
193 | /** index in {"EAX", "ECX", "EDX", "EBX", "ESP", "EBP", "ESI", "EDI"}
|
---|
194 | * @{
|
---|
195 | */
|
---|
196 | #define USE_REG_EAX 0
|
---|
197 | #define USE_REG_ECX 1
|
---|
198 | #define USE_REG_EDX 2
|
---|
199 | #define USE_REG_EBX 3
|
---|
200 | #define USE_REG_ESP 4
|
---|
201 | #define USE_REG_EBP 5
|
---|
202 | #define USE_REG_ESI 6
|
---|
203 | #define USE_REG_EDI 7
|
---|
204 | /** @} */
|
---|
205 | /** index in {"AX", "CX", "DX", "BX", "SP", "BP", "SI", "DI"}
|
---|
206 | * @{
|
---|
207 | */
|
---|
208 | #define USE_REG_AX 0
|
---|
209 | #define USE_REG_CX 1
|
---|
210 | #define USE_REG_DX 2
|
---|
211 | #define USE_REG_BX 3
|
---|
212 | #define USE_REG_SP 4
|
---|
213 | #define USE_REG_BP 5
|
---|
214 | #define USE_REG_SI 6
|
---|
215 | #define USE_REG_DI 7
|
---|
216 | /** @} */
|
---|
217 |
|
---|
218 | /** index in {"AL", "CL", "DL", "BL", "AH", "CH", "DH", "BH"}
|
---|
219 | * @{
|
---|
220 | */
|
---|
221 | #define USE_REG_AL 0
|
---|
222 | #define USE_REG_CL 1
|
---|
223 | #define USE_REG_DL 2
|
---|
224 | #define USE_REG_BL 3
|
---|
225 | #define USE_REG_AH 4
|
---|
226 | #define USE_REG_CH 5
|
---|
227 | #define USE_REG_DH 6
|
---|
228 | #define USE_REG_BH 7
|
---|
229 | /** @} */
|
---|
230 |
|
---|
231 | /** index in {ES, CS, SS, DS, FS, GS}
|
---|
232 | * @{
|
---|
233 | */
|
---|
234 | #define USE_REG_ES 0
|
---|
235 | #define USE_REG_CS 1
|
---|
236 | #define USE_REG_SS 2
|
---|
237 | #define USE_REG_DS 3
|
---|
238 | #define USE_REG_FS 4
|
---|
239 | #define USE_REG_GS 5
|
---|
240 | /** @} */
|
---|
241 |
|
---|
242 | #define USE_REG_FP0 0
|
---|
243 | #define USE_REG_FP1 1
|
---|
244 | #define USE_REG_FP2 2
|
---|
245 | #define USE_REG_FP3 3
|
---|
246 | #define USE_REG_FP4 4
|
---|
247 | #define USE_REG_FP5 5
|
---|
248 | #define USE_REG_FP6 6
|
---|
249 | #define USE_REG_FP7 7
|
---|
250 |
|
---|
251 | #define USE_REG_CR0 0
|
---|
252 | #define USE_REG_CR1 1
|
---|
253 | #define USE_REG_CR2 2
|
---|
254 | #define USE_REG_CR3 3
|
---|
255 | #define USE_REG_CR4 4
|
---|
256 |
|
---|
257 | #define USE_REG_DR0 0
|
---|
258 | #define USE_REG_DR1 1
|
---|
259 | #define USE_REG_DR2 2
|
---|
260 | #define USE_REG_DR3 3
|
---|
261 | #define USE_REG_DR4 4
|
---|
262 | #define USE_REG_DR5 5
|
---|
263 | #define USE_REG_DR6 6
|
---|
264 | #define USE_REG_DR7 7
|
---|
265 |
|
---|
266 | #define USE_REG_MMX0 0
|
---|
267 | #define USE_REG_MMX1 1
|
---|
268 | #define USE_REG_MMX2 2
|
---|
269 | #define USE_REG_MMX3 3
|
---|
270 | #define USE_REG_MMX4 4
|
---|
271 | #define USE_REG_MMX5 5
|
---|
272 | #define USE_REG_MMX6 6
|
---|
273 | #define USE_REG_MMX7 7
|
---|
274 |
|
---|
275 | #define USE_REG_XMM0 0
|
---|
276 | #define USE_REG_XMM1 1
|
---|
277 | #define USE_REG_XMM2 2
|
---|
278 | #define USE_REG_XMM3 3
|
---|
279 | #define USE_REG_XMM4 4
|
---|
280 | #define USE_REG_XMM5 5
|
---|
281 | #define USE_REG_XMM6 6
|
---|
282 | #define USE_REG_XMM7 7
|
---|
283 |
|
---|
284 | /** Used by DISQueryParamVal & EMIQueryParamVal
|
---|
285 | * @{
|
---|
286 | */
|
---|
287 | #define PARAM_VAL8 RT_BIT(0)
|
---|
288 | #define PARAM_VAL16 RT_BIT(1)
|
---|
289 | #define PARAM_VAL32 RT_BIT(2)
|
---|
290 | #define PARAM_VAL64 RT_BIT(3)
|
---|
291 | #define PARAM_VALFARPTR16 RT_BIT(4)
|
---|
292 | #define PARAM_VALFARPTR32 RT_BIT(5)
|
---|
293 |
|
---|
294 | #define PARMTYPE_REGISTER 1
|
---|
295 | #define PARMTYPE_ADDRESS 2
|
---|
296 | #define PARMTYPE_IMMEDIATE 3
|
---|
297 |
|
---|
298 | typedef struct
|
---|
299 | {
|
---|
300 | uint32_t type;
|
---|
301 | uint32_t size;
|
---|
302 | uint64_t flags;
|
---|
303 |
|
---|
304 | union
|
---|
305 | {
|
---|
306 | uint8_t val8;
|
---|
307 | uint16_t val16;
|
---|
308 | uint32_t val32;
|
---|
309 | uint64_t val64;
|
---|
310 |
|
---|
311 | struct
|
---|
312 | {
|
---|
313 | uint16_t sel;
|
---|
314 | uint32_t offset;
|
---|
315 | } farptr;
|
---|
316 | } val;
|
---|
317 |
|
---|
318 | } OP_PARAMVAL;
|
---|
319 | /** Pointer to opcode parameter value. */
|
---|
320 | typedef OP_PARAMVAL *POP_PARAMVAL;
|
---|
321 |
|
---|
322 | typedef enum
|
---|
323 | {
|
---|
324 | PARAM_DEST,
|
---|
325 | PARAM_SOURCE
|
---|
326 | } PARAM_TYPE;
|
---|
327 |
|
---|
328 | /** @} */
|
---|
329 |
|
---|
330 | /**
|
---|
331 | * Operand Parameter.
|
---|
332 | */
|
---|
333 | typedef struct _OP_PARAMETER
|
---|
334 | {
|
---|
335 | int param;
|
---|
336 | uint64_t parval;
|
---|
337 | char szParam[32];
|
---|
338 |
|
---|
339 | int32_t disp8, disp16, disp32;
|
---|
340 | uint32_t size;
|
---|
341 |
|
---|
342 | int64_t disp64;
|
---|
343 | uint64_t flags;
|
---|
344 |
|
---|
345 | union
|
---|
346 | {
|
---|
347 | uint32_t reg_gen;
|
---|
348 | /** ST(0) - ST(7) */
|
---|
349 | uint32_t reg_fp;
|
---|
350 | /** MMX0 - MMX7 */
|
---|
351 | uint32_t reg_mmx;
|
---|
352 | /** XMM0 - XMM7 */
|
---|
353 | uint32_t reg_xmm;
|
---|
354 | /** {ES, CS, SS, DS, FS, GS} */
|
---|
355 | uint32_t reg_seg;
|
---|
356 | /** TR0-TR7 (?) */
|
---|
357 | uint32_t reg_test;
|
---|
358 | /** CR0-CR4 */
|
---|
359 | uint32_t reg_ctrl;
|
---|
360 | /** DR0-DR7 */
|
---|
361 | uint32_t reg_dbg;
|
---|
362 | } base;
|
---|
363 | union
|
---|
364 | {
|
---|
365 | uint32_t reg_gen;
|
---|
366 | } index;
|
---|
367 |
|
---|
368 | /** 2, 4 or 8. */
|
---|
369 | uint32_t scale;
|
---|
370 |
|
---|
371 | } OP_PARAMETER;
|
---|
372 | /** Pointer to opcode parameter. */
|
---|
373 | typedef OP_PARAMETER *POP_PARAMETER;
|
---|
374 | /** Pointer to opcode parameter. */
|
---|
375 | typedef const OP_PARAMETER *PCOP_PARAMETER;
|
---|
376 |
|
---|
377 |
|
---|
378 | struct _OPCODE;
|
---|
379 | /** Pointer to opcode. */
|
---|
380 | typedef struct _OPCODE *POPCODE;
|
---|
381 | /** Pointer to const opcode. */
|
---|
382 | typedef const struct _OPCODE *PCOPCODE;
|
---|
383 |
|
---|
384 | typedef DECLCALLBACK(int) FN_DIS_READBYTES(RTUINTPTR pSrc, uint8_t *pDest, uint32_t size, void *pvUserdata);
|
---|
385 | typedef FN_DIS_READBYTES *PFN_DIS_READBYTES;
|
---|
386 |
|
---|
387 | /* forward decl */
|
---|
388 | struct _DISCPUSTATE;
|
---|
389 | /** Pointer to the disassembler CPU state. */
|
---|
390 | typedef struct _DISCPUSTATE *PDISCPUSTATE;
|
---|
391 |
|
---|
392 | /** Parser callback.
|
---|
393 | * @remark no DECLCALLBACK() here because it's considered to be internal (really, I'm too lazy to update all the functions). */
|
---|
394 | typedef unsigned FNDISPARSE(RTUINTPTR pu8CodeBlock, PCOPCODE pOp, POP_PARAMETER pParam, PDISCPUSTATE pCpu);
|
---|
395 | typedef FNDISPARSE *PFNDISPARSE;
|
---|
396 |
|
---|
397 | typedef struct _DISCPUSTATE
|
---|
398 | {
|
---|
399 | /* Global setting */
|
---|
400 | DISCPUMODE mode;
|
---|
401 |
|
---|
402 | /* Per instruction prefix settings */
|
---|
403 | uint32_t prefix;
|
---|
404 | /** segment prefix value. */
|
---|
405 | uint32_t prefix_seg;
|
---|
406 | /** rex prefix value (64 bits only */
|
---|
407 | uint32_t prefix_rex;
|
---|
408 | /** addressing mode (16 or 32 bits). (CPUMODE_*) */
|
---|
409 | DISCPUMODE addrmode;
|
---|
410 | /** operand mode (16 or 32 bits). (CPUMODE_*) */
|
---|
411 | DISCPUMODE opmode;
|
---|
412 |
|
---|
413 | OP_PARAMETER param1;
|
---|
414 | OP_PARAMETER param2;
|
---|
415 | OP_PARAMETER param3;
|
---|
416 |
|
---|
417 | /** ModRM fields. */
|
---|
418 | union
|
---|
419 | {
|
---|
420 | /* Bitfield view */
|
---|
421 | struct
|
---|
422 | {
|
---|
423 | unsigned Rm : 4;
|
---|
424 | unsigned Reg : 4;
|
---|
425 | unsigned Mod : 2;
|
---|
426 | } Bits;
|
---|
427 | /* unsigned view */
|
---|
428 | unsigned u;
|
---|
429 | } ModRM;
|
---|
430 |
|
---|
431 | /** SIB fields. */
|
---|
432 | union
|
---|
433 | {
|
---|
434 | /* Bitfield view */
|
---|
435 | struct
|
---|
436 | {
|
---|
437 | unsigned Base : 4;
|
---|
438 | unsigned Index : 4;
|
---|
439 | unsigned Scale : 2;
|
---|
440 | } Bits;
|
---|
441 | /* unsigned view */
|
---|
442 | unsigned u;
|
---|
443 | } SIB;
|
---|
444 |
|
---|
445 | int32_t disp;
|
---|
446 |
|
---|
447 | /** First opcode byte of instruction. */
|
---|
448 | uint8_t opcode;
|
---|
449 | /** Last prefix byte (for SSE2 extension tables) */
|
---|
450 | uint8_t lastprefix;
|
---|
451 | RTUINTPTR opaddr;
|
---|
452 | uint32_t opsize;
|
---|
453 | #ifndef DIS_CORE_ONLY
|
---|
454 | /** Opcode format string for current instruction. */
|
---|
455 | const char *pszOpcode;
|
---|
456 | #endif
|
---|
457 |
|
---|
458 | /** Internal: pointer to disassembly function table */
|
---|
459 | PFNDISPARSE *pfnDisasmFnTable;
|
---|
460 | /** Internal: instruction filter */
|
---|
461 | uint32_t uFilter;
|
---|
462 |
|
---|
463 | /** Pointer to the current instruction. */
|
---|
464 | PCOPCODE pCurInstr;
|
---|
465 |
|
---|
466 | void *apvUserData[3];
|
---|
467 |
|
---|
468 | /** Optional read function */
|
---|
469 | PFN_DIS_READBYTES pfnReadBytes;
|
---|
470 | #ifdef __L4ENV__
|
---|
471 | jmp_buf *pJumpBuffer;
|
---|
472 | #endif /* __L4ENV__ */
|
---|
473 | } DISCPUSTATE;
|
---|
474 |
|
---|
475 | /** Opcode. */
|
---|
476 | #pragma pack(4)
|
---|
477 | typedef struct _OPCODE
|
---|
478 | {
|
---|
479 | #ifndef DIS_CORE_ONLY
|
---|
480 | const char *pszOpcode;
|
---|
481 | #endif
|
---|
482 | uint8_t idxParse1;
|
---|
483 | uint8_t idxParse2;
|
---|
484 | uint8_t idxParse3;
|
---|
485 | uint16_t opcode;
|
---|
486 | uint16_t param1;
|
---|
487 | uint16_t param2;
|
---|
488 | uint16_t param3;
|
---|
489 |
|
---|
490 | unsigned optype;
|
---|
491 | } OPCODE;
|
---|
492 | #pragma pack()
|
---|
493 |
|
---|
494 |
|
---|
495 | /**
|
---|
496 | * Disassembles a code block.
|
---|
497 | *
|
---|
498 | * @returns VBox error code
|
---|
499 | * @param pCpu Pointer to cpu structure which have DISCPUSTATE::mode
|
---|
500 | * set correctly.
|
---|
501 | * @param pvCodeBlock Pointer to the strunction to disassemble.
|
---|
502 | * @param cbMax Maximum number of bytes to disassemble.
|
---|
503 | * @param pcbSize Where to store the size of the instruction.
|
---|
504 | * NULL is allowed.
|
---|
505 | *
|
---|
506 | *
|
---|
507 | * @todo Define output callback.
|
---|
508 | * @todo Using signed integers as sizes is a bit odd. There are still
|
---|
509 | * some GCC warnings about mixing signed and unsigend integers.
|
---|
510 | * @todo Need to extend this interface to include a code address so we
|
---|
511 | * can dissassemble GC code. Perhaps a new function is better...
|
---|
512 | * @remark cbMax isn't respected as a boundry. DISInstr() will read beyond cbMax.
|
---|
513 | * This means *pcbSize >= cbMax sometimes.
|
---|
514 | */
|
---|
515 | DISDECL(int) DISBlock(PDISCPUSTATE pCpu, RTUINTPTR pvCodeBlock, unsigned cbMax, unsigned *pSize);
|
---|
516 |
|
---|
517 | /**
|
---|
518 | * Disassembles one instruction
|
---|
519 | *
|
---|
520 | * @returns VBox error code
|
---|
521 | * @param pCpu Pointer to cpu structure which have DISCPUSTATE::mode
|
---|
522 | * set correctly.
|
---|
523 | * @param pu8Instruction Pointer to the instrunction to disassemble.
|
---|
524 | * @param u32EipOffset Offset to add to instruction address to get the real virtual address
|
---|
525 | * @param pcbSize Where to store the size of the instruction.
|
---|
526 | * NULL is allowed.
|
---|
527 | * @param pszOutput Storage for disassembled instruction
|
---|
528 | *
|
---|
529 | * @todo Define output callback.
|
---|
530 | */
|
---|
531 | DISDECL(int) DISInstr(PDISCPUSTATE pCpu, RTUINTPTR pu8Instruction, unsigned u32EipOffset, unsigned *pcbSize, char *pszOutput);
|
---|
532 |
|
---|
533 | /**
|
---|
534 | * Disassembles one instruction
|
---|
535 | *
|
---|
536 | * @returns VBox error code
|
---|
537 | * @param pCpu Pointer to cpu structure which have DISCPUSTATE::mode
|
---|
538 | * set correctly.
|
---|
539 | * @param pu8Instruction Pointer to the strunction to disassemble.
|
---|
540 | * @param u32EipOffset Offset to add to instruction address to get the real virtual address
|
---|
541 | * @param pcbSize Where to store the size of the instruction.
|
---|
542 | * NULL is allowed.
|
---|
543 | * @param pszOutput Storage for disassembled instruction
|
---|
544 | * @param uFilter Instruction type filter
|
---|
545 | *
|
---|
546 | * @todo Define output callback.
|
---|
547 | */
|
---|
548 | DISDECL(int) DISInstrEx(PDISCPUSTATE pCpu, RTUINTPTR pu8Instruction, uint32_t u32EipOffset, uint32_t *pcbSize,
|
---|
549 | char *pszOutput, unsigned uFilter);
|
---|
550 |
|
---|
551 | /**
|
---|
552 | * Parses one instruction.
|
---|
553 | * The result is found in pCpu.
|
---|
554 | *
|
---|
555 | * @returns VBox error code
|
---|
556 | * @param pCpu Pointer to cpu structure which has DISCPUSTATE::mode set correctly.
|
---|
557 | * @param InstructionAddr Pointer to the instruction to parse.
|
---|
558 | * @param pcbInstruction Where to store the size of the instruction.
|
---|
559 | * NULL is allowed.
|
---|
560 | */
|
---|
561 | DISDECL(int) DISCoreOne(PDISCPUSTATE pCpu, RTUINTPTR InstructionAddr, unsigned *pcbInstruction);
|
---|
562 |
|
---|
563 | /**
|
---|
564 | * Parses one guest instruction.
|
---|
565 | * The result is found in pCpu and pcbInstruction.
|
---|
566 | *
|
---|
567 | * @returns VBox status code.
|
---|
568 | * @param InstructionAddr Address of the instruction to decode. What this means
|
---|
569 | * is left to the pfnReadBytes function.
|
---|
570 | * @param enmCpuMode The CPU mode. CPUMODE_32BIT, CPUMODE_16BIT, or CPUMODE_64BIT.
|
---|
571 | * @param pfnReadBytes Callback for reading instruction bytes.
|
---|
572 | * @param pvUser User argument for the instruction reader. (Ends up in apvUserData[0].)
|
---|
573 | * @param pCpu Pointer to cpu structure. Will be initialized.
|
---|
574 | * @param pcbInstruction Where to store the size of the instruction.
|
---|
575 | * NULL is allowed.
|
---|
576 | */
|
---|
577 | DISDECL(int) DISCoreOneEx(RTUINTPTR InstructionAddr, DISCPUMODE enmCpuMode, PFN_DIS_READBYTES pfnReadBytes, void *pvUser,
|
---|
578 | PDISCPUSTATE pCpu, unsigned *pcbInstruction);
|
---|
579 |
|
---|
580 | DISDECL(int) DISGetParamSize(PDISCPUSTATE pCpu, POP_PARAMETER pParam);
|
---|
581 | DISDECL(int) DISDetectSegReg(PDISCPUSTATE pCpu, POP_PARAMETER pParam);
|
---|
582 | DISDECL(uint8_t) DISQuerySegPrefixByte(PDISCPUSTATE pCpu);
|
---|
583 |
|
---|
584 | /**
|
---|
585 | * Returns the value of the parameter in pParam
|
---|
586 | *
|
---|
587 | * @returns VBox error code
|
---|
588 | * @param pCtx Exception structure pointer
|
---|
589 | * @param pCpu Pointer to cpu structure which have DISCPUSTATE::mode
|
---|
590 | * set correctly.
|
---|
591 | * @param pParam Pointer to the parameter to parse
|
---|
592 | * @param pParamVal Pointer to parameter value (OUT)
|
---|
593 | * @param parmtype Parameter type
|
---|
594 | *
|
---|
595 | * @note Currently doesn't handle FPU/XMM/MMX/3DNow! parameters correctly!!
|
---|
596 | *
|
---|
597 | */
|
---|
598 | DISDECL(int) DISQueryParamVal(PCPUMCTXCORE pCtx, PDISCPUSTATE pCpu, POP_PARAMETER pParam, POP_PARAMVAL pParamVal, PARAM_TYPE parmtype);
|
---|
599 | DISDECL(int) DISQueryParamRegPtr(PCPUMCTXCORE pCtx, PDISCPUSTATE pCpu, POP_PARAMETER pParam, void **ppReg, size_t *pcbSize);
|
---|
600 |
|
---|
601 | DISDECL(int) DISFetchReg8(PCPUMCTXCORE pCtx, unsigned reg8, uint8_t *pVal);
|
---|
602 | DISDECL(int) DISFetchReg16(PCPUMCTXCORE pCtx, unsigned reg16, uint16_t *pVal);
|
---|
603 | DISDECL(int) DISFetchReg32(PCPUMCTXCORE pCtx, unsigned reg32, uint32_t *pVal);
|
---|
604 | DISDECL(int) DISFetchReg64(PCPUMCTXCORE pCtx, unsigned reg64, uint64_t *pVal);
|
---|
605 | DISDECL(int) DISFetchRegSeg(PCPUMCTXCORE pCtx, unsigned sel, RTSEL *pVal);
|
---|
606 | DISDECL(int) DISFetchRegSegEx(PCPUMCTXCORE pCtx, unsigned sel, RTSEL *pVal, PCPUMSELREGHID *ppSelHidReg);
|
---|
607 | DISDECL(int) DISWriteReg8(PCPUMCTXCORE pRegFrame, unsigned reg8, uint8_t val8);
|
---|
608 | DISDECL(int) DISWriteReg16(PCPUMCTXCORE pRegFrame, unsigned reg32, uint16_t val16);
|
---|
609 | DISDECL(int) DISWriteReg32(PCPUMCTXCORE pRegFrame, unsigned reg32, uint32_t val32);
|
---|
610 | DISDECL(int) DISWriteReg64(PCPUMCTXCORE pRegFrame, unsigned reg64, uint64_t val64);
|
---|
611 | DISDECL(int) DISWriteRegSeg(PCPUMCTXCORE pCtx, unsigned sel, RTSEL val);
|
---|
612 | DISDECL(int) DISPtrReg8(PCPUMCTXCORE pCtx, unsigned reg8, uint8_t **ppReg);
|
---|
613 | DISDECL(int) DISPtrReg16(PCPUMCTXCORE pCtx, unsigned reg16, uint16_t **ppReg);
|
---|
614 | DISDECL(int) DISPtrReg32(PCPUMCTXCORE pCtx, unsigned reg32, uint32_t **ppReg);
|
---|
615 | DISDECL(int) DISPtrReg64(PCPUMCTXCORE pCtx, unsigned reg64, uint64_t **ppReg);
|
---|
616 |
|
---|
617 | __END_DECLS
|
---|
618 |
|
---|
619 | #endif
|
---|
620 |
|
---|