include/exec/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 struct TranslationBlock;
  44 typedef struct TranslationBlock TranslationBlock;
  45
  46 /* XXX: make safe guess about sizes */
  47 #define MAX_OP_PER_INSTR 266
  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 5
  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))
  62 #define OPC_BUF_SIZE 640
  63 #define OPC_MAX_SIZE (OPC_BUF_SIZE - MAX_OP_PER_INSTR)
  64
  65 #define OPPARAM_BUF_SIZE (OPC_BUF_SIZE * MAX_OPC_PARAM)
  66
  67 #include "qemu/log.h"
  68
  69 void gen_intermediate_code(CPUArchState *env, struct TranslationBlock *tb);
  70 void restore_state_to_opc(CPUArchState *env, struct TranslationBlock *tb,
  71                           target_ulong *data);
  72
  73 void cpu_gen_init(void);
  74 bool cpu_restore_state(CPUState *cpu, uintptr_t searched_pc);
  75
  76 void QEMU_NORETURN cpu_resume_from_signal(CPUState *cpu, void *puc);
  77 void QEMU_NORETURN cpu_io_recompile(CPUState *cpu, uintptr_t retaddr);
  78 TranslationBlock *tb_gen_code(CPUState *cpu,
  79                               target_ulong pc, target_ulong cs_base, int flags,
  80                               int cflags);
  81 void cpu_exec_init(CPUState *cpu, Error **errp);
  82 void QEMU_NORETURN cpu_loop_exit(CPUState *cpu);
  83 void QEMU_NORETURN cpu_loop_exit_restore(CPUState *cpu, uintptr_t pc);
  84
  85 #if !defined(CONFIG_USER_ONLY)
  86 void cpu_reloading_memory_map(void);
  87 /**
  88  * cpu_address_space_init:
  89  * @cpu: CPU to add this address space to
  90  * @as: address space to add
  91  * @asidx: integer index of this address space
  92  *
  93  * Add the specified address space to the CPU's cpu_ases list.
  94  * The address space added with @asidx 0 is the one used for the
  95  * convenience pointer cpu->as.
  96  * The target-specific code which registers ASes is responsible
  97  * for defining what semantics address space 0, 1, 2, etc have.
  98  *
  99  * Before the first call to this function, the caller must set
 100  * cpu->num_ases to the total number of address spaces it needs
 101  * to support.
 102  *
 103  * Note that with KVM only one address space is supported.
 104  */
 105 void cpu_address_space_init(CPUState *cpu, AddressSpace *as, int asidx);
 106 /**
 107  * cpu_get_address_space:
 108  * @cpu: CPU to get address space from
 109  * @asidx: index identifying which address space to get
 110  *
 111  * Return the requested address space of this CPU. @asidx
 112  * specifies which address space to read.
 113  */
 114 AddressSpace *cpu_get_address_space(CPUState *cpu, int asidx);
 115 /* cputlb.c */
 116 /**
 117  * tlb_flush_page:
 118  * @cpu: CPU whose TLB should be flushed
 119  * @addr: virtual address of page to be flushed
 120  *
 121  * Flush one page from the TLB of the specified CPU, for all
 122  * MMU indexes.
 123  */
 124 void tlb_flush_page(CPUState *cpu, target_ulong addr);
 125 /**
 126  * tlb_flush:
 127  * @cpu: CPU whose TLB should be flushed
 128  * @flush_global: ignored
 129  *
 130  * Flush the entire TLB for the specified CPU.
 131  * The flush_global flag is in theory an indicator of whether the whole
 132  * TLB should be flushed, or only those entries not marked global.
 133  * In practice QEMU does not implement any global/not global flag for
 134  * TLB entries, and the argument is ignored.
 135  */
 136 void tlb_flush(CPUState *cpu, int flush_global);
 137 /**
 138  * tlb_flush_page_by_mmuidx:
 139  * @cpu: CPU whose TLB should be flushed
 140  * @addr: virtual address of page to be flushed
 141  * @...: list of MMU indexes to flush, terminated by a negative value
 142  *
 143  * Flush one page from the TLB of the specified CPU, for the specified
 144  * MMU indexes.
 145  */
 146 void tlb_flush_page_by_mmuidx(CPUState *cpu, target_ulong addr, ...);
 147 /**
 148  * tlb_flush_by_mmuidx:
 149  * @cpu: CPU whose TLB should be flushed
 150  * @...: list of MMU indexes to flush, terminated by a negative value
 151  *
 152  * Flush all entries from the TLB of the specified CPU, for the specified
 153  * MMU indexes.
 154  */
 155 void tlb_flush_by_mmuidx(CPUState *cpu, ...);
 156 /**
 157  * tlb_set_page_with_attrs:
 158  * @cpu: CPU to add this TLB entry for
 159  * @vaddr: virtual address of page to add entry for
 160  * @paddr: physical address of the page
 161  * @attrs: memory transaction attributes
 162  * @prot: access permissions (PAGE_READ/PAGE_WRITE/PAGE_EXEC bits)
 163  * @mmu_idx: MMU index to insert TLB entry for
 164  * @size: size of the page in bytes
 165  *
 166  * Add an entry to this CPU's TLB (a mapping from virtual address
 167  * @vaddr to physical address @paddr) with the specified memory
 168  * transaction attributes. This is generally called by the target CPU
 169  * specific code after it has been called through the tlb_fill()
 170  * entry point and performed a successful page table walk to find
 171  * the physical address and attributes for the virtual address
 172  * which provoked the TLB miss.
 173  *
 174  * At most one entry for a given virtual address is permitted. Only a
 175  * single TARGET_PAGE_SIZE region is mapped; the supplied @size is only
 176  * used by tlb_flush_page.
 177  */
 178 void tlb_set_page_with_attrs(CPUState *cpu, target_ulong vaddr,
 179                              hwaddr paddr, MemTxAttrs attrs,
 180                              int prot, int mmu_idx, target_ulong size);
 181 /* tlb_set_page:
 182  *
 183  * This function is equivalent to calling tlb_set_page_with_attrs()
 184  * with an @attrs argument of MEMTXATTRS_UNSPECIFIED. It's provided
 185  * as a convenience for CPUs which don't use memory transaction attributes.
 186  */
 187 void tlb_set_page(CPUState *cpu, target_ulong vaddr,
 188                   hwaddr paddr, int prot,
 189                   int mmu_idx, target_ulong size);
 190 void tb_invalidate_phys_addr(AddressSpace *as, hwaddr addr);
 191 void probe_write(CPUArchState *env, target_ulong addr, int mmu_idx,
 192                  uintptr_t retaddr);
 193 #else
 194 static inline void tlb_flush_page(CPUState *cpu, target_ulong addr)
 195 {
 196 }
 197
 198 static inline void tlb_flush(CPUState *cpu, int flush_global)
 199 {
 200 }
 201
 202 static inline void tlb_flush_page_by_mmuidx(CPUState *cpu,
 203                                             target_ulong addr, ...)
 204 {
 205 }
 206
 207 static inline void tlb_flush_by_mmuidx(CPUState *cpu, ...)
 208 {
 209 }
 210 #endif
 211
 212 #define CODE_GEN_ALIGN           16 /* must be >= of the size of a icache line */
 213
 214 #define CODE_GEN_PHYS_HASH_BITS     15
 215 #define CODE_GEN_PHYS_HASH_SIZE     (1 << CODE_GEN_PHYS_HASH_BITS)
 216
 217 /* Estimated block size for TB allocation.  */
 218 /* ??? The following is based on a 2015 survey of x86_64 host output.
 219    Better would seem to be some sort of dynamically sized TB array,
 220    adapting to the block sizes actually being produced.  */
 221 #if defined(CONFIG_SOFTMMU)
 222 #define CODE_GEN_AVG_BLOCK_SIZE 400
 223 #else
 224 #define CODE_GEN_AVG_BLOCK_SIZE 150
 225 #endif
 226
 227 #if defined(__arm__) || defined(_ARCH_PPC) \
 228     || defined(__x86_64__) || defined(__i386__) \
 229     || defined(__sparc__) || defined(__aarch64__) \
 230     || defined(__s390x__) || defined(__mips__) \
 231     || defined(CONFIG_TCG_INTERPRETER)
 232 #define USE_DIRECT_JUMP
 233 #endif
 234
 235 struct TranslationBlock {
 236     target_ulong pc;   /* simulated PC corresponding to this block (EIP + CS base) */
 237     target_ulong cs_base; /* CS base for this block */
 238     uint64_t flags; /* flags defining in which context the code was generated */
 239     uint16_t size;      /* size of target code for this block (1 <=
 240                            size <= TARGET_PAGE_SIZE) */
 241     uint16_t icount;
 242     uint32_t cflags;    /* compile flags */
 243 #define CF_COUNT_MASK  0x7fff
 244 #define CF_LAST_IO     0x8000 /* Last insn may be an IO access.  */
 245 #define CF_NOCACHE     0x10000 /* To be freed after execution */
 246 #define CF_USE_ICOUNT  0x20000
 247 #define CF_IGNORE_ICOUNT 0x40000 /* Do not generate icount code */
 248
 249     void *tc_ptr;    /* pointer to the translated code */
 250     uint8_t *tc_search;  /* pointer to search data */
 251     /* next matching tb for physical address. */
 252     struct TranslationBlock *phys_hash_next;
 253     /* original tb when cflags has CF_NOCACHE */
 254     struct TranslationBlock *orig_tb;
 255     /* first and second physical page containing code. The lower bit
 256        of the pointer tells the index in page_next[] */
 257     struct TranslationBlock *page_next[2];
 258     tb_page_addr_t page_addr[2];
 259
 260     /* the following data are used to directly call another TB from
 261        the code of this one. */
 262     uint16_t tb_next_offset[2]; /* offset of original jump target */
 263 #ifdef USE_DIRECT_JUMP
 264     uint16_t tb_jmp_offset[2]; /* offset of jump instruction */
 265 #else
 266     uintptr_t tb_next[2]; /* address of jump generated code */
 267 #endif
 268     /* list of TBs jumping to this one. This is a circular list using
 269        the two least significant bits of the pointers to tell what is
 270        the next pointer: 0 = jmp_next[0], 1 = jmp_next[1], 2 =
 271        jmp_first */
 272     struct TranslationBlock *jmp_next[2];
 273     struct TranslationBlock *jmp_first;
 274 };
 275
 276 #include "qemu/thread.h"
 277
 278 typedef struct TBContext TBContext;
 279
 280 struct TBContext {
 281
 282     TranslationBlock *tbs;
 283     TranslationBlock *tb_phys_hash[CODE_GEN_PHYS_HASH_SIZE];
 284     int nb_tbs;
 285     /* any access to the tbs or the page table must use this lock */
 286     QemuMutex tb_lock;
 287
 288     /* statistics */
 289     int tb_flush_count;
 290     int tb_phys_invalidate_count;
 291
 292     int tb_invalidated_flag;
 293 };
 294
 295 void tb_free(TranslationBlock *tb);
 296 void tb_flush(CPUState *cpu);
 297 void tb_phys_invalidate(TranslationBlock *tb, tb_page_addr_t page_addr);
 298
 299 #if defined(USE_DIRECT_JUMP)
 300
 301 #if defined(CONFIG_TCG_INTERPRETER)
 302 static inline void tb_set_jmp_target1(uintptr_t jmp_addr, uintptr_t addr)
 303 {
 304     /* patch the branch destination */
 305     *(uint32_t *)jmp_addr = addr - (jmp_addr + 4);
 306     /* no need to flush icache explicitly */
 307 }
 308 #elif defined(_ARCH_PPC)
 309 void ppc_tb_set_jmp_target(uintptr_t jmp_addr, uintptr_t addr);
 310 #define tb_set_jmp_target1 ppc_tb_set_jmp_target
 311 #elif defined(__i386__) || defined(__x86_64__)
 312 static inline void tb_set_jmp_target1(uintptr_t jmp_addr, uintptr_t addr)
 313 {
 314     /* patch the branch destination */
 315     stl_le_p((void*)jmp_addr, addr - (jmp_addr + 4));
 316     /* no need to flush icache explicitly */
 317 }
 318 #elif defined(__s390x__)
 319 static inline void tb_set_jmp_target1(uintptr_t jmp_addr, uintptr_t addr)
 320 {
 321     /* patch the branch destination */
 322     intptr_t disp = addr - (jmp_addr - 2);
 323     stl_be_p((void*)jmp_addr, disp / 2);
 324     /* no need to flush icache explicitly */
 325 }
 326 #elif defined(__aarch64__)
 327 void aarch64_tb_set_jmp_target(uintptr_t jmp_addr, uintptr_t addr);
 328 #define tb_set_jmp_target1 aarch64_tb_set_jmp_target
 329 #elif defined(__arm__)
 330 static inline void tb_set_jmp_target1(uintptr_t jmp_addr, uintptr_t addr)
 331 {
 332 #if !QEMU_GNUC_PREREQ(4, 1)
 333     register unsigned long _beg __asm ("a1");
 334     register unsigned long _end __asm ("a2");
 335     register unsigned long _flg __asm ("a3");
 336 #endif
 337
 338     /* we could use a ldr pc, [pc, #-4] kind of branch and avoid the flush */
 339     *(uint32_t *)jmp_addr =
 340         (*(uint32_t *)jmp_addr & ~0xffffff)
 341         | (((addr - (jmp_addr + 8)) >> 2) & 0xffffff);
 342
 343 #if QEMU_GNUC_PREREQ(4, 1)
 344     __builtin___clear_cache((char *) jmp_addr, (char *) jmp_addr + 4);
 345 #else
 346     /* flush icache */
 347     _beg = jmp_addr;
 348     _end = jmp_addr + 4;
 349     _flg = 0;
 350     __asm __volatile__ ("swi 0x9f0002" : : "r" (_beg), "r" (_end), "r" (_flg));
 351 #endif
 352 }
 353 #elif defined(__sparc__) || defined(__mips__)
 354 void tb_set_jmp_target1(uintptr_t jmp_addr, uintptr_t addr);
 355 #else
 356 #error tb_set_jmp_target1 is missing
 357 #endif
 358
 359 static inline void tb_set_jmp_target(TranslationBlock *tb,
 360                                      int n, uintptr_t addr)
 361 {
 362     uint16_t offset = tb->tb_jmp_offset[n];
 363     tb_set_jmp_target1((uintptr_t)(tb->tc_ptr + offset), addr);
 364 }
 365
 366 #else
 367
 368 /* set the jump target */
 369 static inline void tb_set_jmp_target(TranslationBlock *tb,
 370                                      int n, uintptr_t addr)
 371 {
 372     tb->tb_next[n] = addr;
 373 }
 374
 375 #endif
 376
 377 static inline void tb_add_jump(TranslationBlock *tb, int n,
 378                                TranslationBlock *tb_next)
 379 {
 380     /* NOTE: this test is only needed for thread safety */
 381     if (!tb->jmp_next[n]) {
 382         qemu_log_mask_and_addr(CPU_LOG_EXEC, tb->pc,
 383                                "Linking TBs %p [" TARGET_FMT_lx
 384                                "] index %d -> %p [" TARGET_FMT_lx "]\n",
 385                                tb->tc_ptr, tb->pc, n,
 386                                tb_next->tc_ptr, tb_next->pc);
 387         /* patch the native jump address */
 388         tb_set_jmp_target(tb, n, (uintptr_t)tb_next->tc_ptr);
 389
 390         /* add in TB jmp circular list */
 391         tb->jmp_next[n] = tb_next->jmp_first;
 392         tb_next->jmp_first = (TranslationBlock *)((uintptr_t)(tb) | (n));
 393     }
 394 }
 395
 396 /* GETRA is the true target of the return instruction that we'll execute,
 397    defined here for simplicity of defining the follow-up macros.  */
 398 #if defined(CONFIG_TCG_INTERPRETER)
 399 extern uintptr_t tci_tb_ptr;
 400 # define GETRA() tci_tb_ptr
 401 #else
 402 # define GETRA() \
 403     ((uintptr_t)__builtin_extract_return_addr(__builtin_return_address(0)))
 404 #endif
 405
 406 /* The true return address will often point to a host insn that is part of
 407    the next translated guest insn.  Adjust the address backward to point to
 408    the middle of the call insn.  Subtracting one would do the job except for
 409    several compressed mode architectures (arm, mips) which set the low bit
 410    to indicate the compressed mode; subtracting two works around that.  It
 411    is also the case that there are no host isas that contain a call insn
 412    smaller than 4 bytes, so we don't worry about special-casing this.  */
 413 #define GETPC_ADJ   2
 414
 415 #define GETPC()  (GETRA() - GETPC_ADJ)
 416
 417 #if !defined(CONFIG_USER_ONLY)
 418
 419 struct MemoryRegion *iotlb_to_region(CPUState *cpu,
 420                                      hwaddr index, MemTxAttrs attrs);
 421
 422 void tlb_fill(CPUState *cpu, target_ulong addr, int is_write, int mmu_idx,
 423               uintptr_t retaddr);
 424
 425 #endif
 426
 427 #if defined(CONFIG_USER_ONLY)
 428 void mmap_lock(void);
 429 void mmap_unlock(void);
 430
 431 static inline tb_page_addr_t get_page_addr_code(CPUArchState *env1, target_ulong addr)
 432 {
 433     return addr;
 434 }
 435 #else
 436 static inline void mmap_lock(void) {}
 437 static inline void mmap_unlock(void) {}
 438
 439 /* cputlb.c */
 440 tb_page_addr_t get_page_addr_code(CPUArchState *env1, target_ulong addr);
 441
 442 void tlb_reset_dirty(CPUState *cpu, ram_addr_t start1, ram_addr_t length);
 443 void tlb_set_dirty(CPUState *cpu, target_ulong vaddr);
 444
 445 /* exec.c */
 446 void tb_flush_jmp_cache(CPUState *cpu, target_ulong addr);
 447
 448 MemoryRegionSection *
 449 address_space_translate_for_iotlb(CPUState *cpu, int asidx, hwaddr addr,
 450                                   hwaddr *xlat, hwaddr *plen);
 451 hwaddr memory_region_section_get_iotlb(CPUState *cpu,
 452                                        MemoryRegionSection *section,
 453                                        target_ulong vaddr,
 454                                        hwaddr paddr, hwaddr xlat,
 455                                        int prot,
 456                                        target_ulong *address);
 457 bool memory_region_is_unassigned(MemoryRegion *mr);
 458
 459 #endif
 460
 461 /* vl.c */
 462 extern int singlestep;
 463
 464 /* cpu-exec.c, accessed with atomic_mb_read/atomic_mb_set */
 465 extern CPUState *tcg_current_cpu;
 466 extern bool exit_request;
 467
 468 #endif