PowerPC system emulation fixes (Jocelyn Mayer)
[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 GCC_MAJOR < 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 uint32_t gen_opc_pc[OPC_BUF_SIZE];
59 extern uint8_t gen_opc_cc_op[OPC_BUF_SIZE];
60 extern uint8_t gen_opc_instr_start[OPC_BUF_SIZE];
61
62 typedef void (GenOpFunc)(void);
63 typedef void (GenOpFunc1)(long);
64 typedef void (GenOpFunc2)(long, long);
65 typedef void (GenOpFunc3)(long, long, long);
66                     
67 #if defined(TARGET_I386)
68
69 void optimize_flags_init(void);
70
71 #endif
72
73 extern FILE *logfile;
74 extern int loglevel;
75
76 int gen_intermediate_code(CPUState *env, struct TranslationBlock *tb);
77 int gen_intermediate_code_pc(CPUState *env, struct TranslationBlock *tb);
78 void dump_ops(const uint16_t *opc_buf, const uint32_t *opparam_buf);
79 int cpu_gen_code(CPUState *env, struct TranslationBlock *tb,
80                  int max_code_size, int *gen_code_size_ptr);
81 int cpu_restore_state(struct TranslationBlock *tb, 
82                       CPUState *env, unsigned long searched_pc,
83                       void *puc);
84 int cpu_gen_code_copy(CPUState *env, struct TranslationBlock *tb,
85                       int max_code_size, int *gen_code_size_ptr);
86 int cpu_restore_state_copy(struct TranslationBlock *tb, 
87                            CPUState *env, unsigned long searched_pc,
88                            void *puc);
89 void cpu_exec_init(void);
90 int page_unprotect(unsigned long address);
91 void tb_invalidate_page_range(target_ulong start, target_ulong end);
92 void tlb_flush_page(CPUState *env, uint32_t addr);
93 void tlb_flush_page_write(CPUState *env, uint32_t addr);
94 void tlb_flush(CPUState *env, int flush_global);
95 int tlb_set_page(CPUState *env, uint32_t vaddr, uint32_t paddr, int prot, 
96                  int is_user, int is_softmmu);
97
98 #define CODE_GEN_MAX_SIZE        65536
99 #define CODE_GEN_ALIGN           16 /* must be >= of the size of a icache line */
100
101 #define CODE_GEN_HASH_BITS     15
102 #define CODE_GEN_HASH_SIZE     (1 << CODE_GEN_HASH_BITS)
103
104 #define CODE_GEN_PHYS_HASH_BITS     15
105 #define CODE_GEN_PHYS_HASH_SIZE     (1 << CODE_GEN_PHYS_HASH_BITS)
106
107 /* maximum total translate dcode allocated */
108
109 /* NOTE: the translated code area cannot be too big because on some
110    archs the range of "fast" function calls is limited. Here is a
111    summary of the ranges:
112
113    i386  : signed 32 bits
114    arm   : signed 26 bits
115    ppc   : signed 24 bits
116    sparc : signed 32 bits
117    alpha : signed 23 bits
118 */
119
120 #if defined(__alpha__)
121 #define CODE_GEN_BUFFER_SIZE     (2 * 1024 * 1024)
122 #elif defined(__powerpc__)
123 #define CODE_GEN_BUFFER_SIZE     (6 * 1024 * 1024)
124 #else
125 #define CODE_GEN_BUFFER_SIZE     (8 * 1024 * 1024)
126 #endif
127
128 //#define CODE_GEN_BUFFER_SIZE     (128 * 1024)
129
130 /* estimated block size for TB allocation */
131 /* XXX: use a per code average code fragment size and modulate it
132    according to the host CPU */
133 #if defined(CONFIG_SOFTMMU)
134 #define CODE_GEN_AVG_BLOCK_SIZE 128
135 #else
136 #define CODE_GEN_AVG_BLOCK_SIZE 64
137 #endif
138
139 #define CODE_GEN_MAX_BLOCKS    (CODE_GEN_BUFFER_SIZE / CODE_GEN_AVG_BLOCK_SIZE)
140
141 #if defined(__powerpc__) 
142 #define USE_DIRECT_JUMP
143 #endif
144 #if defined(__i386__) && !defined(_WIN32)
145 #define USE_DIRECT_JUMP
146 #endif
147
148 typedef struct TranslationBlock {
149     unsigned long pc;   /* simulated PC corresponding to this block (EIP + CS base) */
150     unsigned long cs_base; /* CS base for this block */
151     unsigned int flags; /* flags defining in which context the code was generated */
152     uint16_t size;      /* size of target code for this block (1 <=
153                            size <= TARGET_PAGE_SIZE) */
154     uint16_t cflags;    /* compile flags */
155 #define CF_CODE_COPY   0x0001 /* block was generated in code copy mode */
156 #define CF_TB_FP_USED  0x0002 /* fp ops are used in the TB */
157 #define CF_FP_USED     0x0004 /* fp ops are used in the TB or in a chained TB */
158
159     uint8_t *tc_ptr;    /* pointer to the translated code */
160     struct TranslationBlock *hash_next; /* next matching tb for virtual address */
161     /* next matching tb for physical address. */
162     struct TranslationBlock *phys_hash_next; 
163     /* first and second physical page containing code. The lower bit
164        of the pointer tells the index in page_next[] */
165     struct TranslationBlock *page_next[2]; 
166     target_ulong page_addr[2]; 
167
168     /* the following data are used to directly call another TB from
169        the code of this one. */
170     uint16_t tb_next_offset[2]; /* offset of original jump target */
171 #ifdef USE_DIRECT_JUMP
172     uint16_t tb_jmp_offset[4]; /* offset of jump instruction */
173 #else
174     uint32_t tb_next[2]; /* address of jump generated code */
175 #endif
176     /* list of TBs jumping to this one. This is a circular list using
177        the two least significant bits of the pointers to tell what is
178        the next pointer: 0 = jmp_next[0], 1 = jmp_next[1], 2 =
179        jmp_first */
180     struct TranslationBlock *jmp_next[2]; 
181     struct TranslationBlock *jmp_first;
182 } TranslationBlock;
183
184 static inline unsigned int tb_hash_func(unsigned long pc)
185 {
186     return pc & (CODE_GEN_HASH_SIZE - 1);
187 }
188
189 static inline unsigned int tb_phys_hash_func(unsigned long pc)
190 {
191     return pc & (CODE_GEN_PHYS_HASH_SIZE - 1);
192 }
193
194 TranslationBlock *tb_alloc(unsigned long pc);
195 void tb_flush(CPUState *env);
196 void tb_link(TranslationBlock *tb);
197 void tb_link_phys(TranslationBlock *tb, 
198                   target_ulong phys_pc, target_ulong phys_page2);
199
200 extern TranslationBlock *tb_hash[CODE_GEN_HASH_SIZE];
201 extern TranslationBlock *tb_phys_hash[CODE_GEN_PHYS_HASH_SIZE];
202
203 extern uint8_t code_gen_buffer[CODE_GEN_BUFFER_SIZE];
204 extern uint8_t *code_gen_ptr;
205
206 /* find a translation block in the translation cache. If not found,
207    return NULL and the pointer to the last element of the list in pptb */
208 static inline TranslationBlock *tb_find(TranslationBlock ***pptb,
209                                         unsigned long pc, 
210                                         unsigned long cs_base,
211                                         unsigned int flags)
212 {
213     TranslationBlock **ptb, *tb;
214     unsigned int h;
215  
216     h = tb_hash_func(pc);
217     ptb = &tb_hash[h];
218     for(;;) {
219         tb = *ptb;
220         if (!tb)
221             break;
222         if (tb->pc == pc && tb->cs_base == cs_base && tb->flags == flags)
223             return tb;
224         ptb = &tb->hash_next;
225     }
226     *pptb = ptb;
227     return NULL;
228 }
229
230
231 #if defined(USE_DIRECT_JUMP)
232
233 #if defined(__powerpc__)
234 static inline void tb_set_jmp_target1(unsigned long jmp_addr, unsigned long addr)
235 {
236     uint32_t val, *ptr;
237
238     /* patch the branch destination */
239     ptr = (uint32_t *)jmp_addr;
240     val = *ptr;
241     val = (val & ~0x03fffffc) | ((addr - jmp_addr) & 0x03fffffc);
242     *ptr = val;
243     /* flush icache */
244     asm volatile ("dcbst 0,%0" : : "r"(ptr) : "memory");
245     asm volatile ("sync" : : : "memory");
246     asm volatile ("icbi 0,%0" : : "r"(ptr) : "memory");
247     asm volatile ("sync" : : : "memory");
248     asm volatile ("isync" : : : "memory");
249 }
250 #elif defined(__i386__)
251 static inline void tb_set_jmp_target1(unsigned long jmp_addr, unsigned long addr)
252 {
253     /* patch the branch destination */
254     *(uint32_t *)jmp_addr = addr - (jmp_addr + 4);
255     /* no need to flush icache explicitely */
256 }
257 #endif
258
259 static inline void tb_set_jmp_target(TranslationBlock *tb, 
260                                      int n, unsigned long addr)
261 {
262     unsigned long offset;
263
264     offset = tb->tb_jmp_offset[n];
265     tb_set_jmp_target1((unsigned long)(tb->tc_ptr + offset), addr);
266     offset = tb->tb_jmp_offset[n + 2];
267     if (offset != 0xffff)
268         tb_set_jmp_target1((unsigned long)(tb->tc_ptr + offset), addr);
269 }
270
271 #else
272
273 /* set the jump target */
274 static inline void tb_set_jmp_target(TranslationBlock *tb, 
275                                      int n, unsigned long addr)
276 {
277     tb->tb_next[n] = addr;
278 }
279
280 #endif
281
282 static inline void tb_add_jump(TranslationBlock *tb, int n, 
283                                TranslationBlock *tb_next)
284 {
285     /* NOTE: this test is only needed for thread safety */
286     if (!tb->jmp_next[n]) {
287         /* patch the native jump address */
288         tb_set_jmp_target(tb, n, (unsigned long)tb_next->tc_ptr);
289         
290         /* add in TB jmp circular list */
291         tb->jmp_next[n] = tb_next->jmp_first;
292         tb_next->jmp_first = (TranslationBlock *)((long)(tb) | (n));
293     }
294 }
295
296 TranslationBlock *tb_find_pc(unsigned long pc_ptr);
297
298 #ifndef offsetof
299 #define offsetof(type, field) ((size_t) &((type *)0)->field)
300 #endif
301
302 #if defined(__powerpc__)
303
304 /* we patch the jump instruction directly */
305 #define JUMP_TB(opname, tbparam, n, eip)\
306 do {\
307     asm volatile (".section \".data\"\n"\
308                   "__op_label" #n "." stringify(opname) ":\n"\
309                   ".long 1f\n"\
310                   ".previous\n"\
311                   "b __op_jmp" #n "\n"\
312                   "1:\n");\
313     T0 = (long)(tbparam) + (n);\
314     EIP = eip;\
315     EXIT_TB();\
316 } while (0)
317
318 #define JUMP_TB2(opname, tbparam, n)\
319 do {\
320     asm volatile ("b __op_jmp" #n "\n");\
321 } while (0)
322
323 #elif defined(__i386__) && defined(USE_DIRECT_JUMP)
324
325 #ifdef _WIN32
326 #define ASM_PREVIOUS_SECTION ".section .text\n"
327 #else
328 #define ASM_PREVIOUS_SECTION ".previous\n"
329 #endif
330
331 /* we patch the jump instruction directly */
332 #define JUMP_TB(opname, tbparam, n, eip)\
333 do {\
334     asm volatile (".section .data\n"\
335                   "__op_label" #n "." stringify(opname) ":\n"\
336                   ".long 1f\n"\
337                   ASM_PREVIOUS_SECTION \
338                   "jmp __op_jmp" #n "\n"\
339                   "1:\n");\
340     T0 = (long)(tbparam) + (n);\
341     EIP = eip;\
342     EXIT_TB();\
343 } while (0)
344
345 #define JUMP_TB2(opname, tbparam, n)\
346 do {\
347     asm volatile ("jmp __op_jmp" #n "\n");\
348 } while (0)
349
350 #else
351
352 /* jump to next block operations (more portable code, does not need
353    cache flushing, but slower because of indirect jump) */
354 #define JUMP_TB(opname, tbparam, n, eip)\
355 do {\
356     static void __attribute__((unused)) *__op_label ## n = &&label ## n;\
357     static void __attribute__((unused)) *dummy ## n = &&dummy_label ## n;\
358     goto *(void *)(((TranslationBlock *)tbparam)->tb_next[n]);\
359 label ## n:\
360     T0 = (long)(tbparam) + (n);\
361     EIP = eip;\
362 dummy_label ## n:\
363     EXIT_TB();\
364 } while (0)
365
366 /* second jump to same destination 'n' */
367 #define JUMP_TB2(opname, tbparam, n)\
368 do {\
369     goto *(void *)(((TranslationBlock *)tbparam)->tb_next[n - 2]);\
370 } while (0)
371
372 #endif
373
374 extern CPUWriteMemoryFunc *io_mem_write[IO_MEM_NB_ENTRIES][4];
375 extern CPUReadMemoryFunc *io_mem_read[IO_MEM_NB_ENTRIES][4];
376
377 #ifdef __powerpc__
378 static inline int testandset (int *p)
379 {
380     int ret;
381     __asm__ __volatile__ (
382                           "0:    lwarx %0,0,%1 ;"
383                           "      xor. %0,%3,%0;"
384                           "      bne 1f;"
385                           "      stwcx. %2,0,%1;"
386                           "      bne- 0b;"
387                           "1:    "
388                           : "=&r" (ret)
389                           : "r" (p), "r" (1), "r" (0)
390                           : "cr0", "memory");
391     return ret;
392 }
393 #endif
394
395 #ifdef __i386__
396 static inline int testandset (int *p)
397 {
398     char ret;
399     long int readval;
400     
401     __asm__ __volatile__ ("lock; cmpxchgl %3, %1; sete %0"
402                           : "=q" (ret), "=m" (*p), "=a" (readval)
403                           : "r" (1), "m" (*p), "a" (0)
404                           : "memory");
405     return ret;
406 }
407 #endif
408
409 #ifdef __x86_64__
410 static inline int testandset (int *p)
411 {
412     char ret;
413     int readval;
414     
415     __asm__ __volatile__ ("lock; cmpxchgl %3, %1; sete %0"
416                           : "=q" (ret), "=m" (*p), "=a" (readval)
417                           : "r" (1), "m" (*p), "a" (0)
418                           : "memory");
419     return ret;
420 }
421 #endif
422
423 #ifdef __s390__
424 static inline int testandset (int *p)
425 {
426     int ret;
427
428     __asm__ __volatile__ ("0: cs    %0,%1,0(%2)\n"
429                           "   jl    0b"
430                           : "=&d" (ret)
431                           : "r" (1), "a" (p), "0" (*p) 
432                           : "cc", "memory" );
433     return ret;
434 }
435 #endif
436
437 #ifdef __alpha__
438 static inline int testandset (int *p)
439 {
440     int ret;
441     unsigned long one;
442
443     __asm__ __volatile__ ("0:   mov 1,%2\n"
444                           "     ldl_l %0,%1\n"
445                           "     stl_c %2,%1\n"
446                           "     beq %2,1f\n"
447                           ".subsection 2\n"
448                           "1:   br 0b\n"
449                           ".previous"
450                           : "=r" (ret), "=m" (*p), "=r" (one)
451                           : "m" (*p));
452     return ret;
453 }
454 #endif
455
456 #ifdef __sparc__
457 static inline int testandset (int *p)
458 {
459         int ret;
460
461         __asm__ __volatile__("ldstub    [%1], %0"
462                              : "=r" (ret)
463                              : "r" (p)
464                              : "memory");
465
466         return (ret ? 1 : 0);
467 }
468 #endif
469
470 #ifdef __arm__
471 static inline int testandset (int *spinlock)
472 {
473     register unsigned int ret;
474     __asm__ __volatile__("swp %0, %1, [%2]"
475                          : "=r"(ret)
476                          : "0"(1), "r"(spinlock));
477     
478     return ret;
479 }
480 #endif
481
482 #ifdef __mc68000
483 static inline int testandset (int *p)
484 {
485     char ret;
486     __asm__ __volatile__("tas %1; sne %0"
487                          : "=r" (ret)
488                          : "m" (p)
489                          : "cc","memory");
490     return ret == 0;
491 }
492 #endif
493
494 typedef int spinlock_t;
495
496 #define SPIN_LOCK_UNLOCKED 0
497
498 #if defined(CONFIG_USER_ONLY)
499 static inline void spin_lock(spinlock_t *lock)
500 {
501     while (testandset(lock));
502 }
503
504 static inline void spin_unlock(spinlock_t *lock)
505 {
506     *lock = 0;
507 }
508
509 static inline int spin_trylock(spinlock_t *lock)
510 {
511     return !testandset(lock);
512 }
513 #else
514 static inline void spin_lock(spinlock_t *lock)
515 {
516 }
517
518 static inline void spin_unlock(spinlock_t *lock)
519 {
520 }
521
522 static inline int spin_trylock(spinlock_t *lock)
523 {
524     return 1;
525 }
526 #endif
527
528 extern spinlock_t tb_lock;
529
530 extern int tb_invalidated_flag;
531
532 #if (defined(TARGET_I386) || defined(TARGET_PPC)) && \
533     !defined(CONFIG_USER_ONLY)
534
535 void tlb_fill(unsigned long addr, int is_write, int is_user, 
536               void *retaddr);
537
538 #define ACCESS_TYPE 3
539 #define MEMSUFFIX _code
540 #define env cpu_single_env
541
542 #define DATA_SIZE 1
543 #include "softmmu_header.h"
544
545 #define DATA_SIZE 2
546 #include "softmmu_header.h"
547
548 #define DATA_SIZE 4
549 #include "softmmu_header.h"
550
551 #undef ACCESS_TYPE
552 #undef MEMSUFFIX
553 #undef env
554
555 #endif
556
557 #if defined(CONFIG_USER_ONLY)
558 static inline target_ulong get_phys_addr_code(CPUState *env, target_ulong addr)
559 {
560     return addr;
561 }
562 #else
563 /* NOTE: this function can trigger an exception */
564 /* NOTE2: the returned address is not exactly the physical address: it
565    is the offset relative to phys_ram_base */
566 /* XXX: i386 target specific */
567 static inline target_ulong get_phys_addr_code(CPUState *env, target_ulong addr)
568 {
569     int is_user, index;
570
571     index = (addr >> TARGET_PAGE_BITS) & (CPU_TLB_SIZE - 1);
572 #if defined(TARGET_I386)
573     is_user = ((env->hflags & HF_CPL_MASK) == 3);
574 #elif defined (TARGET_PPC)
575     is_user = msr_pr;
576 #else
577 #error "Unimplemented !"
578 #endif
579     if (__builtin_expect(env->tlb_read[is_user][index].address != 
580                          (addr & TARGET_PAGE_MASK), 0)) {
581 #if defined (TARGET_PPC)
582         env->access_type = ACCESS_CODE;
583         ldub_code((void *)addr);
584         env->access_type = ACCESS_INT;
585 #else
586         ldub_code((void *)addr);
587 #endif
588     }
589     return addr + env->tlb_read[is_user][index].addend - (unsigned long)phys_ram_base;
590 }
591 #endif