tcg/tcg.h

   1 /*
   2  * Tiny Code Generator for QEMU
   3  *
   4  * Copyright (c) 2008 Fabrice Bellard
   5  *
   6  * Permission is hereby granted, free of charge, to any person obtaining a copy
   7  * of this software and associated documentation files (the "Software"), to deal
   8  * in the Software without restriction, including without limitation the rights
   9  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  10  * copies of the Software, and to permit persons to whom the Software is
  11  * furnished to do so, subject to the following conditions:
  12  *
  13  * The above copyright notice and this permission notice shall be included in
  14  * all copies or substantial portions of the Software.
  15  *
  16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
  19  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  21  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  22  * THE SOFTWARE.
  23  */
  24
  25 #ifndef TCG_H
  26 #define TCG_H
  27
  28 #include "qemu-common.h"
  29
  30 #include "tcg-target.h"
  31
  32 /* Default target word size to pointer size.  */
  33 #ifndef TCG_TARGET_REG_BITS
  34 # if UINTPTR_MAX == UINT32_MAX
  35 #  define TCG_TARGET_REG_BITS 32
  36 # elif UINTPTR_MAX == UINT64_MAX
  37 #  define TCG_TARGET_REG_BITS 64
  38 # else
  39 #  error Unknown pointer size for tcg target
  40 # endif
  41 #endif
  42
  43 #if TCG_TARGET_REG_BITS == 32
  44 typedef int32_t tcg_target_long;
  45 typedef uint32_t tcg_target_ulong;
  46 #define TCG_PRIlx PRIx32
  47 #define TCG_PRIld PRId32
  48 #elif TCG_TARGET_REG_BITS == 64
  49 typedef int64_t tcg_target_long;
  50 typedef uint64_t tcg_target_ulong;
  51 #define TCG_PRIlx PRIx64
  52 #define TCG_PRIld PRId64
  53 #else
  54 #error unsupported
  55 #endif
  56
  57 #include "tcg-runtime.h"
  58
  59 #if TCG_TARGET_NB_REGS <= 32
  60 typedef uint32_t TCGRegSet;
  61 #elif TCG_TARGET_NB_REGS <= 64
  62 typedef uint64_t TCGRegSet;
  63 #else
  64 #error unsupported
  65 #endif
  66
  67 #if TCG_TARGET_REG_BITS == 32
  68 /* Turn some undef macros into false macros.  */
  69 #define TCG_TARGET_HAS_div_i64          0
  70 #define TCG_TARGET_HAS_rem_i64          0
  71 #define TCG_TARGET_HAS_div2_i64         0
  72 #define TCG_TARGET_HAS_rot_i64          0
  73 #define TCG_TARGET_HAS_ext8s_i64        0
  74 #define TCG_TARGET_HAS_ext16s_i64       0
  75 #define TCG_TARGET_HAS_ext32s_i64       0
  76 #define TCG_TARGET_HAS_ext8u_i64        0
  77 #define TCG_TARGET_HAS_ext16u_i64       0
  78 #define TCG_TARGET_HAS_ext32u_i64       0
  79 #define TCG_TARGET_HAS_bswap16_i64      0
  80 #define TCG_TARGET_HAS_bswap32_i64      0
  81 #define TCG_TARGET_HAS_bswap64_i64      0
  82 #define TCG_TARGET_HAS_neg_i64          0
  83 #define TCG_TARGET_HAS_not_i64          0
  84 #define TCG_TARGET_HAS_andc_i64         0
  85 #define TCG_TARGET_HAS_orc_i64          0
  86 #define TCG_TARGET_HAS_eqv_i64          0
  87 #define TCG_TARGET_HAS_nand_i64         0
  88 #define TCG_TARGET_HAS_nor_i64          0
  89 #define TCG_TARGET_HAS_deposit_i64      0
  90 #define TCG_TARGET_HAS_movcond_i64      0
  91 #define TCG_TARGET_HAS_add2_i64         0
  92 #define TCG_TARGET_HAS_sub2_i64         0
  93 #define TCG_TARGET_HAS_mulu2_i64        0
  94 #define TCG_TARGET_HAS_muls2_i64        0
  95 #define TCG_TARGET_HAS_muluh_i64        0
  96 #define TCG_TARGET_HAS_mulsh_i64        0
  97 /* Turn some undef macros into true macros.  */
  98 #define TCG_TARGET_HAS_add2_i32         1
  99 #define TCG_TARGET_HAS_sub2_i32         1
 100 #define TCG_TARGET_HAS_mulu2_i32        1
 101 #endif
 102
 103 #ifndef TCG_TARGET_deposit_i32_valid
 104 #define TCG_TARGET_deposit_i32_valid(ofs, len) 1
 105 #endif
 106 #ifndef TCG_TARGET_deposit_i64_valid
 107 #define TCG_TARGET_deposit_i64_valid(ofs, len) 1
 108 #endif
 109
 110 /* Only one of DIV or DIV2 should be defined.  */
 111 #if defined(TCG_TARGET_HAS_div_i32)
 112 #define TCG_TARGET_HAS_div2_i32         0
 113 #elif defined(TCG_TARGET_HAS_div2_i32)
 114 #define TCG_TARGET_HAS_div_i32          0
 115 #define TCG_TARGET_HAS_rem_i32          0
 116 #endif
 117 #if defined(TCG_TARGET_HAS_div_i64)
 118 #define TCG_TARGET_HAS_div2_i64         0
 119 #elif defined(TCG_TARGET_HAS_div2_i64)
 120 #define TCG_TARGET_HAS_div_i64          0
 121 #define TCG_TARGET_HAS_rem_i64          0
 122 #endif
 123
 124 typedef enum TCGOpcode {
 125 #define DEF(name, oargs, iargs, cargs, flags) INDEX_op_ ## name,
 126 #include "tcg-opc.h"
 127 #undef DEF
 128     NB_OPS,
 129 } TCGOpcode;
 130
 131 #define tcg_regset_clear(d) (d) = 0
 132 #define tcg_regset_set(d, s) (d) = (s)
 133 #define tcg_regset_set32(d, reg, val32) (d) |= (val32) << (reg)
 134 #define tcg_regset_set_reg(d, r) (d) |= 1L << (r)
 135 #define tcg_regset_reset_reg(d, r) (d) &= ~(1L << (r))
 136 #define tcg_regset_test_reg(d, r) (((d) >> (r)) & 1)
 137 #define tcg_regset_or(d, a, b) (d) = (a) | (b)
 138 #define tcg_regset_and(d, a, b) (d) = (a) & (b)
 139 #define tcg_regset_andnot(d, a, b) (d) = (a) & ~(b)
 140 #define tcg_regset_not(d, a) (d) = ~(a)
 141
 142 typedef struct TCGRelocation {
 143     struct TCGRelocation *next;
 144     int type;
 145     uint8_t *ptr;
 146     intptr_t addend;
 147 } TCGRelocation;
 148
 149 typedef struct TCGLabel {
 150     int has_value;
 151     union {
 152         uintptr_t value;
 153         TCGRelocation *first_reloc;
 154     } u;
 155 } TCGLabel;
 156
 157 typedef struct TCGPool {
 158     struct TCGPool *next;
 159     int size;
 160     uint8_t data[0] __attribute__ ((aligned));
 161 } TCGPool;
 162
 163 #define TCG_POOL_CHUNK_SIZE 32768
 164
 165 #define TCG_MAX_LABELS 512
 166
 167 #define TCG_MAX_TEMPS 512
 168
 169 /* when the size of the arguments of a called function is smaller than
 170    this value, they are statically allocated in the TB stack frame */
 171 #define TCG_STATIC_CALL_ARGS_SIZE 128
 172
 173 typedef enum TCGType {
 174     TCG_TYPE_I32,
 175     TCG_TYPE_I64,
 176     TCG_TYPE_COUNT, /* number of different types */
 177
 178     /* An alias for the size of the host register.  */
 179 #if TCG_TARGET_REG_BITS == 32
 180     TCG_TYPE_REG = TCG_TYPE_I32,
 181 #else
 182     TCG_TYPE_REG = TCG_TYPE_I64,
 183 #endif
 184
 185     /* An alias for the size of the native pointer.  */
 186 #if UINTPTR_MAX == UINT32_MAX
 187     TCG_TYPE_PTR = TCG_TYPE_I32,
 188 #else
 189     TCG_TYPE_PTR = TCG_TYPE_I64,
 190 #endif
 191
 192     /* An alias for the size of the target "long", aka register.  */
 193 #if TARGET_LONG_BITS == 64
 194     TCG_TYPE_TL = TCG_TYPE_I64,
 195 #else
 196     TCG_TYPE_TL = TCG_TYPE_I32,
 197 #endif
 198 } TCGType;
 199
 200 typedef tcg_target_ulong TCGArg;
 201
 202 /* Define a type and accessor macros for variables.  Using a struct is
 203    nice because it gives some level of type safely.  Ideally the compiler
 204    be able to see through all this.  However in practice this is not true,
 205    especially on targets with braindamaged ABIs (e.g. i386).
 206    We use plain int by default to avoid this runtime overhead.
 207    Users of tcg_gen_* don't need to know about any of this, and should
 208    treat TCGv as an opaque type.
 209    In addition we do typechecking for different types of variables.  TCGv_i32
 210    and TCGv_i64 are 32/64-bit variables respectively.  TCGv and TCGv_ptr
 211    are aliases for target_ulong and host pointer sized values respectively.
 212  */
 213
 214 #if defined(CONFIG_QEMU_LDST_OPTIMIZATION) && defined(CONFIG_SOFTMMU)
 215 /* Macros/structures for qemu_ld/st IR code optimization:
 216    TCG_MAX_HELPER_LABELS is defined as same as OPC_BUF_SIZE in exec-all.h. */
 217 #define TCG_MAX_QEMU_LDST       640
 218
 219 typedef struct TCGLabelQemuLdst {
 220     int is_ld:1;            /* qemu_ld: 1, qemu_st: 0 */
 221     int opc:4;
 222     int addrlo_reg;         /* reg index for low word of guest virtual addr */
 223     int addrhi_reg;         /* reg index for high word of guest virtual addr */
 224     int datalo_reg;         /* reg index for low word to be loaded or stored */
 225     int datahi_reg;         /* reg index for high word to be loaded or stored */
 226     int mem_index;          /* soft MMU memory index */
 227     uint8_t *raddr;         /* gen code addr of the next IR of qemu_ld/st IR */
 228     uint8_t *label_ptr[2];  /* label pointers to be updated */
 229 } TCGLabelQemuLdst;
 230 #endif
 231
 232 #ifdef CONFIG_DEBUG_TCG
 233 #define DEBUG_TCGV 1
 234 #endif
 235
 236 #ifdef DEBUG_TCGV
 237
 238 typedef struct
 239 {
 240     int i32;
 241 } TCGv_i32;
 242
 243 typedef struct
 244 {
 245     int i64;
 246 } TCGv_i64;
 247
 248 typedef struct {
 249     int iptr;
 250 } TCGv_ptr;
 251
 252 #define MAKE_TCGV_I32(i) __extension__                  \
 253     ({ TCGv_i32 make_tcgv_tmp = {i}; make_tcgv_tmp;})
 254 #define MAKE_TCGV_I64(i) __extension__                  \
 255     ({ TCGv_i64 make_tcgv_tmp = {i}; make_tcgv_tmp;})
 256 #define MAKE_TCGV_PTR(i) __extension__                  \
 257     ({ TCGv_ptr make_tcgv_tmp = {i}; make_tcgv_tmp; })
 258 #define GET_TCGV_I32(t) ((t).i32)
 259 #define GET_TCGV_I64(t) ((t).i64)
 260 #define GET_TCGV_PTR(t) ((t).iptr)
 261 #if TCG_TARGET_REG_BITS == 32
 262 #define TCGV_LOW(t) MAKE_TCGV_I32(GET_TCGV_I64(t))
 263 #define TCGV_HIGH(t) MAKE_TCGV_I32(GET_TCGV_I64(t) + 1)
 264 #endif
 265
 266 #else /* !DEBUG_TCGV */
 267
 268 typedef int TCGv_i32;
 269 typedef int TCGv_i64;
 270 #if TCG_TARGET_REG_BITS == 32
 271 #define TCGv_ptr TCGv_i32
 272 #else
 273 #define TCGv_ptr TCGv_i64
 274 #endif
 275 #define MAKE_TCGV_I32(x) (x)
 276 #define MAKE_TCGV_I64(x) (x)
 277 #define MAKE_TCGV_PTR(x) (x)
 278 #define GET_TCGV_I32(t) (t)
 279 #define GET_TCGV_I64(t) (t)
 280 #define GET_TCGV_PTR(t) (t)
 281
 282 #if TCG_TARGET_REG_BITS == 32
 283 #define TCGV_LOW(t) (t)
 284 #define TCGV_HIGH(t) ((t) + 1)
 285 #endif
 286
 287 #endif /* DEBUG_TCGV */
 288
 289 #define TCGV_EQUAL_I32(a, b) (GET_TCGV_I32(a) == GET_TCGV_I32(b))
 290 #define TCGV_EQUAL_I64(a, b) (GET_TCGV_I64(a) == GET_TCGV_I64(b))
 291
 292 /* Dummy definition to avoid compiler warnings.  */
 293 #define TCGV_UNUSED_I32(x) x = MAKE_TCGV_I32(-1)
 294 #define TCGV_UNUSED_I64(x) x = MAKE_TCGV_I64(-1)
 295
 296 #define TCGV_IS_UNUSED_I32(x) (GET_TCGV_I32(x) == -1)
 297 #define TCGV_IS_UNUSED_I64(x) (GET_TCGV_I64(x) == -1)
 298
 299 /* call flags */
 300 /* Helper does not read globals (either directly or through an exception). It
 301    implies TCG_CALL_NO_WRITE_GLOBALS. */
 302 #define TCG_CALL_NO_READ_GLOBALS    0x0010
 303 /* Helper does not write globals */
 304 #define TCG_CALL_NO_WRITE_GLOBALS   0x0020
 305 /* Helper can be safely suppressed if the return value is not used. */
 306 #define TCG_CALL_NO_SIDE_EFFECTS    0x0040
 307
 308 /* convenience version of most used call flags */
 309 #define TCG_CALL_NO_RWG         TCG_CALL_NO_READ_GLOBALS
 310 #define TCG_CALL_NO_WG          TCG_CALL_NO_WRITE_GLOBALS
 311 #define TCG_CALL_NO_SE          TCG_CALL_NO_SIDE_EFFECTS
 312 #define TCG_CALL_NO_RWG_SE      (TCG_CALL_NO_RWG | TCG_CALL_NO_SE)
 313 #define TCG_CALL_NO_WG_SE       (TCG_CALL_NO_WG | TCG_CALL_NO_SE)
 314
 315 /* used to align parameters */
 316 #define TCG_CALL_DUMMY_TCGV     MAKE_TCGV_I32(-1)
 317 #define TCG_CALL_DUMMY_ARG      ((TCGArg)(-1))
 318
 319 /* Conditions.  Note that these are laid out for easy manipulation by
 320    the functions below:
 321      bit 0 is used for inverting;
 322      bit 1 is signed,
 323      bit 2 is unsigned,
 324      bit 3 is used with bit 0 for swapping signed/unsigned.  */
 325 typedef enum {
 326     /* non-signed */
 327     TCG_COND_NEVER  = 0 | 0 | 0 | 0,
 328     TCG_COND_ALWAYS = 0 | 0 | 0 | 1,
 329     TCG_COND_EQ     = 8 | 0 | 0 | 0,
 330     TCG_COND_NE     = 8 | 0 | 0 | 1,
 331     /* signed */
 332     TCG_COND_LT     = 0 | 0 | 2 | 0,
 333     TCG_COND_GE     = 0 | 0 | 2 | 1,
 334     TCG_COND_LE     = 8 | 0 | 2 | 0,
 335     TCG_COND_GT     = 8 | 0 | 2 | 1,
 336     /* unsigned */
 337     TCG_COND_LTU    = 0 | 4 | 0 | 0,
 338     TCG_COND_GEU    = 0 | 4 | 0 | 1,
 339     TCG_COND_LEU    = 8 | 4 | 0 | 0,
 340     TCG_COND_GTU    = 8 | 4 | 0 | 1,
 341 } TCGCond;
 342
 343 /* Invert the sense of the comparison.  */
 344 static inline TCGCond tcg_invert_cond(TCGCond c)
 345 {
 346     return (TCGCond)(c ^ 1);
 347 }
 348
 349 /* Swap the operands in a comparison.  */
 350 static inline TCGCond tcg_swap_cond(TCGCond c)
 351 {
 352     return c & 6 ? (TCGCond)(c ^ 9) : c;
 353 }
 354
 355 /* Create an "unsigned" version of a "signed" comparison.  */
 356 static inline TCGCond tcg_unsigned_cond(TCGCond c)
 357 {
 358     return c & 2 ? (TCGCond)(c ^ 6) : c;
 359 }
 360
 361 /* Must a comparison be considered unsigned?  */
 362 static inline bool is_unsigned_cond(TCGCond c)
 363 {
 364     return (c & 4) != 0;
 365 }
 366
 367 /* Create a "high" version of a double-word comparison.
 368    This removes equality from a LTE or GTE comparison.  */
 369 static inline TCGCond tcg_high_cond(TCGCond c)
 370 {
 371     switch (c) {
 372     case TCG_COND_GE:
 373     case TCG_COND_LE:
 374     case TCG_COND_GEU:
 375     case TCG_COND_LEU:
 376         return (TCGCond)(c ^ 8);
 377     default:
 378         return c;
 379     }
 380 }
 381
 382 #define TEMP_VAL_DEAD  0
 383 #define TEMP_VAL_REG   1
 384 #define TEMP_VAL_MEM   2
 385 #define TEMP_VAL_CONST 3
 386
 387 /* XXX: optimize memory layout */
 388 typedef struct TCGTemp {
 389     TCGType base_type;
 390     TCGType type;
 391     int val_type;
 392     int reg;
 393     tcg_target_long val;
 394     int mem_reg;
 395     intptr_t mem_offset;
 396     unsigned int fixed_reg:1;
 397     unsigned int mem_coherent:1;
 398     unsigned int mem_allocated:1;
 399     unsigned int temp_local:1; /* If true, the temp is saved across
 400                                   basic blocks. Otherwise, it is not
 401                                   preserved across basic blocks. */
 402     unsigned int temp_allocated:1; /* never used for code gen */
 403     /* index of next free temp of same base type, -1 if end */
 404     int next_free_temp;
 405     const char *name;
 406 } TCGTemp;
 407
 408 typedef struct TCGHelperInfo {
 409     uintptr_t func;
 410     const char *name;
 411 } TCGHelperInfo;
 412
 413 typedef struct TCGContext TCGContext;
 414
 415 struct TCGContext {
 416     uint8_t *pool_cur, *pool_end;
 417     TCGPool *pool_first, *pool_current, *pool_first_large;
 418     TCGLabel *labels;
 419     int nb_labels;
 420     int nb_globals;
 421     int nb_temps;
 422     /* index of free temps, -1 if none */
 423     int first_free_temp[TCG_TYPE_COUNT * 2];
 424
 425     /* goto_tb support */
 426     uint8_t *code_buf;
 427     uintptr_t *tb_next;
 428     uint16_t *tb_next_offset;
 429     uint16_t *tb_jmp_offset; /* != NULL if USE_DIRECT_JUMP */
 430
 431     /* liveness analysis */
 432     uint16_t *op_dead_args; /* for each operation, each bit tells if the
 433                                corresponding argument is dead */
 434     uint8_t *op_sync_args;  /* for each operation, each bit tells if the
 435                                corresponding output argument needs to be
 436                                sync to memory. */
 437
 438     /* tells in which temporary a given register is. It does not take
 439        into account fixed registers */
 440     int reg_to_temp[TCG_TARGET_NB_REGS];
 441     TCGRegSet reserved_regs;
 442     intptr_t current_frame_offset;
 443     intptr_t frame_start;
 444     intptr_t frame_end;
 445     int frame_reg;
 446
 447     uint8_t *code_ptr;
 448     TCGTemp temps[TCG_MAX_TEMPS]; /* globals first, temps after */
 449
 450     TCGHelperInfo *helpers;
 451     int nb_helpers;
 452     int allocated_helpers;
 453     int helpers_sorted;
 454
 455 #ifdef CONFIG_PROFILER
 456     /* profiling info */
 457     int64_t tb_count1;
 458     int64_t tb_count;
 459     int64_t op_count; /* total insn count */
 460     int op_count_max; /* max insn per TB */
 461     int64_t temp_count;
 462     int temp_count_max;
 463     int64_t del_op_count;
 464     int64_t code_in_len;
 465     int64_t code_out_len;
 466     int64_t interm_time;
 467     int64_t code_time;
 468     int64_t la_time;
 469     int64_t opt_time;
 470     int64_t restore_count;
 471     int64_t restore_time;
 472 #endif
 473
 474 #ifdef CONFIG_DEBUG_TCG
 475     int temps_in_use;
 476     int goto_tb_issue_mask;
 477 #endif
 478
 479     uint16_t gen_opc_buf[OPC_BUF_SIZE];
 480     TCGArg gen_opparam_buf[OPPARAM_BUF_SIZE];
 481
 482     uint16_t *gen_opc_ptr;
 483     TCGArg *gen_opparam_ptr;
 484     target_ulong gen_opc_pc[OPC_BUF_SIZE];
 485     uint16_t gen_opc_icount[OPC_BUF_SIZE];
 486     uint8_t gen_opc_instr_start[OPC_BUF_SIZE];
 487
 488     /* Code generation */
 489     int code_gen_max_blocks;
 490     uint8_t *code_gen_prologue;
 491     uint8_t *code_gen_buffer;
 492     size_t code_gen_buffer_size;
 493     /* threshold to flush the translated code buffer */
 494     size_t code_gen_buffer_max_size;
 495     uint8_t *code_gen_ptr;
 496
 497     TBContext tb_ctx;
 498
 499 #if defined(CONFIG_QEMU_LDST_OPTIMIZATION) && defined(CONFIG_SOFTMMU)
 500     /* labels info for qemu_ld/st IRs
 501        The labels help to generate TLB miss case codes at the end of TB */
 502     TCGLabelQemuLdst *qemu_ldst_labels;
 503     int nb_qemu_ldst_labels;
 504 #endif
 505 };
 506
 507 extern TCGContext tcg_ctx;
 508
 509 /* pool based memory allocation */
 510
 511 void *tcg_malloc_internal(TCGContext *s, int size);
 512 void tcg_pool_reset(TCGContext *s);
 513 void tcg_pool_delete(TCGContext *s);
 514
 515 static inline void *tcg_malloc(int size)
 516 {
 517     TCGContext *s = &tcg_ctx;
 518     uint8_t *ptr, *ptr_end;
 519     size = (size + sizeof(long) - 1) & ~(sizeof(long) - 1);
 520     ptr = s->pool_cur;
 521     ptr_end = ptr + size;
 522     if (unlikely(ptr_end > s->pool_end)) {
 523         return tcg_malloc_internal(&tcg_ctx, size);
 524     } else {
 525         s->pool_cur = ptr_end;
 526         return ptr;
 527     }
 528 }
 529
 530 void tcg_context_init(TCGContext *s);
 531 void tcg_prologue_init(TCGContext *s);
 532 void tcg_func_start(TCGContext *s);
 533
 534 int tcg_gen_code(TCGContext *s, uint8_t *gen_code_buf);
 535 int tcg_gen_code_search_pc(TCGContext *s, uint8_t *gen_code_buf, long offset);
 536
 537 void tcg_set_frame(TCGContext *s, int reg, intptr_t start, intptr_t size);
 538
 539 TCGv_i32 tcg_global_reg_new_i32(int reg, const char *name);
 540 TCGv_i32 tcg_global_mem_new_i32(int reg, intptr_t offset, const char *name);
 541 TCGv_i32 tcg_temp_new_internal_i32(int temp_local);
 542 static inline TCGv_i32 tcg_temp_new_i32(void)
 543 {
 544     return tcg_temp_new_internal_i32(0);
 545 }
 546 static inline TCGv_i32 tcg_temp_local_new_i32(void)
 547 {
 548     return tcg_temp_new_internal_i32(1);
 549 }
 550 void tcg_temp_free_i32(TCGv_i32 arg);
 551 char *tcg_get_arg_str_i32(TCGContext *s, char *buf, int buf_size, TCGv_i32 arg);
 552
 553 TCGv_i64 tcg_global_reg_new_i64(int reg, const char *name);
 554 TCGv_i64 tcg_global_mem_new_i64(int reg, intptr_t offset, const char *name);
 555 TCGv_i64 tcg_temp_new_internal_i64(int temp_local);
 556 static inline TCGv_i64 tcg_temp_new_i64(void)
 557 {
 558     return tcg_temp_new_internal_i64(0);
 559 }
 560 static inline TCGv_i64 tcg_temp_local_new_i64(void)
 561 {
 562     return tcg_temp_new_internal_i64(1);
 563 }
 564 void tcg_temp_free_i64(TCGv_i64 arg);
 565 char *tcg_get_arg_str_i64(TCGContext *s, char *buf, int buf_size, TCGv_i64 arg);
 566
 567 #if defined(CONFIG_DEBUG_TCG)
 568 /* If you call tcg_clear_temp_count() at the start of a section of
 569  * code which is not supposed to leak any TCG temporaries, then
 570  * calling tcg_check_temp_count() at the end of the section will
 571  * return 1 if the section did in fact leak a temporary.
 572  */
 573 void tcg_clear_temp_count(void);
 574 int tcg_check_temp_count(void);
 575 #else
 576 #define tcg_clear_temp_count() do { } while (0)
 577 #define tcg_check_temp_count() 0
 578 #endif
 579
 580 void tcg_dump_info(FILE *f, fprintf_function cpu_fprintf);
 581
 582 #define TCG_CT_ALIAS  0x80
 583 #define TCG_CT_IALIAS 0x40
 584 #define TCG_CT_REG    0x01
 585 #define TCG_CT_CONST  0x02 /* any constant of register size */
 586
 587 typedef struct TCGArgConstraint {
 588     uint16_t ct;
 589     uint8_t alias_index;
 590     union {
 591         TCGRegSet regs;
 592     } u;
 593 } TCGArgConstraint;
 594
 595 #define TCG_MAX_OP_ARGS 16
 596
 597 /* Bits for TCGOpDef->flags, 8 bits available.  */
 598 enum {
 599     /* Instruction defines the end of a basic block.  */
 600     TCG_OPF_BB_END       = 0x01,
 601     /* Instruction clobbers call registers and potentially update globals.  */
 602     TCG_OPF_CALL_CLOBBER = 0x02,
 603     /* Instruction has side effects: it cannot be removed if its outputs
 604        are not used, and might trigger exceptions.  */
 605     TCG_OPF_SIDE_EFFECTS = 0x04,
 606     /* Instruction operands are 64-bits (otherwise 32-bits).  */
 607     TCG_OPF_64BIT        = 0x08,
 608     /* Instruction is optional and not implemented by the host, or insn
 609        is generic and should not be implemened by the host.  */
 610     TCG_OPF_NOT_PRESENT  = 0x10,
 611 };
 612
 613 typedef struct TCGOpDef {
 614     const char *name;
 615     uint8_t nb_oargs, nb_iargs, nb_cargs, nb_args;
 616     uint8_t flags;
 617     TCGArgConstraint *args_ct;
 618     int *sorted_args;
 619 #if defined(CONFIG_DEBUG_TCG)
 620     int used;
 621 #endif
 622 } TCGOpDef;
 623
 624 extern TCGOpDef tcg_op_defs[];
 625 extern const size_t tcg_op_defs_max;
 626
 627 typedef struct TCGTargetOpDef {
 628     TCGOpcode op;
 629     const char *args_ct_str[TCG_MAX_OP_ARGS];
 630 } TCGTargetOpDef;
 631
 632 #define tcg_abort() \
 633 do {\
 634     fprintf(stderr, "%s:%d: tcg fatal error\n", __FILE__, __LINE__);\
 635     abort();\
 636 } while (0)
 637
 638 #ifdef CONFIG_DEBUG_TCG
 639 # define tcg_debug_assert(X) do { assert(X); } while (0)
 640 #elif QEMU_GNUC_PREREQ(4, 5)
 641 # define tcg_debug_assert(X) \
 642     do { if (!(X)) { __builtin_unreachable(); } } while (0)
 643 #else
 644 # define tcg_debug_assert(X) do { (void)(X); } while (0)
 645 #endif
 646
 647 void tcg_add_target_add_op_defs(const TCGTargetOpDef *tdefs);
 648
 649 #if UINTPTR_MAX == UINT32_MAX
 650 #define TCGV_NAT_TO_PTR(n) MAKE_TCGV_PTR(GET_TCGV_I32(n))
 651 #define TCGV_PTR_TO_NAT(n) MAKE_TCGV_I32(GET_TCGV_PTR(n))
 652
 653 #define tcg_const_ptr(V) TCGV_NAT_TO_PTR(tcg_const_i32((intptr_t)(V)))
 654 #define tcg_global_reg_new_ptr(R, N) \
 655     TCGV_NAT_TO_PTR(tcg_global_reg_new_i32((R), (N)))
 656 #define tcg_global_mem_new_ptr(R, O, N) \
 657     TCGV_NAT_TO_PTR(tcg_global_mem_new_i32((R), (O), (N)))
 658 #define tcg_temp_new_ptr() TCGV_NAT_TO_PTR(tcg_temp_new_i32())
 659 #define tcg_temp_free_ptr(T) tcg_temp_free_i32(TCGV_PTR_TO_NAT(T))
 660 #else
 661 #define TCGV_NAT_TO_PTR(n) MAKE_TCGV_PTR(GET_TCGV_I64(n))
 662 #define TCGV_PTR_TO_NAT(n) MAKE_TCGV_I64(GET_TCGV_PTR(n))
 663
 664 #define tcg_const_ptr(V) TCGV_NAT_TO_PTR(tcg_const_i64((intptr_t)(V)))
 665 #define tcg_global_reg_new_ptr(R, N) \
 666     TCGV_NAT_TO_PTR(tcg_global_reg_new_i64((R), (N)))
 667 #define tcg_global_mem_new_ptr(R, O, N) \
 668     TCGV_NAT_TO_PTR(tcg_global_mem_new_i64((R), (O), (N)))
 669 #define tcg_temp_new_ptr() TCGV_NAT_TO_PTR(tcg_temp_new_i64())
 670 #define tcg_temp_free_ptr(T) tcg_temp_free_i64(TCGV_PTR_TO_NAT(T))
 671 #endif
 672
 673 void tcg_gen_callN(TCGContext *s, TCGv_ptr func, unsigned int flags,
 674                    int sizemask, TCGArg ret, int nargs, TCGArg *args);
 675
 676 void tcg_gen_shifti_i64(TCGv_i64 ret, TCGv_i64 arg1,
 677                         int c, int right, int arith);
 678
 679 TCGArg *tcg_optimize(TCGContext *s, uint16_t *tcg_opc_ptr, TCGArg *args,
 680                      TCGOpDef *tcg_op_def);
 681
 682 /* only used for debugging purposes */
 683 void tcg_register_helper(void *func, const char *name);
 684 const char *tcg_helper_get_name(TCGContext *s, void *func);
 685 void tcg_dump_ops(TCGContext *s);
 686
 687 void dump_ops(const uint16_t *opc_buf, const TCGArg *opparam_buf);
 688 TCGv_i32 tcg_const_i32(int32_t val);
 689 TCGv_i64 tcg_const_i64(int64_t val);
 690 TCGv_i32 tcg_const_local_i32(int32_t val);
 691 TCGv_i64 tcg_const_local_i64(int64_t val);
 692
 693 /**
 694  * tcg_qemu_tb_exec:
 695  * @env: CPUArchState * for the CPU
 696  * @tb_ptr: address of generated code for the TB to execute
 697  *
 698  * Start executing code from a given translation block.
 699  * Where translation blocks have been linked, execution
 700  * may proceed from the given TB into successive ones.
 701  * Control eventually returns only when some action is needed
 702  * from the top-level loop: either control must pass to a TB
 703  * which has not yet been directly linked, or an asynchronous
 704  * event such as an interrupt needs handling.
 705  *
 706  * The return value is a pointer to the next TB to execute
 707  * (if known; otherwise zero). This pointer is assumed to be
 708  * 4-aligned, and the bottom two bits are used to return further
 709  * information:
 710  *  0, 1: the link between this TB and the next is via the specified
 711  *        TB index (0 or 1). That is, we left the TB via (the equivalent
 712  *        of) "goto_tb <index>". The main loop uses this to determine
 713  *        how to link the TB just executed to the next.
 714  *  2:    we are using instruction counting code generation, and we
 715  *        did not start executing this TB because the instruction counter
 716  *        would hit zero midway through it. In this case the next-TB pointer
 717  *        returned is the TB we were about to execute, and the caller must
 718  *        arrange to execute the remaining count of instructions.
 719  *  3:    we stopped because the CPU's exit_request flag was set
 720  *        (usually meaning that there is an interrupt that needs to be
 721  *        handled). The next-TB pointer returned is the TB we were
 722  *        about to execute when we noticed the pending exit request.
 723  *
 724  * If the bottom two bits indicate an exit-via-index then the CPU
 725  * state is correctly synchronised and ready for execution of the next
 726  * TB (and in particular the guest PC is the address to execute next).
 727  * Otherwise, we gave up on execution of this TB before it started, and
 728  * the caller must fix up the CPU state by calling cpu_pc_from_tb()
 729  * with the next-TB pointer we return.
 730  *
 731  * Note that TCG targets may use a different definition of tcg_qemu_tb_exec
 732  * to this default (which just calls the prologue.code emitted by
 733  * tcg_target_qemu_prologue()).
 734  */
 735 #define TB_EXIT_MASK 3
 736 #define TB_EXIT_IDX0 0
 737 #define TB_EXIT_IDX1 1
 738 #define TB_EXIT_ICOUNT_EXPIRED 2
 739 #define TB_EXIT_REQUESTED 3
 740
 741 #if !defined(tcg_qemu_tb_exec)
 742 # define tcg_qemu_tb_exec(env, tb_ptr) \
 743     ((uintptr_t (*)(void *, void *))tcg_ctx.code_gen_prologue)(env, tb_ptr)
 744 #endif
 745
 746 void tcg_register_jit(void *buf, size_t buf_size);
 747
 748 #if defined(CONFIG_QEMU_LDST_OPTIMIZATION) && defined(CONFIG_SOFTMMU)
 749 /* Generate TB finalization at the end of block */
 750 void tcg_out_tb_finalize(TCGContext *s);
 751 #endif
 752
 753 /*
 754  * Memory helpers that will be used by TCG generated code.
 755  */
 756 #ifdef CONFIG_SOFTMMU
 757 /* Value zero-extended to tcg register size.  */
 758 tcg_target_ulong helper_ret_ldub_mmu(CPUArchState *env, target_ulong addr,
 759                                      int mmu_idx, uintptr_t retaddr);
 760 tcg_target_ulong helper_ret_lduw_mmu(CPUArchState *env, target_ulong addr,
 761                                      int mmu_idx, uintptr_t retaddr);
 762 tcg_target_ulong helper_ret_ldul_mmu(CPUArchState *env, target_ulong addr,
 763                                      int mmu_idx, uintptr_t retaddr);
 764 uint64_t helper_ret_ldq_mmu(CPUArchState *env, target_ulong addr,
 765                             int mmu_idx, uintptr_t retaddr);
 766
 767 /* Value sign-extended to tcg register size.  */
 768 tcg_target_ulong helper_ret_ldsb_mmu(CPUArchState *env, target_ulong addr,
 769                                      int mmu_idx, uintptr_t retaddr);
 770 tcg_target_ulong helper_ret_ldsw_mmu(CPUArchState *env, target_ulong addr,
 771                                      int mmu_idx, uintptr_t retaddr);
 772 tcg_target_ulong helper_ret_ldsl_mmu(CPUArchState *env, target_ulong addr,
 773                                      int mmu_idx, uintptr_t retaddr);
 774
 775 void helper_ret_stb_mmu(CPUArchState *env, target_ulong addr, uint8_t val,
 776                         int mmu_idx, uintptr_t retaddr);
 777 void helper_ret_stw_mmu(CPUArchState *env, target_ulong addr, uint16_t val,
 778                         int mmu_idx, uintptr_t retaddr);
 779 void helper_ret_stl_mmu(CPUArchState *env, target_ulong addr, uint32_t val,
 780                         int mmu_idx, uintptr_t retaddr);
 781 void helper_ret_stq_mmu(CPUArchState *env, target_ulong addr, uint64_t val,
 782                         int mmu_idx, uintptr_t retaddr);
 783
 784 uint8_t helper_ldb_mmu(CPUArchState *env, target_ulong addr, int mmu_idx);
 785 uint16_t helper_ldw_mmu(CPUArchState *env, target_ulong addr, int mmu_idx);
 786 uint32_t helper_ldl_mmu(CPUArchState *env, target_ulong addr, int mmu_idx);
 787 uint64_t helper_ldq_mmu(CPUArchState *env, target_ulong addr, int mmu_idx);
 788
 789 void helper_stb_mmu(CPUArchState *env, target_ulong addr,
 790                     uint8_t val, int mmu_idx);
 791 void helper_stw_mmu(CPUArchState *env, target_ulong addr,
 792                     uint16_t val, int mmu_idx);
 793 void helper_stl_mmu(CPUArchState *env, target_ulong addr,
 794                     uint32_t val, int mmu_idx);
 795 void helper_stq_mmu(CPUArchState *env, target_ulong addr,
 796                     uint64_t val, int mmu_idx);
 797 #endif /* CONFIG_SOFTMMU */
 798
 799 #endif /* TCG_H */