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