Revived GUEST_BASE support for usermode emulation targets.
[qemu] / cpu-all.h
1 /*
2  * defines common to all virtual CPUs
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., 51 Franklin Street, Fifth Floor, Boston MA  02110-1301 USA
19  */
20 #ifndef CPU_ALL_H
21 #define CPU_ALL_H
22
23 #include "qemu-common.h"
24
25 #if defined(__arm__) || defined(__sparc__) || defined(__mips__) || defined(__hppa__)
26 #define WORDS_ALIGNED
27 #endif
28
29 /* some important defines:
30  *
31  * WORDS_ALIGNED : if defined, the host cpu can only make word aligned
32  * memory accesses.
33  *
34  * WORDS_BIGENDIAN : if defined, the host cpu is big endian and
35  * otherwise little endian.
36  *
37  * (TARGET_WORDS_ALIGNED : same for target cpu (not supported yet))
38  *
39  * TARGET_WORDS_BIGENDIAN : same for target cpu
40  */
41
42 #include "bswap.h"
43 #include "softfloat.h"
44
45 #if defined(WORDS_BIGENDIAN) != defined(TARGET_WORDS_BIGENDIAN)
46 #define BSWAP_NEEDED
47 #endif
48
49 #ifdef BSWAP_NEEDED
50
51 static inline uint16_t tswap16(uint16_t s)
52 {
53     return bswap16(s);
54 }
55
56 static inline uint32_t tswap32(uint32_t s)
57 {
58     return bswap32(s);
59 }
60
61 static inline uint64_t tswap64(uint64_t s)
62 {
63     return bswap64(s);
64 }
65
66 static inline void tswap16s(uint16_t *s)
67 {
68     *s = bswap16(*s);
69 }
70
71 static inline void tswap32s(uint32_t *s)
72 {
73     *s = bswap32(*s);
74 }
75
76 static inline void tswap64s(uint64_t *s)
77 {
78     *s = bswap64(*s);
79 }
80
81 #else
82
83 static inline uint16_t tswap16(uint16_t s)
84 {
85     return s;
86 }
87
88 static inline uint32_t tswap32(uint32_t s)
89 {
90     return s;
91 }
92
93 static inline uint64_t tswap64(uint64_t s)
94 {
95     return s;
96 }
97
98 static inline void tswap16s(uint16_t *s)
99 {
100 }
101
102 static inline void tswap32s(uint32_t *s)
103 {
104 }
105
106 static inline void tswap64s(uint64_t *s)
107 {
108 }
109
110 #endif
111
112 #if TARGET_LONG_SIZE == 4
113 #define tswapl(s) tswap32(s)
114 #define tswapls(s) tswap32s((uint32_t *)(s))
115 #define bswaptls(s) bswap32s(s)
116 #else
117 #define tswapl(s) tswap64(s)
118 #define tswapls(s) tswap64s((uint64_t *)(s))
119 #define bswaptls(s) bswap64s(s)
120 #endif
121
122 typedef union {
123     float32 f;
124     uint32_t l;
125 } CPU_FloatU;
126
127 /* NOTE: arm FPA is horrible as double 32 bit words are stored in big
128    endian ! */
129 typedef union {
130     float64 d;
131 #if defined(WORDS_BIGENDIAN) \
132     || (defined(__arm__) && !defined(__VFP_FP__) && !defined(CONFIG_SOFTFLOAT))
133     struct {
134         uint32_t upper;
135         uint32_t lower;
136     } l;
137 #else
138     struct {
139         uint32_t lower;
140         uint32_t upper;
141     } l;
142 #endif
143     uint64_t ll;
144 } CPU_DoubleU;
145
146 #ifdef TARGET_SPARC
147 typedef union {
148     float128 q;
149 #if defined(WORDS_BIGENDIAN) \
150     || (defined(__arm__) && !defined(__VFP_FP__) && !defined(CONFIG_SOFTFLOAT))
151     struct {
152         uint32_t upmost;
153         uint32_t upper;
154         uint32_t lower;
155         uint32_t lowest;
156     } l;
157     struct {
158         uint64_t upper;
159         uint64_t lower;
160     } ll;
161 #else
162     struct {
163         uint32_t lowest;
164         uint32_t lower;
165         uint32_t upper;
166         uint32_t upmost;
167     } l;
168     struct {
169         uint64_t lower;
170         uint64_t upper;
171     } ll;
172 #endif
173 } CPU_QuadU;
174 #endif
175
176 /* CPU memory access without any memory or io remapping */
177
178 /*
179  * the generic syntax for the memory accesses is:
180  *
181  * load: ld{type}{sign}{size}{endian}_{access_type}(ptr)
182  *
183  * store: st{type}{size}{endian}_{access_type}(ptr, val)
184  *
185  * type is:
186  * (empty): integer access
187  *   f    : float access
188  *
189  * sign is:
190  * (empty): for floats or 32 bit size
191  *   u    : unsigned
192  *   s    : signed
193  *
194  * size is:
195  *   b: 8 bits
196  *   w: 16 bits
197  *   l: 32 bits
198  *   q: 64 bits
199  *
200  * endian is:
201  * (empty): target cpu endianness or 8 bit access
202  *   r    : reversed target cpu endianness (not implemented yet)
203  *   be   : big endian (not implemented yet)
204  *   le   : little endian (not implemented yet)
205  *
206  * access_type is:
207  *   raw    : host memory access
208  *   user   : user mode access using soft MMU
209  *   kernel : kernel mode access using soft MMU
210  */
211 static inline int ldub_p(const void *ptr)
212 {
213     return *(uint8_t *)ptr;
214 }
215
216 static inline int ldsb_p(const void *ptr)
217 {
218     return *(int8_t *)ptr;
219 }
220
221 static inline void stb_p(void *ptr, int v)
222 {
223     *(uint8_t *)ptr = v;
224 }
225
226 /* NOTE: on arm, putting 2 in /proc/sys/debug/alignment so that the
227    kernel handles unaligned load/stores may give better results, but
228    it is a system wide setting : bad */
229 #if defined(WORDS_BIGENDIAN) || defined(WORDS_ALIGNED)
230
231 /* conservative code for little endian unaligned accesses */
232 static inline int lduw_le_p(const void *ptr)
233 {
234 #ifdef _ARCH_PPC
235     int val;
236     __asm__ __volatile__ ("lhbrx %0,0,%1" : "=r" (val) : "r" (ptr));
237     return val;
238 #else
239     const uint8_t *p = ptr;
240     return p[0] | (p[1] << 8);
241 #endif
242 }
243
244 static inline int ldsw_le_p(const void *ptr)
245 {
246 #ifdef _ARCH_PPC
247     int val;
248     __asm__ __volatile__ ("lhbrx %0,0,%1" : "=r" (val) : "r" (ptr));
249     return (int16_t)val;
250 #else
251     const uint8_t *p = ptr;
252     return (int16_t)(p[0] | (p[1] << 8));
253 #endif
254 }
255
256 static inline int ldl_le_p(const void *ptr)
257 {
258 #ifdef _ARCH_PPC
259     int val;
260     __asm__ __volatile__ ("lwbrx %0,0,%1" : "=r" (val) : "r" (ptr));
261     return val;
262 #else
263     const uint8_t *p = ptr;
264     return p[0] | (p[1] << 8) | (p[2] << 16) | (p[3] << 24);
265 #endif
266 }
267
268 static inline uint64_t ldq_le_p(const void *ptr)
269 {
270     const uint8_t *p = ptr;
271     uint32_t v1, v2;
272     v1 = ldl_le_p(p);
273     v2 = ldl_le_p(p + 4);
274     return v1 | ((uint64_t)v2 << 32);
275 }
276
277 static inline void stw_le_p(void *ptr, int v)
278 {
279 #ifdef _ARCH_PPC
280     __asm__ __volatile__ ("sthbrx %1,0,%2" : "=m" (*(uint16_t *)ptr) : "r" (v), "r" (ptr));
281 #else
282     uint8_t *p = ptr;
283     p[0] = v;
284     p[1] = v >> 8;
285 #endif
286 }
287
288 static inline void stl_le_p(void *ptr, int v)
289 {
290 #ifdef _ARCH_PPC
291     __asm__ __volatile__ ("stwbrx %1,0,%2" : "=m" (*(uint32_t *)ptr) : "r" (v), "r" (ptr));
292 #else
293     uint8_t *p = ptr;
294     p[0] = v;
295     p[1] = v >> 8;
296     p[2] = v >> 16;
297     p[3] = v >> 24;
298 #endif
299 }
300
301 static inline void stq_le_p(void *ptr, uint64_t v)
302 {
303     uint8_t *p = ptr;
304     stl_le_p(p, (uint32_t)v);
305     stl_le_p(p + 4, v >> 32);
306 }
307
308 /* float access */
309
310 static inline float32 ldfl_le_p(const void *ptr)
311 {
312     union {
313         float32 f;
314         uint32_t i;
315     } u;
316     u.i = ldl_le_p(ptr);
317     return u.f;
318 }
319
320 static inline void stfl_le_p(void *ptr, float32 v)
321 {
322     union {
323         float32 f;
324         uint32_t i;
325     } u;
326     u.f = v;
327     stl_le_p(ptr, u.i);
328 }
329
330 static inline float64 ldfq_le_p(const void *ptr)
331 {
332     CPU_DoubleU u;
333     u.l.lower = ldl_le_p(ptr);
334     u.l.upper = ldl_le_p(ptr + 4);
335     return u.d;
336 }
337
338 static inline void stfq_le_p(void *ptr, float64 v)
339 {
340     CPU_DoubleU u;
341     u.d = v;
342     stl_le_p(ptr, u.l.lower);
343     stl_le_p(ptr + 4, u.l.upper);
344 }
345
346 #else
347
348 static inline int lduw_le_p(const void *ptr)
349 {
350     return *(uint16_t *)ptr;
351 }
352
353 static inline int ldsw_le_p(const void *ptr)
354 {
355     return *(int16_t *)ptr;
356 }
357
358 static inline int ldl_le_p(const void *ptr)
359 {
360     return *(uint32_t *)ptr;
361 }
362
363 static inline uint64_t ldq_le_p(const void *ptr)
364 {
365     return *(uint64_t *)ptr;
366 }
367
368 static inline void stw_le_p(void *ptr, int v)
369 {
370     *(uint16_t *)ptr = v;
371 }
372
373 static inline void stl_le_p(void *ptr, int v)
374 {
375     *(uint32_t *)ptr = v;
376 }
377
378 static inline void stq_le_p(void *ptr, uint64_t v)
379 {
380     *(uint64_t *)ptr = v;
381 }
382
383 /* float access */
384
385 static inline float32 ldfl_le_p(const void *ptr)
386 {
387     return *(float32 *)ptr;
388 }
389
390 static inline float64 ldfq_le_p(const void *ptr)
391 {
392     return *(float64 *)ptr;
393 }
394
395 static inline void stfl_le_p(void *ptr, float32 v)
396 {
397     *(float32 *)ptr = v;
398 }
399
400 static inline void stfq_le_p(void *ptr, float64 v)
401 {
402     *(float64 *)ptr = v;
403 }
404 #endif
405
406 #if !defined(WORDS_BIGENDIAN) || defined(WORDS_ALIGNED)
407
408 static inline int lduw_be_p(const void *ptr)
409 {
410 #if defined(__i386__)
411     int val;
412     asm volatile ("movzwl %1, %0\n"
413                   "xchgb %b0, %h0\n"
414                   : "=q" (val)
415                   : "m" (*(uint16_t *)ptr));
416     return val;
417 #else
418     const uint8_t *b = ptr;
419     return ((b[0] << 8) | b[1]);
420 #endif
421 }
422
423 static inline int ldsw_be_p(const void *ptr)
424 {
425 #if defined(__i386__)
426     int val;
427     asm volatile ("movzwl %1, %0\n"
428                   "xchgb %b0, %h0\n"
429                   : "=q" (val)
430                   : "m" (*(uint16_t *)ptr));
431     return (int16_t)val;
432 #else
433     const uint8_t *b = ptr;
434     return (int16_t)((b[0] << 8) | b[1]);
435 #endif
436 }
437
438 static inline int ldl_be_p(const void *ptr)
439 {
440 #if defined(__i386__) || defined(__x86_64__)
441     int val;
442     asm volatile ("movl %1, %0\n"
443                   "bswap %0\n"
444                   : "=r" (val)
445                   : "m" (*(uint32_t *)ptr));
446     return val;
447 #else
448     const uint8_t *b = ptr;
449     return (b[0] << 24) | (b[1] << 16) | (b[2] << 8) | b[3];
450 #endif
451 }
452
453 static inline uint64_t ldq_be_p(const void *ptr)
454 {
455     uint32_t a,b;
456     a = ldl_be_p(ptr);
457     b = ldl_be_p((uint8_t *)ptr + 4);
458     return (((uint64_t)a<<32)|b);
459 }
460
461 static inline void stw_be_p(void *ptr, int v)
462 {
463 #if defined(__i386__)
464     asm volatile ("xchgb %b0, %h0\n"
465                   "movw %w0, %1\n"
466                   : "=q" (v)
467                   : "m" (*(uint16_t *)ptr), "0" (v));
468 #else
469     uint8_t *d = (uint8_t *) ptr;
470     d[0] = v >> 8;
471     d[1] = v;
472 #endif
473 }
474
475 static inline void stl_be_p(void *ptr, int v)
476 {
477 #if defined(__i386__) || defined(__x86_64__)
478     asm volatile ("bswap %0\n"
479                   "movl %0, %1\n"
480                   : "=r" (v)
481                   : "m" (*(uint32_t *)ptr), "0" (v));
482 #else
483     uint8_t *d = (uint8_t *) ptr;
484     d[0] = v >> 24;
485     d[1] = v >> 16;
486     d[2] = v >> 8;
487     d[3] = v;
488 #endif
489 }
490
491 static inline void stq_be_p(void *ptr, uint64_t v)
492 {
493     stl_be_p(ptr, v >> 32);
494     stl_be_p((uint8_t *)ptr + 4, v);
495 }
496
497 /* float access */
498
499 static inline float32 ldfl_be_p(const void *ptr)
500 {
501     union {
502         float32 f;
503         uint32_t i;
504     } u;
505     u.i = ldl_be_p(ptr);
506     return u.f;
507 }
508
509 static inline void stfl_be_p(void *ptr, float32 v)
510 {
511     union {
512         float32 f;
513         uint32_t i;
514     } u;
515     u.f = v;
516     stl_be_p(ptr, u.i);
517 }
518
519 static inline float64 ldfq_be_p(const void *ptr)
520 {
521     CPU_DoubleU u;
522     u.l.upper = ldl_be_p(ptr);
523     u.l.lower = ldl_be_p((uint8_t *)ptr + 4);
524     return u.d;
525 }
526
527 static inline void stfq_be_p(void *ptr, float64 v)
528 {
529     CPU_DoubleU u;
530     u.d = v;
531     stl_be_p(ptr, u.l.upper);
532     stl_be_p((uint8_t *)ptr + 4, u.l.lower);
533 }
534
535 #else
536
537 static inline int lduw_be_p(const void *ptr)
538 {
539     return *(uint16_t *)ptr;
540 }
541
542 static inline int ldsw_be_p(const void *ptr)
543 {
544     return *(int16_t *)ptr;
545 }
546
547 static inline int ldl_be_p(const void *ptr)
548 {
549     return *(uint32_t *)ptr;
550 }
551
552 static inline uint64_t ldq_be_p(const void *ptr)
553 {
554     return *(uint64_t *)ptr;
555 }
556
557 static inline void stw_be_p(void *ptr, int v)
558 {
559     *(uint16_t *)ptr = v;
560 }
561
562 static inline void stl_be_p(void *ptr, int v)
563 {
564     *(uint32_t *)ptr = v;
565 }
566
567 static inline void stq_be_p(void *ptr, uint64_t v)
568 {
569     *(uint64_t *)ptr = v;
570 }
571
572 /* float access */
573
574 static inline float32 ldfl_be_p(const void *ptr)
575 {
576     return *(float32 *)ptr;
577 }
578
579 static inline float64 ldfq_be_p(const void *ptr)
580 {
581     return *(float64 *)ptr;
582 }
583
584 static inline void stfl_be_p(void *ptr, float32 v)
585 {
586     *(float32 *)ptr = v;
587 }
588
589 static inline void stfq_be_p(void *ptr, float64 v)
590 {
591     *(float64 *)ptr = v;
592 }
593
594 #endif
595
596 /* target CPU memory access functions */
597 #if defined(TARGET_WORDS_BIGENDIAN)
598 #define lduw_p(p) lduw_be_p(p)
599 #define ldsw_p(p) ldsw_be_p(p)
600 #define ldl_p(p) ldl_be_p(p)
601 #define ldq_p(p) ldq_be_p(p)
602 #define ldfl_p(p) ldfl_be_p(p)
603 #define ldfq_p(p) ldfq_be_p(p)
604 #define stw_p(p, v) stw_be_p(p, v)
605 #define stl_p(p, v) stl_be_p(p, v)
606 #define stq_p(p, v) stq_be_p(p, v)
607 #define stfl_p(p, v) stfl_be_p(p, v)
608 #define stfq_p(p, v) stfq_be_p(p, v)
609 #else
610 #define lduw_p(p) lduw_le_p(p)
611 #define ldsw_p(p) ldsw_le_p(p)
612 #define ldl_p(p) ldl_le_p(p)
613 #define ldq_p(p) ldq_le_p(p)
614 #define ldfl_p(p) ldfl_le_p(p)
615 #define ldfq_p(p) ldfq_le_p(p)
616 #define stw_p(p, v) stw_le_p(p, v)
617 #define stl_p(p, v) stl_le_p(p, v)
618 #define stq_p(p, v) stq_le_p(p, v)
619 #define stfl_p(p, v) stfl_le_p(p, v)
620 #define stfq_p(p, v) stfq_le_p(p, v)
621 #endif
622
623 /* MMU memory access macros */
624
625 #if defined(CONFIG_USER_ONLY)
626 #include <assert.h>
627 #include "qemu-types.h"
628
629 /* On some host systems the guest address space is reserved on the host.
630  * This allows the guest address space to be offset to a convenient location.
631  */
632 #if defined(CONFIG_USE_GUEST_BASE)
633 extern unsigned long guest_base;
634 #define GUEST_BASE guest_base
635 #else
636 #define GUEST_BASE 0
637 #endif
638
639 /* All direct uses of g2h and h2g need to go away for usermode softmmu.  */
640 #define g2h(x) ((void *)((unsigned long)(x) + GUEST_BASE))
641 #define h2g(x) ({ \
642     unsigned long __ret = (unsigned long)(x) - GUEST_BASE; \
643     /* Check if given address fits target address space */ \
644     assert(__ret == (abi_ulong)__ret); \
645     (abi_ulong)__ret; \
646 })
647 #define h2g_valid(x) ({ \
648     unsigned long __guest = (unsigned long)(x) - GUEST_BASE; \
649     (__guest == (abi_ulong)__guest); \
650 })
651
652 #define saddr(x) g2h(x)
653 #define laddr(x) g2h(x)
654
655 #else /* !CONFIG_USER_ONLY */
656 /* NOTE: we use double casts if pointers and target_ulong have
657    different sizes */
658 #define saddr(x) (uint8_t *)(long)(x)
659 #define laddr(x) (uint8_t *)(long)(x)
660 #endif
661
662 #define ldub_raw(p) ldub_p(laddr((p)))
663 #define ldsb_raw(p) ldsb_p(laddr((p)))
664 #define lduw_raw(p) lduw_p(laddr((p)))
665 #define ldsw_raw(p) ldsw_p(laddr((p)))
666 #define ldl_raw(p) ldl_p(laddr((p)))
667 #define ldq_raw(p) ldq_p(laddr((p)))
668 #define ldfl_raw(p) ldfl_p(laddr((p)))
669 #define ldfq_raw(p) ldfq_p(laddr((p)))
670 #define stb_raw(p, v) stb_p(saddr((p)), v)
671 #define stw_raw(p, v) stw_p(saddr((p)), v)
672 #define stl_raw(p, v) stl_p(saddr((p)), v)
673 #define stq_raw(p, v) stq_p(saddr((p)), v)
674 #define stfl_raw(p, v) stfl_p(saddr((p)), v)
675 #define stfq_raw(p, v) stfq_p(saddr((p)), v)
676
677
678 #if defined(CONFIG_USER_ONLY)
679
680 /* if user mode, no other memory access functions */
681 #define ldub(p) ldub_raw(p)
682 #define ldsb(p) ldsb_raw(p)
683 #define lduw(p) lduw_raw(p)
684 #define ldsw(p) ldsw_raw(p)
685 #define ldl(p) ldl_raw(p)
686 #define ldq(p) ldq_raw(p)
687 #define ldfl(p) ldfl_raw(p)
688 #define ldfq(p) ldfq_raw(p)
689 #define stb(p, v) stb_raw(p, v)
690 #define stw(p, v) stw_raw(p, v)
691 #define stl(p, v) stl_raw(p, v)
692 #define stq(p, v) stq_raw(p, v)
693 #define stfl(p, v) stfl_raw(p, v)
694 #define stfq(p, v) stfq_raw(p, v)
695
696 #define ldub_code(p) ldub_raw(p)
697 #define ldsb_code(p) ldsb_raw(p)
698 #define lduw_code(p) lduw_raw(p)
699 #define ldsw_code(p) ldsw_raw(p)
700 #define ldl_code(p) ldl_raw(p)
701 #define ldq_code(p) ldq_raw(p)
702
703 #define ldub_kernel(p) ldub_raw(p)
704 #define ldsb_kernel(p) ldsb_raw(p)
705 #define lduw_kernel(p) lduw_raw(p)
706 #define ldsw_kernel(p) ldsw_raw(p)
707 #define ldl_kernel(p) ldl_raw(p)
708 #define ldq_kernel(p) ldq_raw(p)
709 #define ldfl_kernel(p) ldfl_raw(p)
710 #define ldfq_kernel(p) ldfq_raw(p)
711 #define stb_kernel(p, v) stb_raw(p, v)
712 #define stw_kernel(p, v) stw_raw(p, v)
713 #define stl_kernel(p, v) stl_raw(p, v)
714 #define stq_kernel(p, v) stq_raw(p, v)
715 #define stfl_kernel(p, v) stfl_raw(p, v)
716 #define stfq_kernel(p, vt) stfq_raw(p, v)
717
718 #endif /* defined(CONFIG_USER_ONLY) */
719
720 /* page related stuff */
721
722 #define TARGET_PAGE_SIZE (1 << TARGET_PAGE_BITS)
723 #define TARGET_PAGE_MASK ~(TARGET_PAGE_SIZE - 1)
724 #define TARGET_PAGE_ALIGN(addr) (((addr) + TARGET_PAGE_SIZE - 1) & TARGET_PAGE_MASK)
725
726 /* ??? These should be the larger of unsigned long and target_ulong.  */
727 extern unsigned long qemu_real_host_page_size;
728 extern unsigned long qemu_host_page_bits;
729 extern unsigned long qemu_host_page_size;
730 extern unsigned long qemu_host_page_mask;
731
732 #define HOST_PAGE_ALIGN(addr) (((addr) + qemu_host_page_size - 1) & qemu_host_page_mask)
733
734 /* same as PROT_xxx */
735 #define PAGE_READ      0x0001
736 #define PAGE_WRITE     0x0002
737 #define PAGE_EXEC      0x0004
738 #define PAGE_BITS      (PAGE_READ | PAGE_WRITE | PAGE_EXEC)
739 #define PAGE_VALID     0x0008
740 /* original state of the write flag (used when tracking self-modifying
741    code */
742 #define PAGE_WRITE_ORG 0x0010
743 #define PAGE_RESERVED  0x0020
744
745 void page_dump(FILE *f);
746 int page_get_flags(target_ulong address);
747 void page_set_flags(target_ulong start, target_ulong end, int flags);
748 int page_check_range(target_ulong start, target_ulong len, int flags);
749
750 void cpu_exec_init_all(unsigned long tb_size);
751 CPUState *cpu_copy(CPUState *env);
752
753 void cpu_dump_state(CPUState *env, FILE *f,
754                     int (*cpu_fprintf)(FILE *f, const char *fmt, ...),
755                     int flags);
756 void cpu_dump_statistics (CPUState *env, FILE *f,
757                           int (*cpu_fprintf)(FILE *f, const char *fmt, ...),
758                           int flags);
759
760 void QEMU_NORETURN cpu_abort(CPUState *env, const char *fmt, ...)
761     __attribute__ ((__format__ (__printf__, 2, 3)));
762 extern CPUState *first_cpu;
763 extern CPUState *cpu_single_env;
764 extern int64_t qemu_icount;
765 extern int use_icount;
766
767 #define CPU_INTERRUPT_EXIT   0x01 /* wants exit from main loop */
768 #define CPU_INTERRUPT_HARD   0x02 /* hardware interrupt pending */
769 #define CPU_INTERRUPT_EXITTB 0x04 /* exit the current TB (use for x86 a20 case) */
770 #define CPU_INTERRUPT_TIMER  0x08 /* internal timer exception pending */
771 #define CPU_INTERRUPT_FIQ    0x10 /* Fast interrupt pending.  */
772 #define CPU_INTERRUPT_HALT   0x20 /* CPU halt wanted */
773 #define CPU_INTERRUPT_SMI    0x40 /* (x86 only) SMI interrupt pending */
774 #define CPU_INTERRUPT_DEBUG  0x80 /* Debug event occured.  */
775 #define CPU_INTERRUPT_VIRQ   0x100 /* virtual interrupt pending.  */
776 #define CPU_INTERRUPT_NMI    0x200 /* NMI pending. */
777
778 void cpu_interrupt(CPUState *s, int mask);
779 void cpu_reset_interrupt(CPUState *env, int mask);
780
781 /* Breakpoint/watchpoint flags */
782 #define BP_MEM_READ           0x01
783 #define BP_MEM_WRITE          0x02
784 #define BP_MEM_ACCESS         (BP_MEM_READ | BP_MEM_WRITE)
785 #define BP_STOP_BEFORE_ACCESS 0x04
786 #define BP_WATCHPOINT_HIT     0x08
787 #define BP_GDB                0x10
788 #define BP_CPU                0x20
789
790 int cpu_breakpoint_insert(CPUState *env, target_ulong pc, int flags,
791                           CPUBreakpoint **breakpoint);
792 int cpu_breakpoint_remove(CPUState *env, target_ulong pc, int flags);
793 void cpu_breakpoint_remove_by_ref(CPUState *env, CPUBreakpoint *breakpoint);
794 void cpu_breakpoint_remove_all(CPUState *env, int mask);
795 int cpu_watchpoint_insert(CPUState *env, target_ulong addr, target_ulong len,
796                           int flags, CPUWatchpoint **watchpoint);
797 int cpu_watchpoint_remove(CPUState *env, target_ulong addr,
798                           target_ulong len, int flags);
799 void cpu_watchpoint_remove_by_ref(CPUState *env, CPUWatchpoint *watchpoint);
800 void cpu_watchpoint_remove_all(CPUState *env, int mask);
801
802 #define SSTEP_ENABLE  0x1  /* Enable simulated HW single stepping */
803 #define SSTEP_NOIRQ   0x2  /* Do not use IRQ while single stepping */
804 #define SSTEP_NOTIMER 0x4  /* Do not Timers while single stepping */
805
806 void cpu_single_step(CPUState *env, int enabled);
807 void cpu_reset(CPUState *s);
808
809 /* Return the physical page corresponding to a virtual one. Use it
810    only for debugging because no protection checks are done. Return -1
811    if no page found. */
812 target_phys_addr_t cpu_get_phys_page_debug(CPUState *env, target_ulong addr);
813
814 #define CPU_LOG_TB_OUT_ASM (1 << 0)
815 #define CPU_LOG_TB_IN_ASM  (1 << 1)
816 #define CPU_LOG_TB_OP      (1 << 2)
817 #define CPU_LOG_TB_OP_OPT  (1 << 3)
818 #define CPU_LOG_INT        (1 << 4)
819 #define CPU_LOG_EXEC       (1 << 5)
820 #define CPU_LOG_PCALL      (1 << 6)
821 #define CPU_LOG_IOPORT     (1 << 7)
822 #define CPU_LOG_TB_CPU     (1 << 8)
823 #define CPU_LOG_RESET      (1 << 9)
824
825 /* define log items */
826 typedef struct CPULogItem {
827     int mask;
828     const char *name;
829     const char *help;
830 } CPULogItem;
831
832 extern const CPULogItem cpu_log_items[];
833
834 void cpu_set_log(int log_flags);
835 void cpu_set_log_filename(const char *filename);
836 int cpu_str_to_log_mask(const char *str);
837
838 /* IO ports API */
839
840 /* NOTE: as these functions may be even used when there is an isa
841    brige on non x86 targets, we always defined them */
842 #ifndef NO_CPU_IO_DEFS
843 void cpu_outb(CPUState *env, int addr, int val);
844 void cpu_outw(CPUState *env, int addr, int val);
845 void cpu_outl(CPUState *env, int addr, int val);
846 int cpu_inb(CPUState *env, int addr);
847 int cpu_inw(CPUState *env, int addr);
848 int cpu_inl(CPUState *env, int addr);
849 #endif
850
851 /* address in the RAM (different from a physical address) */
852 #ifdef USE_KQEMU
853 typedef uint32_t ram_addr_t;
854 #else
855 typedef unsigned long ram_addr_t;
856 #endif
857
858 /* memory API */
859
860 extern ram_addr_t phys_ram_size;
861 extern int phys_ram_fd;
862 extern uint8_t *phys_ram_base;
863 extern uint8_t *phys_ram_dirty;
864 extern ram_addr_t ram_size;
865
866 /* physical memory access */
867
868 /* MMIO pages are identified by a combination of an IO device index and
869    3 flags.  The ROMD code stores the page ram offset in iotlb entry, 
870    so only a limited number of ids are avaiable.  */
871
872 #define IO_MEM_SHIFT       3
873 #define IO_MEM_NB_ENTRIES  (1 << (TARGET_PAGE_BITS  - IO_MEM_SHIFT))
874
875 #define IO_MEM_RAM         (0 << IO_MEM_SHIFT) /* hardcoded offset */
876 #define IO_MEM_ROM         (1 << IO_MEM_SHIFT) /* hardcoded offset */
877 #define IO_MEM_UNASSIGNED  (2 << IO_MEM_SHIFT)
878 #define IO_MEM_NOTDIRTY    (3 << IO_MEM_SHIFT)
879
880 /* Acts like a ROM when read and like a device when written.  */
881 #define IO_MEM_ROMD        (1)
882 #define IO_MEM_SUBPAGE     (2)
883 #define IO_MEM_SUBWIDTH    (4)
884
885 /* Flags stored in the low bits of the TLB virtual address.  These are
886    defined so that fast path ram access is all zeros.  */
887 /* Zero if TLB entry is valid.  */
888 #define TLB_INVALID_MASK   (1 << 3)
889 /* Set if TLB entry references a clean RAM page.  The iotlb entry will
890    contain the page physical address.  */
891 #define TLB_NOTDIRTY    (1 << 4)
892 /* Set if TLB entry is an IO callback.  */
893 #define TLB_MMIO        (1 << 5)
894
895 typedef void CPUWriteMemoryFunc(void *opaque, target_phys_addr_t addr, uint32_t value);
896 typedef uint32_t CPUReadMemoryFunc(void *opaque, target_phys_addr_t addr);
897
898 void cpu_register_physical_memory_offset(target_phys_addr_t start_addr,
899                                          ram_addr_t size,
900                                          ram_addr_t phys_offset,
901                                          ram_addr_t region_offset);
902 static inline void cpu_register_physical_memory(target_phys_addr_t start_addr,
903                                                 ram_addr_t size,
904                                                 ram_addr_t phys_offset)
905 {
906     cpu_register_physical_memory_offset(start_addr, size, phys_offset, 0);
907 }
908
909 ram_addr_t cpu_get_physical_page_desc(target_phys_addr_t addr);
910 ram_addr_t qemu_ram_alloc(ram_addr_t);
911 void qemu_ram_free(ram_addr_t addr);
912 int cpu_register_io_memory(int io_index,
913                            CPUReadMemoryFunc **mem_read,
914                            CPUWriteMemoryFunc **mem_write,
915                            void *opaque);
916 void cpu_unregister_io_memory(int table_address);
917 CPUWriteMemoryFunc **cpu_get_io_memory_write(int io_index);
918 CPUReadMemoryFunc **cpu_get_io_memory_read(int io_index);
919
920 void cpu_physical_memory_rw(target_phys_addr_t addr, uint8_t *buf,
921                             int len, int is_write);
922 static inline void cpu_physical_memory_read(target_phys_addr_t addr,
923                                             uint8_t *buf, int len)
924 {
925     cpu_physical_memory_rw(addr, buf, len, 0);
926 }
927 static inline void cpu_physical_memory_write(target_phys_addr_t addr,
928                                              const uint8_t *buf, int len)
929 {
930     cpu_physical_memory_rw(addr, (uint8_t *)buf, len, 1);
931 }
932 void *cpu_physical_memory_map(target_phys_addr_t addr,
933                               target_phys_addr_t *plen,
934                               int is_write);
935 void cpu_physical_memory_unmap(void *buffer, target_phys_addr_t len,
936                                int is_write, target_phys_addr_t access_len);
937 void *cpu_register_map_client(void *opaque, void (*callback)(void *opaque));
938 void cpu_unregister_map_client(void *cookie);
939
940 uint32_t ldub_phys(target_phys_addr_t addr);
941 uint32_t lduw_phys(target_phys_addr_t addr);
942 uint32_t ldl_phys(target_phys_addr_t addr);
943 uint64_t ldq_phys(target_phys_addr_t addr);
944 void stl_phys_notdirty(target_phys_addr_t addr, uint32_t val);
945 void stq_phys_notdirty(target_phys_addr_t addr, uint64_t val);
946 void stb_phys(target_phys_addr_t addr, uint32_t val);
947 void stw_phys(target_phys_addr_t addr, uint32_t val);
948 void stl_phys(target_phys_addr_t addr, uint32_t val);
949 void stq_phys(target_phys_addr_t addr, uint64_t val);
950
951 void cpu_physical_memory_write_rom(target_phys_addr_t addr,
952                                    const uint8_t *buf, int len);
953 int cpu_memory_rw_debug(CPUState *env, target_ulong addr,
954                         uint8_t *buf, int len, int is_write);
955
956 #define VGA_DIRTY_FLAG       0x01
957 #define CODE_DIRTY_FLAG      0x02
958 #define KQEMU_DIRTY_FLAG     0x04
959 #define MIGRATION_DIRTY_FLAG 0x08
960
961 /* read dirty bit (return 0 or 1) */
962 static inline int cpu_physical_memory_is_dirty(ram_addr_t addr)
963 {
964     return phys_ram_dirty[addr >> TARGET_PAGE_BITS] == 0xff;
965 }
966
967 static inline int cpu_physical_memory_get_dirty(ram_addr_t addr,
968                                                 int dirty_flags)
969 {
970     return phys_ram_dirty[addr >> TARGET_PAGE_BITS] & dirty_flags;
971 }
972
973 static inline void cpu_physical_memory_set_dirty(ram_addr_t addr)
974 {
975     phys_ram_dirty[addr >> TARGET_PAGE_BITS] = 0xff;
976 }
977
978 void cpu_physical_memory_reset_dirty(ram_addr_t start, ram_addr_t end,
979                                      int dirty_flags);
980 void cpu_tlb_update_dirty(CPUState *env);
981
982 int cpu_physical_memory_set_dirty_tracking(int enable);
983
984 int cpu_physical_memory_get_dirty_tracking(void);
985
986 void cpu_physical_sync_dirty_bitmap(target_phys_addr_t start_addr, target_phys_addr_t end_addr);
987
988 void dump_exec_info(FILE *f,
989                     int (*cpu_fprintf)(FILE *f, const char *fmt, ...));
990
991 /* Coalesced MMIO regions are areas where write operations can be reordered.
992  * This usually implies that write operations are side-effect free.  This allows
993  * batching which can make a major impact on performance when using
994  * virtualization.
995  */
996 void qemu_register_coalesced_mmio(target_phys_addr_t addr, ram_addr_t size);
997
998 void qemu_unregister_coalesced_mmio(target_phys_addr_t addr, ram_addr_t size);
999
1000 /*******************************************/
1001 /* host CPU ticks (if available) */
1002
1003 #if defined(_ARCH_PPC)
1004
1005 static inline int64_t cpu_get_real_ticks(void)
1006 {
1007     int64_t retval;
1008 #ifdef _ARCH_PPC64
1009     /* This reads timebase in one 64bit go and includes Cell workaround from:
1010        http://ozlabs.org/pipermail/linuxppc-dev/2006-October/027052.html
1011      */
1012     __asm__ __volatile__ (
1013         "mftb    %0\n\t"
1014         "cmpwi   %0,0\n\t"
1015         "beq-    $-8"
1016         : "=r" (retval));
1017 #else
1018     /* http://ozlabs.org/pipermail/linuxppc-dev/1999-October/003889.html */
1019     unsigned long junk;
1020     __asm__ __volatile__ (
1021         "mftbu   %1\n\t"
1022         "mftb    %L0\n\t"
1023         "mftbu   %0\n\t"
1024         "cmpw    %0,%1\n\t"
1025         "bne     $-16"
1026         : "=r" (retval), "=r" (junk));
1027 #endif
1028     return retval;
1029 }
1030
1031 #elif defined(__i386__)
1032
1033 static inline int64_t cpu_get_real_ticks(void)
1034 {
1035     int64_t val;
1036     asm volatile ("rdtsc" : "=A" (val));
1037     return val;
1038 }
1039
1040 #elif defined(__x86_64__)
1041
1042 static inline int64_t cpu_get_real_ticks(void)
1043 {
1044     uint32_t low,high;
1045     int64_t val;
1046     asm volatile("rdtsc" : "=a" (low), "=d" (high));
1047     val = high;
1048     val <<= 32;
1049     val |= low;
1050     return val;
1051 }
1052
1053 #elif defined(__hppa__)
1054
1055 static inline int64_t cpu_get_real_ticks(void)
1056 {
1057     int val;
1058     asm volatile ("mfctl %%cr16, %0" : "=r"(val));
1059     return val;
1060 }
1061
1062 #elif defined(__ia64)
1063
1064 static inline int64_t cpu_get_real_ticks(void)
1065 {
1066         int64_t val;
1067         asm volatile ("mov %0 = ar.itc" : "=r"(val) :: "memory");
1068         return val;
1069 }
1070
1071 #elif defined(__s390__)
1072
1073 static inline int64_t cpu_get_real_ticks(void)
1074 {
1075     int64_t val;
1076     asm volatile("stck 0(%1)" : "=m" (val) : "a" (&val) : "cc");
1077     return val;
1078 }
1079
1080 #elif defined(__sparc_v8plus__) || defined(__sparc_v8plusa__) || defined(__sparc_v9__)
1081
1082 static inline int64_t cpu_get_real_ticks (void)
1083 {
1084 #if     defined(_LP64)
1085         uint64_t        rval;
1086         asm volatile("rd %%tick,%0" : "=r"(rval));
1087         return rval;
1088 #else
1089         union {
1090                 uint64_t i64;
1091                 struct {
1092                         uint32_t high;
1093                         uint32_t low;
1094                 }       i32;
1095         } rval;
1096         asm volatile("rd %%tick,%1; srlx %1,32,%0"
1097                 : "=r"(rval.i32.high), "=r"(rval.i32.low));
1098         return rval.i64;
1099 #endif
1100 }
1101
1102 #elif defined(__mips__)
1103
1104 static inline int64_t cpu_get_real_ticks(void)
1105 {
1106 #if __mips_isa_rev >= 2
1107     uint32_t count;
1108     static uint32_t cyc_per_count = 0;
1109
1110     if (!cyc_per_count)
1111         __asm__ __volatile__("rdhwr %0, $3" : "=r" (cyc_per_count));
1112
1113     __asm__ __volatile__("rdhwr %1, $2" : "=r" (count));
1114     return (int64_t)(count * cyc_per_count);
1115 #else
1116     /* FIXME */
1117     static int64_t ticks = 0;
1118     return ticks++;
1119 #endif
1120 }
1121
1122 #else
1123 /* The host CPU doesn't have an easily accessible cycle counter.
1124    Just return a monotonically increasing value.  This will be
1125    totally wrong, but hopefully better than nothing.  */
1126 static inline int64_t cpu_get_real_ticks (void)
1127 {
1128     static int64_t ticks = 0;
1129     return ticks++;
1130 }
1131 #endif
1132
1133 /* profiling */
1134 #ifdef CONFIG_PROFILER
1135 static inline int64_t profile_getclock(void)
1136 {
1137     return cpu_get_real_ticks();
1138 }
1139
1140 extern int64_t kqemu_time, kqemu_time_start;
1141 extern int64_t qemu_time, qemu_time_start;
1142 extern int64_t tlb_flush_time;
1143 extern int64_t kqemu_exec_count;
1144 extern int64_t dev_time;
1145 extern int64_t kqemu_ret_int_count;
1146 extern int64_t kqemu_ret_excp_count;
1147 extern int64_t kqemu_ret_intr_count;
1148 #endif
1149
1150 #endif /* CPU_ALL_H */