dis.h revision ab00a1ced6adde2929a57318c5c1f2ab06961a1a
a0240ff4f7663045c848fdbc192ea3d4d9f70a11vboxsync * DIS - The VirtualBox Disassembler.
a0240ff4f7663045c848fdbc192ea3d4d9f70a11vboxsync * Copyright (C) 2006-2007 Sun Microsystems, Inc.
a0240ff4f7663045c848fdbc192ea3d4d9f70a11vboxsync * This file is part of VirtualBox Open Source Edition (OSE), as
a0240ff4f7663045c848fdbc192ea3d4d9f70a11vboxsync * available from http://www.virtualbox.org. This file is free software;
a0240ff4f7663045c848fdbc192ea3d4d9f70a11vboxsync * you can redistribute it and/or modify it under the terms of the GNU
a0240ff4f7663045c848fdbc192ea3d4d9f70a11vboxsync * General Public License (GPL) as published by the Free Software
a16eb14ad7a4b5ef91ddc22d3e8e92d930f736fcvboxsync * 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.
a0240ff4f7663045c848fdbc192ea3d4d9f70a11vboxsync * The contents of this file may alternatively be used under the terms
a0240ff4f7663045c848fdbc192ea3d4d9f70a11vboxsync * of the Common Development and Distribution License Version 1.0
a0240ff4f7663045c848fdbc192ea3d4d9f70a11vboxsync * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
a0240ff4f7663045c848fdbc192ea3d4d9f70a11vboxsync * VirtualBox OSE distribution, in which case the provisions of the
a0240ff4f7663045c848fdbc192ea3d4d9f70a11vboxsync * CDDL are applicable instead of those of the GPL.
a0240ff4f7663045c848fdbc192ea3d4d9f70a11vboxsync * You may elect to license modified versions of this file under the
cd6f71bc352f550074f1ba2c830a2cf2f0b3dd46vboxsync * terms and conditions of either the GPL or the CDDL or both.
43747b1f0bc8302a238fb35e55857a5e9aa1933dvboxsync * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
43747b1f0bc8302a238fb35e55857a5e9aa1933dvboxsync * Clara, CA 95054 USA or visit http://www.sun.com if you need
16a9adc14900ca18e6909679a579f6833425e030vboxsync * additional information or have any questions.
51fe8789a74f6c118894aaa12eb69ec155386dbdvboxsync/** CPU mode flags (DISCPUSTATE::mode).
efff36b306e370346025647a158689021df2e1d1vboxsynctypedef enum
51fe8789a74f6c118894aaa12eb69ec155386dbdvboxsync /** hack forcing the size of the enum to 32-bits. */
a0240ff4f7663045c848fdbc192ea3d4d9f70a11vboxsync/** Prefix byte flags
1bf495e3eec00dd79cecb6b36ef2a97f422c3737vboxsync/** non-default address size. */
a0240ff4f7663045c848fdbc192ea3d4d9f70a11vboxsync/** non-default operand size. */
a0240ff4f7663045c848fdbc192ea3d4d9f70a11vboxsync/** lock prefix. */
a0240ff4f7663045c848fdbc192ea3d4d9f70a11vboxsync/** segment prefix. */
a0240ff4f7663045c848fdbc192ea3d4d9f70a11vboxsync/** rep(e) prefix (not a prefix, but we'll treat is as one). */
0abd77741a608f6c41c8dfcd4781b8b84adf1044vboxsync/** rep(e) prefix (not a prefix, but we'll treat is as one). */
9496f2d398b49813176939d7a339ae513d5175efvboxsync/** REX prefix (64 bits) */
d80c85a1bc7317da7d0cd1254fae6a20db039c8cvboxsync/** 64 bits prefix byte flags
d80c85a1bc7317da7d0cd1254fae6a20db039c8cvboxsync#define PREFIX_REX_OP_2_FLAGS(a) (a - OP_PARM_REX_START)
d80c85a1bc7317da7d0cd1254fae6a20db039c8cvboxsync#define PREFIX_REX_FLAGS PREFIX_REX_OP_2_FLAGS(OP_PARM_REX)
d80c85a1bc7317da7d0cd1254fae6a20db039c8cvboxsync#define PREFIX_REX_FLAGS_B PREFIX_REX_OP_2_FLAGS(OP_PARM_REX_B)
d80c85a1bc7317da7d0cd1254fae6a20db039c8cvboxsync#define PREFIX_REX_FLAGS_X PREFIX_REX_OP_2_FLAGS(OP_PARM_REX_X)
d80c85a1bc7317da7d0cd1254fae6a20db039c8cvboxsync#define PREFIX_REX_FLAGS_XB PREFIX_REX_OP_2_FLAGS(OP_PARM_REX_XB)
d80c85a1bc7317da7d0cd1254fae6a20db039c8cvboxsync#define PREFIX_REX_FLAGS_R PREFIX_REX_OP_2_FLAGS(OP_PARM_REX_R)
d80c85a1bc7317da7d0cd1254fae6a20db039c8cvboxsync#define PREFIX_REX_FLAGS_RB PREFIX_REX_OP_2_FLAGS(OP_PARM_REX_RB)
d80c85a1bc7317da7d0cd1254fae6a20db039c8cvboxsync#define PREFIX_REX_FLAGS_RX PREFIX_REX_OP_2_FLAGS(OP_PARM_REX_RX)
d80c85a1bc7317da7d0cd1254fae6a20db039c8cvboxsync#define PREFIX_REX_FLAGS_RXB PREFIX_REX_OP_2_FLAGS(OP_PARM_REX_RXB)
c0a370e600bb60153a269fb32b5f709347c35768vboxsync#define PREFIX_REX_FLAGS_W PREFIX_REX_OP_2_FLAGS(OP_PARM_REX_W)
c0a370e600bb60153a269fb32b5f709347c35768vboxsync#define PREFIX_REX_FLAGS_WB PREFIX_REX_OP_2_FLAGS(OP_PARM_REX_WB)
c0a370e600bb60153a269fb32b5f709347c35768vboxsync#define PREFIX_REX_FLAGS_WX PREFIX_REX_OP_2_FLAGS(OP_PARM_REX_WX)
c0a370e600bb60153a269fb32b5f709347c35768vboxsync#define PREFIX_REX_FLAGS_WXB PREFIX_REX_OP_2_FLAGS(OP_PARM_REX_WXB)
d80c85a1bc7317da7d0cd1254fae6a20db039c8cvboxsync#define PREFIX_REX_FLAGS_WR PREFIX_REX_OP_2_FLAGS(OP_PARM_REX_WR)
d80c85a1bc7317da7d0cd1254fae6a20db039c8cvboxsync#define PREFIX_REX_FLAGS_WRB PREFIX_REX_OP_2_FLAGS(OP_PARM_REX_WRB)
5341459ca931b65de60b5af2a4cba6836b6b45cavboxsync#define PREFIX_REX_FLAGS_WRX PREFIX_REX_OP_2_FLAGS(OP_PARM_REX_WRX)
5341459ca931b65de60b5af2a4cba6836b6b45cavboxsync#define PREFIX_REX_FLAGS_WRXB PREFIX_REX_OP_2_FLAGS(OP_PARM_REX_WRXB)
5341459ca931b65de60b5af2a4cba6836b6b45cavboxsync * Operand type.
a0240ff4f7663045c848fdbc192ea3d4d9f70a11vboxsync#define OPTYPE_RRM_DANGEROUS RT_BIT(14) /**< Some additional dangerouse ones when recompiling raw r0. */
ee4d840f54fd2dcea8a73b1b86d5ec0db370b05dvboxsync#define OPTYPE_RRM_DANGEROUS_16 RT_BIT(15) /**< Some additional dangerouse ones when recompiling 16-bit raw r0. */
ee4d840f54fd2dcea8a73b1b86d5ec0db370b05dvboxsync#define OPTYPE_RRM_MASK (OPTYPE_RRM_DANGEROUS | OPTYPE_RRM_DANGEROUS_16)
ee4d840f54fd2dcea8a73b1b86d5ec0db370b05dvboxsync#define OPTYPE_INHIBIT_IRQS RT_BIT(16) /**< Will or can inhibit irqs (sti, pop ss, mov ss) */
ee4d840f54fd2dcea8a73b1b86d5ec0db370b05dvboxsync#define OPTYPE_INVALID_64 RT_BIT(19) /**< Invalid in 64 bits mode */
ee4d840f54fd2dcea8a73b1b86d5ec0db370b05dvboxsync#define OPTYPE_ONLY_64 RT_BIT(20) /**< Only valid in 64 bits mode */
a0240ff4f7663045c848fdbc192ea3d4d9f70a11vboxsync#define OPTYPE_DEFAULT_64_OP_SIZE RT_BIT(21) /**< Default 64 bits operand size */
a0240ff4f7663045c848fdbc192ea3d4d9f70a11vboxsync#define OPTYPE_FORCED_64_OP_SIZE RT_BIT(22) /**< Forced 64 bits operand size; regardless of prefix bytes */
a0240ff4f7663045c848fdbc192ea3d4d9f70a11vboxsync#define OPTYPE_REXB_EXTENDS_OPREG RT_BIT(23) /**< REX.B extends the register field in the opcode byte */
a0240ff4f7663045c848fdbc192ea3d4d9f70a11vboxsync/** Parameter usage flags.
d80c85a1bc7317da7d0cd1254fae6a20db039c8cvboxsync/** DS:ESI */
61d064a54f03596920c3918f58ecc7764074a5d8vboxsync/** ES:EDI */
16a9adc14900ca18e6909679a579f6833425e030vboxsync#define USE_IMMEDIATE (USE_IMMEDIATE8|USE_IMMEDIATE16|USE_IMMEDIATE32|USE_IMMEDIATE64|USE_IMMEDIATE8_REL|USE_IMMEDIATE16_REL|USE_IMMEDIATE32_REL|USE_IMMEDIATE64_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)
16a9adc14900ca18e6909679a579f6833425e030vboxsync#define DIS_IS_EFFECTIVE_ADDR(flags) !!((flags) & (USE_BASE|USE_INDEX|USE_DISPLACEMENT32|USE_DISPLACEMENT16|USE_DISPLACEMENT8|USE_RIPDISPLACEMENT32))
16a9adc14900ca18e6909679a579f6833425e030vboxsync/** index in {"RAX", "RCX", "RDX", "RBX", "RSP", "RBP", "RSI", "RDI", "R8", "R9", "R10", "R11", "R12", "R13", "R14", "R15"}
681fd85cc7cd49e9cf66a917d6ae9ff36eb7d9e9vboxsync/** index in {"EAX", "ECX", "EDX", "EBX", "ESP", "EBP", "ESI", "EDI"}
1bf495e3eec00dd79cecb6b36ef2a97f422c3737vboxsync/** index in {"AX", "CX", "DX", "BX", "SP", "BP", "SI", "DI"}
d80c85a1bc7317da7d0cd1254fae6a20db039c8cvboxsync/** index in {"AL", "CL", "DL", "BL", "AH", "CH", "DH", "BH"}
d80c85a1bc7317da7d0cd1254fae6a20db039c8cvboxsync/** index in {ES, CS, SS, DS, FS, GS}
d80c85a1bc7317da7d0cd1254fae6a20db039c8cvboxsynctypedef enum
16a9adc14900ca18e6909679a579f6833425e030vboxsync /** The usual 32-bit paranoia. */
1bf495e3eec00dd79cecb6b36ef2a97f422c3737vboxsync/** Used by DISQueryParamVal & EMIQueryParamVal
1bf495e3eec00dd79cecb6b36ef2a97f422c3737vboxsynctypedef struct
5341459ca931b65de60b5af2a4cba6836b6b45cavboxsync/** Pointer to opcode parameter value. */
7766bf675357fd940d8c49e69a5d72dc6eaa6be4vboxsynctypedef enum
cc15c3fa4bb2d3fb91e4d0cd15a73133963f86b0vboxsync * Operand Parameter.
5341459ca931b65de60b5af2a4cba6836b6b45cavboxsync /** @todo switch param and parval and move disp64 and flags up here with the other 64-bit vars to get more natural alignment and save space. */
5341459ca931b65de60b5af2a4cba6836b6b45cavboxsync /** ST(0) - ST(7) */
ffbe6daf773e38167f3cabaf1f063d84ecd063e9vboxsync /** MMX0 - MMX7 */
5341459ca931b65de60b5af2a4cba6836b6b45cavboxsync /** XMM0 - XMM7 */
fbf08fabb4c4b383d6aa2830c2bd5b943a26f10cvboxsync /** {ES, CS, SS, DS, FS, GS} */
5341459ca931b65de60b5af2a4cba6836b6b45cavboxsync /** TR0-TR7 (?) */
adefd5e9babba486cba0cfae52f5a0f6c8c4ef24vboxsync /** CR0-CR4 */
61d064a54f03596920c3918f58ecc7764074a5d8vboxsync /** DR0-DR7 */
adefd5e9babba486cba0cfae52f5a0f6c8c4ef24vboxsync /** 2, 4 or 8. */
b5ad839a3757b305d4e98d7264da2b53c9cd27f0vboxsync/** Pointer to opcode parameter. */
5341459ca931b65de60b5af2a4cba6836b6b45cavboxsync/** Pointer to opcode parameter. */
b5ad839a3757b305d4e98d7264da2b53c9cd27f0vboxsync/** Pointer to opcode. */
b5ad839a3757b305d4e98d7264da2b53c9cd27f0vboxsync/** Pointer to const opcode. */
b5ad839a3757b305d4e98d7264da2b53c9cd27f0vboxsynctypedef DECLCALLBACK(int) FN_DIS_READBYTES(RTUINTPTR pSrc, uint8_t *pDest, unsigned size, void *pvUserdata);
5341459ca931b65de60b5af2a4cba6836b6b45cavboxsync/* forward decl */
5341459ca931b65de60b5af2a4cba6836b6b45cavboxsync/** Pointer to the disassembler CPU state. */
5341459ca931b65de60b5af2a4cba6836b6b45cavboxsync/** Parser callback.
5341459ca931b65de60b5af2a4cba6836b6b45cavboxsync * @remark no DECLCALLBACK() here because it's considered to be internal (really, I'm too lazy to update all the functions). */
5341459ca931b65de60b5af2a4cba6836b6b45cavboxsynctypedef unsigned FNDISPARSE(RTUINTPTR pu8CodeBlock, PCOPCODE pOp, POP_PARAMETER pParam, PDISCPUSTATE pCpu);
9496f2d398b49813176939d7a339ae513d5175efvboxsynctypedef struct _DISCPUSTATE
5341459ca931b65de60b5af2a4cba6836b6b45cavboxsync /* Global setting */
5341459ca931b65de60b5af2a4cba6836b6b45cavboxsync /* Per instruction prefix settings */
5341459ca931b65de60b5af2a4cba6836b6b45cavboxsync /** segment prefix value. */
5341459ca931b65de60b5af2a4cba6836b6b45cavboxsync /** rex prefix value (64 bits only */
9496f2d398b49813176939d7a339ae513d5175efvboxsync /** addressing mode (16 or 32 bits). (CPUMODE_*) */
9496f2d398b49813176939d7a339ae513d5175efvboxsync /** operand mode (16 or 32 bits). (CPUMODE_*) */
a9f41cb889f53e8407561a6155052c441eb0fc5fvboxsync /** ModRM fields. */
5341459ca931b65de60b5af2a4cba6836b6b45cavboxsync /* Bitfield view */
5341459ca931b65de60b5af2a4cba6836b6b45cavboxsync /* unsigned view */
5341459ca931b65de60b5af2a4cba6836b6b45cavboxsync unsigned u;
ce03ea57fdcf3d48523b1de5b894feb75e1b34davboxsync /** SIB fields. */
ce03ea57fdcf3d48523b1de5b894feb75e1b34davboxsync /* Bitfield view */
7766bf675357fd940d8c49e69a5d72dc6eaa6be4vboxsync /* unsigned view */
9496f2d398b49813176939d7a339ae513d5175efvboxsync unsigned u;
16a9adc14900ca18e6909679a579f6833425e030vboxsync /** First opcode byte of instruction. */
a9f41cb889f53e8407561a6155052c441eb0fc5fvboxsync /** Last prefix byte (for SSE2 extension tables) */
5341459ca931b65de60b5af2a4cba6836b6b45cavboxsync /** Opcode format string for current instruction. */
5341459ca931b65de60b5af2a4cba6836b6b45cavboxsync /** Internal: pointer to disassembly function table */
5341459ca931b65de60b5af2a4cba6836b6b45cavboxsync /** Internal: instruction filter */
ce03ea57fdcf3d48523b1de5b894feb75e1b34davboxsync /** Pointer to the current instruction. */
ce03ea57fdcf3d48523b1de5b894feb75e1b34davboxsync /** Optional read function */
5341459ca931b65de60b5af2a4cba6836b6b45cavboxsync#endif /* __L4ENV__ */
9496f2d398b49813176939d7a339ae513d5175efvboxsync/** Pointer to a const disassembler CPU state. */
16a9adc14900ca18e6909679a579f6833425e030vboxsync/** Opcode. */
5341459ca931b65de60b5af2a4cba6836b6b45cavboxsynctypedef struct _OPCODE
ce03ea57fdcf3d48523b1de5b894feb75e1b34davboxsync * Disassembles a code block.
7766bf675357fd940d8c49e69a5d72dc6eaa6be4vboxsync * @returns VBox error code
9496f2d398b49813176939d7a339ae513d5175efvboxsync * @param pCpu Pointer to cpu structure which have DISCPUSTATE::mode
9496f2d398b49813176939d7a339ae513d5175efvboxsync * set correctly.
5341459ca931b65de60b5af2a4cba6836b6b45cavboxsync * @param pvCodeBlock Pointer to the strunction to disassemble.
a9f41cb889f53e8407561a6155052c441eb0fc5fvboxsync * @param cbMax Maximum number of bytes to disassemble.
5341459ca931b65de60b5af2a4cba6836b6b45cavboxsync * @param pcbSize Where to store the size of the instruction.
5341459ca931b65de60b5af2a4cba6836b6b45cavboxsync * NULL is allowed.
5341459ca931b65de60b5af2a4cba6836b6b45cavboxsync * @todo Define output callback.
9496f2d398b49813176939d7a339ae513d5175efvboxsync * @todo Using signed integers as sizes is a bit odd. There are still
c7551981eb6d97331da479f68f14a9c56247e4f7vboxsync * some GCC warnings about mixing signed and unsigend integers.
c7551981eb6d97331da479f68f14a9c56247e4f7vboxsync * @todo Need to extend this interface to include a code address so we
c7551981eb6d97331da479f68f14a9c56247e4f7vboxsync * can dissassemble GC code. Perhaps a new function is better...
c7551981eb6d97331da479f68f14a9c56247e4f7vboxsync * @remark cbMax isn't respected as a boundry. DISInstr() will read beyond cbMax.
c7551981eb6d97331da479f68f14a9c56247e4f7vboxsync * This means *pcbSize >= cbMax sometimes.
5341459ca931b65de60b5af2a4cba6836b6b45cavboxsyncDISDECL(int) DISBlock(PDISCPUSTATE pCpu, RTUINTPTR pvCodeBlock, unsigned cbMax, unsigned *pSize);
a9f41cb889f53e8407561a6155052c441eb0fc5fvboxsync * Disassembles one instruction
5341459ca931b65de60b5af2a4cba6836b6b45cavboxsync * @returns VBox error code
5341459ca931b65de60b5af2a4cba6836b6b45cavboxsync * @param pCpu Pointer to cpu structure which have DISCPUSTATE::mode
16a9adc14900ca18e6909679a579f6833425e030vboxsync * set correctly.
5341459ca931b65de60b5af2a4cba6836b6b45cavboxsync * @param pu8Instruction Pointer to the instrunction to disassemble.
9496f2d398b49813176939d7a339ae513d5175efvboxsync * @param u32EipOffset Offset to add to instruction address to get the real virtual address
c7551981eb6d97331da479f68f14a9c56247e4f7vboxsync * @param pcbSize Where to store the size of the instruction.
c7551981eb6d97331da479f68f14a9c56247e4f7vboxsync * NULL is allowed.
c7551981eb6d97331da479f68f14a9c56247e4f7vboxsync * @param pszOutput Storage for disassembled instruction
c7551981eb6d97331da479f68f14a9c56247e4f7vboxsync * @todo Define output callback.
5341459ca931b65de60b5af2a4cba6836b6b45cavboxsyncDISDECL(int) DISInstr(PDISCPUSTATE pCpu, RTUINTPTR pu8Instruction, unsigned u32EipOffset, unsigned *pcbSize, char *pszOutput);
5341459ca931b65de60b5af2a4cba6836b6b45cavboxsync * Disassembles one instruction
16a9adc14900ca18e6909679a579f6833425e030vboxsync * @returns VBox error code
5341459ca931b65de60b5af2a4cba6836b6b45cavboxsync * @param pCpu Pointer to cpu structure which have DISCPUSTATE::mode
9496f2d398b49813176939d7a339ae513d5175efvboxsync * set correctly.
c7551981eb6d97331da479f68f14a9c56247e4f7vboxsync * @param pu8Instruction Pointer to the strunction to disassemble.
c7551981eb6d97331da479f68f14a9c56247e4f7vboxsync * @param u32EipOffset Offset to add to instruction address to get the real virtual address
c7551981eb6d97331da479f68f14a9c56247e4f7vboxsync * @param pcbSize Where to store the size of the instruction.
c7551981eb6d97331da479f68f14a9c56247e4f7vboxsync * NULL is allowed.
c7551981eb6d97331da479f68f14a9c56247e4f7vboxsync * @param pszOutput Storage for disassembled instruction
c7551981eb6d97331da479f68f14a9c56247e4f7vboxsync * @param uFilter Instruction type filter
9496f2d398b49813176939d7a339ae513d5175efvboxsync * @todo Define output callback.
369a8817da53dbd5ea6ac360ca0376dba003cde4vboxsyncDISDECL(int) DISInstrEx(PDISCPUSTATE pCpu, RTUINTPTR pu8Instruction, uint32_t u32EipOffset, uint32_t *pcbSize,
369a8817da53dbd5ea6ac360ca0376dba003cde4vboxsync * Parses one instruction.
369a8817da53dbd5ea6ac360ca0376dba003cde4vboxsync * The result is found in pCpu.
369a8817da53dbd5ea6ac360ca0376dba003cde4vboxsync * @returns VBox error code
369a8817da53dbd5ea6ac360ca0376dba003cde4vboxsync * @param pCpu Pointer to cpu structure which has DISCPUSTATE::mode set correctly.
369a8817da53dbd5ea6ac360ca0376dba003cde4vboxsync * @param InstructionAddr Pointer to the instruction to parse.
369a8817da53dbd5ea6ac360ca0376dba003cde4vboxsync * @param pcbInstruction Where to store the size of the instruction.
369a8817da53dbd5ea6ac360ca0376dba003cde4vboxsync * NULL is allowed.
369a8817da53dbd5ea6ac360ca0376dba003cde4vboxsyncDISDECL(int) DISCoreOne(PDISCPUSTATE pCpu, RTUINTPTR InstructionAddr, unsigned *pcbInstruction);
369a8817da53dbd5ea6ac360ca0376dba003cde4vboxsync * Parses one guest instruction.
369a8817da53dbd5ea6ac360ca0376dba003cde4vboxsync * The result is found in pCpu and pcbInstruction.
59d7f5939d42ad9d344fbad8401e00a900db92c5vboxsync * @returns VBox status code.
59d7f5939d42ad9d344fbad8401e00a900db92c5vboxsync * @param InstructionAddr Address of the instruction to decode. What this means
5341459ca931b65de60b5af2a4cba6836b6b45cavboxsync * is left to the pfnReadBytes function.
16a9adc14900ca18e6909679a579f6833425e030vboxsync * @param enmCpuMode The CPU mode. CPUMODE_32BIT, CPUMODE_16BIT, or CPUMODE_64BIT.
16a9adc14900ca18e6909679a579f6833425e030vboxsync * @param pfnReadBytes Callback for reading instruction bytes.
16a9adc14900ca18e6909679a579f6833425e030vboxsync * @param pvUser User argument for the instruction reader. (Ends up in apvUserData[0].)
16a9adc14900ca18e6909679a579f6833425e030vboxsync * @param pCpu Pointer to cpu structure. Will be initialized.
16a9adc14900ca18e6909679a579f6833425e030vboxsync * @param pcbInstruction Where to store the size of the instruction.
16a9adc14900ca18e6909679a579f6833425e030vboxsync * NULL is allowed.
16a9adc14900ca18e6909679a579f6833425e030vboxsyncDISDECL(int) DISCoreOneEx(RTUINTPTR InstructionAddr, DISCPUMODE enmCpuMode, PFN_DIS_READBYTES pfnReadBytes, void *pvUser,
16a9adc14900ca18e6909679a579f6833425e030vboxsyncDISDECL(int) DISGetParamSize(PDISCPUSTATE pCpu, POP_PARAMETER pParam);
16a9adc14900ca18e6909679a579f6833425e030vboxsyncDISDECL(DIS_SELREG) DISDetectSegReg(PDISCPUSTATE pCpu, POP_PARAMETER pParam);
16a9adc14900ca18e6909679a579f6833425e030vboxsyncDISDECL(uint8_t) DISQuerySegPrefixByte(PDISCPUSTATE pCpu);
16a9adc14900ca18e6909679a579f6833425e030vboxsync * Returns the value of the parameter in pParam
16a9adc14900ca18e6909679a579f6833425e030vboxsync * @returns VBox error code
16a9adc14900ca18e6909679a579f6833425e030vboxsync * @param pCtx Exception structure pointer
16a9adc14900ca18e6909679a579f6833425e030vboxsync * @param pCpu Pointer to cpu structure which have DISCPUSTATE::mode
16a9adc14900ca18e6909679a579f6833425e030vboxsync * set correctly.
16a9adc14900ca18e6909679a579f6833425e030vboxsync * @param pParam Pointer to the parameter to parse
16a9adc14900ca18e6909679a579f6833425e030vboxsync * @param pParamVal Pointer to parameter value (OUT)
16a9adc14900ca18e6909679a579f6833425e030vboxsync * @param parmtype Parameter type
16a9adc14900ca18e6909679a579f6833425e030vboxsync * @note Currently doesn't handle FPU/XMM/MMX/3DNow! parameters correctly!!
16a9adc14900ca18e6909679a579f6833425e030vboxsyncDISDECL(int) DISQueryParamVal(PCPUMCTXCORE pCtx, PDISCPUSTATE pCpu, POP_PARAMETER pParam, POP_PARAMVAL pParamVal, PARAM_TYPE parmtype);
16a9adc14900ca18e6909679a579f6833425e030vboxsyncDISDECL(int) DISQueryParamRegPtr(PCPUMCTXCORE pCtx, PDISCPUSTATE pCpu, POP_PARAMETER pParam, void **ppReg, size_t *pcbSize);
16a9adc14900ca18e6909679a579f6833425e030vboxsyncDISDECL(int) DISFetchReg8(PCPUMCTXCORE pCtx, unsigned reg8, uint8_t *pVal);
16a9adc14900ca18e6909679a579f6833425e030vboxsyncDISDECL(int) DISFetchReg16(PCPUMCTXCORE pCtx, unsigned reg16, uint16_t *pVal);
9c149a2789022f5011e88fb62f02a1cc8068e88fvboxsyncDISDECL(int) DISFetchReg32(PCPUMCTXCORE pCtx, unsigned reg32, uint32_t *pVal);
9c149a2789022f5011e88fb62f02a1cc8068e88fvboxsyncDISDECL(int) DISFetchReg64(PCPUMCTXCORE pCtx, unsigned reg64, uint64_t *pVal);
9c149a2789022f5011e88fb62f02a1cc8068e88fvboxsyncDISDECL(int) DISFetchRegSeg(PCPUMCTXCORE pCtx, DIS_SELREG sel, RTSEL *pVal);
9c149a2789022f5011e88fb62f02a1cc8068e88fvboxsyncDISDECL(int) DISFetchRegSegEx(PCPUMCTXCORE pCtx, DIS_SELREG sel, RTSEL *pVal, PCPUMSELREGHID *ppSelHidReg);
975ad9d9bc9c4dc96b41d9f67a65228b1b338e2avboxsyncDISDECL(int) DISWriteReg8(PCPUMCTXCORE pRegFrame, unsigned reg8, uint8_t val8);
9c149a2789022f5011e88fb62f02a1cc8068e88fvboxsyncDISDECL(int) DISWriteReg16(PCPUMCTXCORE pRegFrame, unsigned reg32, uint16_t val16);
975ad9d9bc9c4dc96b41d9f67a65228b1b338e2avboxsyncDISDECL(int) DISWriteReg32(PCPUMCTXCORE pRegFrame, unsigned reg32, uint32_t val32);
9c149a2789022f5011e88fb62f02a1cc8068e88fvboxsyncDISDECL(int) DISWriteReg64(PCPUMCTXCORE pRegFrame, unsigned reg64, uint64_t val64);
9c149a2789022f5011e88fb62f02a1cc8068e88fvboxsyncDISDECL(int) DISWriteRegSeg(PCPUMCTXCORE pCtx, DIS_SELREG sel, RTSEL val);
975ad9d9bc9c4dc96b41d9f67a65228b1b338e2avboxsyncDISDECL(int) DISPtrReg8(PCPUMCTXCORE pCtx, unsigned reg8, uint8_t **ppReg);
9c149a2789022f5011e88fb62f02a1cc8068e88fvboxsyncDISDECL(int) DISPtrReg16(PCPUMCTXCORE pCtx, unsigned reg16, uint16_t **ppReg);
975ad9d9bc9c4dc96b41d9f67a65228b1b338e2avboxsyncDISDECL(int) DISPtrReg32(PCPUMCTXCORE pCtx, unsigned reg32, uint32_t **ppReg);
9c149a2789022f5011e88fb62f02a1cc8068e88fvboxsyncDISDECL(int) DISPtrReg64(PCPUMCTXCORE pCtx, unsigned reg64, uint64_t **ppReg);
975ad9d9bc9c4dc96b41d9f67a65228b1b338e2avboxsync * Try resolve an address into a symbol name.
9c149a2789022f5011e88fb62f02a1cc8068e88fvboxsync * For use with DISFormatYasmEx(), DISFormatMasmEx() and DISFormatGasEx().
efff36b306e370346025647a158689021df2e1d1vboxsync * @returns VBox status code.
51fe8789a74f6c118894aaa12eb69ec155386dbdvboxsync * @retval VINF_SUCCESS on success, pszBuf contains the full symbol name.
51fe8789a74f6c118894aaa12eb69ec155386dbdvboxsync * @retval VINF_BUFFER_OVERFLOW if pszBuf is too small the symbol name. The
51fe8789a74f6c118894aaa12eb69ec155386dbdvboxsync * content of pszBuf is truncated and zero terminated.
51fe8789a74f6c118894aaa12eb69ec155386dbdvboxsync * @retval VERR_SYMBOL_NOT_FOUND if no matching symbol was found for the address.
8dbf70ba2345e69b0b6d45c38cf1add0ef10591cvboxsync * @param pCpu Pointer to the disassembler CPU state.
8dbf70ba2345e69b0b6d45c38cf1add0ef10591cvboxsync * @param u32Sel The selector value. Use DIS_FMT_SEL_IS_REG, DIS_FMT_SEL_GET_VALUE,
8dbf70ba2345e69b0b6d45c38cf1add0ef10591cvboxsync * DIS_FMT_SEL_GET_REG to access this.
8dbf70ba2345e69b0b6d45c38cf1add0ef10591cvboxsync * @param uAddress The segment address.
8dbf70ba2345e69b0b6d45c38cf1add0ef10591cvboxsync * @param pszBuf Where to store the symbol name
cc15c3fa4bb2d3fb91e4d0cd15a73133963f86b0vboxsync * @param cchBuf The size of the buffer.
cc15c3fa4bb2d3fb91e4d0cd15a73133963f86b0vboxsync * @param poff If not a perfect match, then this is where the offset from the return
cc15c3fa4bb2d3fb91e4d0cd15a73133963f86b0vboxsync * symbol to the specified address is returned.
cc15c3fa4bb2d3fb91e4d0cd15a73133963f86b0vboxsync * @param pvUser The user argument.
cc15c3fa4bb2d3fb91e4d0cd15a73133963f86b0vboxsynctypedef DECLCALLBACK(int) FNDISGETSYMBOL(PCDISCPUSTATE pCpu, uint32_t u32Sel, RTUINTPTR uAddress, char *pszBuf, size_t cchBuf, RTINTPTR *poff, void *pvUser);
cc15c3fa4bb2d3fb91e4d0cd15a73133963f86b0vboxsync/** Pointer to a FNDISGETSYMBOL(). */
cc15c3fa4bb2d3fb91e4d0cd15a73133963f86b0vboxsync * Checks if the FNDISGETSYMBOL argument u32Sel is a register or not.
cc15c3fa4bb2d3fb91e4d0cd15a73133963f86b0vboxsync#define DIS_FMT_SEL_IS_REG(u32Sel) ( !!((u32Sel) & RT_BIT(31)) )
cc15c3fa4bb2d3fb91e4d0cd15a73133963f86b0vboxsync * Extracts the selector value from the FNDISGETSYMBOL argument u32Sel.
cc15c3fa4bb2d3fb91e4d0cd15a73133963f86b0vboxsync * @returns Selector value.
cc15c3fa4bb2d3fb91e4d0cd15a73133963f86b0vboxsync#define DIS_FMT_SEL_GET_VALUE(u32Sel) ( (RTSEL)(u32Sel) )
cc15c3fa4bb2d3fb91e4d0cd15a73133963f86b0vboxsync * Extracts the register number from the FNDISGETSYMBOL argument u32Sel.
cc15c3fa4bb2d3fb91e4d0cd15a73133963f86b0vboxsync * @returns USE_REG_CS, USE_REG_SS, USE_REG_DS, USE_REG_ES, USE_REG_FS or USE_REG_FS.
cc15c3fa4bb2d3fb91e4d0cd15a73133963f86b0vboxsync#define DIS_FMT_SEL_GET_REG(u32Sel) ( ((u32Sel) >> 16) & 0xf )
cc15c3fa4bb2d3fb91e4d0cd15a73133963f86b0vboxsync/** @internal */
cc15c3fa4bb2d3fb91e4d0cd15a73133963f86b0vboxsync#define DIS_FMT_SEL_FROM_REG(uReg) ( ((uReg) << 16) | RT_BIT(31) | 0xffff )
cc15c3fa4bb2d3fb91e4d0cd15a73133963f86b0vboxsync/** @internal */
cc15c3fa4bb2d3fb91e4d0cd15a73133963f86b0vboxsync#define DIS_FMT_SEL_FROM_VALUE(Sel) ( (Sel) & 0xffff )
cc15c3fa4bb2d3fb91e4d0cd15a73133963f86b0vboxsync/** @name Flags for use with DISFormatYasmEx(), DISFormatMasmEx() and DISFormatGasEx().
cc15c3fa4bb2d3fb91e4d0cd15a73133963f86b0vboxsync/** Put the address to the right. */
cc15c3fa4bb2d3fb91e4d0cd15a73133963f86b0vboxsync/** Put the address to the left. */
51fe8789a74f6c118894aaa12eb69ec155386dbdvboxsync/** Put the address in comments.
cc15c3fa4bb2d3fb91e4d0cd15a73133963f86b0vboxsync * For some assemblers this implies placing it to the right. */
51fe8789a74f6c118894aaa12eb69ec155386dbdvboxsync/** Put the instruction bytes to the right of the disassembly. */
cc15c3fa4bb2d3fb91e4d0cd15a73133963f86b0vboxsync/** Put the instruction bytes to the left of the disassembly. */
51fe8789a74f6c118894aaa12eb69ec155386dbdvboxsync/** Put the instruction bytes in comments.
51fe8789a74f6c118894aaa12eb69ec155386dbdvboxsync * For some assemblers this implies placing the bytes to the right. */
51fe8789a74f6c118894aaa12eb69ec155386dbdvboxsync/** Put the bytes in square brackets. */
51fe8789a74f6c118894aaa12eb69ec155386dbdvboxsync/** Put spaces between the bytes. */
51fe8789a74f6c118894aaa12eb69ec155386dbdvboxsync/** Display the relative +/- offset of branch instructions that uses relative addresses,
51fe8789a74f6c118894aaa12eb69ec155386dbdvboxsync * and put the target address in parenthesis. */
51fe8789a74f6c118894aaa12eb69ec155386dbdvboxsync/** Strict assembly. The assembly should, when ever possible, make the
51fe8789a74f6c118894aaa12eb69ec155386dbdvboxsync * assembler reproduce the exact same binary. (Refers to the yasm
51fe8789a74f6c118894aaa12eb69ec155386dbdvboxsync * strict keyword.) */
cc15c3fa4bb2d3fb91e4d0cd15a73133963f86b0vboxsync/** Checks if the given flags are a valid combination. */
51fe8789a74f6c118894aaa12eb69ec155386dbdvboxsync && ((fFlags) & (DIS_FMT_FLAGS_ADDR_RIGHT | DIS_FMT_FLAGS_ADDR_LEFT)) != (DIS_FMT_FLAGS_ADDR_RIGHT | DIS_FMT_FLAGS_ADDR_LEFT) \
51fe8789a74f6c118894aaa12eb69ec155386dbdvboxsync || (fFlags & (DIS_FMT_FLAGS_ADDR_RIGHT | DIS_FMT_FLAGS_ADDR_LEFT)) ) \
51fe8789a74f6c118894aaa12eb69ec155386dbdvboxsync && ((fFlags) & (DIS_FMT_FLAGS_BYTES_RIGHT | DIS_FMT_FLAGS_BYTES_LEFT)) != (DIS_FMT_FLAGS_BYTES_RIGHT | DIS_FMT_FLAGS_BYTES_LEFT) \
cc15c3fa4bb2d3fb91e4d0cd15a73133963f86b0vboxsync && ( !((fFlags) & (DIS_FMT_FLAGS_BYTES_COMMENT | DIS_FMT_FLAGS_BYTES_BRACKETS)) \
51fe8789a74f6c118894aaa12eb69ec155386dbdvboxsync || (fFlags & (DIS_FMT_FLAGS_BYTES_RIGHT | DIS_FMT_FLAGS_BYTES_LEFT)) ) \
51fe8789a74f6c118894aaa12eb69ec155386dbdvboxsyncDISDECL(size_t) DISFormatYasm( PCDISCPUSTATE pCpu, char *pszBuf, size_t cchBuf);
cc15c3fa4bb2d3fb91e4d0cd15a73133963f86b0vboxsyncDISDECL(size_t) DISFormatYasmEx(PCDISCPUSTATE pCpu, char *pszBuf, size_t cchBuf, uint32_t fFlags, PFNDISGETSYMBOL pfnGetSymbol, void *pvUser);
51fe8789a74f6c118894aaa12eb69ec155386dbdvboxsyncDISDECL(size_t) DISFormatMasm( PCDISCPUSTATE pCpu, char *pszBuf, size_t cchBuf);
51fe8789a74f6c118894aaa12eb69ec155386dbdvboxsyncDISDECL(size_t) DISFormatMasmEx(PCDISCPUSTATE pCpu, char *pszBuf, size_t cchBuf, uint32_t fFlags, PFNDISGETSYMBOL pfnGetSymbol, void *pvUser);
51fe8789a74f6c118894aaa12eb69ec155386dbdvboxsyncDISDECL(size_t) DISFormatGas( PCDISCPUSTATE pCpu, char *pszBuf, size_t cchBuf);
51fe8789a74f6c118894aaa12eb69ec155386dbdvboxsyncDISDECL(size_t) DISFormatGasEx( PCDISCPUSTATE pCpu, char *pszBuf, size_t cchBuf, uint32_t fFlags, PFNDISGETSYMBOL pfnGetSymbol, void *pvUser);
51fe8789a74f6c118894aaa12eb69ec155386dbdvboxsync/** @todo DISAnnotate(PCDISCPUSTATE pCpu, char *pszBuf, size_t cchBuf, register reader, memory reader); */