MMU support
[qemu] / cpu-i386.h
1 /*
2  * i386 virtual CPU header
3  * 
4  *  Copyright (c) 2003 Fabrice Bellard
5  *
6  * This library is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Lesser General Public
8  * License as published by the Free Software Foundation; either
9  * version 2 of the License, or (at your option) any later version.
10  *
11  * This library is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  * Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License along with this library; if not, write to the Free Software
18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
19  */
20 #ifndef CPU_I386_H
21 #define CPU_I386_H
22
23 #include "config.h"
24 #include <setjmp.h>
25
26 #define R_EAX 0
27 #define R_ECX 1
28 #define R_EDX 2
29 #define R_EBX 3
30 #define R_ESP 4
31 #define R_EBP 5
32 #define R_ESI 6
33 #define R_EDI 7
34
35 #define R_AL 0
36 #define R_CL 1
37 #define R_DL 2
38 #define R_BL 3
39 #define R_AH 4
40 #define R_CH 5
41 #define R_DH 6
42 #define R_BH 7
43
44 #define R_ES 0
45 #define R_CS 1
46 #define R_SS 2
47 #define R_DS 3
48 #define R_FS 4
49 #define R_GS 5
50
51 /* segment descriptor fields */
52 #define DESC_G_MASK     (1 << 23)
53 #define DESC_B_SHIFT    22
54 #define DESC_B_MASK     (1 << DESC_B_SHIFT)
55 #define DESC_AVL_MASK   (1 << 20)
56 #define DESC_P_MASK     (1 << 15)
57 #define DESC_DPL_SHIFT  13
58 #define DESC_S_MASK     (1 << 12)
59 #define DESC_TYPE_SHIFT 8
60 #define DESC_A_MASK     (1 << 8)
61
62 #define DESC_CS_MASK    (1 << 11)
63 #define DESC_C_MASK     (1 << 10)
64 #define DESC_R_MASK     (1 << 9)
65
66 #define DESC_E_MASK     (1 << 10)
67 #define DESC_W_MASK     (1 << 9)
68
69 /* eflags masks */
70 #define CC_C    0x0001
71 #define CC_P    0x0004
72 #define CC_A    0x0010
73 #define CC_Z    0x0040
74 #define CC_S    0x0080
75 #define CC_O    0x0800
76
77 #define TF_MASK                 0x00000100
78 #define IF_MASK                 0x00000200
79 #define DF_MASK                 0x00000400
80 #define IOPL_MASK               0x00003000
81 #define NT_MASK                 0x00004000
82 #define RF_MASK                 0x00010000
83 #define VM_MASK                 0x00020000
84 #define AC_MASK                 0x00040000 
85 #define VIF_MASK                0x00080000
86 #define VIP_MASK                0x00100000
87 #define ID_MASK                 0x00200000
88
89 #define CR0_PE_MASK  (1 << 0)
90 #define CR0_TS_MASK  (1 << 3)
91 #define CR0_WP_MASK  (1 << 16)
92 #define CR0_AM_MASK  (1 << 18)
93 #define CR0_PG_MASK  (1 << 31)
94
95 #define CR4_VME_MASK  (1 << 0)
96 #define CR4_PVI_MASK  (1 << 1)
97 #define CR4_TSD_MASK  (1 << 2)
98 #define CR4_DE_MASK   (1 << 3)
99 #define CR4_PSE_MASK  (1 << 4)
100
101 #define PG_PRESENT_BIT  0
102 #define PG_RW_BIT       1
103 #define PG_USER_BIT     2
104 #define PG_PWT_BIT      3
105 #define PG_PCD_BIT      4
106 #define PG_ACCESSED_BIT 5
107 #define PG_DIRTY_BIT    6
108 #define PG_PSE_BIT      7
109 #define PG_GLOBAL_BIT   8
110
111 #define PG_PRESENT_MASK  (1 << PG_PRESENT_BIT)
112 #define PG_RW_MASK       (1 << PG_RW_BIT)
113 #define PG_USER_MASK     (1 << PG_USER_BIT)
114 #define PG_PWT_MASK      (1 << PG_PWT_BIT)
115 #define PG_PCD_MASK      (1 << PG_PCD_BIT)
116 #define PG_ACCESSED_MASK (1 << PG_ACCESSED_BIT)
117 #define PG_DIRTY_MASK    (1 << PG_DIRTY_BIT)
118 #define PG_PSE_MASK      (1 << PG_PSE_BIT)
119 #define PG_GLOBAL_MASK   (1 << PG_GLOBAL_BIT)
120
121 #define PG_ERROR_W_BIT     1
122
123 #define PG_ERROR_P_MASK    0x01
124 #define PG_ERROR_W_MASK    (1 << PG_ERROR_W_BIT)
125 #define PG_ERROR_U_MASK    0x04
126 #define PG_ERROR_RSVD_MASK 0x08
127
128 #define EXCP00_DIVZ     0
129 #define EXCP01_SSTP     1
130 #define EXCP02_NMI      2
131 #define EXCP03_INT3     3
132 #define EXCP04_INTO     4
133 #define EXCP05_BOUND    5
134 #define EXCP06_ILLOP    6
135 #define EXCP07_PREX     7
136 #define EXCP08_DBLE     8
137 #define EXCP09_XERR     9
138 #define EXCP0A_TSS      10
139 #define EXCP0B_NOSEG    11
140 #define EXCP0C_STACK    12
141 #define EXCP0D_GPF      13
142 #define EXCP0E_PAGE     14
143 #define EXCP10_COPR     16
144 #define EXCP11_ALGN     17
145 #define EXCP12_MCHK     18
146
147 #define EXCP_INTERRUPT  256 /* async interruption */
148 #define EXCP_HLT        257 /* hlt instruction reached */
149
150 enum {
151     CC_OP_DYNAMIC, /* must use dynamic code to get cc_op */
152     CC_OP_EFLAGS,  /* all cc are explicitely computed, CC_SRC = flags */
153     CC_OP_MUL, /* modify all flags, C, O = (CC_SRC != 0) */
154
155     CC_OP_ADDB, /* modify all flags, CC_DST = res, CC_SRC = src1 */
156     CC_OP_ADDW,
157     CC_OP_ADDL,
158
159     CC_OP_ADCB, /* modify all flags, CC_DST = res, CC_SRC = src1 */
160     CC_OP_ADCW,
161     CC_OP_ADCL,
162
163     CC_OP_SUBB, /* modify all flags, CC_DST = res, CC_SRC = src1 */
164     CC_OP_SUBW,
165     CC_OP_SUBL,
166
167     CC_OP_SBBB, /* modify all flags, CC_DST = res, CC_SRC = src1 */
168     CC_OP_SBBW,
169     CC_OP_SBBL,
170
171     CC_OP_LOGICB, /* modify all flags, CC_DST = res */
172     CC_OP_LOGICW,
173     CC_OP_LOGICL,
174
175     CC_OP_INCB, /* modify all flags except, CC_DST = res, CC_SRC = C */
176     CC_OP_INCW,
177     CC_OP_INCL,
178
179     CC_OP_DECB, /* modify all flags except, CC_DST = res, CC_SRC = C  */
180     CC_OP_DECW,
181     CC_OP_DECL,
182
183     CC_OP_SHLB, /* modify all flags, CC_DST = res, CC_SRC.lsb = C */
184     CC_OP_SHLW,
185     CC_OP_SHLL,
186
187     CC_OP_SARB, /* modify all flags, CC_DST = res, CC_SRC.lsb = C */
188     CC_OP_SARW,
189     CC_OP_SARL,
190
191     CC_OP_NB,
192 };
193
194 #ifdef __i386__
195 #define USE_X86LDOUBLE
196 #endif
197
198 #ifdef USE_X86LDOUBLE
199 typedef long double CPU86_LDouble;
200 #else
201 typedef double CPU86_LDouble;
202 #endif
203
204 typedef struct SegmentCache {
205     uint32_t selector;
206     uint8_t *base;
207     uint32_t limit;
208     uint32_t flags;
209 } SegmentCache;
210
211 typedef struct CPUX86State {
212     /* standard registers */
213     uint32_t regs[8];
214     uint32_t eip;
215     uint32_t eflags; /* eflags register. During CPU emulation, CC
216                         flags and DF are set to zero because they are
217                         stored elsewhere */
218
219     /* emulator internal eflags handling */
220     uint32_t cc_src;
221     uint32_t cc_dst;
222     uint32_t cc_op;
223     int32_t df; /* D flag : 1 if D = 0, -1 if D = 1 */
224
225     /* FPU state */
226     unsigned int fpstt; /* top of stack index */
227     unsigned int fpus;
228     unsigned int fpuc;
229     uint8_t fptags[8];   /* 0 = valid, 1 = empty */
230     CPU86_LDouble fpregs[8];    
231
232     /* emulator internal variables */
233     CPU86_LDouble ft0;
234     union {
235         float f;
236         double d;
237         int i32;
238         int64_t i64;
239     } fp_convert;
240     
241     /* segments */
242     SegmentCache segs[6]; /* selector values */
243     SegmentCache ldt;
244     SegmentCache tr;
245     SegmentCache gdt; /* only base and limit are used */
246     SegmentCache idt; /* only base and limit are used */
247     
248     /* exception/interrupt handling */
249     jmp_buf jmp_env;
250     int exception_index;
251     int error_code;
252     int exception_is_int;
253     int exception_next_eip;
254
255     uint32_t cr[5]; /* NOTE: cr1 is unused */
256     uint32_t dr[8]; /* debug registers */
257     int interrupt_request; /* if true, will exit from cpu_exec() ASAP */
258     /* if true, will call cpu_x86_get_pic_interrupt() ASAP to get the
259        request interrupt number */
260     int hard_interrupt_request; 
261     int user_mode_only; /* user mode only simulation */
262
263     /* user data */
264     void *opaque;
265 } CPUX86State;
266
267 #ifndef IN_OP_I386
268 void cpu_x86_outb(CPUX86State *env, int addr, int val);
269 void cpu_x86_outw(CPUX86State *env, int addr, int val);
270 void cpu_x86_outl(CPUX86State *env, int addr, int val);
271 int cpu_x86_inb(CPUX86State *env, int addr);
272 int cpu_x86_inw(CPUX86State *env, int addr);
273 int cpu_x86_inl(CPUX86State *env, int addr);
274 #endif
275
276 CPUX86State *cpu_x86_init(void);
277 int cpu_x86_exec(CPUX86State *s);
278 void cpu_x86_interrupt(CPUX86State *s);
279 void cpu_x86_close(CPUX86State *s);
280 int cpu_x86_get_pic_interrupt(CPUX86State *s);
281
282 /* needed to load some predefinied segment registers */
283 void cpu_x86_load_seg(CPUX86State *s, int seg_reg, int selector);
284
285 /* simulate fsave/frstor */
286 void cpu_x86_fsave(CPUX86State *s, uint8_t *ptr, int data32);
287 void cpu_x86_frstor(CPUX86State *s, uint8_t *ptr, int data32);
288
289 /* you can call this signal handler from your SIGBUS and SIGSEGV
290    signal handlers to inform the virtual CPU of exceptions. non zero
291    is returned if the signal was handled by the virtual CPU.  */
292 struct siginfo;
293 int cpu_x86_signal_handler(int host_signum, struct siginfo *info, 
294                            void *puc);
295
296 /* MMU defines */
297 void cpu_x86_init_mmu(CPUX86State *env);
298 extern CPUX86State *global_env;
299 extern int phys_ram_size;
300 extern int phys_ram_fd;
301 extern uint8_t *phys_ram_base;
302
303 /* used to debug */
304 #define X86_DUMP_FPU  0x0001 /* dump FPU state too */
305 #define X86_DUMP_CCOP 0x0002 /* dump qemu flag cache */
306 void cpu_x86_dump_state(CPUX86State *env, FILE *f, int flags);
307
308 #define TARGET_PAGE_BITS 12
309 #include "cpu-all.h"
310
311 #endif /* CPU_I386_H */