tstDisasm-2.cpp revision bfcfd0575ea3b853e34e5058debd5ad24693d607
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync/* $Id$ */
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync/** @file
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync * Testcase - Generic Disassembler Tool.
9b5a120b694c2603a7a3dccbd6cc519164943b17vboxsync */
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync/*
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync * Copyright (C) 2008 Oracle Corporation
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync *
c58f1213e628a545081c70e26c6b67a841cff880vboxsync * This file is part of VirtualBox Open Source Edition (OSE), as
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync * available from http://www.virtualbox.org. This file is free software;
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync * you can redistribute it and/or modify it under the terms of the GNU
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync * General Public License (GPL) as published by the Free Software
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync * Foundation, in version 2 as it comes in the "COPYING" file of the
a16eb14ad7a4b5ef91ddc22d3e8e92d930f736fcvboxsync * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
a16eb14ad7a4b5ef91ddc22d3e8e92d930f736fcvboxsync * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
a16eb14ad7a4b5ef91ddc22d3e8e92d930f736fcvboxsync */
a16eb14ad7a4b5ef91ddc22d3e8e92d930f736fcvboxsync
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync/*******************************************************************************
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync* Header Files *
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync*******************************************************************************/
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync#include <VBox/dis.h>
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync#include <VBox/err.h>
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync#include <iprt/alloc.h>
2d97f8baccdd684bc0a8a15eb86bbe9ff2b85374vboxsync#include <iprt/assert.h>
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync#include <iprt/initterm.h>
866306ba031a2f258907507dd4abb3b84b6983e7vboxsync#include <iprt/getopt.h>
866306ba031a2f258907507dd4abb3b84b6983e7vboxsync#include <iprt/file.h>
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync#include <iprt/path.h>
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync#include <iprt/stream.h>
120ee2736ed70b5ce8b0b4dd73cc4f8b4b9416c1vboxsync#include <iprt/string.h>
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync#include <iprt/ctype.h>
0593edaa1761266cd29c8534b4090646737d3c99vboxsync
0593edaa1761266cd29c8534b4090646737d3c99vboxsync
120ee2736ed70b5ce8b0b4dd73cc4f8b4b9416c1vboxsync/*******************************************************************************
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync* Structures and Typedefs *
120ee2736ed70b5ce8b0b4dd73cc4f8b4b9416c1vboxsync*******************************************************************************/
bb4f31aac6155757fe15ef9fe0bf843ed9a14441vboxsynctypedef enum { kAsmStyle_Default, kAsmStyle_yasm, kAsmStyle_masm, kAsmStyle_gas, kAsmStyle_invalid } ASMSTYLE;
bb4f31aac6155757fe15ef9fe0bf843ed9a14441vboxsynctypedef enum { kUndefOp_Fail, kUndefOp_All, kUndefOp_DefineByte, kUndefOp_End } UNDEFOPHANDLING;
ba00a478700c77b6b1435cd8a7e7cb64d84f8d93vboxsync
ba00a478700c77b6b1435cd8a7e7cb64d84f8d93vboxsynctypedef struct MYDISSTATE
ba00a478700c77b6b1435cd8a7e7cb64d84f8d93vboxsync{
ba00a478700c77b6b1435cd8a7e7cb64d84f8d93vboxsync DISCPUSTATE Cpu;
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync uint64_t uAddress; /**< The current instruction address. */
120ee2736ed70b5ce8b0b4dd73cc4f8b4b9416c1vboxsync uint8_t *pbInstr; /**< The current instruction (pointer). */
ba00a478700c77b6b1435cd8a7e7cb64d84f8d93vboxsync uint32_t cbInstr; /**< The size of the current instruction. */
ba00a478700c77b6b1435cd8a7e7cb64d84f8d93vboxsync bool fUndefOp; /**< Whether the current instruction is really an undefined opcode.*/
3238841f4d74fd0e37778c270ae81b177a98e21bvboxsync UNDEFOPHANDLING enmUndefOp; /**< How to treat undefined opcodes. */
ba00a478700c77b6b1435cd8a7e7cb64d84f8d93vboxsync int rc; /**< Set if we hit EOF. */
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync size_t cbLeft; /**< The number of bytes left. (read) */
120ee2736ed70b5ce8b0b4dd73cc4f8b4b9416c1vboxsync uint8_t *pbNext; /**< The next byte. (read) */
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync uint64_t uNextAddr; /**< The address of the next byte. (read) */
120ee2736ed70b5ce8b0b4dd73cc4f8b4b9416c1vboxsync char szLine[256]; /**< The disassembler text output. */
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync} MYDISSTATE;
120ee2736ed70b5ce8b0b4dd73cc4f8b4b9416c1vboxsynctypedef MYDISSTATE *PMYDISSTATE;
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync
120ee2736ed70b5ce8b0b4dd73cc4f8b4b9416c1vboxsync
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync
120ee2736ed70b5ce8b0b4dd73cc4f8b4b9416c1vboxsync/**
0d9f0399d4356c471af5e68c30b51c73f7909487vboxsync * Default style.
abb14a9d49aa819cc2296b1daf7c416118d39f1evboxsync *
abb14a9d49aa819cc2296b1daf7c416118d39f1evboxsync * @param pState The disassembler state.
0d9f0399d4356c471af5e68c30b51c73f7909487vboxsync */
0d9f0399d4356c471af5e68c30b51c73f7909487vboxsyncstatic void MyDisasDefaultFormatter(PMYDISSTATE pState)
0d9f0399d4356c471af5e68c30b51c73f7909487vboxsync{
0d9f0399d4356c471af5e68c30b51c73f7909487vboxsync RTPrintf("%s", pState->szLine);
0d9f0399d4356c471af5e68c30b51c73f7909487vboxsync}
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync
120ee2736ed70b5ce8b0b4dd73cc4f8b4b9416c1vboxsync
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync/**
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync * Yasm style.
120ee2736ed70b5ce8b0b4dd73cc4f8b4b9416c1vboxsync *
d89903d4817e25634b9f9e877e1c54bb83886115vboxsync * @param pState The disassembler state.
9d58ed91e29fc16c33e0e8f0530a1b8c58b98462vboxsync */
9d58ed91e29fc16c33e0e8f0530a1b8c58b98462vboxsyncstatic void MyDisasYasmFormatter(PMYDISSTATE pState)
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync{
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync char szTmp[256];
890b5e4f0265eb78919f6a41d1ccaa89eba51768vboxsync#if 0
d3b1e232c566c55799a7bfc83f66b045c4d82657vboxsync /* a very quick hack. */
120ee2736ed70b5ce8b0b4dd73cc4f8b4b9416c1vboxsync strcpy(szTmp, RTStrStripL(strchr(pState->szLine, ':') + 1));
120ee2736ed70b5ce8b0b4dd73cc4f8b4b9416c1vboxsync
120ee2736ed70b5ce8b0b4dd73cc4f8b4b9416c1vboxsync char *psz = strrchr(szTmp, '[');
d645696bf70e804f18f661a9b1b8b79c32a1b331vboxsync *psz = '\0';
dccbbd8ec5b45b567312112e7edd5c7130d56262vboxsync RTStrStripR(szTmp);
120ee2736ed70b5ce8b0b4dd73cc4f8b4b9416c1vboxsync
d645696bf70e804f18f661a9b1b8b79c32a1b331vboxsync psz = strstr(szTmp, " ptr ");
3f72ab7ee9d1539bfa4ed19972430194627b9273vboxsync if (psz)
3f72ab7ee9d1539bfa4ed19972430194627b9273vboxsync memset(psz, ' ', 5);
3f72ab7ee9d1539bfa4ed19972430194627b9273vboxsync
3f72ab7ee9d1539bfa4ed19972430194627b9273vboxsync char *pszEnd = strchr(szTmp, '\0');
a99c525910b735565952ae4e13e8bed173255d40vboxsync while (pszEnd - &szTmp[0] < 71)
a99c525910b735565952ae4e13e8bed173255d40vboxsync *pszEnd++ = ' ';
a99c525910b735565952ae4e13e8bed173255d40vboxsync *pszEnd = '\0';
a99c525910b735565952ae4e13e8bed173255d40vboxsync
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync#else
f92fba8b6d97160b7c58689eff6c3848702bd7bavboxsync size_t cch = DISFormatYasmEx(&pState->Cpu, szTmp, sizeof(szTmp),
342d1c2e846281e0bcbde2e97218273216b3fb32vboxsync DIS_FMT_FLAGS_STRICT | DIS_FMT_FLAGS_ADDR_RIGHT | DIS_FMT_FLAGS_ADDR_COMMENT
342d1c2e846281e0bcbde2e97218273216b3fb32vboxsync | DIS_FMT_FLAGS_BYTES_RIGHT | DIS_FMT_FLAGS_BYTES_COMMENT | DIS_FMT_FLAGS_BYTES_SPACED,
342d1c2e846281e0bcbde2e97218273216b3fb32vboxsync NULL, NULL);
342d1c2e846281e0bcbde2e97218273216b3fb32vboxsync Assert(cch < sizeof(szTmp));
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync while (cch < 71)
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync szTmp[cch++] = ' ';
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync szTmp[cch] = '\0';
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync#endif
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync RTPrintf(" %s ; %s", szTmp, pState->szLine);
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync}
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync/**
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync * Masm style.
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync *
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync * @param pState The disassembler state.
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync */
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsyncstatic void MyDisasMasmFormatter(PMYDISSTATE pState)
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync{
df3a016ea59e69ab2758221fd91e62a9782b144evboxsync RTPrintf("masm not implemented: %s", pState->szLine);
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync}
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync/**
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync * This is a temporary workaround for catching a few illegal opcodes
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync * that the disassembler is currently letting thru, just enough to make
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync * the assemblers happy.
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync *
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync * We're too close to a release to dare mess with these things now as
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync * they may consequences for performance and let alone introduce bugs.
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync *
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync * @returns true if it's valid. false if it isn't.
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync *
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync * @param pCpu The disassembler output.
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync */
df3a016ea59e69ab2758221fd91e62a9782b144evboxsyncstatic bool MyDisasIsValidInstruction(DISCPUSTATE const *pCpu)
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync{
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync switch (pCpu->pCurInstr->opcode)
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync {
df3a016ea59e69ab2758221fd91e62a9782b144evboxsync /* These doesn't take memory operands. */
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync case OP_MOV_CR:
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync case OP_MOV_DR:
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync case OP_MOV_TR:
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync if (pCpu->ModRM.Bits.Mod != 3)
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync return false;
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync break;
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync /* The 0x8f /0 variant of this instruction doesn't get its /r value verified. */
060664c5bfb70021bf92e01127d02b178b8c20acvboxsync case OP_POP:
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync if ( pCpu->bOpCode == 0x8f
df3a016ea59e69ab2758221fd91e62a9782b144evboxsync && pCpu->ModRM.Bits.Reg != 0)
060664c5bfb70021bf92e01127d02b178b8c20acvboxsync return false;
060664c5bfb70021bf92e01127d02b178b8c20acvboxsync break;
060664c5bfb70021bf92e01127d02b178b8c20acvboxsync
060664c5bfb70021bf92e01127d02b178b8c20acvboxsync /* The 0xc6 /0 and 0xc7 /0 variants of this instruction don't get their /r values verified. */
73a750ff6ce8ed53244049d291856a1eea296654vboxsync case OP_MOV:
73a750ff6ce8ed53244049d291856a1eea296654vboxsync if ( ( pCpu->bOpCode == 0xc6
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync || pCpu->bOpCode == 0xc7)
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync && pCpu->ModRM.Bits.Reg != 0)
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync return false;
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync break;
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync default:
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync break;
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync }
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync return true;
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync}
df3a016ea59e69ab2758221fd91e62a9782b144evboxsync
060664c5bfb70021bf92e01127d02b178b8c20acvboxsync
060664c5bfb70021bf92e01127d02b178b8c20acvboxsync/**
060664c5bfb70021bf92e01127d02b178b8c20acvboxsync * Callback for reading bytes.
060664c5bfb70021bf92e01127d02b178b8c20acvboxsync *
060664c5bfb70021bf92e01127d02b178b8c20acvboxsync * @todo This should check that the disassembler doesn't do unnecessary reads,
060664c5bfb70021bf92e01127d02b178b8c20acvboxsync * however the current doesn't do this and is just complicated...
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync */
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsyncstatic DECLCALLBACK(int) MyDisasInstrRead(PDISCPUSTATE pDisState, uint8_t *pbDst, RTUINTPTR uSrcAddr, uint32_t cbToRead)
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync{
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync PMYDISSTATE pState = (PMYDISSTATE)pDisState;
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync if (RT_LIKELY( pState->uNextAddr == uSrcAddr
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync && pState->cbLeft >= cbToRead))
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync {
060664c5bfb70021bf92e01127d02b178b8c20acvboxsync /*
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync * Straight forward reading.
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync */
83204c5c9e83c7825a8e0537821a199459b783c8vboxsync if (cbToRead == 1)
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync {
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync pState->cbLeft--;
df3a016ea59e69ab2758221fd91e62a9782b144evboxsync *pbDst = *pState->pbNext++;
060664c5bfb70021bf92e01127d02b178b8c20acvboxsync pState->uNextAddr++;
060664c5bfb70021bf92e01127d02b178b8c20acvboxsync }
060664c5bfb70021bf92e01127d02b178b8c20acvboxsync else
060664c5bfb70021bf92e01127d02b178b8c20acvboxsync {
060664c5bfb70021bf92e01127d02b178b8c20acvboxsync memcpy(pbDst, pState->pbNext, cbToRead);
df3a016ea59e69ab2758221fd91e62a9782b144evboxsync pState->pbNext += cbToRead;
060664c5bfb70021bf92e01127d02b178b8c20acvboxsync pState->cbLeft -= cbToRead;
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync pState->uNextAddr += cbToRead;
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync }
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync }
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync else
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync {
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync /*
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync * Jumping up the stream.
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync * This occurs when the byte sequence is added to the output string.
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync */
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync uint64_t offReq64 = uSrcAddr - pState->uAddress;
83204c5c9e83c7825a8e0537821a199459b783c8vboxsync if (offReq64 < 32)
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync {
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync uint32_t offReq = offReq64;
df3a016ea59e69ab2758221fd91e62a9782b144evboxsync uintptr_t off = pState->pbNext - pState->pbInstr;
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync if (off + pState->cbLeft <= offReq)
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync {
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync pState->pbNext += pState->cbLeft;
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync pState->uNextAddr += pState->cbLeft;
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync pState->cbLeft = 0;
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync memset(pbDst, 0xcc, cbToRead);
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync pState->rc = VERR_EOF;
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync return VERR_EOF;
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync }
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync
83204c5c9e83c7825a8e0537821a199459b783c8vboxsync /* reset the stream. */
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync pState->cbLeft += off;
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync pState->pbNext = pState->pbInstr;
df3a016ea59e69ab2758221fd91e62a9782b144evboxsync pState->uNextAddr = pState->uAddress;
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync /* skip ahead. */
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync pState->cbLeft -= offReq;
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync pState->pbNext += offReq;
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync pState->uNextAddr += offReq;
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync /* do the reading. */
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync if (pState->cbLeft >= cbToRead)
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync {
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync memcpy(pbDst, pState->pbNext, cbToRead);
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync pState->cbLeft -= cbToRead;
df3a016ea59e69ab2758221fd91e62a9782b144evboxsync pState->pbNext += cbToRead;
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync pState->uNextAddr += cbToRead;
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync }
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync else
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync {
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync if (pState->cbLeft > 0)
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync {
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync memcpy(pbDst, pState->pbNext, pState->cbLeft);
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync pbDst += pState->cbLeft;
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync cbToRead -= (uint32_t)pState->cbLeft;
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync pState->pbNext += pState->cbLeft;
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync pState->uNextAddr += pState->cbLeft;
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync pState->cbLeft = 0;
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync }
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync memset(pbDst, 0xcc, cbToRead);
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync pState->rc = VERR_EOF;
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync return VERR_EOF;
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync }
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync }
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync else
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync {
ba00a478700c77b6b1435cd8a7e7cb64d84f8d93vboxsync RTStrmPrintf(g_pStdErr, "Reading before current instruction!\n");
6a762861f4545ff60f0cb6e4d0a947793adc2f74vboxsync memset(pbDst, 0x90, cbToRead);
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync pState->rc = VERR_INTERNAL_ERROR;
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync return VERR_INTERNAL_ERROR;
ba00a478700c77b6b1435cd8a7e7cb64d84f8d93vboxsync }
ba00a478700c77b6b1435cd8a7e7cb64d84f8d93vboxsync }
ba00a478700c77b6b1435cd8a7e7cb64d84f8d93vboxsync
ba00a478700c77b6b1435cd8a7e7cb64d84f8d93vboxsync return VINF_SUCCESS;
ba00a478700c77b6b1435cd8a7e7cb64d84f8d93vboxsync}
7a6ba152515c963d275e7c1371ba39155ec6cf58vboxsync
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync
337640774b62333151a0c5cc6407afcb25d93a37vboxsync/**
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync * Disassembles a block of memory.
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync *
dccbbd8ec5b45b567312112e7edd5c7130d56262vboxsync * @returns VBox status code.
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync * @param argv0 Program name (for errors and warnings).
ba00a478700c77b6b1435cd8a7e7cb64d84f8d93vboxsync * @param enmCpuMode The cpu mode to disassemble in.
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync * @param uAddress The address we're starting to disassemble at.
41738f3838049e665b571d59d971cc5c74efb6dcvboxsync * @param uHighlightAddr The address of the instruction that should be
ba00a478700c77b6b1435cd8a7e7cb64d84f8d93vboxsync * highlighted. Pass UINT64_MAX to keep quiet.
ba00a478700c77b6b1435cd8a7e7cb64d84f8d93vboxsync * @param pbFile Where to start disassemble.
ba00a478700c77b6b1435cd8a7e7cb64d84f8d93vboxsync * @param cbFile How much to disassemble.
625f0ce802a913c7685bc8ae837583bea69ebf8avboxsync * @param enmStyle The assembly output style.
ba00a478700c77b6b1435cd8a7e7cb64d84f8d93vboxsync * @param fListing Whether to print in a listing like mode.
ba00a478700c77b6b1435cd8a7e7cb64d84f8d93vboxsync * @param enmUndefOp How to deal with undefined opcodes.
ae9f3922b0becc4f4b4fca43422314700a4ed8a7vboxsync */
625f0ce802a913c7685bc8ae837583bea69ebf8avboxsyncstatic int MyDisasmBlock(const char *argv0, DISCPUMODE enmCpuMode, uint64_t uAddress,
625f0ce802a913c7685bc8ae837583bea69ebf8avboxsync uint64_t uHighlightAddr, uint8_t *pbFile, size_t cbFile,
625f0ce802a913c7685bc8ae837583bea69ebf8avboxsync ASMSTYLE enmStyle, bool fListing, UNDEFOPHANDLING enmUndefOp)
625f0ce802a913c7685bc8ae837583bea69ebf8avboxsync{
ba00a478700c77b6b1435cd8a7e7cb64d84f8d93vboxsync /*
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync * Initialize the CPU context.
d89903d4817e25634b9f9e877e1c54bb83886115vboxsync */
dfff275f489de72e78be4fb4fbc3a2780f0ee2aavboxsync MYDISSTATE State;
9d58ed91e29fc16c33e0e8f0530a1b8c58b98462vboxsync State.uAddress = uAddress;
dfff275f489de72e78be4fb4fbc3a2780f0ee2aavboxsync State.pbInstr = pbFile;
9d58ed91e29fc16c33e0e8f0530a1b8c58b98462vboxsync State.cbInstr = 0;
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync State.enmUndefOp = enmUndefOp;
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync State.rc = VINF_SUCCESS;
587f936a5f1c792ede2dcb60a7769780a3487c6fvboxsync State.cbLeft = cbFile;
ba00a478700c77b6b1435cd8a7e7cb64d84f8d93vboxsync State.pbNext = pbFile;
12bda05d421d110736c4d6127a36e9c438072dadvboxsync State.uNextAddr = uAddress;
12bda05d421d110736c4d6127a36e9c438072dadvboxsync
ba00a478700c77b6b1435cd8a7e7cb64d84f8d93vboxsync void (*pfnFormatter)(PMYDISSTATE pState);
ba00a478700c77b6b1435cd8a7e7cb64d84f8d93vboxsync switch (enmStyle)
bb4f31aac6155757fe15ef9fe0bf843ed9a14441vboxsync {
ba00a478700c77b6b1435cd8a7e7cb64d84f8d93vboxsync case kAsmStyle_Default:
ba00a478700c77b6b1435cd8a7e7cb64d84f8d93vboxsync pfnFormatter = MyDisasDefaultFormatter;
ba00a478700c77b6b1435cd8a7e7cb64d84f8d93vboxsync break;
ba00a478700c77b6b1435cd8a7e7cb64d84f8d93vboxsync
ba00a478700c77b6b1435cd8a7e7cb64d84f8d93vboxsync case kAsmStyle_yasm:
ba00a478700c77b6b1435cd8a7e7cb64d84f8d93vboxsync RTPrintf(" BITS %d\n", enmCpuMode == DISCPUMODE_16BIT ? 16 : enmCpuMode == DISCPUMODE_32BIT ? 32 : 64);
ba00a478700c77b6b1435cd8a7e7cb64d84f8d93vboxsync pfnFormatter = MyDisasYasmFormatter;
ba00a478700c77b6b1435cd8a7e7cb64d84f8d93vboxsync break;
ba00a478700c77b6b1435cd8a7e7cb64d84f8d93vboxsync
ba00a478700c77b6b1435cd8a7e7cb64d84f8d93vboxsync case kAsmStyle_masm:
ba00a478700c77b6b1435cd8a7e7cb64d84f8d93vboxsync pfnFormatter = MyDisasMasmFormatter;
ba00a478700c77b6b1435cd8a7e7cb64d84f8d93vboxsync break;
ba00a478700c77b6b1435cd8a7e7cb64d84f8d93vboxsync
ae9f3922b0becc4f4b4fca43422314700a4ed8a7vboxsync default:
ba00a478700c77b6b1435cd8a7e7cb64d84f8d93vboxsync AssertFailedReturn(VERR_INTERNAL_ERROR);
ae9f3922b0becc4f4b4fca43422314700a4ed8a7vboxsync }
ba00a478700c77b6b1435cd8a7e7cb64d84f8d93vboxsync
de4903f1d13565a610af0e58c490a8fc9873e3e9vboxsync /*
ba00a478700c77b6b1435cd8a7e7cb64d84f8d93vboxsync * The loop.
ba00a478700c77b6b1435cd8a7e7cb64d84f8d93vboxsync */
ba00a478700c77b6b1435cd8a7e7cb64d84f8d93vboxsync int rcRet = VINF_SUCCESS;
ba00a478700c77b6b1435cd8a7e7cb64d84f8d93vboxsync while (State.cbLeft > 0)
ba00a478700c77b6b1435cd8a7e7cb64d84f8d93vboxsync {
ba00a478700c77b6b1435cd8a7e7cb64d84f8d93vboxsync /*
ba00a478700c77b6b1435cd8a7e7cb64d84f8d93vboxsync * Disassemble it.
3238841f4d74fd0e37778c270ae81b177a98e21bvboxsync */
3238841f4d74fd0e37778c270ae81b177a98e21bvboxsync State.cbInstr = 0;
ba00a478700c77b6b1435cd8a7e7cb64d84f8d93vboxsync State.cbLeft += State.pbNext - State.pbInstr;
f92fba8b6d97160b7c58689eff6c3848702bd7bavboxsync State.uNextAddr = State.uAddress;
f92fba8b6d97160b7c58689eff6c3848702bd7bavboxsync State.pbNext = State.pbInstr;
342d1c2e846281e0bcbde2e97218273216b3fb32vboxsync
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync int rc = DISInstrToStrWithReader(State.uAddress, enmCpuMode, MyDisasInstrRead, &State,
9b5a120b694c2603a7a3dccbd6cc519164943b17vboxsync &State.Cpu, &State.cbInstr, State.szLine, sizeof(State.szLine));
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync if ( RT_SUCCESS(rc)
9b5a120b694c2603a7a3dccbd6cc519164943b17vboxsync || ( ( rc == VERR_DIS_INVALID_OPCODE
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync || rc == VERR_DIS_GEN_FAILURE)
9b5a120b694c2603a7a3dccbd6cc519164943b17vboxsync && State.enmUndefOp == kUndefOp_DefineByte))
9b5a120b694c2603a7a3dccbd6cc519164943b17vboxsync {
9b5a120b694c2603a7a3dccbd6cc519164943b17vboxsync State.fUndefOp = rc == VERR_DIS_INVALID_OPCODE
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync || rc == VERR_DIS_GEN_FAILURE
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync || State.Cpu.pCurInstr->opcode == OP_INVALID
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync || State.Cpu.pCurInstr->opcode == OP_ILLUD2
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync || ( State.enmUndefOp == kUndefOp_DefineByte
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync && !MyDisasIsValidInstruction(&State.Cpu));
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync if (State.fUndefOp && State.enmUndefOp == kUndefOp_DefineByte)
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync {
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync if (!State.cbInstr)
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync {
9f4747a43944848d911353b1bcc99f41aaa5bf81vboxsync State.Cpu.abInstr[0] = 0;
State.Cpu.pfnReadBytes(&State.Cpu, &State.Cpu.abInstr[0], State.uAddress, 1);
State.cbInstr = 1;
}
RTPrintf(" db");
for (unsigned off = 0; off < State.cbInstr; off++)
RTPrintf(off ? ", %03xh" : " %03xh", State.Cpu.abInstr[off]);
RTPrintf(" ; %s\n", State.szLine);
}
else if (!State.fUndefOp && State.enmUndefOp == kUndefOp_All)
{
RTPrintf("%s: error at %#RX64: unexpected valid instruction (op=%d)\n", argv0, State.uAddress, State.Cpu.pCurInstr->opcode);
pfnFormatter(&State);
rcRet = VERR_GENERAL_FAILURE;
}
else if (State.fUndefOp && State.enmUndefOp == kUndefOp_Fail)
{
RTPrintf("%s: error at %#RX64: undefined opcode (op=%d)\n", argv0, State.uAddress, State.Cpu.pCurInstr->opcode);
pfnFormatter(&State);
rcRet = VERR_GENERAL_FAILURE;
}
else
{
/* Use db for odd encodings that we can't make the assembler use. */
if ( State.enmUndefOp == kUndefOp_DefineByte
&& DISFormatYasmIsOddEncoding(&State.Cpu))
{
RTPrintf(" db");
for (unsigned off = 0; off < State.cbInstr; off++)
RTPrintf(off ? ", %03xh" : " %03xh", State.Cpu.abInstr[off]);
RTPrintf(" ; ");
}
pfnFormatter(&State);
}
}
else
{
State.cbInstr = State.pbNext - State.pbInstr;
if (!State.cbLeft)
RTPrintf("%s: error at %#RX64: read beyond the end (%Rrc)\n", argv0, State.uAddress, rc);
else if (State.cbInstr)
RTPrintf("%s: error at %#RX64: %Rrc cbInstr=%d\n", argv0, State.uAddress, rc, State.cbInstr);
else
{
RTPrintf("%s: error at %#RX64: %Rrc cbInstr=%d!\n", argv0, State.uAddress, rc, State.cbInstr);
if (rcRet == VINF_SUCCESS)
rcRet = rc;
break;
}
}
/* Highlight this instruction? */
if (uHighlightAddr - State.uAddress < State.cbInstr)
RTPrintf("; ^^^^^^^^^^^^^^^^^^^^^\n");
/* next */
State.uAddress += State.cbInstr;
State.pbInstr += State.cbInstr;
}
return rcRet;
}
/**
* Converts a hex char to a number.
*
* @returns 0..15 on success, -1 on failure.
* @param ch The character.
*/
static int HexDigitToNum(char ch)
{
switch (ch)
{
case '0': return 0;
case '1': return 1;
case '2': return 2;
case '3': return 3;
case '4': return 4;
case '5': return 5;
case '6': return 6;
case '7': return 7;
case '8': return 8;
case '9': return 9;
case 'A':
case 'a': return 0xa;
case 'B':
case 'b': return 0xb;
case 'C':
case 'c': return 0xc;
case 'D':
case 'd': return 0xd;
case 'E':
case 'e': return 0xe;
case 'F':
case 'f': return 0xf;
default:
RTPrintf("error: Invalid hex digig '%c'\n", ch);
return -1;
}
}
/**
* Prints usage info.
*
* @returns 1.
* @param argv0 The program name.
*/
static int Usage(const char *argv0)
{
RTStrmPrintf(g_pStdErr,
"usage: %s [options] <file1> [file2..fileN]\n"
" or: %s [options] <-x|--hex-bytes> <hex byte> [more hex..]\n"
" or: %s <--help|-h>\n"
"\n"
"Options:\n"
" --address|-a <address>\n"
" The base address. Default: 0\n"
" --max-bytes|-b <bytes>\n"
" The maximum number of bytes to disassemble. Default: 1GB\n"
" --cpumode|-c <16|32|64>\n"
" The cpu mode. Default: 32\n"
" --listing|-l, --no-listing|-L\n"
" Enables or disables listing mode. Default: --no-listing\n"
" --offset|-o <offset>\n"
" The file offset at which to start disassembling. Default: 0\n"
" --style|-s <default|yasm|masm>\n"
" The assembly output style. Default: default\n"
" --undef-op|-u <fail|all|db>\n"
" How to treat undefined opcodes. Default: fail\n"
, argv0, argv0);
return 1;
}
int main(int argc, char **argv)
{
RTR3InitExe(argc, &argv, 0);
const char * const argv0 = RTPathFilename(argv[0]);
/* options */
uint64_t uAddress = 0;
uint64_t uHighlightAddr = UINT64_MAX;
ASMSTYLE enmStyle = kAsmStyle_Default;
UNDEFOPHANDLING enmUndefOp = kUndefOp_Fail;
bool fListing = true;
DISCPUMODE enmCpuMode = DISCPUMODE_32BIT;
RTFOFF off = 0;
RTFOFF cbMax = _1G;
bool fHexBytes = false;
/*
* Parse arguments.
*/
static const RTGETOPTDEF g_aOptions[] =
{
{ "--address", 'a', RTGETOPT_REQ_UINT64 },
{ "--cpumode", 'c', RTGETOPT_REQ_UINT32 },
{ "--bytes", 'b', RTGETOPT_REQ_INT64 },
{ "--listing", 'l', RTGETOPT_REQ_NOTHING },
{ "--no-listing", 'L', RTGETOPT_REQ_NOTHING },
{ "--offset", 'o', RTGETOPT_REQ_INT64 },
{ "--style", 's', RTGETOPT_REQ_STRING },
{ "--undef-op", 'u', RTGETOPT_REQ_STRING },
{ "--hex-bytes", 'x', RTGETOPT_REQ_NOTHING },
};
int ch;
RTGETOPTUNION ValueUnion;
RTGETOPTSTATE GetState;
RTGetOptInit(&GetState, argc, argv, g_aOptions, RT_ELEMENTS(g_aOptions), 1, RTGETOPTINIT_FLAGS_OPTS_FIRST);
while ( (ch = RTGetOpt(&GetState, &ValueUnion))
&& ch != VINF_GETOPT_NOT_OPTION)
{
switch (ch)
{
case 'a':
uAddress = ValueUnion.u64;
break;
case 'b':
cbMax = ValueUnion.i64;
break;
case 'c':
if (ValueUnion.u32 == 16)
enmCpuMode = DISCPUMODE_16BIT;
else if (ValueUnion.u32 == 32)
enmCpuMode = DISCPUMODE_32BIT;
else if (ValueUnion.u32 == 64)
enmCpuMode = DISCPUMODE_64BIT;
else
{
RTStrmPrintf(g_pStdErr, "%s: Invalid CPU mode value %RU32\n", argv0, ValueUnion.u32);
return 1;
}
break;
case 'h':
return Usage(argv0);
case 'l':
fListing = true;
break;
case 'L':
fListing = false;
break;
case 'o':
off = ValueUnion.i64;
break;
case 's':
if (!strcmp(ValueUnion.psz, "default"))
enmStyle = kAsmStyle_Default;
else if (!strcmp(ValueUnion.psz, "yasm"))
enmStyle = kAsmStyle_yasm;
else if (!strcmp(ValueUnion.psz, "masm"))
{
enmStyle = kAsmStyle_masm;
RTStrmPrintf(g_pStdErr, "%s: masm style isn't implemented yet\n", argv0);
return 1;
}
else
{
RTStrmPrintf(g_pStdErr, "%s: unknown assembly style: %s\n", argv0, ValueUnion.psz);
return 1;
}
break;
case 'u':
if (!strcmp(ValueUnion.psz, "fail"))
enmUndefOp = kUndefOp_Fail;
else if (!strcmp(ValueUnion.psz, "all"))
enmUndefOp = kUndefOp_All;
else if (!strcmp(ValueUnion.psz, "db"))
enmUndefOp = kUndefOp_DefineByte;
else
{
RTStrmPrintf(g_pStdErr, "%s: unknown undefined opcode handling method: %s\n", argv0, ValueUnion.psz);
return 1;
}
break;
case 'x':
fHexBytes = true;
break;
case 'V':
RTPrintf("$Revision: $\n");
return 0;
default:
return RTGetOptPrintError(ch, &ValueUnion);
}
}
int iArg = GetState.iNext - 1; /** @todo Not pretty, add RTGetOptInit flag for this. */
if (iArg >= argc)
return Usage(argv0);
int rc = VINF_SUCCESS;
if (fHexBytes)
{
/*
* Convert the remaining arguments from a hex byte string into
* a buffer that we disassemble.
*/
size_t cb = 0;
uint8_t *pb = NULL;
for ( ; iArg < argc; iArg++)
{
char ch2;
const char *psz = argv[iArg];
while (*psz)
{
/** @todo this stuff belongs in IPRT, same stuff as mac address reading. Could be reused for IPv6 with a different item size.*/
/* skip white space, and for the benefit of linux panics '<' and '>'. */
while (RT_C_IS_SPACE(ch2 = *psz) || ch2 == '<' || ch2 == '>')
{
if (ch2 == '<')
uHighlightAddr = uAddress + cb;
psz++;
}
if (!ch2)
break;
/* one digit followed by a space or EOS, or two digits. */
int iNum = HexDigitToNum(*psz++);
if (iNum == -1)
return 1;
if (!RT_C_IS_SPACE(ch2 = *psz) && ch2 != '\0' && ch2 != '>')
{
int iDigit = HexDigitToNum(*psz++);
if (iDigit == -1)
return 1;
iNum = iNum * 16 + iDigit;
}
/* add the byte */
if (!(cb % 4 /*64*/))
{
pb = (uint8_t *)RTMemRealloc(pb, cb + 64);
if (!pb)
{
RTPrintf("%s: error: RTMemRealloc failed\n", argv[0]);
return 1;
}
}
pb[cb++] = (uint8_t)iNum;
}
}
/*
* Disassemble it.
*/
rc = MyDisasmBlock(argv0, enmCpuMode, uAddress, uHighlightAddr, pb, cb, enmStyle, fListing, enmUndefOp);
}
else
{
/*
* Process the files.
*/
for ( ; iArg < argc; iArg++)
{
/*
* Read the file into memory.
*/
void *pvFile;
size_t cbFile;
rc = RTFileReadAllEx(argv[iArg], off, cbMax, RTFILE_RDALL_O_DENY_NONE, &pvFile, &cbFile);
if (RT_FAILURE(rc))
{
RTStrmPrintf(g_pStdErr, "%s: %s: %Rrc\n", argv0, argv[iArg], rc);
break;
}
/*
* Disassemble it.
*/
rc = MyDisasmBlock(argv0, enmCpuMode, uAddress, uHighlightAddr, (uint8_t *)pvFile, cbFile, enmStyle, fListing, enmUndefOp);
if (RT_FAILURE(rc))
break;
}
}
return RT_SUCCESS(rc) ? 0 : 1;
}