exec-all.h 13 KB
Newer Older
1 2
/*
 * internal execution defines for qemu
3
 *
4 5 6 7 8 9 10 11 12 13 14 15 16
 *  Copyright (c) 2003 Fabrice Bellard
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * 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 21
#ifndef _EXEC_ALL_H_
#define _EXEC_ALL_H_
22 23 24

#include "qemu-common.h"

bellard's avatar
bellard committed
25
/* allow to see translation results - the slowdown should be negligible, so we leave it */
26
#define DEBUG_DISAS
bellard's avatar
bellard committed
27

Paul Brook's avatar
Paul Brook committed
28 29 30 31
/* Page tracking code uses ram addresses in system mode, and virtual
   addresses in userspace mode.  Define tb_page_addr_t to be an appropriate
   type.  */
#if defined(CONFIG_USER_ONLY)
32
typedef abi_ulong tb_page_addr_t;
Paul Brook's avatar
Paul Brook committed
33 34 35 36
#else
typedef ram_addr_t tb_page_addr_t;
#endif

bellard's avatar
bellard committed
37 38 39 40 41 42
/* is_jmp field values */
#define DISAS_NEXT    0 /* next instruction can be analyzed */
#define DISAS_JUMP    1 /* only pc was modified dynamically */
#define DISAS_UPDATE  2 /* cpu state was modified dynamically */
#define DISAS_TB_JUMP 3 /* only pc was modified statically */

43
struct TranslationBlock;
pbrook's avatar
pbrook committed
44
typedef struct TranslationBlock TranslationBlock;
bellard's avatar
bellard committed
45 46

/* XXX: make safe guess about sizes */
47
#define MAX_OP_PER_INSTR 208
48 49 50 51 52 53

#if HOST_LONG_BITS == 32
#define MAX_OPC_PARAM_PER_ARG 2
#else
#define MAX_OPC_PARAM_PER_ARG 1
#endif
54
#define MAX_OPC_PARAM_IARGS 5
55 56 57 58 59 60 61
#define MAX_OPC_PARAM_OARGS 1
#define MAX_OPC_PARAM_ARGS (MAX_OPC_PARAM_IARGS + MAX_OPC_PARAM_OARGS)

/* A Call op needs up to 4 + 2N parameters on 32-bit archs,
 * and up to 4 + N parameters on 64-bit archs
 * (N = number of input arguments + output arguments).  */
#define MAX_OPC_PARAM (4 + (MAX_OPC_PARAM_PER_ARG * MAX_OPC_PARAM_ARGS))
62
#define OPC_BUF_SIZE 640
bellard's avatar
bellard committed
63 64
#define OPC_MAX_SIZE (OPC_BUF_SIZE - MAX_OP_PER_INSTR)

pbrook's avatar
pbrook committed
65
/* Maximum size a TCG op can expand to.  This is complicated because a
66 67
   single op may require several host instructions and register reloads.
   For now take a wild guess at 192 bytes, which should allow at least
pbrook's avatar
pbrook committed
68
   a couple of fixup instructions per argument.  */
69
#define TCG_MAX_OP_SIZE 192
pbrook's avatar
pbrook committed
70

pbrook's avatar
pbrook committed
71
#define OPPARAM_BUF_SIZE (OPC_BUF_SIZE * MAX_OPC_PARAM)
bellard's avatar
bellard committed
72

73
#include "qemu/log.h"
bellard's avatar
bellard committed
74

75 76 77
void gen_intermediate_code(CPUArchState *env, struct TranslationBlock *tb);
void gen_intermediate_code_pc(CPUArchState *env, struct TranslationBlock *tb);
void restore_state_to_opc(CPUArchState *env, struct TranslationBlock *tb,
78
                          int pc_pos);
aurel32's avatar
aurel32 committed
79

bellard's avatar
bellard committed
80
void cpu_gen_init(void);
81
int cpu_gen_code(CPUArchState *env, struct TranslationBlock *tb,
82
                 int *gen_code_size_ptr);
83
bool cpu_restore_state(CPUArchState *env, uintptr_t searched_pc);
84
void page_size_init(void);
85

86
void QEMU_NORETURN cpu_resume_from_signal(CPUArchState *env1, void *puc);
87
void QEMU_NORETURN cpu_io_recompile(CPUArchState *env, uintptr_t retaddr);
88
TranslationBlock *tb_gen_code(CPUArchState *env, 
pbrook's avatar
pbrook committed
89 90
                              target_ulong pc, target_ulong cs_base, int flags,
                              int cflags);
91 92
void cpu_exec_init(CPUArchState *env);
void QEMU_NORETURN cpu_loop_exit(CPUArchState *env1);
93
int page_unprotect(target_ulong address, uintptr_t pc, void *puc);
Paul Brook's avatar
Paul Brook committed
94
void tb_invalidate_phys_page_range(tb_page_addr_t start, tb_page_addr_t end,
95
                                   int is_cpu_write_access);
96 97
void tb_invalidate_phys_range(tb_page_addr_t start, tb_page_addr_t end,
                              int is_cpu_write_access);
98 99
#if !defined(CONFIG_USER_ONLY)
/* cputlb.c */
100 101 102
void tlb_flush_page(CPUArchState *env, target_ulong addr);
void tlb_flush(CPUArchState *env, int flush_global);
void tlb_set_page(CPUArchState *env, target_ulong vaddr,
103
                  hwaddr paddr, int prot,
Paul Brook's avatar
Paul Brook committed
104
                  int mmu_idx, target_ulong size);
105
void tb_invalidate_phys_addr(AddressSpace *as, hwaddr addr);
106 107 108 109 110 111 112 113
#else
static inline void tlb_flush_page(CPUArchState *env, target_ulong addr)
{
}

static inline void tlb_flush(CPUArchState *env, int flush_global)
{
}
114
#endif
115 116 117

#define CODE_GEN_ALIGN           16 /* must be >= of the size of a icache line */

118 119 120 121 122 123 124 125 126 127 128 129
#define CODE_GEN_PHYS_HASH_BITS     15
#define CODE_GEN_PHYS_HASH_SIZE     (1 << CODE_GEN_PHYS_HASH_BITS)

/* estimated block size for TB allocation */
/* XXX: use a per code average code fragment size and modulate it
   according to the host CPU */
#if defined(CONFIG_SOFTMMU)
#define CODE_GEN_AVG_BLOCK_SIZE 128
#else
#define CODE_GEN_AVG_BLOCK_SIZE 64
#endif

130 131
#if defined(__arm__) || defined(_ARCH_PPC) \
    || defined(__x86_64__) || defined(__i386__) \
132
    || defined(__sparc__) || defined(__aarch64__) \
133
    || defined(CONFIG_TCG_INTERPRETER)
134
#define USE_DIRECT_JUMP
135 136
#endif

pbrook's avatar
pbrook committed
137
struct TranslationBlock {
138 139
    target_ulong pc;   /* simulated PC corresponding to this block (EIP + CS base) */
    target_ulong cs_base; /* CS base for this block */
140
    uint64_t flags; /* flags defining in which context the code was generated */
141 142
    uint16_t size;      /* size of target code for this block (1 <=
                           size <= TARGET_PAGE_SIZE) */
bellard's avatar
bellard committed
143
    uint16_t cflags;    /* compile flags */
pbrook's avatar
pbrook committed
144 145
#define CF_COUNT_MASK  0x7fff
#define CF_LAST_IO     0x8000 /* Last insn may be an IO access.  */
bellard's avatar
bellard committed
146

147
    uint8_t *tc_ptr;    /* pointer to the translated code */
148
    /* next matching tb for physical address. */
149
    struct TranslationBlock *phys_hash_next;
150 151
    /* first and second physical page containing code. The lower bit
       of the pointer tells the index in page_next[] */
152
    struct TranslationBlock *page_next[2];
Paul Brook's avatar
Paul Brook committed
153
    tb_page_addr_t page_addr[2];
154

155 156 157 158
    /* the following data are used to directly call another TB from
       the code of this one. */
    uint16_t tb_next_offset[2]; /* offset of original jump target */
#ifdef USE_DIRECT_JUMP
159
    uint16_t tb_jmp_offset[2]; /* offset of jump instruction */
160
#else
161
    uintptr_t tb_next[2]; /* address of jump generated code */
162 163 164 165 166
#endif
    /* list of TBs jumping to this one. This is a circular list using
       the two least significant bits of the pointers to tell what is
       the next pointer: 0 = jmp_next[0], 1 = jmp_next[1], 2 =
       jmp_first */
167
    struct TranslationBlock *jmp_next[2];
168
    struct TranslationBlock *jmp_first;
pbrook's avatar
pbrook committed
169 170
    uint32_t icount;
};
171

172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190
#include "exec/spinlock.h"

typedef struct TBContext TBContext;

struct TBContext {

    TranslationBlock *tbs;
    TranslationBlock *tb_phys_hash[CODE_GEN_PHYS_HASH_SIZE];
    int nb_tbs;
    /* any access to the tbs or the page table must use this lock */
    spinlock_t tb_lock;

    /* statistics */
    int tb_flush_count;
    int tb_phys_invalidate_count;

    int tb_invalidated_flag;
};

191 192 193 194
static inline unsigned int tb_jmp_cache_hash_page(target_ulong pc)
{
    target_ulong tmp;
    tmp = pc ^ (pc >> (TARGET_PAGE_BITS - TB_JMP_PAGE_BITS));
195
    return (tmp >> (TARGET_PAGE_BITS - TB_JMP_PAGE_BITS)) & TB_JMP_PAGE_MASK;
196 197
}

198
static inline unsigned int tb_jmp_cache_hash_func(target_ulong pc)
199
{
200 201
    target_ulong tmp;
    tmp = pc ^ (pc >> (TARGET_PAGE_BITS - TB_JMP_PAGE_BITS));
202 203
    return (((tmp >> (TARGET_PAGE_BITS - TB_JMP_PAGE_BITS)) & TB_JMP_PAGE_MASK)
	    | (tmp & TB_JMP_ADDR_MASK));
204 205
}

Paul Brook's avatar
Paul Brook committed
206
static inline unsigned int tb_phys_hash_func(tb_page_addr_t pc)
207
{
208
    return (pc >> 2) & (CODE_GEN_PHYS_HASH_SIZE - 1);
209 210
}

pbrook's avatar
pbrook committed
211
void tb_free(TranslationBlock *tb);
212
void tb_flush(CPUArchState *env);
Paul Brook's avatar
Paul Brook committed
213
void tb_phys_invalidate(TranslationBlock *tb, tb_page_addr_t page_addr);
214

215 216
#if defined(USE_DIRECT_JUMP)

217 218 219 220 221 222 223 224
#if defined(CONFIG_TCG_INTERPRETER)
static inline void tb_set_jmp_target1(uintptr_t jmp_addr, uintptr_t addr)
{
    /* patch the branch destination */
    *(uint32_t *)jmp_addr = addr - (jmp_addr + 4);
    /* no need to flush icache explicitly */
}
#elif defined(_ARCH_PPC)
225
void ppc_tb_set_jmp_target(unsigned long jmp_addr, unsigned long addr);
226
#define tb_set_jmp_target1 ppc_tb_set_jmp_target
bellard's avatar
bellard committed
227
#elif defined(__i386__) || defined(__x86_64__)
228
static inline void tb_set_jmp_target1(uintptr_t jmp_addr, uintptr_t addr)
229 230 231
{
    /* patch the branch destination */
    *(uint32_t *)jmp_addr = addr - (jmp_addr + 4);
ths's avatar
ths committed
232
    /* no need to flush icache explicitly */
233
}
234 235 236
#elif defined(__aarch64__)
void aarch64_tb_set_jmp_target(uintptr_t jmp_addr, uintptr_t addr);
#define tb_set_jmp_target1 aarch64_tb_set_jmp_target
237
#elif defined(__arm__)
238
static inline void tb_set_jmp_target1(uintptr_t jmp_addr, uintptr_t addr)
239
{
240
#if !QEMU_GNUC_PREREQ(4, 1)
241 242 243
    register unsigned long _beg __asm ("a1");
    register unsigned long _end __asm ("a2");
    register unsigned long _flg __asm ("a3");
244
#endif
245 246

    /* we could use a ldr pc, [pc, #-4] kind of branch and avoid the flush */
247 248 249
    *(uint32_t *)jmp_addr =
        (*(uint32_t *)jmp_addr & ~0xffffff)
        | (((addr - (jmp_addr + 8)) >> 2) & 0xffffff);
250

251
#if QEMU_GNUC_PREREQ(4, 1)
252
    __builtin___clear_cache((char *) jmp_addr, (char *) jmp_addr + 4);
253
#else
254 255 256 257 258
    /* flush icache */
    _beg = jmp_addr;
    _end = jmp_addr + 4;
    _flg = 0;
    __asm __volatile__ ("swi 0x9f0002" : : "r" (_beg), "r" (_end), "r" (_flg));
259
#endif
260
}
261 262
#elif defined(__sparc__)
void tb_set_jmp_target1(uintptr_t jmp_addr, uintptr_t addr);
263 264
#else
#error tb_set_jmp_target1 is missing
265
#endif
266

267
static inline void tb_set_jmp_target(TranslationBlock *tb,
268
                                     int n, uintptr_t addr)
269
{
270 271
    uint16_t offset = tb->tb_jmp_offset[n];
    tb_set_jmp_target1((uintptr_t)(tb->tc_ptr + offset), addr);
272 273
}

274 275 276
#else

/* set the jump target */
277
static inline void tb_set_jmp_target(TranslationBlock *tb,
278
                                     int n, uintptr_t addr)
279
{
280
    tb->tb_next[n] = addr;
281 282 283 284
}

#endif

285
static inline void tb_add_jump(TranslationBlock *tb, int n,
286 287
                               TranslationBlock *tb_next)
{
bellard's avatar
bellard committed
288 289 290
    /* NOTE: this test is only needed for thread safety */
    if (!tb->jmp_next[n]) {
        /* patch the native jump address */
291
        tb_set_jmp_target(tb, n, (uintptr_t)tb_next->tc_ptr);
292

bellard's avatar
bellard committed
293 294
        /* add in TB jmp circular list */
        tb->jmp_next[n] = tb_next->jmp_first;
295
        tb_next->jmp_first = (TranslationBlock *)((uintptr_t)(tb) | (n));
bellard's avatar
bellard committed
296
    }
297 298
}

299 300
/* GETRA is the true target of the return instruction that we'll execute,
   defined here for simplicity of defining the follow-up macros.  */
301
#if defined(CONFIG_TCG_INTERPRETER)
302
extern uintptr_t tci_tb_ptr;
303 304 305 306 307 308 309 310 311 312 313 314 315 316 317
# define GETRA() tci_tb_ptr
#else
# define GETRA() \
    ((uintptr_t)__builtin_extract_return_addr(__builtin_return_address(0)))
#endif

/* The true return address will often point to a host insn that is part of
   the next translated guest insn.  Adjust the address backward to point to
   the middle of the call insn.  Subtracting one would do the job except for
   several compressed mode architectures (arm, mips) which set the low bit
   to indicate the compressed mode; subtracting two works around that.  It
   is also the case that there are no host isas that contain a call insn
   smaller than 4 bytes, so we don't worry about special-casing this.  */
#if defined(CONFIG_TCG_INTERPRETER)
# define GETPC_ADJ   0
318
#else
319
# define GETPC_ADJ   2
320 321
#endif

322 323
#define GETPC()  (GETRA() - GETPC_ADJ)

324
#if !defined(CONFIG_USER_ONLY)
bellard's avatar
bellard committed
325

326
void phys_mem_set_alloc(void *(*alloc)(size_t));
327

328
struct MemoryRegion *iotlb_to_region(hwaddr index);
329 330 331
bool io_mem_read(struct MemoryRegion *mr, hwaddr addr,
                 uint64_t *pvalue, unsigned size);
bool io_mem_write(struct MemoryRegion *mr, hwaddr addr,
332
                  uint64_t value, unsigned size);
333

334
void tlb_fill(CPUArchState *env1, target_ulong addr, int is_write, int mmu_idx,
335
              uintptr_t retaddr);
bellard's avatar
bellard committed
336

337 338 339 340
uint8_t helper_ldb_cmmu(CPUArchState *env, target_ulong addr, int mmu_idx);
uint16_t helper_ldw_cmmu(CPUArchState *env, target_ulong addr, int mmu_idx);
uint32_t helper_ldl_cmmu(CPUArchState *env, target_ulong addr, int mmu_idx);
uint64_t helper_ldq_cmmu(CPUArchState *env, target_ulong addr, int mmu_idx);
341

342
#define ACCESS_TYPE (NB_MMU_MODES + 1)
bellard's avatar
bellard committed
343 344 345
#define MEMSUFFIX _code

#define DATA_SIZE 1
346
#include "exec/softmmu_header.h"
bellard's avatar
bellard committed
347 348

#define DATA_SIZE 2
349
#include "exec/softmmu_header.h"
bellard's avatar
bellard committed
350 351

#define DATA_SIZE 4
352
#include "exec/softmmu_header.h"
bellard's avatar
bellard committed
353

bellard's avatar
bellard committed
354
#define DATA_SIZE 8
355
#include "exec/softmmu_header.h"
bellard's avatar
bellard committed
356

bellard's avatar
bellard committed
357 358 359 360
#undef ACCESS_TYPE
#undef MEMSUFFIX

#endif
361 362

#if defined(CONFIG_USER_ONLY)
363
static inline tb_page_addr_t get_page_addr_code(CPUArchState *env1, target_ulong addr)
364 365 366 367
{
    return addr;
}
#else
368
/* cputlb.c */
369
tb_page_addr_t get_page_addr_code(CPUArchState *env1, target_ulong addr);
370
#endif
bellard's avatar
bellard committed
371

372
typedef void (CPUDebugExcpHandler)(CPUArchState *env);
373

374
void cpu_set_debug_excp_handler(CPUDebugExcpHandler *handler);
375 376 377 378

/* vl.c */
extern int singlestep;

379 380 381
/* cpu-exec.c */
extern volatile sig_atomic_t exit_request;

382 383
/* Deterministic execution requires that IO only be performed on the last
   instruction of a TB so that interrupts take effect immediately.  */
384
static inline int can_do_io(CPUArchState *env)
385
{
386 387
    CPUState *cpu = ENV_GET_CPU(env);

388 389 390 391
    if (!use_icount) {
        return 1;
    }
    /* If not executing code then assume we are ok.  */
392
    if (cpu->current_tb == NULL) {
393 394 395 396 397
        return 1;
    }
    return env->can_do_io != 0;
}

398
#endif