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