VirtualBox

source: vbox/trunk/src/VBox/Disassembler/Disasm.cpp@ 8155

Last change on this file since 8155 was 8155, checked in by vboxsync, 16 years ago

The Big Sun Rebranding Header Change
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 14.0 KB
Line 
1/** @file
2 *
3 * VBox disassembler:
4 * Main
5 */
6
7/*
8 * Copyright (C) 2006-2007 Sun Microsystems, Inc.
9 *
10 * This file is part of VirtualBox Open Source Edition (OSE), as
11 * available from http://www.virtualbox.org. This file is free software;
12 * you can redistribute it and/or modify it under the terms of the GNU
13 * General Public License (GPL) as published by the Free Software
14 * Foundation, in version 2 as it comes in the "COPYING" file of the
15 * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
16 * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
17 *
18 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
19 * Clara, CA 95054 USA or visit http://www.sun.com if you need
20 * additional information or have any questions.
21 */
22
23
24/*******************************************************************************
25* Header Files *
26*******************************************************************************/
27#ifdef USING_VISUAL_STUDIO
28# include <stdafx.h>
29#endif
30#include <VBox/dis.h>
31#include <VBox/disopcode.h>
32#include <VBox/err.h>
33#include <iprt/assert.h>
34#include <iprt/string.h>
35#include "DisasmInternal.h"
36#include "DisasmTables.h"
37
38
39/**
40 * Disassembles a code block.
41 *
42 * @returns VBox error code
43 * @param pCpu Pointer to cpu structure which have DISCPUSTATE::mode
44 * set correctly.
45 * @param pvCodeBlock Pointer to the strunction to disassemble.
46 * @param cbMax Maximum number of bytes to disassemble.
47 * @param pcbSize Where to store the size of the instruction.
48 * NULL is allowed.
49 *
50 *
51 * @todo Define output callback.
52 * @todo Using signed integers as sizes is a bit odd. There are still
53 * some GCC warnings about mixing signed and unsigend integers.
54 * @todo Need to extend this interface to include a code address so we
55 * can dissassemble GC code. Perhaps a new function is better...
56 * @remark cbMax isn't respected as a boundry. DISInstr() will read beyond cbMax.
57 * This means *pcbSize >= cbMax sometimes.
58 */
59DISDECL(int) DISBlock(PDISCPUSTATE pCpu, RTUINTPTR pvCodeBlock, unsigned cbMax, unsigned *pSize)
60{
61 unsigned i = 0;
62 char szOutput[256];
63
64 while (i < cbMax)
65 {
66 unsigned cbInstr;
67 int rc = DISInstr(pCpu, pvCodeBlock + i, 0, &cbInstr, szOutput);
68 if (VBOX_FAILURE(rc))
69 return rc;
70
71 i += cbInstr;
72 }
73
74 if (pSize)
75 *pSize = i;
76 return true;
77}
78
79/**
80 * Disassembles one instruction
81 *
82 * @returns VBox error code
83 * @param pCpu Pointer to cpu structure which have DISCPUSTATE::mode
84 * set correctly.
85 * @param pu8Instruction Pointer to the strunction to disassemble.
86 * @param u32EipOffset Offset to add to instruction address to get the real virtual address
87 * @param pcbSize Where to store the size of the instruction.
88 * NULL is allowed.
89 * @param pszOutput Storage for disassembled instruction
90 *
91 * @todo Define output callback.
92 */
93DISDECL(int) DISInstr(PDISCPUSTATE pCpu, RTUINTPTR pu8Instruction, unsigned u32EipOffset, unsigned *pcbSize,
94 char *pszOutput)
95{
96 return DISInstrEx(pCpu, pu8Instruction, u32EipOffset, pcbSize, pszOutput, OPTYPE_ALL);
97}
98
99/**
100 * Disassembles one instruction; only fully disassembly an instruction if it matches the filter criteria
101 *
102 * @returns VBox error code
103 * @param pCpu Pointer to cpu structure which have DISCPUSTATE::mode
104 * set correctly.
105 * @param pu8Instruction Pointer to the strunction to disassemble.
106 * @param u32EipOffset Offset to add to instruction address to get the real virtual address
107 * @param pcbSize Where to store the size of the instruction.
108 * NULL is allowed.
109 * @param pszOutput Storage for disassembled instruction
110 * @param uFilter Instruction type filter
111 *
112 * @todo Define output callback.
113 */
114DISDECL(int) DISInstrEx(PDISCPUSTATE pCpu, RTUINTPTR pu8Instruction, unsigned u32EipOffset, unsigned *pcbSize,
115 char *pszOutput, unsigned uFilter)
116{
117 unsigned i = 0, prefixbytes;
118 unsigned idx, inc;
119#ifdef __L4ENV__
120 jmp_buf jumpbuffer;
121#endif
122
123 //reset instruction settings
124 pCpu->prefix = PREFIX_NONE;
125 pCpu->prefix_seg = 0;
126 pCpu->addrmode = pCpu->mode;
127 pCpu->opmode = pCpu->mode;
128 pCpu->ModRM = 0;
129 pCpu->SIB = 0;
130 pCpu->lastprefix = 0;
131 pCpu->param1.parval = 0;
132 pCpu->param2.parval = 0;
133 pCpu->param3.parval = 0;
134 pCpu->param1.szParam[0] = 0;
135 pCpu->param2.szParam[0] = 0;
136 pCpu->param3.szParam[0] = 0;
137 pCpu->param1.size = 0;
138 pCpu->param2.size = 0;
139 pCpu->param3.size = 0;
140 pCpu->param1.flags = 0;
141 pCpu->param2.flags = 0;
142 pCpu->param3.flags = 0;
143 pCpu->uFilter = uFilter;
144 pCpu->pfnDisasmFnTable = pfnFullDisasm;
145
146 if (pszOutput)
147 *pszOutput = '\0';
148
149 prefixbytes = 0;
150#ifndef __L4ENV__ /* Unfortunately, we have no exception handling in l4env */
151 try
152#else
153 pCpu->pJumpBuffer = &jumpbuffer;
154 if (setjmp(jumpbuffer) == 0)
155#endif
156 {
157 while(1)
158 {
159 uint8_t codebyte = DISReadByte(pCpu, pu8Instruction+i);
160 uint8_t opcode = g_aOneByteMapX86[codebyte].opcode;
161
162 /* Hardcoded assumption about OP_* values!! */
163 if (opcode <= OP_LOCK)
164 {
165 pCpu->lastprefix = opcode;
166 switch(opcode)
167 {
168 case OP_INVALID:
169#if 0 //defined (DEBUG_Sander)
170 AssertMsgFailed(("Invalid opcode!!\n"));
171#endif
172 return VERR_DIS_INVALID_OPCODE;
173
174 // segment override prefix byte
175 case OP_SEG:
176 pCpu->prefix_seg = g_aOneByteMapX86[codebyte].param1 - OP_PARM_REG_SEG_START;
177 pCpu->prefix |= PREFIX_SEG;
178 i += sizeof(uint8_t);
179 prefixbytes++;
180 continue; //fetch the next byte
181
182 // lock prefix byte
183 case OP_LOCK:
184 pCpu->prefix |= PREFIX_LOCK;
185 i += sizeof(uint8_t);
186 prefixbytes++;
187 continue; //fetch the next byte
188
189 // address size override prefix byte
190 case OP_ADRSIZE:
191 pCpu->prefix |= PREFIX_ADDRSIZE;
192 if(pCpu->mode == CPUMODE_16BIT)
193 pCpu->addrmode = CPUMODE_32BIT;
194 else pCpu->addrmode = CPUMODE_16BIT;
195 i += sizeof(uint8_t);
196 prefixbytes++;
197 continue; //fetch the next byte
198
199 // operand size override prefix byte
200 case OP_OPSIZE:
201 pCpu->prefix |= PREFIX_OPSIZE;
202 if(pCpu->mode == CPUMODE_16BIT)
203 pCpu->opmode = CPUMODE_32BIT;
204 else pCpu->opmode = CPUMODE_16BIT;
205 i += sizeof(uint8_t);
206 prefixbytes++;
207 continue; //fetch the next byte
208
209 // rep and repne are not really prefixes, but we'll treat them as such
210 case OP_REPE:
211 pCpu->prefix |= PREFIX_REP;
212 i += sizeof(uint8_t);
213 prefixbytes += sizeof(uint8_t);
214 continue; //fetch the next byte
215
216 case OP_REPNE:
217 pCpu->prefix |= PREFIX_REPNE;
218 i += sizeof(uint8_t);
219 prefixbytes += sizeof(uint8_t);
220 continue; //fetch the next byte
221 }
222 }
223
224 idx = i;
225 i += sizeof(uint8_t); //first opcode byte
226
227 pCpu->opcode = codebyte;
228 /* Prefix byte(s) is/are part of the instruction. */
229 pCpu->opaddr = pu8Instruction + idx + u32EipOffset - prefixbytes;
230
231 inc = ParseInstruction(pu8Instruction + i, &g_aOneByteMapX86[pCpu->opcode], pCpu);
232
233 pCpu->opsize = prefixbytes + inc + sizeof(uint8_t);
234
235 if(pszOutput) {
236 disasmSprintf(pszOutput, pu8Instruction+i-1-prefixbytes, pCpu, &pCpu->param1, &pCpu->param2, &pCpu->param3);
237 }
238
239 i += inc;
240 prefixbytes = 0;
241 break;
242 }
243 }
244#ifndef __L4ENV__
245 catch(...)
246#else
247 else /* setjmp has returned a non-zero value: an exception occured */
248#endif
249 {
250 if (pcbSize)
251 *pcbSize = 0;
252 return VERR_DIS_GEN_FAILURE;
253 }
254
255 if (pcbSize)
256 *pcbSize = i;
257
258 return VINF_SUCCESS;
259}
260//*****************************************************************************
261//*****************************************************************************
262char *DbgBytesToString(PDISCPUSTATE pCpu, RTUINTPTR pBytes, int size, char *pszOutput)
263{
264 char szByte[4];
265 int len = strlen(pszOutput);
266 int i;
267
268 for(i = len; i < 40; i++)
269 {
270 strcat(pszOutput, " ");
271 }
272 strcat(pszOutput, " [");
273 for(i = 0; i < size; i++)
274 {
275 RTStrPrintf(szByte, sizeof(szByte), "%02X ", DISReadByte(pCpu, pBytes+i));
276 RTStrPrintf(&pszOutput[strlen(pszOutput)], 64, szByte);
277 }
278 len = strlen(pszOutput);
279 pszOutput[len - 1] = 0; //cut off last space
280
281 strcat(pszOutput, "]");
282 return pszOutput;
283}
284//*****************************************************************************
285//*****************************************************************************
286void disasmSprintf(char *pszOutput, RTUINTPTR pu8Instruction, PDISCPUSTATE pCpu, OP_PARAMETER *pParam1, OP_PARAMETER *pParam2, OP_PARAMETER *pParam3)
287{
288 const char *lpszFormat = pCpu->pszOpcode;
289 int param = 1;
290
291 RTStrPrintf(pszOutput, 64, "%08X: ", (unsigned)pCpu->opaddr);
292 if(pCpu->prefix & PREFIX_LOCK)
293 {
294 RTStrPrintf(&pszOutput[strlen(pszOutput)], 64, "lock ");
295 }
296 if(pCpu->prefix & PREFIX_REP)
297 {
298 RTStrPrintf(&pszOutput[strlen(pszOutput)], 64, "rep(e) ");
299 }
300 else
301 if(pCpu->prefix & PREFIX_REPNE)
302 {
303 RTStrPrintf(&pszOutput[strlen(pszOutput)], 64, "repne ");
304 }
305
306 if(!strcmp("Invalid Opcode", lpszFormat))
307 {
308 RTStrPrintf(&pszOutput[strlen(pszOutput)], 64, "Invalid Opcode [%02X][%02X]", DISReadByte(pCpu, pu8Instruction), DISReadByte(pCpu, pu8Instruction+1) );
309 }
310 else
311 while(*lpszFormat)
312 {
313 switch(*lpszFormat)
314 {
315 case '%':
316 switch(*(lpszFormat+1))
317 {
318 case 'J': //Relative jump offset
319 {
320 int32_t disp;
321
322 AssertMsg(param == 1, ("Invalid branch parameter nr"));
323 if(pParam1->flags & USE_IMMEDIATE8_REL)
324 {
325 disp = (int32_t)(char)pParam1->parval;
326 }
327 else
328 if(pParam1->flags & USE_IMMEDIATE16_REL)
329 {
330 disp = (int32_t)(uint16_t)pParam1->parval;
331 }
332 else
333 if(pParam1->flags & USE_IMMEDIATE32_REL)
334 {
335 disp = (int32_t)pParam1->parval;
336 }
337 else
338 {
339 AssertMsgFailed(("Oops!\n"));
340 return;
341 }
342 uint32_t addr = (uint32_t)(pCpu->opaddr + pCpu->opsize) + disp;
343 RTStrPrintf(&pszOutput[strlen(pszOutput)], 64, "[%08X]", addr);
344 }
345
346 //no break;
347
348 case 'A': //direct address
349 case 'C': //control register
350 case 'D': //debug register
351 case 'E': //ModRM specifies parameter
352 case 'F': //Eflags register
353 case 'G': //ModRM selects general register
354 case 'I': //Immediate data
355 case 'M': //ModRM may only refer to memory
356 case 'O': //No ModRM byte
357 case 'P': //ModRM byte selects MMX register
358 case 'Q': //ModRM byte selects MMX register or memory address
359 case 'R': //ModRM byte may only refer to a general register
360 case 'S': //ModRM byte selects a segment register
361 case 'T': //ModRM byte selects a test register
362 case 'V': //ModRM byte selects an XMM/SSE register
363 case 'W': //ModRM byte selects an XMM/SSE register or a memory address
364 case 'X': //DS:SI
365 case 'Y': //ES:DI
366 switch(param)
367 {
368 case 1:
369 RTStrPrintf(&pszOutput[strlen(pszOutput)], 64, pParam1->szParam);
370 break;
371 case 2:
372 RTStrPrintf(&pszOutput[strlen(pszOutput)], 64, pParam2->szParam);
373 break;
374 case 3:
375 RTStrPrintf(&pszOutput[strlen(pszOutput)], 64, pParam3->szParam);
376 break;
377 }
378 break;
379
380 case 'e': //register based on operand size (e.g. %eAX)
381 if(pCpu->opmode == CPUMODE_32BIT)
382 {
383 RTStrPrintf(&pszOutput[strlen(pszOutput)], 64, "E");
384 }
385 RTStrPrintf(&pszOutput[strlen(pszOutput)], 64, "%c%c", lpszFormat[2], lpszFormat[3]);
386 break;
387
388 default:
389 AssertMsgFailed(("Oops!\n"));
390 break;
391 }
392
393 //Go to the next parameter in the format string
394 while(*lpszFormat && *lpszFormat != ',') lpszFormat++;
395 if(*lpszFormat == ',') lpszFormat--;
396
397 break;
398
399 case ',':
400 param++;
401 //no break
402
403 default:
404 RTStrPrintf(&pszOutput[strlen(pszOutput)], 64, "%c", *lpszFormat);
405 break;
406 }
407
408 if(*lpszFormat) lpszFormat++;
409 }
410 DbgBytesToString(pCpu, pu8Instruction, pCpu->opsize, pszOutput);
411 RTStrPrintf(&pszOutput[strlen(pszOutput)], 64, "\n");
412}
413//*****************************************************************************
414//*****************************************************************************
Note: See TracBrowser for help on using the repository browser.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette