Annotation of qemu/exec-all.h, revision 1.1.1.14

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

unix.superglobalmegacorp.com