util/x86emu/x86emu/debug.h

   1 /****************************************************************************
   2 *
   3 *                                               Realmode X86 Emulator Library
   4 *
   5 *               Copyright (C) 1996-1999 SciTech Software, Inc.
   6 *                                    Copyright (C) David Mosberger-Tang
   7 *                                          Copyright (C) 1999 Egbert Eich
   8 *
   9 *  ========================================================================
  10 *
  11 *  Permission to use, copy, modify, distribute, and sell this software and
  12 *  its documentation for any purpose is hereby granted without fee,
  13 *  provided that the above copyright notice appear in all copies and that
  14 *  both that copyright notice and this permission notice appear in
  15 *  supporting documentation, and that the name of the authors not be used
  16 *  in advertising or publicity pertaining to distribution of the software
  17 *  without specific, written prior permission.  The authors makes no
  18 *  representations about the suitability of this software for any purpose.
  19 *  It is provided "as is" without express or implied warranty.
  20 *
  21 *  THE AUTHORS DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
  22 *  INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
  23 *  EVENT SHALL THE AUTHORS BE LIABLE FOR ANY SPECIAL, INDIRECT OR
  24 *  CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF
  25 *  USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
  26 *  OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
  27 *  PERFORMANCE OF THIS SOFTWARE.
  28 *
  29 *  ========================================================================
  30 *
  31 * Language:             ANSI C
  32 * Environment:  Any
  33 * Developer:    Kendall Bennett
  34 *
  35 * Description:  Header file for debug definitions.
  36 *
  37 ****************************************************************************/
  38 /* $XFree86: xc/extras/x86emu/src/x86emu/x86emu/debug.h,v 1.4 2000/11/21 23:10:27 tsi Exp $ */
  39
  40 #ifndef __X86EMU_DEBUG_H
  41 #define __X86EMU_DEBUG_H
  42
  43 /*---------------------- Macros and type definitions ----------------------*/
  44
  45 /* printf is not available in coreboot... use printk */
  46 #define printf(x...) printk(BIOS_DEBUG, x)
  47
  48 /* checks to be enabled for "runtime" */
  49
  50 #define CHECK_IP_FETCH_F                0x1
  51 #define CHECK_SP_ACCESS_F               0x2
  52 #define CHECK_MEM_ACCESS_F              0x4 /*using regular linear pointer */
  53 #define CHECK_DATA_ACCESS_F             0x8 /*using segment:offset*/
  54
  55 #ifdef DEBUG
  56 # define CHECK_IP_FETCH()               (M.x86.check & CHECK_IP_FETCH_F)
  57 # define CHECK_SP_ACCESS()              (M.x86.check & CHECK_SP_ACCESS_F)
  58 # define CHECK_MEM_ACCESS()             (M.x86.check & CHECK_MEM_ACCESS_F)
  59 # define CHECK_DATA_ACCESS()            (M.x86.check & CHECK_DATA_ACCESS_F)
  60 #else
  61 # define CHECK_IP_FETCH()
  62 # define CHECK_SP_ACCESS()
  63 # define CHECK_MEM_ACCESS()
  64 # define CHECK_DATA_ACCESS()
  65 #endif
  66
  67 #ifdef DEBUG
  68 # define DEBUG_INSTRUMENT()     (M.x86.debug & DEBUG_INSTRUMENT_F)
  69 # define DEBUG_DECODE()         (M.x86.debug & DEBUG_DECODE_F)
  70 # define DEBUG_TRACE()          (M.x86.debug & DEBUG_TRACE_F)
  71 # define DEBUG_STEP()           (M.x86.debug & DEBUG_STEP_F)
  72 # define DEBUG_DISASSEMBLE()    (M.x86.debug & DEBUG_DISASSEMBLE_F)
  73 # define DEBUG_BREAK()          (M.x86.debug & DEBUG_BREAK_F)
  74 # define DEBUG_SVC()            (M.x86.debug & DEBUG_SVC_F)
  75 # define DEBUG_SAVE_IP_CS()     (M.x86.debug & DEBUG_SAVE_IP_CS_F)
  76
  77 # define DEBUG_FS()             (M.x86.debug & DEBUG_FS_F)
  78 # define DEBUG_PROC()           (M.x86.debug & DEBUG_PROC_F)
  79 # define DEBUG_SYSINT()         (M.x86.debug & DEBUG_SYSINT_F)
  80 # define DEBUG_TRACECALL()      (M.x86.debug & DEBUG_TRACECALL_F)
  81 # define DEBUG_TRACECALLREGS()  (M.x86.debug & DEBUG_TRACECALL_REGS_F)
  82 # define DEBUG_TRACEJMP()       (M.x86.debug & DEBUG_TRACEJMP_F)
  83 # define DEBUG_TRACEJMPREGS()   (M.x86.debug & DEBUG_TRACEJMP_REGS_F)
  84 # define DEBUG_SYS()            (M.x86.debug & DEBUG_SYS_F)
  85 # define DEBUG_MEM_TRACE()      (M.x86.debug & DEBUG_MEM_TRACE_F)
  86 # define DEBUG_IO_TRACE()       (M.x86.debug & DEBUG_IO_TRACE_F)
  87 # define DEBUG_DECODE_NOPRINT() (M.x86.debug & DEBUG_DECODE_NOPRINT_F)
  88 #else
  89 # define DEBUG_INSTRUMENT()     0
  90 # define DEBUG_DECODE()         0
  91 # define DEBUG_TRACE()          0
  92 # define DEBUG_STEP()           0
  93 # define DEBUG_DISASSEMBLE()    0
  94 # define DEBUG_BREAK()          0
  95 # define DEBUG_SVC()            0
  96 # define DEBUG_SAVE_IP_CS()     0
  97 # define DEBUG_FS()             0
  98 # define DEBUG_PROC()           0
  99 # define DEBUG_SYSINT()         0
 100 # define DEBUG_TRACECALL()      0
 101 # define DEBUG_TRACECALLREGS()  0
 102 # define DEBUG_TRACEJMP()       0
 103 # define DEBUG_TRACEJMPREGS()   0
 104 # define DEBUG_SYS()            0
 105 # define DEBUG_MEM_TRACE()      0
 106 # define DEBUG_IO_TRACE()       0
 107 # define DEBUG_DECODE_NOPRINT() 0
 108 #endif
 109
 110 #ifdef DEBUG
 111
 112 # define DECODE_PRINTF(x)       if (DEBUG_DECODE()) \
 113                                                                         x86emu_decode_printf(x)
 114 # define DECODE_PRINTF2(x,y)    if (DEBUG_DECODE()) \
 115                                                                         x86emu_decode_printf2(x,y)
 116
 117 /*
 118  * The following allow us to look at the bytes of an instruction.  The
 119  * first INCR_INSTRN_LEN, is called everytime bytes are consumed in
 120  * the decoding process.  The SAVE_IP_CS is called initially when the
 121  * major opcode of the instruction is accessed.
 122  */
 123 #define INC_DECODED_INST_LEN(x)                         \
 124         if (DEBUG_DECODE())                             \
 125                 x86emu_inc_decoded_inst_len(x)
 126
 127 #define SAVE_IP_CS(x,y)                                                 \
 128         if (DEBUG_DECODE() | DEBUG_TRACECALL() | DEBUG_BREAK() \
 129               | DEBUG_IO_TRACE() | DEBUG_SAVE_IP_CS()) { \
 130                 M.x86.saved_cs = x;                                             \
 131                 M.x86.saved_ip = y;                                             \
 132         }
 133 #else
 134 # define INC_DECODED_INST_LEN(x)
 135 # define DECODE_PRINTF(x)
 136 # define DECODE_PRINTF2(x,y)
 137 # define SAVE_IP_CS(x,y)
 138 #endif
 139
 140 #ifdef DEBUG
 141 #define TRACE_REGS()                                            \
 142         if (DEBUG_DISASSEMBLE()) {                                      \
 143                 x86emu_just_disassemble();                              \
 144                 goto EndOfTheInstructionProcedure;                      \
 145         }                                                       \
 146         if (DEBUG_TRACE() || DEBUG_DECODE()) X86EMU_trace_regs()
 147 #else
 148 # define TRACE_REGS()
 149 #endif
 150
 151 #ifdef DEBUG
 152 # define SINGLE_STEP()          if (DEBUG_STEP()) x86emu_single_step()
 153 #else
 154 # define SINGLE_STEP()
 155 #endif
 156
 157 #define TRACE_AND_STEP()        \
 158         TRACE_REGS();                   \
 159         SINGLE_STEP()
 160
 161 #ifdef DEBUG
 162 # define START_OF_INSTR()
 163 # define END_OF_INSTR()         EndOfTheInstructionProcedure: x86emu_end_instr();
 164 # define END_OF_INSTR_NO_TRACE()        x86emu_end_instr();
 165 #else
 166 # define START_OF_INSTR()
 167 # define END_OF_INSTR()
 168 # define END_OF_INSTR_NO_TRACE()
 169 #endif
 170
 171 #ifdef DEBUG
 172 # define  CALL_TRACE(u,v,w,x,s)                                 \
 173         if (DEBUG_TRACECALLREGS())                                                                      \
 174                 x86emu_dump_regs();                                     \
 175         if (DEBUG_TRACECALL())                                          \
 176                 printf("%04x:%04x: CALL %s%04x:%04x\n", u , v, s, w, x);
 177 # define RETURN_TRACE(u,v,w,x,s)                                    \
 178         if (DEBUG_TRACECALLREGS())                                                                      \
 179                 x86emu_dump_regs();                                     \
 180         if (DEBUG_TRACECALL())                                          \
 181                 printf("%04x:%04x: RET %s %04x:%04x\n",u,v,s,w,x);
 182 # define  JMP_TRACE(u,v,w,x,s)                                 \
 183    if (DEBUG_TRACEJMPREGS()) \
 184       x86emu_dump_regs(); \
 185    if (DEBUG_TRACEJMP()) \
 186       printf("%04x:%04x: JMP %s%04x:%04x\n", u , v, s, w, x);
 187 #else
 188 # define CALL_TRACE(u,v,w,x,s)
 189 # define RETURN_TRACE(u,v,w,x,s)
 190 # define  JMP_TRACE(u,v,w,x,s)
 191 #endif
 192
 193 #ifdef DEBUG
 194 #define DB(x)   x
 195 #else
 196 #define DB(x)
 197 #endif
 198
 199 /*-------------------------- Function Prototypes --------------------------*/
 200
 201 #ifdef  __cplusplus
 202 extern "C" {                                    /* Use "C" linkage when in C++ mode */
 203 #endif
 204
 205 void x86emu_inc_decoded_inst_len (int x);
 206 void x86emu_decode_printf (const char *x);
 207 void x86emu_decode_printf2 (const char *x, int y);
 208 void x86emu_just_disassemble (void);
 209 void x86emu_single_step (void);
 210 void x86emu_end_instr (void);
 211 void x86emu_dump_regs (void);
 212 void x86emu_dump_xregs (void);
 213 void x86emu_print_int_vect (u16 iv);
 214 void x86emu_instrument_instruction (void);
 215 void x86emu_check_ip_access (void);
 216 void x86emu_check_sp_access (void);
 217 void x86emu_check_mem_access (u32 p);
 218 void x86emu_check_data_access (uint s, uint o);
 219
 220 void disassemble_forward (u16 seg, u16 off, int n);
 221
 222 #ifdef  __cplusplus
 223 }                                               /* End of "C" linkage for C++           */
 224 #endif
 225
 226 #endif /* __X86EMU_DEBUG_H */