aboutsummaryrefslogtreecommitdiffstats
path: root/util/vgabios/x86emu/src/x86emu/x86emu/debug.h
blob: 7bf62c799542b39eac4c66431ba5dc425e97689f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
/****************************************************************************
*
*                       Realmode X86 Emulator Library
*
*               Copyright (C) 1991-2004 SciTech Software, Inc.
*                    Copyright (C) David Mosberger-Tang
*                      Copyright (C) 1999 Egbert Eich
*
*  ========================================================================
*
*  Permission to use, copy, modify, distribute, and sell this software and
*  its documentation for any purpose is hereby granted without fee,
*  provided that the above copyright notice appear in all copies and that
*  both that copyright notice and this permission notice appear in
*  supporting documentation, and that the name of the authors not be used
*  in advertising or publicity pertaining to distribution of the software
*  without specific, written prior permission.  The authors makes no
*  representations about the suitability of this software for any purpose.
*  It is provided "as is" without express or implied warranty.
*
*  THE AUTHORS DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
*  INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
*  EVENT SHALL THE AUTHORS BE LIABLE FOR ANY SPECIAL, INDIRECT OR
*  CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF
*  USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
*  OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
*  PERFORMANCE OF THIS SOFTWARE.
*
*  ========================================================================
*
* Language:     ANSI C
* Environment:  Any
* Developer:    Kendall Bennett
*
* Description:  Header file for debug definitions.
*
****************************************************************************/

#ifndef __X86EMU_DEBUG_H
#define __X86EMU_DEBUG_H

/*---------------------- Macros and type definitions ----------------------*/

/* checks to be enabled for "runtime" */

#define CHECK_IP_FETCH_F                0x1
#define CHECK_SP_ACCESS_F               0x2
#define CHECK_MEM_ACCESS_F              0x4 /*using regular linear pointer */
#define CHECK_DATA_ACCESS_F             0x8 /*using segment:offset*/

#ifdef CONFIG_DEBUG
# define CHECK_IP_FETCH()               (M.x86.check & CHECK_IP_FETCH_F)
# define CHECK_SP_ACCESS()              (M.x86.check & CHECK_SP_ACCESS_F)
# define CHECK_MEM_ACCESS()             (M.x86.check & CHECK_MEM_ACCESS_F)
# define CHECK_DATA_ACCESS()            (M.x86.check & CHECK_DATA_ACCESS_F)
#else
# define CHECK_IP_FETCH()
# define CHECK_SP_ACCESS()
# define CHECK_MEM_ACCESS()
# define CHECK_DATA_ACCESS()
#endif

#ifdef CONFIG_DEBUG
# define DEBUG_INSTRUMENT()     (M.x86.debug & DEBUG_INSTRUMENT_F)
# define DEBUG_DECODE()         (M.x86.debug & DEBUG_DECODE_F)
# define DEBUG_TRACE()          (M.x86.debug & DEBUG_TRACE_F)
# define DEBUG_STEP()           (M.x86.debug & DEBUG_STEP_F)
# define DEBUG_DISASSEMBLE()    (M.x86.debug & DEBUG_DISASSEMBLE_F)
# define DEBUG_BREAK()          (M.x86.debug & DEBUG_BREAK_F)
# define DEBUG_SVC()            (M.x86.debug & DEBUG_SVC_F)
# define DEBUG_SAVE_IP_CS()     (M.x86.debug & DEBUG_SAVE_CS_IP)

# define DEBUG_FS()             (M.x86.debug & DEBUG_FS_F)
# define DEBUG_PROC()           (M.x86.debug & DEBUG_PROC_F)
# define DEBUG_SYSINT()         (M.x86.debug & DEBUG_SYSINT_F)
# define DEBUG_TRACECALL()      (M.x86.debug & DEBUG_TRACECALL_F)
# define DEBUG_TRACECALLREGS()  (M.x86.debug & DEBUG_TRACECALL_REGS_F)
# define DEBUG_SYS()            (M.x86.debug & DEBUG_SYS_F)
# define DEBUG_MEM_TRACE()      (M.x86.debug & DEBUG_MEM_TRACE_F)
# define DEBUG_IO_TRACE()       (M.x86.debug & DEBUG_IO_TRACE_F)
# define DEBUG_DECODE_NOPRINT() (M.x86.debug & DEBUG_DECODE_NOPRINT_F)
#else
# define DEBUG_INSTRUMENT()     0
# define DEBUG_DECODE()         0
# define DEBUG_TRACE()          0
# define DEBUG_STEP()           0
# define DEBUG_DISASSEMBLE()    0
# define DEBUG_BREAK()          0
# define DEBUG_SVC()            0
# define DEBUG_SAVE_IP_CS()     0
# define DEBUG_FS()             0
# define DEBUG_PROC()           0
# define DEBUG_SYSINT()         0
# define DEBUG_TRACECALL()      0
# define DEBUG_TRACECALLREGS()  0
# define DEBUG_SYS()            0
# define DEBUG_MEM_TRACE()      0
# define DEBUG_IO_TRACE()       0
# define DEBUG_DECODE_NOPRINT() 0
#endif

