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