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, see <http://www.gnu.org/licenses/>.
  18  */
  19
  20 #ifndef _EXEC_ALL_H_
  21 #define _EXEC_ALL_H_
  22
  23 #include "qemu-common.h"
  24
  25 /* allow to see translation results - the slowdown should be negligible, so we leave it */
  26 #define DEBUG_DISAS
  27
  28 /* Page tracking code uses ram addresses in system mode, and virtual
  29    addresses in userspace mode.  Define tb_page_addr_t to be an appropriate
  30    type.  */
  31 #if defined(CONFIG_USER_ONLY)
  32 typedef abi_ulong tb_page_addr_t;
  33 #else
  34 typedef ram_addr_t tb_page_addr_t;
  35 #endif
  36
  37 /* is_jmp field values */
  38 #define DISAS_NEXT    0 /* next instruction can be analyzed */
  39 #define DISAS_JUMP    1 /* only pc was modified dynamically */
  40 #define DISAS_UPDATE  2 /* cpu state was modified dynamically */
  41 #define DISAS_TB_JUMP 3 /* only pc was modified statically */
  42
  43 typedef struct TranslationBlock TranslationBlock;
  44
  45 /* XXX: make safe guess about sizes */
  46 #define MAX_OP_PER_INSTR 96
  47 /* A Call op needs up to 6 + 2N parameters (N = number of arguments).  */
  48 #define MAX_OPC_PARAM 10
  49 #define OPC_BUF_SIZE 640
  50 #define OPC_MAX_SIZE (OPC_BUF_SIZE - MAX_OP_PER_INSTR)
  51
  52 /* Maximum size a TCG op can expand to.  This is complicated because a
  53    single op may require several host instructions and register reloads.
  54    For now take a wild guess at 192 bytes, which should allow at least
  55    a couple of fixup instructions per argument.  */
  56 #define TCG_MAX_OP_SIZE 192
  57
  58 #define OPPARAM_BUF_SIZE (OPC_BUF_SIZE * MAX_OPC_PARAM)
  59
  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 uint16_t gen_opc_icount[OPC_BUF_SIZE];
  65 extern target_ulong gen_opc_jump_pc[2];
  66 extern uint32_t gen_opc_hflags[OPC_BUF_SIZE];
  67
  68 #include "qemu-log.h"
  69
  70 void gen_intermediate_code(CPUState *env, struct TranslationBlock *tb);
  71 void gen_intermediate_code_pc(CPUState *env, struct TranslationBlock *tb);
  72 void gen_pc_load(CPUState *env, struct TranslationBlock *tb,
  73                  unsigned long searched_pc, int pc_pos, void *puc);
  74
  75 unsigned long code_gen_max_block_size(void);
  76 void cpu_gen_init(void);
  77 int cpu_gen_code(CPUState *env, struct TranslationBlock *tb,
  78                  int *gen_code_size_ptr);
  79 int cpu_restore_state(struct TranslationBlock *tb,
  80                       CPUState *env, unsigned long searched_pc,
  81                       void *puc);
  82 int cpu_restore_state_copy(struct TranslationBlock *tb,
  83                            CPUState *env, unsigned long searched_pc,
  84                            void *puc);
  85 void cpu_resume_from_signal(CPUState *env1, void *puc);
  86 void cpu_io_recompile(CPUState *env, void *retaddr);
  87 TranslationBlock *tb_gen_code(CPUState *env,
  88                               target_ulong pc, target_ulong cs_base, int flags,
  89                               int cflags);
  90 void cpu_exec_init(CPUState *env);
  91 void QEMU_NORETURN cpu_loop_exit(void);
  92 int page_unprotect(target_ulong address, unsigned long pc, void *puc);
  93 void tb_invalidate_phys_page_range(tb_page_addr_t start, tb_page_addr_t end,
  94                                    int is_cpu_write_access);
  95 void tb_invalidate_page_range(target_ulong start, target_ulong end);
  96 void tlb_flush_page(CPUState *env, target_ulong addr);
  97 void tlb_flush(CPUState *env, int flush_global);
  98 #if !defined(CONFIG_USER_ONLY)
  99 void tlb_set_page(CPUState *env, target_ulong vaddr,
 100                   target_phys_addr_t paddr, int prot,
 101                   int mmu_idx, target_ulong size);
 102 #endif
 103
 104 #define CODE_GEN_ALIGN           16 /* must be >= of the size of a icache line */
 105
 106 #define CODE_GEN_PHYS_HASH_BITS     15
 107 #define CODE_GEN_PHYS_HASH_SIZE     (1 << CODE_GEN_PHYS_HASH_BITS)
 108
 109 #define MIN_CODE_GEN_BUFFER_SIZE     (1024 * 1024)
 110
 111 /* estimated block size for TB allocation */
 112 /* XXX: use a per code average code fragment size and modulate it
 113    according to the host CPU */
 114 #if defined(CONFIG_SOFTMMU)
 115 #define CODE_GEN_AVG_BLOCK_SIZE 128
 116 #else
 117 #define CODE_GEN_AVG_BLOCK_SIZE 64
 118 #endif
 119
 120 #if defined(_ARCH_PPC) || defined(__x86_64__) || defined(__arm__) || defined(__i386__)
 121 #define USE_DIRECT_JUMP
 122 #endif
 123
 124 struct TranslationBlock {
 125     target_ulong pc;   /* simulated PC corresponding to this block (EIP + CS base) */
 126     target_ulong cs_base; /* CS base for this block */
 127     uint64_t flags; /* flags defining in which context the code was generated */
 128     uint16_t size;      /* size of target code for this block (1 <=
 129                            size <= TARGET_PAGE_SIZE) */
 130     uint16_t cflags;    /* compile flags */
 131 #define CF_COUNT_MASK  0x7fff
 132 #define CF_LAST_IO     0x8000 /* Last insn may be an IO access.  */
 133
 134     uint8_t *tc_ptr;    /* pointer to the translated code */
 135     /* next matching tb for physical address. */
 136     struct TranslationBlock *phys_hash_next;
 137     /* first and second physical page containing code. The lower bit
 138        of the pointer tells the index in page_next[] */
 139     struct TranslationBlock *page_next[2];
 140     tb_page_addr_t page_addr[2];
 141
 142     /* the following data are used to directly call another TB from
 143        the code of this one. */
 144     uint16_t tb_next_offset[2]; /* offset of original jump target */
 145 #ifdef USE_DIRECT_JUMP
 146     uint16_t tb_jmp_offset[4]; /* offset of jump instruction */
 147 #else
 148     unsigned long tb_next[2]; /* address of jump generated code */
 149 #endif
 150     /* list of TBs jumping to this one. This is a circular list using
 151        the two least significant bits of the pointers to tell what is
 152        the next pointer: 0 = jmp_next[0], 1 = jmp_next[1], 2 =
 153        jmp_first */
 154     struct TranslationBlock *jmp_next[2];
 155     struct TranslationBlock *jmp_first;
 156     uint32_t icount;
 157 };
 158
 159 static inline unsigned int tb_jmp_cache_hash_page(target_ulong pc)
 160 {
 161     target_ulong tmp;
 162     tmp = pc ^ (pc >> (TARGET_PAGE_BITS - TB_JMP_PAGE_BITS));
 163     return (tmp >> (TARGET_PAGE_BITS - TB_JMP_PAGE_BITS)) & TB_JMP_PAGE_MASK;
 164 }
 165
 166 static inline unsigned int tb_jmp_cache_hash_func(target_ulong pc)
 167 {
 168     target_ulong tmp;
 169     tmp = pc ^ (pc >> (TARGET_PAGE_BITS - TB_JMP_PAGE_BITS));
 170     return (((tmp >> (TARGET_PAGE_BITS - TB_JMP_PAGE_BITS)) & TB_JMP_PAGE_MASK)
 171             | (tmp & TB_JMP_ADDR_MASK));
 172 }
 173
 174 static inline unsigned int tb_phys_hash_func(tb_page_addr_t pc)
 175 {
 176     return pc & (CODE_GEN_PHYS_HASH_SIZE - 1);
 177 }
 178
 179 TranslationBlock *tb_alloc(target_ulong pc);
 180 void tb_free(TranslationBlock *tb);
 181 void tb_flush(CPUState *env);
 182 void tb_link_page(TranslationBlock *tb,
 183                   tb_page_addr_t phys_pc, tb_page_addr_t phys_page2);
 184 void tb_phys_invalidate(TranslationBlock *tb, tb_page_addr_t page_addr);
 185
 186 extern TranslationBlock *tb_phys_hash[CODE_GEN_PHYS_HASH_SIZE];
 187 extern uint8_t *code_gen_ptr;
 188 extern int code_gen_max_blocks;
 189
 190 #if defined(USE_DIRECT_JUMP)
 191
 192 #if defined(_ARCH_PPC)
 193 extern void ppc_tb_set_jmp_target(unsigned long jmp_addr, unsigned long addr);
 194 #define tb_set_jmp_target1 ppc_tb_set_jmp_target
 195 #elif defined(__i386__) || defined(__x86_64__)
 196 static inline void tb_set_jmp_target1(unsigned long jmp_addr, unsigned long addr)
 197 {
 198     /* patch the branch destination */
 199     *(uint32_t *)jmp_addr = addr - (jmp_addr + 4);
 200     /* no need to flush icache explicitly */
 201 }
 202 #elif defined(__arm__)
 203 static inline void tb_set_jmp_target1(unsigned long jmp_addr, unsigned long addr)
 204 {
 205 #if QEMU_GNUC_PREREQ(4, 1)
 206     void __clear_cache(char *beg, char *end);
 207 #else
 208     register unsigned long _beg __asm ("a1");
 209     register unsigned long _end __asm ("a2");
 210     register unsigned long _flg __asm ("a3");
 211 #endif
 212
 213     /* we could use a ldr pc, [pc, #-4] kind of branch and avoid the flush */
 214     *(uint32_t *)jmp_addr =
 215         (*(uint32_t *)jmp_addr & ~0xffffff)
 216         | (((addr - (jmp_addr + 8)) >> 2) & 0xffffff);
 217
 218 #if QEMU_GNUC_PREREQ(4, 1)
 219     __clear_cache((char *) jmp_addr, (char *) jmp_addr + 4);
 220 #else
 221     /* flush icache */
 222     _beg = jmp_addr;
 223     _end = jmp_addr + 4;
 224     _flg = 0;
 225     __asm __volatile__ ("swi 0x9f0002" : : "r" (_beg), "r" (_end), "r" (_flg));
 226 #endif
 227 }
 228 #endif
 229
 230 static inline void tb_set_jmp_target(TranslationBlock *tb,
 231                                      int n, unsigned long addr)
 232 {
 233     unsigned long offset;
 234
 235     offset = tb->tb_jmp_offset[n];
 236     tb_set_jmp_target1((unsigned long)(tb->tc_ptr + offset), addr);
 237     offset = tb->tb_jmp_offset[n + 2];
 238     if (offset != 0xffff)
 239         tb_set_jmp_target1((unsigned long)(tb->tc_ptr + offset), addr);
 240 }
 241
 242 #else
 243
 244 /* set the jump target */
 245 static inline void tb_set_jmp_target(TranslationBlock *tb,
 246                                      int n, unsigned long addr)
 247 {
 248     tb->tb_next[n] = addr;
 249 }
 250
 251 #endif
 252
 253 static inline void tb_add_jump(TranslationBlock *tb, int n,
 254                                TranslationBlock *tb_next)
 255 {
 256     /* NOTE: this test is only needed for thread safety */
 257     if (!tb->jmp_next[n]) {
 258         /* patch the native jump address */
 259         tb_set_jmp_target(tb, n, (unsigned long)tb_next->tc_ptr);
 260
 261         /* add in TB jmp circular list */
 262         tb->jmp_next[n] = tb_next->jmp_first;
 263         tb_next->jmp_first = (TranslationBlock *)((long)(tb) | (n));
 264     }
 265 }
 266
 267 TranslationBlock *tb_find_pc(unsigned long pc_ptr);
 268
 269 #include "qemu-lock.h"
 270
 271 extern spinlock_t tb_lock;
 272
 273 extern int tb_invalidated_flag;
 274
 275 #if !defined(CONFIG_USER_ONLY)
 276
 277 extern CPUWriteMemoryFunc *io_mem_write[IO_MEM_NB_ENTRIES][4];
 278 extern CPUReadMemoryFunc *io_mem_read[IO_MEM_NB_ENTRIES][4];
 279 extern void *io_mem_opaque[IO_MEM_NB_ENTRIES];
 280
 281 void tlb_fill(target_ulong addr, int is_write, int mmu_idx,
 282               void *retaddr);
 283
 284 #include "softmmu_defs.h"
 285
 286 #define ACCESS_TYPE (NB_MMU_MODES + 1)
 287 #define MEMSUFFIX _code
 288 #define env cpu_single_env
 289
 290 #define DATA_SIZE 1
 291 #include "softmmu_header.h"
 292
 293 #define DATA_SIZE 2
 294 #include "softmmu_header.h"
 295
 296 #define DATA_SIZE 4
 297 #include "softmmu_header.h"
 298
 299 #define DATA_SIZE 8
 300 #include "softmmu_header.h"
 301
 302 #undef ACCESS_TYPE
 303 #undef MEMSUFFIX
 304 #undef env
 305
 306 #endif
 307
 308 #if defined(CONFIG_USER_ONLY)
 309 static inline tb_page_addr_t get_page_addr_code(CPUState *env1, target_ulong addr)
 310 {
 311     return addr;
 312 }
 313 #else
 314 /* NOTE: this function can trigger an exception */
 315 /* NOTE2: the returned address is not exactly the physical address: it
 316    is the offset relative to phys_ram_base */
 317 static inline tb_page_addr_t get_page_addr_code(CPUState *env1, target_ulong addr)
 318 {
 319     int mmu_idx, page_index, pd;
 320     void *p;
 321
 322     page_index = (addr >> TARGET_PAGE_BITS) & (CPU_TLB_SIZE - 1);
 323     mmu_idx = cpu_mmu_index(env1);
 324     if (unlikely(env1->tlb_table[mmu_idx][page_index].addr_code !=
 325                  (addr & TARGET_PAGE_MASK))) {
 326         ldub_code(addr);
 327     }
 328     pd = env1->tlb_table[mmu_idx][page_index].addr_code & ~TARGET_PAGE_MASK;
 329     if (pd > IO_MEM_ROM && !(pd & IO_MEM_ROMD)) {
 330 #if defined(TARGET_SPARC) || defined(TARGET_MIPS)
 331         do_unassigned_access(addr, 0, 1, 0, 4);
 332 #else
 333         cpu_abort(env1, "Trying to execute code outside RAM or ROM at 0x" TARGET_FMT_lx "\n", addr);
 334 #endif
 335     }
 336     p = (void *)(unsigned long)addr
 337         + env1->tlb_table[mmu_idx][page_index].addend;
 338     return qemu_ram_addr_from_host(p);
 339 }
 340
 341 /* Deterministic execution requires that IO only be performed on the last
 342    instruction of a TB so that interrupts take effect immediately.  */
 343 static inline int can_do_io(CPUState *env)
 344 {
 345     if (!use_icount)
 346         return 1;
 347
 348     /* If not executing code then assume we are ok.  */
 349     if (!env->current_tb)
 350         return 1;
 351
 352     return env->can_do_io != 0;
 353 }
 354 #endif
 355
 356 typedef void (CPUDebugExcpHandler)(CPUState *env);
 357
 358 CPUDebugExcpHandler *cpu_set_debug_excp_handler(CPUDebugExcpHandler *handler);
 359
 360 /* vl.c */
 361 extern int singlestep;
 362
 363 #endif