65fea56f17cd614bc8908264df980a62e1931468vboxsync/****************************************************************************
65fea56f17cd614bc8908264df980a62e1931468vboxsync*
65fea56f17cd614bc8908264df980a62e1931468vboxsync* Realmode X86 Emulator Library
65fea56f17cd614bc8908264df980a62e1931468vboxsync*
65fea56f17cd614bc8908264df980a62e1931468vboxsync* Copyright (C) 1996-1999 SciTech Software, Inc.
65fea56f17cd614bc8908264df980a62e1931468vboxsync* Copyright (C) David Mosberger-Tang
65fea56f17cd614bc8908264df980a62e1931468vboxsync* Copyright (C) 1999 Egbert Eich
65fea56f17cd614bc8908264df980a62e1931468vboxsync*
65fea56f17cd614bc8908264df980a62e1931468vboxsync* ========================================================================
65fea56f17cd614bc8908264df980a62e1931468vboxsync*
65fea56f17cd614bc8908264df980a62e1931468vboxsync* Permission to use, copy, modify, distribute, and sell this software and
65fea56f17cd614bc8908264df980a62e1931468vboxsync* its documentation for any purpose is hereby granted without fee,
65fea56f17cd614bc8908264df980a62e1931468vboxsync* provided that the above copyright notice appear in all copies and that
65fea56f17cd614bc8908264df980a62e1931468vboxsync* both that copyright notice and this permission notice appear in
65fea56f17cd614bc8908264df980a62e1931468vboxsync* supporting documentation, and that the name of the authors not be used
65fea56f17cd614bc8908264df980a62e1931468vboxsync* in advertising or publicity pertaining to distribution of the software
65fea56f17cd614bc8908264df980a62e1931468vboxsync* without specific, written prior permission. The authors makes no
65fea56f17cd614bc8908264df980a62e1931468vboxsync* representations about the suitability of this software for any purpose.
65fea56f17cd614bc8908264df980a62e1931468vboxsync* It is provided "as is" without express or implied warranty.
65fea56f17cd614bc8908264df980a62e1931468vboxsync*
65fea56f17cd614bc8908264df980a62e1931468vboxsync* THE AUTHORS DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
65fea56f17cd614bc8908264df980a62e1931468vboxsync* INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
65fea56f17cd614bc8908264df980a62e1931468vboxsync* EVENT SHALL THE AUTHORS BE LIABLE FOR ANY SPECIAL, INDIRECT OR
65fea56f17cd614bc8908264df980a62e1931468vboxsync* CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF
65fea56f17cd614bc8908264df980a62e1931468vboxsync* USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
65fea56f17cd614bc8908264df980a62e1931468vboxsync* OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
65fea56f17cd614bc8908264df980a62e1931468vboxsync* PERFORMANCE OF THIS SOFTWARE.
65fea56f17cd614bc8908264df980a62e1931468vboxsync*
65fea56f17cd614bc8908264df980a62e1931468vboxsync* ========================================================================
65fea56f17cd614bc8908264df980a62e1931468vboxsync*
65fea56f17cd614bc8908264df980a62e1931468vboxsync* Language: ANSI C
65fea56f17cd614bc8908264df980a62e1931468vboxsync* Environment: Any
65fea56f17cd614bc8908264df980a62e1931468vboxsync* Developer: Kendall Bennett
65fea56f17cd614bc8908264df980a62e1931468vboxsync*
65fea56f17cd614bc8908264df980a62e1931468vboxsync* Description: Header file for debug definitions.
65fea56f17cd614bc8908264df980a62e1931468vboxsync*
65fea56f17cd614bc8908264df980a62e1931468vboxsync****************************************************************************/
65fea56f17cd614bc8908264df980a62e1931468vboxsync
65fea56f17cd614bc8908264df980a62e1931468vboxsync#ifndef __X86EMU_DEBUG_H
65fea56f17cd614bc8908264df980a62e1931468vboxsync#define __X86EMU_DEBUG_H
65fea56f17cd614bc8908264df980a62e1931468vboxsync
65fea56f17cd614bc8908264df980a62e1931468vboxsync/*---------------------- Macros and type definitions ----------------------*/
65fea56f17cd614bc8908264df980a62e1931468vboxsync
65fea56f17cd614bc8908264df980a62e1931468vboxsync/* checks to be enabled for "runtime" */
65fea56f17cd614bc8908264df980a62e1931468vboxsync
65fea56f17cd614bc8908264df980a62e1931468vboxsync#define CHECK_IP_FETCH_F 0x1
65fea56f17cd614bc8908264df980a62e1931468vboxsync#define CHECK_SP_ACCESS_F 0x2
65fea56f17cd614bc8908264df980a62e1931468vboxsync#define CHECK_MEM_ACCESS_F 0x4 /*using regular linear pointer */
65fea56f17cd614bc8908264df980a62e1931468vboxsync#define CHECK_DATA_ACCESS_F 0x8 /*using segment:offset */
65fea56f17cd614bc8908264df980a62e1931468vboxsync
65fea56f17cd614bc8908264df980a62e1931468vboxsync#ifdef DEBUG
65fea56f17cd614bc8908264df980a62e1931468vboxsync#define CHECK_IP_FETCH() (M.x86.check & CHECK_IP_FETCH_F)
65fea56f17cd614bc8908264df980a62e1931468vboxsync#define CHECK_SP_ACCESS() (M.x86.check & CHECK_SP_ACCESS_F)
65fea56f17cd614bc8908264df980a62e1931468vboxsync#define CHECK_MEM_ACCESS() (M.x86.check & CHECK_MEM_ACCESS_F)
65fea56f17cd614bc8908264df980a62e1931468vboxsync#define CHECK_DATA_ACCESS() (M.x86.check & CHECK_DATA_ACCESS_F)
65fea56f17cd614bc8908264df980a62e1931468vboxsync#else
65fea56f17cd614bc8908264df980a62e1931468vboxsync#define CHECK_IP_FETCH()
65fea56f17cd614bc8908264df980a62e1931468vboxsync#define CHECK_SP_ACCESS()
65fea56f17cd614bc8908264df980a62e1931468vboxsync#define CHECK_MEM_ACCESS()
65fea56f17cd614bc8908264df980a62e1931468vboxsync#define CHECK_DATA_ACCESS()
65fea56f17cd614bc8908264df980a62e1931468vboxsync#endif
65fea56f17cd614bc8908264df980a62e1931468vboxsync
65fea56f17cd614bc8908264df980a62e1931468vboxsync#ifdef DEBUG
65fea56f17cd614bc8908264df980a62e1931468vboxsync#define DEBUG_INSTRUMENT() (M.x86.debug & DEBUG_INSTRUMENT_F)
65fea56f17cd614bc8908264df980a62e1931468vboxsync#define DEBUG_DECODE() (M.x86.debug & DEBUG_DECODE_F)
65fea56f17cd614bc8908264df980a62e1931468vboxsync#define DEBUG_TRACE() (M.x86.debug & DEBUG_TRACE_F)
65fea56f17cd614bc8908264df980a62e1931468vboxsync#define DEBUG_STEP() (M.x86.debug & DEBUG_STEP_F)
65fea56f17cd614bc8908264df980a62e1931468vboxsync#define DEBUG_DISASSEMBLE() (M.x86.debug & DEBUG_DISASSEMBLE_F)
65fea56f17cd614bc8908264df980a62e1931468vboxsync#define DEBUG_BREAK() (M.x86.debug & DEBUG_BREAK_F)
65fea56f17cd614bc8908264df980a62e1931468vboxsync#define DEBUG_SVC() (M.x86.debug & DEBUG_SVC_F)
65fea56f17cd614bc8908264df980a62e1931468vboxsync#define DEBUG_SAVE_IP_CS() (M.x86.debug & DEBUG_SAVE_IP_CS_F)
65fea56f17cd614bc8908264df980a62e1931468vboxsync
65fea56f17cd614bc8908264df980a62e1931468vboxsync#define DEBUG_FS() (M.x86.debug & DEBUG_FS_F)
65fea56f17cd614bc8908264df980a62e1931468vboxsync#define DEBUG_PROC() (M.x86.debug & DEBUG_PROC_F)
65fea56f17cd614bc8908264df980a62e1931468vboxsync#define DEBUG_SYSINT() (M.x86.debug & DEBUG_SYSINT_F)
65fea56f17cd614bc8908264df980a62e1931468vboxsync#define DEBUG_TRACECALL() (M.x86.debug & DEBUG_TRACECALL_F)
65fea56f17cd614bc8908264df980a62e1931468vboxsync#define DEBUG_TRACECALLREGS() (M.x86.debug & DEBUG_TRACECALL_REGS_F)
65fea56f17cd614bc8908264df980a62e1931468vboxsync#define DEBUG_SYS() (M.x86.debug & DEBUG_SYS_F)
65fea56f17cd614bc8908264df980a62e1931468vboxsync#define DEBUG_MEM_TRACE() (M.x86.debug & DEBUG_MEM_TRACE_F)
65fea56f17cd614bc8908264df980a62e1931468vboxsync#define DEBUG_IO_TRACE() (M.x86.debug & DEBUG_IO_TRACE_F)
65fea56f17cd614bc8908264df980a62e1931468vboxsync#define DEBUG_DECODE_NOPRINT() (M.x86.debug & DEBUG_DECODE_NOPRINT_F)
65fea56f17cd614bc8908264df980a62e1931468vboxsync#else
65fea56f17cd614bc8908264df980a62e1931468vboxsync#define DEBUG_INSTRUMENT() 0
65fea56f17cd614bc8908264df980a62e1931468vboxsync#define DEBUG_DECODE() 0
65fea56f17cd614bc8908264df980a62e1931468vboxsync#define DEBUG_TRACE() 0
65fea56f17cd614bc8908264df980a62e1931468vboxsync#define DEBUG_STEP() 0
65fea56f17cd614bc8908264df980a62e1931468vboxsync#define DEBUG_DISASSEMBLE() 0
65fea56f17cd614bc8908264df980a62e1931468vboxsync#define DEBUG_BREAK() 0
65fea56f17cd614bc8908264df980a62e1931468vboxsync#define DEBUG_SVC() 0
65fea56f17cd614bc8908264df980a62e1931468vboxsync#define DEBUG_SAVE_IP_CS() 0
65fea56f17cd614bc8908264df980a62e1931468vboxsync#define DEBUG_FS() 0
65fea56f17cd614bc8908264df980a62e1931468vboxsync#define DEBUG_PROC() 0
65fea56f17cd614bc8908264df980a62e1931468vboxsync#define DEBUG_SYSINT() 0
65fea56f17cd614bc8908264df980a62e1931468vboxsync#define DEBUG_TRACECALL() 0
65fea56f17cd614bc8908264df980a62e1931468vboxsync#define DEBUG_TRACECALLREGS() 0
65fea56f17cd614bc8908264df980a62e1931468vboxsync#define DEBUG_SYS() 0
65fea56f17cd614bc8908264df980a62e1931468vboxsync#define DEBUG_MEM_TRACE() 0
65fea56f17cd614bc8908264df980a62e1931468vboxsync#define DEBUG_IO_TRACE() 0
65fea56f17cd614bc8908264df980a62e1931468vboxsync#define DEBUG_DECODE_NOPRINT() 0
65fea56f17cd614bc8908264df980a62e1931468vboxsync#endif
65fea56f17cd614bc8908264df980a62e1931468vboxsync
65fea56f17cd614bc8908264df980a62e1931468vboxsync#ifdef DEBUG
65fea56f17cd614bc8908264df980a62e1931468vboxsync
65fea56f17cd614bc8908264df980a62e1931468vboxsync#define DECODE_PRINTF(x) if (DEBUG_DECODE()) \
65fea56f17cd614bc8908264df980a62e1931468vboxsync x86emu_decode_printf(x)
65fea56f17cd614bc8908264df980a62e1931468vboxsync#define DECODE_PRINTF2(x,y) if (DEBUG_DECODE()) \
65fea56f17cd614bc8908264df980a62e1931468vboxsync x86emu_decode_printf2(x,y)
65fea56f17cd614bc8908264df980a62e1931468vboxsync
65fea56f17cd614bc8908264df980a62e1931468vboxsync/*
65fea56f17cd614bc8908264df980a62e1931468vboxsync * The following allow us to look at the bytes of an instruction. The
65fea56f17cd614bc8908264df980a62e1931468vboxsync * first INCR_INSTRN_LEN, is called everytime bytes are consumed in
65fea56f17cd614bc8908264df980a62e1931468vboxsync * the decoding process. The SAVE_IP_CS is called initially when the
65fea56f17cd614bc8908264df980a62e1931468vboxsync * major opcode of the instruction is accessed.
65fea56f17cd614bc8908264df980a62e1931468vboxsync */
65fea56f17cd614bc8908264df980a62e1931468vboxsync#define INC_DECODED_INST_LEN(x) \
65fea56f17cd614bc8908264df980a62e1931468vboxsync if (DEBUG_DECODE()) \
65fea56f17cd614bc8908264df980a62e1931468vboxsync x86emu_inc_decoded_inst_len(x)
65fea56f17cd614bc8908264df980a62e1931468vboxsync
65fea56f17cd614bc8908264df980a62e1931468vboxsync#define SAVE_IP_CS(x,y) \
65fea56f17cd614bc8908264df980a62e1931468vboxsync if (DEBUG_DECODE() | DEBUG_TRACECALL() | DEBUG_BREAK() \
65fea56f17cd614bc8908264df980a62e1931468vboxsync | DEBUG_IO_TRACE() | DEBUG_SAVE_IP_CS()) { \
65fea56f17cd614bc8908264df980a62e1931468vboxsync M.x86.saved_cs = x; \
65fea56f17cd614bc8908264df980a62e1931468vboxsync M.x86.saved_ip = y; \
65fea56f17cd614bc8908264df980a62e1931468vboxsync }
65fea56f17cd614bc8908264df980a62e1931468vboxsync#else
65fea56f17cd614bc8908264df980a62e1931468vboxsync#define INC_DECODED_INST_LEN(x)
65fea56f17cd614bc8908264df980a62e1931468vboxsync#define DECODE_PRINTF(x)
65fea56f17cd614bc8908264df980a62e1931468vboxsync#define DECODE_PRINTF2(x,y)
65fea56f17cd614bc8908264df980a62e1931468vboxsync#define SAVE_IP_CS(x,y)
65fea56f17cd614bc8908264df980a62e1931468vboxsync#endif
65fea56f17cd614bc8908264df980a62e1931468vboxsync
65fea56f17cd614bc8908264df980a62e1931468vboxsync#ifdef DEBUG
65fea56f17cd614bc8908264df980a62e1931468vboxsync#define TRACE_REGS() \
65fea56f17cd614bc8908264df980a62e1931468vboxsync if (DEBUG_DISASSEMBLE()) { \
65fea56f17cd614bc8908264df980a62e1931468vboxsync x86emu_just_disassemble(); \
65fea56f17cd614bc8908264df980a62e1931468vboxsync goto EndOfTheInstructionProcedure; \
65fea56f17cd614bc8908264df980a62e1931468vboxsync } \
65fea56f17cd614bc8908264df980a62e1931468vboxsync if (DEBUG_TRACE() || DEBUG_DECODE()) X86EMU_trace_regs()
65fea56f17cd614bc8908264df980a62e1931468vboxsync#else
65fea56f17cd614bc8908264df980a62e1931468vboxsync#define TRACE_REGS()
65fea56f17cd614bc8908264df980a62e1931468vboxsync#endif
65fea56f17cd614bc8908264df980a62e1931468vboxsync
65fea56f17cd614bc8908264df980a62e1931468vboxsync#ifdef DEBUG
65fea56f17cd614bc8908264df980a62e1931468vboxsync#define SINGLE_STEP() if (DEBUG_STEP()) x86emu_single_step()
65fea56f17cd614bc8908264df980a62e1931468vboxsync#else
65fea56f17cd614bc8908264df980a62e1931468vboxsync#define SINGLE_STEP()
65fea56f17cd614bc8908264df980a62e1931468vboxsync#endif
65fea56f17cd614bc8908264df980a62e1931468vboxsync
65fea56f17cd614bc8908264df980a62e1931468vboxsync#define TRACE_AND_STEP() \
65fea56f17cd614bc8908264df980a62e1931468vboxsync TRACE_REGS(); \
65fea56f17cd614bc8908264df980a62e1931468vboxsync SINGLE_STEP()
65fea56f17cd614bc8908264df980a62e1931468vboxsync
65fea56f17cd614bc8908264df980a62e1931468vboxsync#ifdef DEBUG
65fea56f17cd614bc8908264df980a62e1931468vboxsync#define START_OF_INSTR()
65fea56f17cd614bc8908264df980a62e1931468vboxsync#define END_OF_INSTR() EndOfTheInstructionProcedure: x86emu_end_instr();
65fea56f17cd614bc8908264df980a62e1931468vboxsync#define END_OF_INSTR_NO_TRACE() x86emu_end_instr();
65fea56f17cd614bc8908264df980a62e1931468vboxsync#else
65fea56f17cd614bc8908264df980a62e1931468vboxsync#define START_OF_INSTR()
65fea56f17cd614bc8908264df980a62e1931468vboxsync#define END_OF_INSTR()
65fea56f17cd614bc8908264df980a62e1931468vboxsync#define END_OF_INSTR_NO_TRACE()
65fea56f17cd614bc8908264df980a62e1931468vboxsync#endif
65fea56f17cd614bc8908264df980a62e1931468vboxsync
65fea56f17cd614bc8908264df980a62e1931468vboxsync#ifdef DEBUG
65fea56f17cd614bc8908264df980a62e1931468vboxsync#define CALL_TRACE(u,v,w,x,s) \
65fea56f17cd614bc8908264df980a62e1931468vboxsync if (DEBUG_TRACECALLREGS()) \
65fea56f17cd614bc8908264df980a62e1931468vboxsync x86emu_dump_regs(); \
65fea56f17cd614bc8908264df980a62e1931468vboxsync if (DEBUG_TRACECALL()) \
65fea56f17cd614bc8908264df980a62e1931468vboxsync printk("%04x:%04x: CALL %s%04x:%04x\n", u , v, s, w, x);
65fea56f17cd614bc8908264df980a62e1931468vboxsync#define RETURN_TRACE(n,u,v) \
65fea56f17cd614bc8908264df980a62e1931468vboxsync if (DEBUG_TRACECALLREGS()) \
65fea56f17cd614bc8908264df980a62e1931468vboxsync x86emu_dump_regs(); \
65fea56f17cd614bc8908264df980a62e1931468vboxsync if (DEBUG_TRACECALL()) \
65fea56f17cd614bc8908264df980a62e1931468vboxsync printk("%04x:%04x: %s\n",u,v,n);
65fea56f17cd614bc8908264df980a62e1931468vboxsync#else
65fea56f17cd614bc8908264df980a62e1931468vboxsync#define CALL_TRACE(u,v,w,x,s)
65fea56f17cd614bc8908264df980a62e1931468vboxsync#define RETURN_TRACE(n,u,v)
65fea56f17cd614bc8908264df980a62e1931468vboxsync#endif
65fea56f17cd614bc8908264df980a62e1931468vboxsync
65fea56f17cd614bc8908264df980a62e1931468vboxsync#ifdef DEBUG
65fea56f17cd614bc8908264df980a62e1931468vboxsync#define DB(x) x
65fea56f17cd614bc8908264df980a62e1931468vboxsync#else
65fea56f17cd614bc8908264df980a62e1931468vboxsync#define DB(x)
65fea56f17cd614bc8908264df980a62e1931468vboxsync#endif
65fea56f17cd614bc8908264df980a62e1931468vboxsync
65fea56f17cd614bc8908264df980a62e1931468vboxsync/*-------------------------- Function Prototypes --------------------------*/
65fea56f17cd614bc8908264df980a62e1931468vboxsync
65fea56f17cd614bc8908264df980a62e1931468vboxsync#ifdef __cplusplus
65fea56f17cd614bc8908264df980a62e1931468vboxsyncextern "C" { /* Use "C" linkage when in C++ mode */
65fea56f17cd614bc8908264df980a62e1931468vboxsync#endif
65fea56f17cd614bc8908264df980a62e1931468vboxsync
65fea56f17cd614bc8908264df980a62e1931468vboxsync extern void x86emu_inc_decoded_inst_len(int x);
65fea56f17cd614bc8908264df980a62e1931468vboxsync extern void x86emu_decode_printf(const char *x);
65fea56f17cd614bc8908264df980a62e1931468vboxsync extern void x86emu_decode_printf2(const char *x, int y);
65fea56f17cd614bc8908264df980a62e1931468vboxsync extern void x86emu_just_disassemble(void);
65fea56f17cd614bc8908264df980a62e1931468vboxsync extern void x86emu_single_step(void);
65fea56f17cd614bc8908264df980a62e1931468vboxsync extern void x86emu_end_instr(void);
65fea56f17cd614bc8908264df980a62e1931468vboxsync extern void x86emu_dump_regs(void);
65fea56f17cd614bc8908264df980a62e1931468vboxsync extern void x86emu_dump_xregs(void);
65fea56f17cd614bc8908264df980a62e1931468vboxsync extern void x86emu_print_int_vect(u16 iv);
65fea56f17cd614bc8908264df980a62e1931468vboxsync extern void x86emu_instrument_instruction(void);
65fea56f17cd614bc8908264df980a62e1931468vboxsync extern void x86emu_check_ip_access(void);
65fea56f17cd614bc8908264df980a62e1931468vboxsync extern void x86emu_check_sp_access(void);
65fea56f17cd614bc8908264df980a62e1931468vboxsync extern void x86emu_check_mem_access(u32 p);
65fea56f17cd614bc8908264df980a62e1931468vboxsync extern void x86emu_check_data_access(uint s, uint o);
65fea56f17cd614bc8908264df980a62e1931468vboxsync
65fea56f17cd614bc8908264df980a62e1931468vboxsync#ifdef __cplusplus
65fea56f17cd614bc8908264df980a62e1931468vboxsync} /* End of "C" linkage for C++ */
65fea56f17cd614bc8908264df980a62e1931468vboxsync#endif
65fea56f17cd614bc8908264df980a62e1931468vboxsync#endif /* __X86EMU_DEBUG_H */