soft mmu support - Memory I/O API - synthetize string instructions
[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 "cpu-defs.h"
24
25 #define R_EAX 0
26 #define R_ECX 1
27 #define R_EDX 2
28 #define R_EBX 3
29 #define R_ESP 4
30 #define R_EBP 5
31 #define R_ESI 6
32 #define R_EDI 7
33
34 #define R_AL 0
35 #define R_CL 1
36 #define R_DL 2
37 #define R_BL 3
38 #define R_AH 4
39 #define R_CH 5
40 #define R_DH 6
41 #define R_BH 7
42
43 #define R_ES 0
44 #define R_CS 1
45 #define R_SS 2
46 #define R_DS 3
47 #define R_FS 4
48 #define R_GS 5
49
50 /* segment descriptor fields */
51 #define DESC_G_MASK     (1 << 23)
52 #define DESC_B_SHIFT    22
53 #define DESC_B_MASK     (1 << DESC_B_SHIFT)
54 #define DESC_AVL_MASK   (1 << 20)
55 #define DESC_P_MASK     (1 << 15)
56 #define DESC_DPL_SHIFT  13
57 #define DESC_S_MASK     (1 << 12)
58 #define DESC_TYPE_SHIFT 8
59 #define DESC_A_MASK     (1 << 8)
60
61 #define DESC_CS_MASK    (1 << 11)
62 #define DESC_C_MASK     (1 << 10)
63 #define DESC_R_MASK     (1 << 9)
64
65 #define DESC_E_MASK     (1 << 10)
66 #define DESC_W_MASK     (1 << 9)
67
68 /* eflags masks */
69 #define CC_C    0x0001
70 #define CC_P    0x0004
71 #define CC_A    0x0010
72 #define CC_Z    0x0040
73 #define CC_S    0x0080
74 #define CC_O    0x0800
75
76 #define TF_MASK                 0x00000100
77 #define IF_MASK                 0x00000200
78 #define DF_MASK                 0x00000400
79 #define IOPL_MASK               0x00003000
80 #define NT_MASK                 0x00004000
81 #define RF_MASK                 0x00010000
82 #define VM_MASK                 0x00020000
83 #define AC_MASK                 0x00040000 
84 #define VIF_MASK                0x00080000
85 #define VIP_MASK                0x00100000
86 #define ID_MASK                 0x00200000
87
88 #define CR0_PE_MASK  (1 << 0)
89 #define CR0_TS_MASK  (1 << 3)
90 #define CR0_WP_MASK  (1 << 16)
91 #define CR0_AM_MASK  (1 << 18)
92 #define CR0_PG_MASK  (1 << 31)
93
94 #define CR4_VME_MASK  (1 << 0)
95 #define CR4_PVI_MASK  (1 << 1)
96 #define CR4_TSD_MASK  (1 << 2)
97 #define CR4_DE_MASK   (1 << 3)
98 #define CR4_PSE_MASK  (1 << 4)
99
100 #define PG_PRESENT_BIT  0
101 #define PG_RW_BIT       1
102 #define PG_USER_BIT     2
103 #define PG_PWT_BIT      3
104 #define PG_PCD_BIT      4
105 #define PG_ACCESSED_BIT 5
106 #define PG_DIRTY_BIT    6
107 #define PG_PSE_BIT      7
108 #define PG_GLOBAL_BIT   8
109
110 #define PG_PRESENT_MASK  (1 << PG_PRESENT_BIT)
111 #define PG_RW_MASK       (1 << PG_RW_BIT)
112 #define PG_USER_MASK     (1 << PG_USER_BIT)
113 #define PG_PWT_MASK      (1 << PG_PWT_BIT)
114 #define PG_PCD_MASK      (1 << PG_PCD_BIT)
115 #define PG_ACCESSED_MASK (1 << PG_ACCESSED_BIT)
116 #define PG_DIRTY_MASK    (1 << PG_DIRTY_BIT)
117 #define PG_PSE_MASK      (1 << PG_PSE_BIT)
118 #define PG_GLOBAL_MASK   (1 << PG_GLOBAL_BIT)
119
120 #define PG_ERROR_W_BIT     1
121
122 #define PG_ERROR_P_MASK    0x01
123 #define PG_ERROR_W_MASK    (1 << PG_ERROR_W_BIT)
124 #define PG_ERROR_U_MASK    0x04
125 #define PG_ERROR_RSVD_MASK 0x08
126
127 #define MSR_IA32_APICBASE               0x1b
128 #define MSR_IA32_APICBASE_BSP           (1<<8)
129 #define MSR_IA32_APICBASE_ENABLE        (1<<11)
130 #define MSR_IA32_APICBASE_BASE          (0xfffff<<12)
131
132 #define MSR_IA32_SYSENTER_CS            0x174
133 #define MSR_IA32_SYSENTER_ESP           0x175
134 #define MSR_IA32_SYSENTER_EIP           0x176
135
136 #define EXCP00_DIVZ     0
137 #define EXCP01_SSTP     1
138 #define EXCP02_NMI      2
139 #define EXCP03_INT3     3
140 #define EXCP04_INTO     4
141 #define EXCP05_BOUND    5
142 #define EXCP06_ILLOP    6
143 #define EXCP07_PREX     7
144 #define EXCP08_DBLE     8
145 #define EXCP09_XERR     9
146 #define EXCP0A_TSS      10
147 #define EXCP0B_NOSEG    11
148 #define EXCP0C_STACK    12
149 #define EXCP0D_GPF      13
150 #define EXCP0E_PAGE     14
151 #define EXCP10_COPR     16
152 #define EXCP11_ALGN     17
153 #define EXCP12_MCHK     18
154
155 enum {
156     CC_OP_DYNAMIC, /* must use dynamic code to get cc_op */
157     CC_OP_EFLAGS,  /* all cc are explicitely computed, CC_SRC = flags */
158     CC_OP_MUL, /* modify all flags, C, O = (CC_SRC != 0) */
159
160     CC_OP_ADDB, /* modify all flags, CC_DST = res, CC_SRC = src1 */
161     CC_OP_ADDW,
162     CC_OP_ADDL,
163
164     CC_OP_ADCB, /* modify all flags, CC_DST = res, CC_SRC = src1 */
165     CC_OP_ADCW,
166     CC_OP_ADCL,
167
168     CC_OP_SUBB, /* modify all flags, CC_DST = res, CC_SRC = src1 */
169     CC_OP_SUBW,
170     CC_OP_SUBL,
171
172     CC_OP_SBBB, /* modify all flags, CC_DST = res, CC_SRC = src1 */
173     CC_OP_SBBW,
174     CC_OP_SBBL,
175
176     CC_OP_LOGICB, /* modify all flags, CC_DST = res */
177     CC_OP_LOGICW,
178     CC_OP_LOGICL,
179
180     CC_OP_INCB, /* modify all flags except, CC_DST = res, CC_SRC = C */
181     CC_OP_INCW,
182     CC_OP_INCL,
183
184     CC_OP_DECB, /* modify all flags except, CC_DST = res, CC_SRC = C  */
185     CC_OP_DECW,
186     CC_OP_DECL,
187
188     CC_OP_SHLB, /* modify all flags, CC_DST = res, CC_SRC.lsb = C */
189     CC_OP_SHLW,
190     CC_OP_SHLL,
191
192     CC_OP_SARB, /* modify all flags, CC_DST = res, CC_SRC.lsb = C */
193     CC_OP_SARW,
194     CC_OP_SARL,
195
196     CC_OP_NB,
197 };
198
199 #ifdef __i386__
200 #define USE_X86LDOUBLE
201 #endif
202
203 #ifdef USE_X86LDOUBLE
204 typedef long double CPU86_LDouble;
205 #else
206 typedef double CPU86_LDouble;
207 #endif
208
209 typedef struct SegmentCache {
210     uint32_t selector;
211     uint8_t *base;
212     uint32_t limit;
213     uint32_t flags;
214 } SegmentCache;
215
216 typedef struct CPUX86State {
217     /* standard registers */
218     uint32_t regs[8];
219     uint32_t eip;
220     uint32_t eflags; /* eflags register. During CPU emulation, CC
221                         flags and DF are set to zero because they are
222                         stored elsewhere */
223
224     /* emulator internal eflags handling */
225     uint32_t cc_src;
226     uint32_t cc_dst;
227     uint32_t cc_op;
228     int32_t df; /* D flag : 1 if D = 0, -1 if D = 1 */
229
230     /* FPU state */
231     unsigned int fpstt; /* top of stack index */
232     unsigned int fpus;
233     unsigned int fpuc;
234     uint8_t fptags[8];   /* 0 = valid, 1 = empty */
235     CPU86_LDouble fpregs[8];    
236
237     /* emulator internal variables */
238     CPU86_LDouble ft0;
239     union {
240         float f;
241         double d;
242         int i32;
243         int64_t i64;
244     } fp_convert;
245     
246     /* segments */
247     SegmentCache segs[6]; /* selector values */
248     SegmentCache ldt;
249     SegmentCache tr;
250     SegmentCache gdt; /* only base and limit are used */
251     SegmentCache idt; /* only base and limit are used */
252     int cpl;          /* current cpl */
253     int soft_mmu;     /* TRUE if soft mmu is being used */
254     
255     /* sysenter registers */
256     uint32_t sysenter_cs;
257     uint32_t sysenter_esp;
258     uint32_t sysenter_eip;
259     
260     /* exception/interrupt handling */
261     jmp_buf jmp_env;
262     int exception_index;
263     int error_code;
264     int exception_is_int;
265     int exception_next_eip;
266     struct TranslationBlock *current_tb; /* currently executing TB */
267     uint32_t cr[5]; /* NOTE: cr1 is unused */
268     uint32_t dr[8]; /* debug registers */
269     int interrupt_request; 
270     int user_mode_only; /* user mode only simulation */
271
272     /* soft mmu support */
273     /* 0 = kernel, 1 = user */
274     CPUTLBEntry tlb_read[2][CPU_TLB_SIZE];
275     CPUTLBEntry tlb_write[2][CPU_TLB_SIZE];
276     
277     /* ice debug support */
278     uint32_t breakpoints[MAX_BREAKPOINTS];
279     int nb_breakpoints;
280     int singlestep_enabled;
281
282     /* user data */
283     void *opaque;
284 } CPUX86State;
285
286 #ifndef IN_OP_I386
287 void cpu_x86_outb(CPUX86State *env, int addr, int val);
288 void cpu_x86_outw(CPUX86State *env, int addr, int val);
289 void cpu_x86_outl(CPUX86State *env, int addr, int val);
290 int cpu_x86_inb(CPUX86State *env, int addr);
291 int cpu_x86_inw(CPUX86State *env, int addr);
292 int cpu_x86_inl(CPUX86State *env, int addr);
293 #endif
294
295 CPUX86State *cpu_x86_init(void);
296 int cpu_x86_exec(CPUX86State *s);
297 void cpu_x86_close(CPUX86State *s);
298 int cpu_x86_get_pic_interrupt(CPUX86State *s);
299
300 /* needed to load some predefinied segment registers */
301 void cpu_x86_load_seg(CPUX86State *s, int seg_reg, int selector);
302
303 /* wrapper, just in case memory mappings must be changed */
304 static inline void cpu_x86_set_cpl(CPUX86State *s, int cpl)
305 {
306     s->cpl = cpl;
307 }
308
309 /* simulate fsave/frstor */
310 void cpu_x86_fsave(CPUX86State *s, uint8_t *ptr, int data32);
311 void cpu_x86_frstor(CPUX86State *s, uint8_t *ptr, int data32);
312
313 /* you can call this signal handler from your SIGBUS and SIGSEGV
314    signal handlers to inform the virtual CPU of exceptions. non zero
315    is returned if the signal was handled by the virtual CPU.  */
316 struct siginfo;
317 int cpu_x86_signal_handler(int host_signum, struct siginfo *info, 
318                            void *puc);
319
320 /* MMU defines */
321 void cpu_x86_init_mmu(CPUX86State *env);
322 extern int phys_ram_size;
323 extern int phys_ram_fd;
324 extern uint8_t *phys_ram_base;
325
326 /* used to debug */
327 #define X86_DUMP_FPU  0x0001 /* dump FPU state too */
328 #define X86_DUMP_CCOP 0x0002 /* dump qemu flag cache */
329 void cpu_x86_dump_state(CPUX86State *env, FILE *f, int flags);
330
331 #define TARGET_PAGE_BITS 12
332 #include "cpu-all.h"
333
334 #endif /* CPU_I386_H */