#ifdef CONFIG_DEBUG

# define DECODE_PRINTF(x)       if (DEBUG_DECODE()) \
                                    x86emu_decode_printf(x)
# define DECODE_PRINTF2(x,y)    if (DEBUG_DECODE()) \
                                    x86emu_decode_printf2(x,y)

/*
 * The following allow us to look at the bytes of an instruction.  The
 * first INCR_INSTRN_LEN, is called everytime bytes are consumed in
 * the decoding process.  The SAVE_IP_CS is called initially when the
 * major opcode of the instruction is accessed.
 */
#define INC_DECODED_INST_LEN(x)                     \
    if (DEBUG_DECODE())                             \
        x86emu_inc_decoded_inst_len(x)

#define SAVE_IP_CS(x,y)                                         \
    if (DEBUG_DECODE() | DEBUG_TRACECALL() | DEBUG_BREAK() \
              | DEBUG_IO_TRACE() | DEBUG_SAVE_IP_CS()) { \
        M.x86.saved_cs = x;                                     \
        M.x86.saved_ip = y;                                     \
    }
#else
# define INC_DECODED_INST_LEN(x)
# define DECODE_PRINTF(x)
# define DECODE_PRINTF2(x,y)
# define SAVE_IP_CS(x,y)
#endif

#ifdef CONFIG_DEBUG
#define TRACE_REGS()                                        \
    if (DEBUG_DISASSEMBLE()) {                              \
        x86emu_just_disassemble();                          \
        goto EndOfTheInstructionProcedure;                  \
    }                                                       \
    if (DEBUG_TRACE() || DEBUG_DECODE()) X86EMU_trace_regs()
#else
# define TRACE_REGS()
#endif

#ifdef CONFIG_DEBUG
# define SINGLE_STEP()      if (DEBUG_STEP()) x86emu_single_step()
#else
# define SINGLE_STEP()
#endif

#define TRACE_AND_STEP()    \
    TRACE_REGS();           \
    SINGLE_STEP()

#ifdef CONFIG_DEBUG
# define START_OF_INSTR()
# define END_OF_INSTR()     EndOfTheInstructionProcedure: x86emu_end_instr();
# define END_OF_INSTR_NO_TRACE()    x86emu_end_instr();
#else
# define START_OF_INSTR()
# define END_OF_INSTR()
# define END_OF_INSTR_NO_TRACE()
#endif

#ifdef CONFIG_DEBUG
# define  CALL_TRACE(u,v,w,x,s)                                 \
    if (DEBUG_TRACECALLREGS())                                  \
        x86emu_dump_regs();                                     \
    if (DEBUG_TRACECALL())                                      \
        printk("%04x:%04x: CALL %s%04x:%04x\n", u , v, s, w, x);
# define RETURN_TRACE(n,u,v)                                    \
    if (DEBUG_TRACECALLREGS())                                  \
        x86emu_dump_regs();                                     \
    if (DEBUG_TRACECALL())                                      \
        printk("%04x:%04x: %s\n",u,v,n);
#else
# define CALL_TRACE(u,v,w,x,s)
# define RETURN_TRACE(n,u,v)
#endif

#ifdef CONFIG_DEBUG
#define DB(x)   x
#else
#define DB(x)
#endif

/*-------------------------- Function Prototypes --------------------------*/

#ifdef  __cplusplus
extern "C" {                        /* Use "C" linkage when in C++ mode */
#endif

extern void x86emu_inc_decoded_inst_len (int x);
extern void x86emu_decode_printf (char *x);
extern void x86emu_decode_printf2 (char *x, int y);
extern void x86emu_just_disassemble (void);
extern void x86emu_single_step (void);
extern void x86emu_end_instr (void);
extern void x86emu_dump_regs (void);
extern void x86emu_dump_xregs (void);
extern void x86emu_print_int_vect (u16 iv);
extern void x86emu_instrument_instruction (void);
extern void x86emu_check_ip_access (void);
extern void x86emu_check_sp_access (void);
extern void x86emu_check_mem_access (u32 p);
extern void x86emu_check_data_access (uint s, uint o);

#ifdef  __cplusplus
}                                   /* End of "C" linkage for C++       */
#endif

#endif /* __X86EMU_DEBUG_H */