Another #elif'ication.
[qemu] / exec-all.h
1 /*
2  * internal execution defines for qemu
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
21 /* allow to see translation results - the slowdown should be negligible, so we leave it */
22 #define DEBUG_DISAS
23
24 #ifndef glue
25 #define xglue(x, y) x ## y
26 #define glue(x, y) xglue(x, y)
27 #define stringify(s)    tostring(s)
28 #define tostring(s)     #s
29 #endif
30
31 #if __GNUC__ < 3
32 #define __builtin_expect(x, n) (x)
33 #endif
34
35 #ifdef __i386__
36 #define REGPARM(n) __attribute((regparm(n)))
37 #else
38 #define REGPARM(n)
39 #endif
40
41 /* is_jmp field values */
42 #define DISAS_NEXT    0 /* next instruction can be analyzed */
43 #define DISAS_JUMP    1 /* only pc was modified dynamically */
44 #define DISAS_UPDATE  2 /* cpu state was modified dynamically */
45 #define DISAS_TB_JUMP 3 /* only pc was modified statically */
46
47 struct TranslationBlock;
48
49 /* XXX: make safe guess about sizes */
50 #define MAX_OP_PER_INSTR 32
51 #define OPC_BUF_SIZE 512
52 #define OPC_MAX_SIZE (OPC_BUF_SIZE - MAX_OP_PER_INSTR)
53
54 #define OPPARAM_BUF_SIZE (OPC_BUF_SIZE * 3)
55
56 extern uint16_t gen_opc_buf[OPC_BUF_SIZE];
57 extern uint32_t gen_opparam_buf[OPPARAM_BUF_SIZE];
58 extern long gen_labels[OPC_BUF_SIZE];
59 extern int nb_gen_labels;
60 extern target_ulong gen_opc_pc[OPC_BUF_SIZE];
61 extern target_ulong gen_opc_npc[OPC_BUF_SIZE];
62 extern uint8_t gen_opc_cc_op[OPC_BUF_SIZE];
63 extern uint8_t gen_opc_instr_start[OPC_BUF_SIZE];
64 extern target_ulong gen_opc_jump_pc[2];
65 extern uint32_t gen_opc_hflags[OPC_BUF_SIZE];
66
67 typedef void (GenOpFunc)(void);
68 typedef void (GenOpFunc1)(long);
69 typedef void (GenOpFunc2)(long, long);
70 typedef void (GenOpFunc3)(long, long, long);
71                     
72 #if defined(TARGET_I386)
73
74 void optimize_flags_init(void);
75
76 #endif
77
78 extern FILE *logfile;
79 extern int loglevel;
80
81 int gen_intermediate_code(CPUState *env, struct TranslationBlock *tb);
82 int gen_intermediate_code_pc(CPUState *env, struct TranslationBlock *tb);
83 void dump_ops(const uint16_t *opc_buf, const uint32_t *opparam_buf);
84 int cpu_gen_code(CPUState *env, struct TranslationBlock *tb,
85                  int max_code_size, int *gen_code_size_ptr);
86 int cpu_restore_state(struct TranslationBlock *tb, 
87                       CPUState *env, unsigned long searched_pc,
88                       void *puc);
89 int cpu_gen_code_copy(CPUState *env, struct TranslationBlock *tb,
90                       int max_code_size, int *gen_code_size_ptr);
91 int cpu_restore_state_copy(struct TranslationBlock *tb, 
92                            CPUState *env, unsigned long searched_pc,
93                            void *puc);
94 void cpu_resume_from_signal(CPUState *env1, void *puc);
95 void cpu_exec_init(CPUState *env);
96 int page_unprotect(target_ulong address, unsigned long pc, void *puc);
97 void tb_invalidate_phys_page_range(target_ulong start, target_ulong end, 
98                                    int is_cpu_write_access);
99 void tb_invalidate_page_range(target_ulong start, target_ulong end);
100 void tlb_flush_page(CPUState *env, target_ulong addr);
101 void tlb_flush(CPUState *env, int flush_global);
102 int tlb_set_page_exec(CPUState *env, target_ulong vaddr, 
103                       target_phys_addr_t paddr, int prot, 
104                       int is_user, int is_softmmu);
105 static inline int tlb_set_page(CPUState *env, target_ulong vaddr, 
106                                target_phys_addr_t paddr, int prot, 
107                                int is_user, int is_softmmu)
108 {
109     if (prot & PAGE_READ)
110         prot |= PAGE_EXEC;
111     return tlb_set_page_exec(env, vaddr, paddr, prot, is_user, is_softmmu);
112 }
113
114 #define CODE_GEN_MAX_SIZE        65536
115 #define CODE_GEN_ALIGN           16 /* must be >= of the size of a icache line */
116
117 #define CODE_GEN_PHYS_HASH_BITS     15
118 #define CODE_GEN_PHYS_HASH_SIZE     (1 << CODE_GEN_PHYS_HASH_BITS)
119
120 /* maximum total translate dcode allocated */
121
122 /* NOTE: the translated code area cannot be too big because on some
123    archs the range of "fast" function calls is limited. Here is a
124    summary of the ranges:
125
126    i386  : signed 32 bits
127    arm   : signed 26 bits
128    ppc   : signed 24 bits
129    sparc : signed 32 bits
130    alpha : signed 23 bits
131 */
132
133 #if defined(__alpha__)
134 #define CODE_GEN_BUFFER_SIZE     (2 * 1024 * 1024)
135 #elif defined(__ia64)
136 #define CODE_GEN_BUFFER_SIZE     (4 * 1024 * 1024)      /* range of addl */
137 #elif defined(__powerpc__)
138 #define CODE_GEN_BUFFER_SIZE     (6 * 1024 * 1024)
139 #else
140 #define CODE_GEN_BUFFER_SIZE     (16 * 1024 * 1024)
141 #endif
142
143 //#define CODE_GEN_BUFFER_SIZE     (128 * 1024)
144
145 /* estimated block size for TB allocation */
146 /* XXX: use a per code average code fragment size and modulate it
147    according to the host CPU */
148 #if defined(CONFIG_SOFTMMU)
149 #define CODE_GEN_AVG_BLOCK_SIZE 128
150 #else
151 #define CODE_GEN_AVG_BLOCK_SIZE 64
152 #endif
153
154 #define CODE_GEN_MAX_BLOCKS    (CODE_GEN_BUFFER_SIZE / CODE_GEN_AVG_BLOCK_SIZE)
155
156 #if defined(__powerpc__) 
157 #define USE_DIRECT_JUMP
158 #endif
159 #if defined(__i386__) && !defined(_WIN32)
160 #define USE_DIRECT_JUMP
161 #endif
162
163 typedef struct TranslationBlock {
164     target_ulong pc;   /* simulated PC corresponding to this block (EIP + CS base) */
165     target_ulong cs_base; /* CS base for this block */
166     unsigned int flags; /* flags defining in which context the code was generated */
167     uint16_t size;      /* size of target code for this block (1 <=
168                            size <= TARGET_PAGE_SIZE) */
169     uint16_t cflags;    /* compile flags */
170 #define CF_CODE_COPY   0x0001 /* block was generated in code copy mode */
171 #define CF_TB_FP_USED  0x0002 /* fp ops are used in the TB */
172 #define CF_FP_USED     0x0004 /* fp ops are used in the TB or in a chained TB */
173 #define CF_SINGLE_INSN 0x0008 /* compile only a single instruction */
174
175     uint8_t *tc_ptr;    /* pointer to the translated code */
176     /* next matching tb for physical address. */
177     struct TranslationBlock *phys_hash_next; 
178     /* first and second physical page containing code. The lower bit
179        of the pointer tells the index in page_next[] */
180     struct TranslationBlock *page_next[2]; 
181     target_ulong page_addr[2]; 
182
183     /* the following data are used to directly call another TB from
184        the code of this one. */
185     uint16_t tb_next_offset[2]; /* offset of original jump target */
186 #ifdef USE_DIRECT_JUMP
187     uint16_t tb_jmp_offset[4]; /* offset of jump instruction */
188 #else
189     uint32_t tb_next[2]; /* address of jump generated code */
190 #endif
191     /* list of TBs jumping to this one. This is a circular list using
192        the two least significant bits of the pointers to tell what is
193        the next pointer: 0 = jmp_next[0], 1 = jmp_next[1], 2 =
194        jmp_first */
195     struct TranslationBlock *jmp_next[2]; 
196     struct TranslationBlock *jmp_first;
197 } TranslationBlock;
198
199 static inline unsigned int tb_jmp_cache_hash_page(target_ulong pc)
200 {
201     target_ulong tmp;
202     tmp = pc ^ (pc >> (TARGET_PAGE_BITS - TB_JMP_PAGE_BITS));
203     return (tmp >> TB_JMP_PAGE_BITS) & TB_JMP_PAGE_MASK;
204 }
205
206 static inline unsigned int tb_jmp_cache_hash_func(target_ulong pc)
207 {
208     target_ulong tmp;
209     tmp = pc ^ (pc >> (TARGET_PAGE_BITS - TB_JMP_PAGE_BITS));
210     return (((tmp >> TB_JMP_PAGE_BITS) & TB_JMP_PAGE_MASK) |
211             (tmp & TB_JMP_ADDR_MASK));
212 }
213
214 static inline unsigned int tb_phys_hash_func(unsigned long pc)
215 {
216     return pc & (CODE_GEN_PHYS_HASH_SIZE - 1);
217 }
218
219 TranslationBlock *tb_alloc(target_ulong pc);
220 void tb_flush(CPUState *env);
221 void tb_link_phys(TranslationBlock *tb, 
222                   target_ulong phys_pc, target_ulong phys_page2);
223
224 extern TranslationBlock *tb_phys_hash[CODE_GEN_PHYS_HASH_SIZE];
225
226 extern uint8_t code_gen_buffer[CODE_GEN_BUFFER_SIZE];
227 extern uint8_t *code_gen_ptr;
228
229 #if defined(USE_DIRECT_JUMP)
230
231 #if defined(__powerpc__)
232 static inline void tb_set_jmp_target1(unsigned long jmp_addr, unsigned long addr)
233 {
234     uint32_t val, *ptr;
235
236     /* patch the branch destination */
237     ptr = (uint32_t *)jmp_addr;
238     val = *ptr;
239     val = (val & ~0x03fffffc) | ((addr - jmp_addr) & 0x03fffffc);
240     *ptr = val;
241     /* flush icache */
242     asm volatile ("dcbst 0,%0" : : "r"(ptr) : "memory");
243     asm volatile ("sync" : : : "memory");
244     asm volatile ("icbi 0,%0" : : "r"(ptr) : "memory");
245     asm volatile ("sync" : : : "memory");
246     asm volatile ("isync" : : : "memory");
247 }
248 #elif defined(__i386__)
249 static inline void tb_set_jmp_target1(unsigned long jmp_addr, unsigned long addr)
250 {
251     /* patch the branch destination */
252     *(uint32_t *)jmp_addr = addr - (jmp_addr + 4);
253     /* no need to flush icache explicitely */
254 }
255 #endif
256
257 static inline void tb_set_jmp_target(TranslationBlock *tb, 
258                                      int n, unsigned long addr)
259 {
260     unsigned long offset;
261
262     offset = tb->tb_jmp_offset[n];
263     tb_set_jmp_target1((unsigned long)(tb->tc_ptr + offset), addr);
264     offset = tb->tb_jmp_offset[n + 2];
265     if (offset != 0xffff)
266         tb_set_jmp_target1((unsigned long)(tb->tc_ptr + offset), addr);
267 }
268
269 #else
270
271 /* set the jump target */
272 static inline void tb_set_jmp_target(TranslationBlock *tb, 
273                                      int n, unsigned long addr)
274 {
275     tb->tb_next[n] = addr;
276 }
277
278 #endif
279
280 static inline void tb_add_jump(TranslationBlock *tb, int n, 
281                                TranslationBlock *tb_next)
282 {
283     /* NOTE: this test is only needed for thread safety */
284     if (!tb->jmp_next[n]) {
285         /* patch the native jump address */
286         tb_set_jmp_target(tb, n, (unsigned long)tb_next->tc_ptr);
287         
288         /* add in TB jmp circular list */
289         tb->jmp_next[n] = tb_next->jmp_first;
290         tb_next->jmp_first = (TranslationBlock *)((long)(tb) | (n));
291     }
292 }
293
294 TranslationBlock *tb_find_pc(unsigned long pc_ptr);
295
296 #ifndef offsetof
297 #define offsetof(type, field) ((size_t) &((type *)0)->field)
298 #endif
299
300 #if defined(_WIN32)
301 #define ASM_DATA_SECTION ".section \".data\"\n"
302 #define ASM_PREVIOUS_SECTION ".section .text\n"
303 #elif defined(__APPLE__)
304 #define ASM_DATA_SECTION ".data\n"
305 #define ASM_PREVIOUS_SECTION ".text\n"
306 #else
307 #define ASM_DATA_SECTION ".section \".data\"\n"
308 #define ASM_PREVIOUS_SECTION ".previous\n"
309 #endif
310
311 #define ASM_OP_LABEL_NAME(n, opname) \
312     ASM_NAME(__op_label) #n "." ASM_NAME(opname)
313
314 #if defined(__powerpc__)
315
316 /* we patch the jump instruction directly */
317 #define GOTO_TB(opname, tbparam, n)\
318 do {\
319     asm volatile (ASM_DATA_SECTION\
320                   ASM_OP_LABEL_NAME(n, opname) ":\n"\
321                   ".long 1f\n"\
322                   ASM_PREVIOUS_SECTION \
323                   "b " ASM_NAME(__op_jmp) #n "\n"\
324                   "1:\n");\
325 } while (0)
326
327 #elif defined(__i386__) && defined(USE_DIRECT_JUMP)
328
329 /* we patch the jump instruction directly */
330 #define GOTO_TB(opname, tbparam, n)\
331 do {\
332     asm volatile (".section .data\n"\
333                   ASM_OP_LABEL_NAME(n, opname) ":\n"\
334                   ".long 1f\n"\
335                   ASM_PREVIOUS_SECTION \
336                   "jmp " ASM_NAME(__op_jmp) #n "\n"\
337                   "1:\n");\
338 } while (0)
339
340 #else
341
342 /* jump to next block operations (more portable code, does not need
343    cache flushing, but slower because of indirect jump) */
344 #define GOTO_TB(opname, tbparam, n)\
345 do {\
346     static void __attribute__((unused)) *dummy ## n = &&dummy_label ## n;\
347     static void __attribute__((unused)) *__op_label ## n \
348         __asm__(ASM_OP_LABEL_NAME(n, opname)) = &&label ## n;\
349     goto *(void *)(((TranslationBlock *)tbparam)->tb_next[n]);\
350 label ## n: ;\
351 dummy_label ## n: ;\
352 } while (0)
353
354 #endif
355
356 extern CPUWriteMemoryFunc *io_mem_write[IO_MEM_NB_ENTRIES][4];
357 extern CPUReadMemoryFunc *io_mem_read[IO_MEM_NB_ENTRIES][4];
358 extern void *io_mem_opaque[IO_MEM_NB_ENTRIES];
359
360 #if defined(__powerpc__)
361 static inline int testandset (int *p)
362 {
363     int ret;
364     __asm__ __volatile__ (
365                           "0:    lwarx %0,0,%1\n"
366                           "      xor. %0,%3,%0\n"
367                           "      bne 1f\n"
368                           "      stwcx. %2,0,%1\n"
369                           "      bne- 0b\n"
370                           "1:    "
371                           : "=&r" (ret)
372                           : "r" (p), "r" (1), "r" (0)
373                           : "cr0", "memory");
374     return ret;
375 }
376 #elif defined(__i386__)
377 static inline int testandset (int *p)
378 {
379     long int readval = 0;
380     
381     __asm__ __volatile__ ("lock; cmpxchgl %2, %0"
382                           : "+m" (*p), "+a" (readval)
383                           : "r" (1)
384                           : "cc");
385     return readval;
386 }
387 #elif defined(__x86_64__)
388 static inline int testandset (int *p)
389 {
390     long int readval = 0;
391     
392     __asm__ __volatile__ ("lock; cmpxchgl %2, %0"
393                           : "+m" (*p), "+a" (readval)
394                           : "r" (1)
395                           : "cc");
396     return readval;
397 }
398 #elif defined(__s390__)
399 static inline int testandset (int *p)
400 {
401     int ret;
402
403     __asm__ __volatile__ ("0: cs    %0,%1,0(%2)\n"
404                           "   jl    0b"
405                           : "=&d" (ret)
406                           : "r" (1), "a" (p), "0" (*p) 
407                           : "cc", "memory" );
408     return ret;
409 }
410 #elif defined(__alpha__)
411 static inline int testandset (int *p)
412 {
413     int ret;
414     unsigned long one;
415
416     __asm__ __volatile__ ("0:   mov 1,%2\n"
417                           "     ldl_l %0,%1\n"
418                           "     stl_c %2,%1\n"
419                           "     beq %2,1f\n"
420                           ".subsection 2\n"
421                           "1:   br 0b\n"
422                           ".previous"
423                           : "=r" (ret), "=m" (*p), "=r" (one)
424                           : "m" (*p));
425     return ret;
426 }
427 #elif defined(__sparc__)
428 static inline int testandset (int *p)
429 {
430         int ret;
431
432         __asm__ __volatile__("ldstub    [%1], %0"
433                              : "=r" (ret)
434                              : "r" (p)
435                              : "memory");
436
437         return (ret ? 1 : 0);
438 }
439 #elif defined(__arm__)
440 static inline int testandset (int *spinlock)
441 {
442     register unsigned int ret;
443     __asm__ __volatile__("swp %0, %1, [%2]"
444                          : "=r"(ret)
445                          : "0"(1), "r"(spinlock));
446     
447     return ret;
448 }
449 #elif defined(__mc68000)
450 static inline int testandset (int *p)
451 {
452     char ret;
453     __asm__ __volatile__("tas %1; sne %0"
454                          : "=r" (ret)
455                          : "m" (p)
456                          : "cc","memory");
457     return ret;
458 }
459 #elif defined(__ia64)
460
461 #include <ia64intrin.h>
462
463 static inline int testandset (int *p)
464 {
465     return __sync_lock_test_and_set (p, 1);
466 }
467 #elif defined(__mips__)
468 static inline int testandset (int *p)
469 {
470     int ret;
471
472     __asm__ __volatile__ (
473         "       .set push               \n"
474         "       .set noat               \n"
475         "       .set mips2              \n"
476         "1:     li      $1, 1           \n"
477         "       ll      %0, %1          \n"
478         "       sc      $1, %1          \n"
479         "       bnez    $1, 1b          \n"
480         "       .set pop                "
481         : "=r" (ret), "+R" (*p)
482         :
483         : "memory");
484
485     return ret;
486 }
487 #else
488 #error unimplemented CPU support
489 #endif
490
491 typedef int spinlock_t;
492
493 #define SPIN_LOCK_UNLOCKED 0
494
495 #if defined(CONFIG_USER_ONLY)
496 static inline void spin_lock(spinlock_t *lock)
497 {
498     while (testandset(lock));
499 }
500
501 static inline void spin_unlock(spinlock_t *lock)
502 {
503     *lock = 0;
504 }
505
506 static inline int spin_trylock(spinlock_t *lock)
507 {
508     return !testandset(lock);
509 }
510 #else
511 static inline void spin_lock(spinlock_t *lock)
512 {
513 }
514
515 static inline void spin_unlock(spinlock_t *lock)
516 {
517 }
518
519 static inline int spin_trylock(spinlock_t *lock)
520 {
521     return 1;
522 }
523 #endif
524
525 extern spinlock_t tb_lock;
526
527 extern int tb_invalidated_flag;
528
529 #if !defined(CONFIG_USER_ONLY)
530
531 void tlb_fill(target_ulong addr, int is_write, int is_user, 
532               void *retaddr);
533
534 #define ACCESS_TYPE 3
535 #define MEMSUFFIX _code
536 #define env cpu_single_env
537
538 #define DATA_SIZE 1
539 #include "softmmu_header.h"
540
541 #define DATA_SIZE 2
542 #include "softmmu_header.h"
543
544 #define DATA_SIZE 4
545 #include "softmmu_header.h"
546
547 #define DATA_SIZE 8
548 #include "softmmu_header.h"
549
550 #undef ACCESS_TYPE
551 #undef MEMSUFFIX
552 #undef env
553
554 #endif
555
556 #if defined(CONFIG_USER_ONLY)
557 static inline target_ulong get_phys_addr_code(CPUState *env, target_ulong addr)
558 {
559     return addr;
560 }
561 #else
562 /* NOTE: this function can trigger an exception */
563 /* NOTE2: the returned address is not exactly the physical address: it
564    is the offset relative to phys_ram_base */
565 static inline target_ulong get_phys_addr_code(CPUState *env, target_ulong addr)
566 {
567     int is_user, index, pd;
568
569     index = (addr >> TARGET_PAGE_BITS) & (CPU_TLB_SIZE - 1);
570 #if defined(TARGET_I386)
571     is_user = ((env->hflags & HF_CPL_MASK) == 3);
572 #elif defined (TARGET_PPC)
573     is_user = msr_pr;
574 #elif defined (TARGET_MIPS)
575     is_user = ((env->hflags & MIPS_HFLAG_MODE) == MIPS_HFLAG_UM);
576 #elif defined (TARGET_SPARC)
577     is_user = (env->psrs == 0);
578 #elif defined (TARGET_ARM)
579     is_user = ((env->uncached_cpsr & CPSR_M) == ARM_CPU_MODE_USR);
580 #elif defined (TARGET_SH4)
581     is_user = ((env->sr & SR_MD) == 0);
582 #elif defined (TARGET_ALPHA)
583     is_user = ((env->ps >> 3) & 3);
584 #else
585 #error unimplemented CPU
586 #endif
587     if (__builtin_expect(env->tlb_table[is_user][index].addr_code != 
588                          (addr & TARGET_PAGE_MASK), 0)) {
589         ldub_code(addr);
590     }
591     pd = env->tlb_table[is_user][index].addr_code & ~TARGET_PAGE_MASK;
592     if (pd > IO_MEM_ROM && !(pd & IO_MEM_ROMD)) {
593         cpu_abort(env, "Trying to execute code outside RAM or ROM at 0x" TARGET_FMT_lx "\n", addr);
594     }
595     return addr + env->tlb_table[is_user][index].addend - (unsigned long)phys_ram_base;
596 }
597 #endif
598
599 #ifdef USE_KQEMU
600 #define KQEMU_MODIFY_PAGE_MASK (0xff & ~(VGA_DIRTY_FLAG | CODE_DIRTY_FLAG))
601
602 int kqemu_init(CPUState *env);
603 int kqemu_cpu_exec(CPUState *env);
604 void kqemu_flush_page(CPUState *env, target_ulong addr);
605 void kqemu_flush(CPUState *env, int global);
606 void kqemu_set_notdirty(CPUState *env, ram_addr_t ram_addr);
607 void kqemu_modify_page(CPUState *env, ram_addr_t ram_addr);
608 void kqemu_cpu_interrupt(CPUState *env);
609 void kqemu_record_dump(void);
610
611 static inline int kqemu_is_ok(CPUState *env)
612 {
613     return(env->kqemu_enabled &&
614            (env->cr[0] & CR0_PE_MASK) && 
615            !(env->hflags & HF_INHIBIT_IRQ_MASK) &&
616            (env->eflags & IF_MASK) &&
617            !(env->eflags & VM_MASK) &&
618            (env->kqemu_enabled == 2 || 
619             ((env->hflags & HF_CPL_MASK) == 3 &&
620              (env->eflags & IOPL_MASK) != IOPL_MASK)));
621 }
622
623 #endif