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 #include "qemu/bitops.h"
  30 #include "tcg-target.h"
  31
  32 #define CPU_TEMP_BUF_NLONGS 128
  33
  34 /* Default target word size to pointer size.  */
  35 #ifndef TCG_TARGET_REG_BITS
  36 # if UINTPTR_MAX == UINT32_MAX
  37 #  define TCG_TARGET_REG_BITS 32
  38 # elif UINTPTR_MAX == UINT64_MAX
  39 #  define TCG_TARGET_REG_BITS 64
  40 # else
  41 #  error Unknown pointer size for tcg target
  42 # endif
  43 #endif
  44
  45 #if TCG_TARGET_REG_BITS == 32
  46 typedef int32_t tcg_target_long;
  47 typedef uint32_t tcg_target_ulong;
  48 #define TCG_PRIlx PRIx32
  49 #define TCG_PRIld PRId32
  50 #elif TCG_TARGET_REG_BITS == 64
  51 typedef int64_t tcg_target_long;
  52 typedef uint64_t tcg_target_ulong;
  53 #define TCG_PRIlx PRIx64
  54 #define TCG_PRIld PRId64
  55 #else
  56 #error unsupported
  57 #endif
  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_extrl_i64_i32    0
  70 #define TCG_TARGET_HAS_extrh_i64_i32    0
  71 #define TCG_TARGET_HAS_div_i64          0
  72 #define TCG_TARGET_HAS_rem_i64          0
  73 #define TCG_TARGET_HAS_div2_i64         0
  74 #define TCG_TARGET_HAS_rot_i64          0
  75 #define TCG_TARGET_HAS_ext8s_i64        0
  76 #define TCG_TARGET_HAS_ext16s_i64       0
  77 #define TCG_TARGET_HAS_ext32s_i64       0
  78 #define TCG_TARGET_HAS_ext8u_i64        0
  79 #define TCG_TARGET_HAS_ext16u_i64       0
  80 #define TCG_TARGET_HAS_ext32u_i64       0
  81 #define TCG_TARGET_HAS_bswap16_i64      0
  82 #define TCG_TARGET_HAS_bswap32_i64      0
  83 #define TCG_TARGET_HAS_bswap64_i64      0
  84 #define TCG_TARGET_HAS_neg_i64          0
  85 #define TCG_TARGET_HAS_not_i64          0
  86 #define TCG_TARGET_HAS_andc_i64         0
  87 #define TCG_TARGET_HAS_orc_i64          0
  88 #define TCG_TARGET_HAS_eqv_i64          0
  89 #define TCG_TARGET_HAS_nand_i64         0
  90 #define TCG_TARGET_HAS_nor_i64          0
  91 #define TCG_TARGET_HAS_deposit_i64      0
  92 #define TCG_TARGET_HAS_movcond_i64      0
  93 #define TCG_TARGET_HAS_add2_i64         0
  94 #define TCG_TARGET_HAS_sub2_i64         0
  95 #define TCG_TARGET_HAS_mulu2_i64        0
  96 #define TCG_TARGET_HAS_muls2_i64        0
  97 #define TCG_TARGET_HAS_muluh_i64        0
  98 #define TCG_TARGET_HAS_mulsh_i64        0
  99 /* Turn some undef macros into true macros.  */
 100 #define TCG_TARGET_HAS_add2_i32         1
 101 #define TCG_TARGET_HAS_sub2_i32         1
 102 #endif
 103
 104 #ifndef TCG_TARGET_deposit_i32_valid
 105 #define TCG_TARGET_deposit_i32_valid(ofs, len) 1
 106 #endif
 107 #ifndef TCG_TARGET_deposit_i64_valid
 108 #define TCG_TARGET_deposit_i64_valid(ofs, len) 1
 109 #endif
 110
 111 /* Only one of DIV or DIV2 should be defined.  */
 112 #if defined(TCG_TARGET_HAS_div_i32)
 113 #define TCG_TARGET_HAS_div2_i32         0
 114 #elif defined(TCG_TARGET_HAS_div2_i32)
 115 #define TCG_TARGET_HAS_div_i32          0
 116 #define TCG_TARGET_HAS_rem_i32          0
 117 #endif
 118 #if defined(TCG_TARGET_HAS_div_i64)
 119 #define TCG_TARGET_HAS_div2_i64         0
 120 #elif defined(TCG_TARGET_HAS_div2_i64)
 121 #define TCG_TARGET_HAS_div_i64          0
 122 #define TCG_TARGET_HAS_rem_i64          0
 123 #endif
 124
 125 /* For 32-bit targets, some sort of unsigned widening multiply is required.  */
 126 #if TCG_TARGET_REG_BITS == 32 \
 127     && !(defined(TCG_TARGET_HAS_mulu2_i32) \
 128          || defined(TCG_TARGET_HAS_muluh_i32))
 129 # error "Missing unsigned widening multiply"
 130 #endif
 131
 132 #ifndef TARGET_INSN_START_EXTRA_WORDS
 133 # define TARGET_INSN_START_WORDS 1
 134 #else
 135 # define TARGET_INSN_START_WORDS (1 + TARGET_INSN_START_EXTRA_WORDS)
 136 #endif
 137
 138 typedef enum TCGOpcode {
 139 #define DEF(name, oargs, iargs, cargs, flags) INDEX_op_ ## name,
 140 #include "tcg-opc.h"
 141 #undef DEF
 142     NB_OPS,
 143 } TCGOpcode;
 144
 145 #define tcg_regset_clear(d) (d) = 0
 146 #define tcg_regset_set(d, s) (d) = (s)
 147 #define tcg_regset_set32(d, reg, val32) (d) |= (val32) << (reg)
 148 #define tcg_regset_set_reg(d, r) (d) |= 1L << (r)
 149 #define tcg_regset_reset_reg(d, r) (d) &= ~(1L << (r))
 150 #define tcg_regset_test_reg(d, r) (((d) >> (r)) & 1)
 151 #define tcg_regset_or(d, a, b) (d) = (a) | (b)
 152 #define tcg_regset_and(d, a, b) (d) = (a) & (b)
 153 #define tcg_regset_andnot(d, a, b) (d) = (a) & ~(b)
 154 #define tcg_regset_not(d, a) (d) = ~(a)
 155
 156 #ifndef TCG_TARGET_INSN_UNIT_SIZE
 157 # error "Missing TCG_TARGET_INSN_UNIT_SIZE"
 158 #elif TCG_TARGET_INSN_UNIT_SIZE == 1
 159 typedef uint8_t tcg_insn_unit;
 160 #elif TCG_TARGET_INSN_UNIT_SIZE == 2
 161 typedef uint16_t tcg_insn_unit;
 162 #elif TCG_TARGET_INSN_UNIT_SIZE == 4
 163 typedef uint32_t tcg_insn_unit;
 164 #elif TCG_TARGET_INSN_UNIT_SIZE == 8
 165 typedef uint64_t tcg_insn_unit;
 166 #else
 167 /* The port better have done this.  */
 168 #endif
 169
 170
 171 typedef struct TCGRelocation {
 172     struct TCGRelocation *next;
 173     int type;
 174     tcg_insn_unit *ptr;
 175     intptr_t addend;
 176 } TCGRelocation;
 177
 178 typedef struct TCGLabel {
 179     unsigned has_value : 1;
 180     unsigned id : 31;
 181     union {
 182         uintptr_t value;
 183         tcg_insn_unit *value_ptr;
 184         TCGRelocation *first_reloc;
 185     } u;
 186 } TCGLabel;
 187
 188 typedef struct TCGPool {
 189     struct TCGPool *next;
 190     int size;
 191     uint8_t data[0] __attribute__ ((aligned));
 192 } TCGPool;
 193
 194 #define TCG_POOL_CHUNK_SIZE 32768
 195
 196 #define TCG_MAX_TEMPS 512
 197
 198 /* when the size of the arguments of a called function is smaller than
 199    this value, they are statically allocated in the TB stack frame */
 200 #define TCG_STATIC_CALL_ARGS_SIZE 128
 201
 202 typedef enum TCGType {
 203     TCG_TYPE_I32,
 204     TCG_TYPE_I64,
 205     TCG_TYPE_COUNT, /* number of different types */
 206
 207     /* An alias for the size of the host register.  */
 208 #if TCG_TARGET_REG_BITS == 32
 209     TCG_TYPE_REG = TCG_TYPE_I32,
 210 #else
 211     TCG_TYPE_REG = TCG_TYPE_I64,
 212 #endif
 213
 214     /* An alias for the size of the native pointer.  */
 215 #if UINTPTR_MAX == UINT32_MAX
 216     TCG_TYPE_PTR = TCG_TYPE_I32,
 217 #else
 218     TCG_TYPE_PTR = TCG_TYPE_I64,
 219 #endif
 220
 221     /* An alias for the size of the target "long", aka register.  */
 222 #if TARGET_LONG_BITS == 64
 223     TCG_TYPE_TL = TCG_TYPE_I64,
 224 #else
 225     TCG_TYPE_TL = TCG_TYPE_I32,
 226 #endif
 227 } TCGType;
 228
 229 /* Constants for qemu_ld and qemu_st for the Memory Operation field.  */
 230 typedef enum TCGMemOp {
 231     MO_8     = 0,
 232     MO_16    = 1,
 233     MO_32    = 2,
 234     MO_64    = 3,
 235     MO_SIZE  = 3,   /* Mask for the above.  */
 236
 237     MO_SIGN  = 4,   /* Sign-extended, otherwise zero-extended.  */
 238
 239     MO_BSWAP = 8,   /* Host reverse endian.  */
 240 #ifdef HOST_WORDS_BIGENDIAN
 241     MO_LE    = MO_BSWAP,
 242     MO_BE    = 0,
 243 #else
 244     MO_LE    = 0,
 245     MO_BE    = MO_BSWAP,
 246 #endif
 247 #ifdef TARGET_WORDS_BIGENDIAN
 248     MO_TE    = MO_BE,
 249 #else
 250     MO_TE    = MO_LE,
 251 #endif
 252
 253     /* MO_UNALN accesses are never checked for alignment.
 254        MO_ALIGN accesses will result in a call to the CPU's
 255        do_unaligned_access hook if the guest address is not aligned.
 256        The default depends on whether the target CPU defines ALIGNED_ONLY.  */
 257     MO_AMASK = 16,
 258 #ifdef ALIGNED_ONLY
 259     MO_ALIGN = 0,
 260     MO_UNALN = MO_AMASK,
 261 #else
 262     MO_ALIGN = MO_AMASK,
 263     MO_UNALN = 0,
 264 #endif
 265
 266     /* Combinations of the above, for ease of use.  */
 267     MO_UB    = MO_8,
 268     MO_UW    = MO_16,
 269     MO_UL    = MO_32,
 270     MO_SB    = MO_SIGN | MO_8,
 271     MO_SW    = MO_SIGN | MO_16,
 272     MO_SL    = MO_SIGN | MO_32,
 273     MO_Q     = MO_64,
 274
 275     MO_LEUW  = MO_LE | MO_UW,
 276     MO_LEUL  = MO_LE | MO_UL,
 277     MO_LESW  = MO_LE | MO_SW,
 278     MO_LESL  = MO_LE | MO_SL,
 279     MO_LEQ   = MO_LE | MO_Q,
 280
 281     MO_BEUW  = MO_BE | MO_UW,
 282     MO_BEUL  = MO_BE | MO_UL,
 283     MO_BESW  = MO_BE | MO_SW,
 284     MO_BESL  = MO_BE | MO_SL,
 285     MO_BEQ   = MO_BE | MO_Q,
 286
 287     MO_TEUW  = MO_TE | MO_UW,
 288     MO_TEUL  = MO_TE | MO_UL,
 289     MO_TESW  = MO_TE | MO_SW,
 290     MO_TESL  = MO_TE | MO_SL,
 291     MO_TEQ   = MO_TE | MO_Q,
 292
 293     MO_SSIZE = MO_SIZE | MO_SIGN,
 294 } TCGMemOp;
 295
 296 typedef tcg_target_ulong TCGArg;
 297
 298 /* Define a type and accessor macros for variables.  Using pointer types
 299    is nice because it gives some level of type safely.  Converting to and
 300    from intptr_t rather than int reduces the number of sign-extension
 301    instructions that get implied on 64-bit hosts.  Users of tcg_gen_* don't
 302    need to know about any of this, and should treat TCGv as an opaque type.
 303    In addition we do typechecking for different types of variables.  TCGv_i32
 304    and TCGv_i64 are 32/64-bit variables respectively.  TCGv and TCGv_ptr
 305    are aliases for target_ulong and host pointer sized values respectively.  */
 306
 307 typedef struct TCGv_i32_d *TCGv_i32;
 308 typedef struct TCGv_i64_d *TCGv_i64;
 309 typedef struct TCGv_ptr_d *TCGv_ptr;
 310
 311 static inline TCGv_i32 QEMU_ARTIFICIAL MAKE_TCGV_I32(intptr_t i)
 312 {
 313     return (TCGv_i32)i;
 314 }
 315
 316 static inline TCGv_i64 QEMU_ARTIFICIAL MAKE_TCGV_I64(intptr_t i)
 317 {
 318     return (TCGv_i64)i;
 319 }
 320
 321 static inline TCGv_ptr QEMU_ARTIFICIAL MAKE_TCGV_PTR(intptr_t i)
 322 {
 323     return (TCGv_ptr)i;
 324 }
 325
 326 static inline intptr_t QEMU_ARTIFICIAL GET_TCGV_I32(TCGv_i32 t)
 327 {
 328     return (intptr_t)t;
 329 }
 330
 331 static inline intptr_t QEMU_ARTIFICIAL GET_TCGV_I64(TCGv_i64 t)
 332 {
 333     return (intptr_t)t;
 334 }
 335
 336 static inline intptr_t QEMU_ARTIFICIAL GET_TCGV_PTR(TCGv_ptr t)
 337 {
 338     return (intptr_t)t;
 339 }
 340
 341 #if TCG_TARGET_REG_BITS == 32
 342 #define TCGV_LOW(t) MAKE_TCGV_I32(GET_TCGV_I64(t))
 343 #define TCGV_HIGH(t) MAKE_TCGV_I32(GET_TCGV_I64(t) + 1)
 344 #endif
 345
 346 #define TCGV_EQUAL_I32(a, b) (GET_TCGV_I32(a) == GET_TCGV_I32(b))
 347 #define TCGV_EQUAL_I64(a, b) (GET_TCGV_I64(a) == GET_TCGV_I64(b))
 348 #define TCGV_EQUAL_PTR(a, b) (GET_TCGV_PTR(a) == GET_TCGV_PTR(b))
 349
 350 /* Dummy definition to avoid compiler warnings.  */
 351 #define TCGV_UNUSED_I32(x) x = MAKE_TCGV_I32(-1)
 352 #define TCGV_UNUSED_I64(x) x = MAKE_TCGV_I64(-1)
 353 #define TCGV_UNUSED_PTR(x) x = MAKE_TCGV_PTR(-1)
 354
 355 #define TCGV_IS_UNUSED_I32(x) (GET_TCGV_I32(x) == -1)
 356 #define TCGV_IS_UNUSED_I64(x) (GET_TCGV_I64(x) == -1)
 357 #define TCGV_IS_UNUSED_PTR(x) (GET_TCGV_PTR(x) == -1)
 358
 359 /* call flags */
 360 /* Helper does not read globals (either directly or through an exception). It
 361    implies TCG_CALL_NO_WRITE_GLOBALS. */
 362 #define TCG_CALL_NO_READ_GLOBALS    0x0010
 363 /* Helper does not write globals */
 364 #define TCG_CALL_NO_WRITE_GLOBALS   0x0020
 365 /* Helper can be safely suppressed if the return value is not used. */
 366 #define TCG_CALL_NO_SIDE_EFFECTS    0x0040
 367
 368 /* convenience version of most used call flags */
 369 #define TCG_CALL_NO_RWG         TCG_CALL_NO_READ_GLOBALS
 370 #define TCG_CALL_NO_WG          TCG_CALL_NO_WRITE_GLOBALS
 371 #define TCG_CALL_NO_SE          TCG_CALL_NO_SIDE_EFFECTS
 372 #define TCG_CALL_NO_RWG_SE      (TCG_CALL_NO_RWG | TCG_CALL_NO_SE)
 373 #define TCG_CALL_NO_WG_SE       (TCG_CALL_NO_WG | TCG_CALL_NO_SE)
 374
 375 /* used to align parameters */
 376 #define TCG_CALL_DUMMY_TCGV     MAKE_TCGV_I32(-1)
 377 #define TCG_CALL_DUMMY_ARG      ((TCGArg)(-1))
 378
 379 /* Conditions.  Note that these are laid out for easy manipulation by
 380    the functions below:
 381      bit 0 is used for inverting;
 382      bit 1 is signed,
 383      bit 2 is unsigned,
 384      bit 3 is used with bit 0 for swapping signed/unsigned.  */
 385 typedef enum {
 386     /* non-signed */
 387     TCG_COND_NEVER  = 0 | 0 | 0 | 0,
 388     TCG_COND_ALWAYS = 0 | 0 | 0 | 1,
 389     TCG_COND_EQ     = 8 | 0 | 0 | 0,
 390     TCG_COND_NE     = 8 | 0 | 0 | 1,
 391     /* signed */
 392     TCG_COND_LT     = 0 | 0 | 2 | 0,
 393     TCG_COND_GE     = 0 | 0 | 2 | 1,
 394     TCG_COND_LE     = 8 | 0 | 2 | 0,
 395     TCG_COND_GT     = 8 | 0 | 2 | 1,
 396     /* unsigned */
 397     TCG_COND_LTU    = 0 | 4 | 0 | 0,
 398     TCG_COND_GEU    = 0 | 4 | 0 | 1,
 399     TCG_COND_LEU    = 8 | 4 | 0 | 0,
 400     TCG_COND_GTU    = 8 | 4 | 0 | 1,
 401 } TCGCond;
 402
 403 /* Invert the sense of the comparison.  */
 404 static inline TCGCond tcg_invert_cond(TCGCond c)
 405 {
 406     return (TCGCond)(c ^ 1);
 407 }
 408
 409 /* Swap the operands in a comparison.  */
 410 static inline TCGCond tcg_swap_cond(TCGCond c)
 411 {
 412     return c & 6 ? (TCGCond)(c ^ 9) : c;
 413 }
 414
 415 /* Create an "unsigned" version of a "signed" comparison.  */
 416 static inline TCGCond tcg_unsigned_cond(TCGCond c)
 417 {
 418     return c & 2 ? (TCGCond)(c ^ 6) : c;
 419 }
 420
 421 /* Must a comparison be considered unsigned?  */
 422 static inline bool is_unsigned_cond(TCGCond c)
 423 {
 424     return (c & 4) != 0;
 425 }
 426
 427 /* Create a "high" version of a double-word comparison.
 428    This removes equality from a LTE or GTE comparison.  */
 429 static inline TCGCond tcg_high_cond(TCGCond c)
 430 {
 431     switch (c) {
 432     case TCG_COND_GE:
 433     case TCG_COND_LE:
 434     case TCG_COND_GEU:
 435     case TCG_COND_LEU:
 436         return (TCGCond)(c ^ 8);
 437     default:
 438         return c;
 439     }
 440 }
 441
 442 typedef enum TCGTempVal {
 443     TEMP_VAL_DEAD,
 444     TEMP_VAL_REG,
 445     TEMP_VAL_MEM,
 446     TEMP_VAL_CONST,
 447 } TCGTempVal;
 448
 449 typedef struct TCGTemp {
 450     unsigned int reg:8;
 451     unsigned int mem_reg:8;
 452     TCGTempVal val_type:8;
 453     TCGType base_type:8;
 454     TCGType type:8;
 455     unsigned int fixed_reg:1;
 456     unsigned int mem_coherent:1;
 457     unsigned int mem_allocated:1;
 458     unsigned int temp_local:1; /* If true, the temp is saved across
 459                                   basic blocks. Otherwise, it is not
 460                                   preserved across basic blocks. */
 461     unsigned int temp_allocated:1; /* never used for code gen */
 462
 463     tcg_target_long val;
 464     intptr_t mem_offset;
 465     const char *name;
 466 } TCGTemp;
 467
 468 typedef struct TCGContext TCGContext;
 469
 470 typedef struct TCGTempSet {
 471     unsigned long l[BITS_TO_LONGS(TCG_MAX_TEMPS)];
 472 } TCGTempSet;
 473
 474 typedef struct TCGOp {
 475     TCGOpcode opc   : 8;
 476
 477     /* The number of out and in parameter for a call.  */
 478     unsigned callo  : 2;
 479     unsigned calli  : 6;
 480
 481     /* Index of the arguments for this op, or -1 for zero-operand ops.  */
 482     signed args     : 16;
 483
 484     /* Index of the prex/next op, or -1 for the end of the list.  */
 485     signed prev     : 16;
 486     signed next     : 16;
 487 } TCGOp;
 488
 489 QEMU_BUILD_BUG_ON(NB_OPS > 0xff);
 490 QEMU_BUILD_BUG_ON(OPC_BUF_SIZE >= 0x7fff);
 491 QEMU_BUILD_BUG_ON(OPPARAM_BUF_SIZE >= 0x7fff);
 492
 493 struct TCGContext {
 494     uint8_t *pool_cur, *pool_end;
 495     TCGPool *pool_first, *pool_current, *pool_first_large;
 496     int nb_labels;
 497     int nb_globals;
 498     int nb_temps;
 499
 500     /* goto_tb support */
 501     tcg_insn_unit *code_buf;
 502     uintptr_t *tb_next;
 503     uint16_t *tb_next_offset;
 504     uint16_t *tb_jmp_offset; /* != NULL if USE_DIRECT_JUMP */
 505
 506     /* liveness analysis */
 507     uint16_t *op_dead_args; /* for each operation, each bit tells if the
 508                                corresponding argument is dead */
 509     uint8_t *op_sync_args;  /* for each operation, each bit tells if the
 510                                corresponding output argument needs to be
 511                                sync to memory. */
 512
 513     TCGRegSet reserved_regs;
 514     intptr_t current_frame_offset;
 515     intptr_t frame_start;
 516     intptr_t frame_end;
 517     int frame_reg;
 518
 519     tcg_insn_unit *code_ptr;
 520
 521     GHashTable *helpers;
 522
 523 #ifdef CONFIG_PROFILER
 524     /* profiling info */
 525     int64_t tb_count1;
 526     int64_t tb_count;
 527     int64_t op_count; /* total insn count */
 528     int op_count_max; /* max insn per TB */
 529     int64_t temp_count;
 530     int temp_count_max;
 531     int64_t del_op_count;
 532     int64_t code_in_len;
 533     int64_t code_out_len;
 534     int64_t interm_time;
 535     int64_t code_time;
 536     int64_t la_time;
 537     int64_t opt_time;
 538     int64_t restore_count;
 539     int64_t restore_time;
 540 #endif
 541
 542 #ifdef CONFIG_DEBUG_TCG
 543     int temps_in_use;
 544     int goto_tb_issue_mask;
 545 #endif
 546
 547     int gen_first_op_idx;
 548     int gen_last_op_idx;
 549     int gen_next_op_idx;
 550     int gen_next_parm_idx;
 551
 552     /* Code generation.  Note that we specifically do not use tcg_insn_unit
 553        here, because there's too much arithmetic throughout that relies
 554        on addition and subtraction working on bytes.  Rely on the GCC
 555        extension that allows arithmetic on void*.  */
 556     int code_gen_max_blocks;
 557     void *code_gen_prologue;
 558     void *code_gen_buffer;
 559     size_t code_gen_buffer_size;
 560     /* threshold to flush the translated code buffer */
 561     size_t code_gen_buffer_max_size;
 562     void *code_gen_ptr;
 563
 564     TBContext tb_ctx;
 565
 566     /* The TCGBackendData structure is private to tcg-target.c.  */
 567     struct TCGBackendData *be;
 568
 569     TCGTempSet free_temps[TCG_TYPE_COUNT * 2];
 570     TCGTemp temps[TCG_MAX_TEMPS]; /* globals first, temps after */
 571
 572     /* tells in which temporary a given register is. It does not take
 573        into account fixed registers */
 574     int reg_to_temp[TCG_TARGET_NB_REGS];
 575
 576     TCGOp gen_op_buf[OPC_BUF_SIZE];
 577     TCGArg gen_opparam_buf[OPPARAM_BUF_SIZE];
 578
 579     target_ulong gen_opc_pc[OPC_BUF_SIZE];
 580     uint16_t gen_opc_icount[OPC_BUF_SIZE];
 581     uint8_t gen_opc_instr_start[OPC_BUF_SIZE];
 582 };
 583
 584 extern TCGContext tcg_ctx;
 585
 586 /* The number of opcodes emitted so far.  */
 587 static inline int tcg_op_buf_count(void)
 588 {
 589     return tcg_ctx.gen_next_op_idx;
 590 }
 591
 592 /* Test for whether to terminate the TB for using too many opcodes.  */
 593 static inline bool tcg_op_buf_full(void)
 594 {
 595     return tcg_op_buf_count() >= OPC_MAX_SIZE;
 596 }
 597
 598 /* pool based memory allocation */
 599
 600 void *tcg_malloc_internal(TCGContext *s, int size);
 601 void tcg_pool_reset(TCGContext *s);
 602 void tcg_pool_delete(TCGContext *s);
 603
 604 void tb_lock(void);
 605 void tb_unlock(void);
 606 void tb_lock_reset(void);
 607
 608 static inline void *tcg_malloc(int size)
 609 {
 610     TCGContext *s = &tcg_ctx;
 611     uint8_t *ptr, *ptr_end;
 612     size = (size + sizeof(long) - 1) & ~(sizeof(long) - 1);
 613     ptr = s->pool_cur;
 614     ptr_end = ptr + size;
 615     if (unlikely(ptr_end > s->pool_end)) {
 616         return tcg_malloc_internal(&tcg_ctx, size);
 617     } else {
 618         s->pool_cur = ptr_end;
 619         return ptr;
 620     }
 621 }
 622
 623 void tcg_context_init(TCGContext *s);
 624 void tcg_prologue_init(TCGContext *s);
 625 void tcg_func_start(TCGContext *s);
 626
 627 int tcg_gen_code(TCGContext *s, tcg_insn_unit *gen_code_buf);
 628 int tcg_gen_code_search_pc(TCGContext *s, tcg_insn_unit *gen_code_buf,
 629                            long offset);
 630
 631 void tcg_set_frame(TCGContext *s, int reg, intptr_t start, intptr_t size);
 632
 633 TCGv_i32 tcg_global_reg_new_i32(int reg, const char *name);
 634 TCGv_i32 tcg_global_mem_new_i32(int reg, intptr_t offset, const char *name);
 635 TCGv_i32 tcg_temp_new_internal_i32(int temp_local);
 636 static inline TCGv_i32 tcg_temp_new_i32(void)
 637 {
 638     return tcg_temp_new_internal_i32(0);
 639 }
 640 static inline TCGv_i32 tcg_temp_local_new_i32(void)
 641 {
 642     return tcg_temp_new_internal_i32(1);
 643 }
 644 void tcg_temp_free_i32(TCGv_i32 arg);
 645 char *tcg_get_arg_str_i32(TCGContext *s, char *buf, int buf_size, TCGv_i32 arg);
 646
 647 TCGv_i64 tcg_global_reg_new_i64(int reg, const char *name);
 648 TCGv_i64 tcg_global_mem_new_i64(int reg, intptr_t offset, const char *name);
 649 TCGv_i64 tcg_temp_new_internal_i64(int temp_local);
 650 static inline TCGv_i64 tcg_temp_new_i64(void)
 651 {
 652     return tcg_temp_new_internal_i64(0);
 653 }
 654 static inline TCGv_i64 tcg_temp_local_new_i64(void)
 655 {
 656     return tcg_temp_new_internal_i64(1);
 657 }
 658 void tcg_temp_free_i64(TCGv_i64 arg);
 659 char *tcg_get_arg_str_i64(TCGContext *s, char *buf, int buf_size, TCGv_i64 arg);
 660
 661 #if defined(CONFIG_DEBUG_TCG)
 662 /* If you call tcg_clear_temp_count() at the start of a section of
 663  * code which is not supposed to leak any TCG temporaries, then
 664  * calling tcg_check_temp_count() at the end of the section will
 665  * return 1 if the section did in fact leak a temporary.
 666  */
 667 void tcg_clear_temp_count(void);
 668 int tcg_check_temp_count(void);
 669 #else
 670 #define tcg_clear_temp_count() do { } while (0)
 671 #define tcg_check_temp_count() 0
 672 #endif
 673
 674 void tcg_dump_info(FILE *f, fprintf_function cpu_fprintf);
 675 void tcg_dump_op_count(FILE *f, fprintf_function cpu_fprintf);
 676
 677 #define TCG_CT_ALIAS  0x80
 678 #define TCG_CT_IALIAS 0x40
 679 #define TCG_CT_REG    0x01
 680 #define TCG_CT_CONST  0x02 /* any constant of register size */
 681
 682 typedef struct TCGArgConstraint {
 683     uint16_t ct;
 684     uint8_t alias_index;
 685     union {
 686         TCGRegSet regs;
 687     } u;
 688 } TCGArgConstraint;
 689
 690 #define TCG_MAX_OP_ARGS 16
 691
 692 /* Bits for TCGOpDef->flags, 8 bits available.  */
 693 enum {
 694     /* Instruction defines the end of a basic block.  */
 695     TCG_OPF_BB_END       = 0x01,
 696     /* Instruction clobbers call registers and potentially update globals.  */
 697     TCG_OPF_CALL_CLOBBER = 0x02,
 698     /* Instruction has side effects: it cannot be removed if its outputs
 699        are not used, and might trigger exceptions.  */
 700     TCG_OPF_SIDE_EFFECTS = 0x04,
 701     /* Instruction operands are 64-bits (otherwise 32-bits).  */
 702     TCG_OPF_64BIT        = 0x08,
 703     /* Instruction is optional and not implemented by the host, or insn
 704        is generic and should not be implemened by the host.  */
 705     TCG_OPF_NOT_PRESENT  = 0x10,
 706 };
 707
 708 typedef struct TCGOpDef {
 709     const char *name;
 710     uint8_t nb_oargs, nb_iargs, nb_cargs, nb_args;
 711     uint8_t flags;
 712     TCGArgConstraint *args_ct;
 713     int *sorted_args;
 714 #if defined(CONFIG_DEBUG_TCG)
 715     int used;
 716 #endif
 717 } TCGOpDef;
 718
 719 extern TCGOpDef tcg_op_defs[];
 720 extern const size_t tcg_op_defs_max;
 721
 722 typedef struct TCGTargetOpDef {
 723     TCGOpcode op;
 724     const char *args_ct_str[TCG_MAX_OP_ARGS];
 725 } TCGTargetOpDef;
 726
 727 #define tcg_abort() \
 728 do {\
 729     fprintf(stderr, "%s:%d: tcg fatal error\n", __FILE__, __LINE__);\
 730     abort();\
 731 } while (0)
 732
 733 #ifdef CONFIG_DEBUG_TCG
 734 # define tcg_debug_assert(X) do { assert(X); } while (0)
 735 #elif QEMU_GNUC_PREREQ(4, 5)
 736 # define tcg_debug_assert(X) \
 737     do { if (!(X)) { __builtin_unreachable(); } } while (0)
 738 #else
 739 # define tcg_debug_assert(X) do { (void)(X); } while (0)
 740 #endif
 741
 742 void tcg_add_target_add_op_defs(const TCGTargetOpDef *tdefs);
 743
 744 #if UINTPTR_MAX == UINT32_MAX
 745 #define TCGV_NAT_TO_PTR(n) MAKE_TCGV_PTR(GET_TCGV_I32(n))
 746 #define TCGV_PTR_TO_NAT(n) MAKE_TCGV_I32(GET_TCGV_PTR(n))
 747
 748 #define tcg_const_ptr(V) TCGV_NAT_TO_PTR(tcg_const_i32((intptr_t)(V)))
 749 #define tcg_global_reg_new_ptr(R, N) \
 750     TCGV_NAT_TO_PTR(tcg_global_reg_new_i32((R), (N)))
 751 #define tcg_global_mem_new_ptr(R, O, N) \
 752     TCGV_NAT_TO_PTR(tcg_global_mem_new_i32((R), (O), (N)))
 753 #define tcg_temp_new_ptr() TCGV_NAT_TO_PTR(tcg_temp_new_i32())
 754 #define tcg_temp_free_ptr(T) tcg_temp_free_i32(TCGV_PTR_TO_NAT(T))
 755 #else
 756 #define TCGV_NAT_TO_PTR(n) MAKE_TCGV_PTR(GET_TCGV_I64(n))
 757 #define TCGV_PTR_TO_NAT(n) MAKE_TCGV_I64(GET_TCGV_PTR(n))
 758
 759 #define tcg_const_ptr(V) TCGV_NAT_TO_PTR(tcg_const_i64((intptr_t)(V)))
 760 #define tcg_global_reg_new_ptr(R, N) \
 761     TCGV_NAT_TO_PTR(tcg_global_reg_new_i64((R), (N)))
 762 #define tcg_global_mem_new_ptr(R, O, N) \
 763     TCGV_NAT_TO_PTR(tcg_global_mem_new_i64((R), (O), (N)))
 764 #define tcg_temp_new_ptr() TCGV_NAT_TO_PTR(tcg_temp_new_i64())
 765 #define tcg_temp_free_ptr(T) tcg_temp_free_i64(TCGV_PTR_TO_NAT(T))
 766 #endif
 767
 768 void tcg_gen_callN(TCGContext *s, void *func,
 769                    TCGArg ret, int nargs, TCGArg *args);
 770
 771 void tcg_op_remove(TCGContext *s, TCGOp *op);
 772 void tcg_optimize(TCGContext *s);
 773
 774 /* only used for debugging purposes */
 775 void tcg_dump_ops(TCGContext *s);
 776
 777 void dump_ops(const uint16_t *opc_buf, const TCGArg *opparam_buf);
 778 TCGv_i32 tcg_const_i32(int32_t val);
 779 TCGv_i64 tcg_const_i64(int64_t val);
 780 TCGv_i32 tcg_const_local_i32(int32_t val);
 781 TCGv_i64 tcg_const_local_i64(int64_t val);
 782
 783 TCGLabel *gen_new_label(void);
 784
 785 /**
 786  * label_arg
 787  * @l: label
 788  *
 789  * Encode a label for storage in the TCG opcode stream.
 790  */
 791
 792 static inline TCGArg label_arg(TCGLabel *l)
 793 {
 794     return (uintptr_t)l;
 795 }
 796
 797 /**
 798  * arg_label
 799  * @i: value
 800  *
 801  * The opposite of label_arg.  Retrieve a label from the
 802  * encoding of the TCG opcode stream.
 803  */
 804
 805 static inline TCGLabel *arg_label(TCGArg i)
 806 {
 807     return (TCGLabel *)(uintptr_t)i;
 808 }
 809
 810 /**
 811  * tcg_ptr_byte_diff
 812  * @a, @b: addresses to be differenced
 813  *
 814  * There are many places within the TCG backends where we need a byte
 815  * difference between two pointers.  While this can be accomplished
 816  * with local casting, it's easy to get wrong -- especially if one is
 817  * concerned with the signedness of the result.
 818  *
 819  * This version relies on GCC's void pointer arithmetic to get the
 820  * correct result.
 821  */
 822
 823 static inline ptrdiff_t tcg_ptr_byte_diff(void *a, void *b)
 824 {
 825     return a - b;
 826 }
 827
 828 /**
 829  * tcg_pcrel_diff
 830  * @s: the tcg context
 831  * @target: address of the target
 832  *
 833  * Produce a pc-relative difference, from the current code_ptr
 834  * to the destination address.
 835  */
 836
 837 static inline ptrdiff_t tcg_pcrel_diff(TCGContext *s, void *target)
 838 {
 839     return tcg_ptr_byte_diff(target, s->code_ptr);
 840 }
 841
 842 /**
 843  * tcg_current_code_size
 844  * @s: the tcg context
 845  *
 846  * Compute the current code size within the translation block.
 847  * This is used to fill in qemu's data structures for goto_tb.
 848  */
 849
 850 static inline size_t tcg_current_code_size(TCGContext *s)
 851 {
 852     return tcg_ptr_byte_diff(s->code_ptr, s->code_buf);
 853 }
 854
 855 /* Combine the TCGMemOp and mmu_idx parameters into a single value.  */
 856 typedef uint32_t TCGMemOpIdx;
 857
 858 /**
 859  * make_memop_idx
 860  * @op: memory operation
 861  * @idx: mmu index
 862  *
 863  * Encode these values into a single parameter.
 864  */
 865 static inline TCGMemOpIdx make_memop_idx(TCGMemOp op, unsigned idx)
 866 {
 867     tcg_debug_assert(idx <= 15);
 868     return (op << 4) | idx;
 869 }
 870
 871 /**
 872  * get_memop
 873  * @oi: combined op/idx parameter
 874  *
 875  * Extract the memory operation from the combined value.
 876  */
 877 static inline TCGMemOp get_memop(TCGMemOpIdx oi)
 878 {
 879     return oi >> 4;
 880 }
 881
 882 /**
 883  * get_mmuidx
 884  * @oi: combined op/idx parameter
 885  *
 886  * Extract the mmu index from the combined value.
 887  */
 888 static inline unsigned get_mmuidx(TCGMemOpIdx oi)
 889 {
 890     return oi & 15;
 891 }
 892
 893 /**
 894  * tcg_qemu_tb_exec:
 895  * @env: CPUArchState * for the CPU
 896  * @tb_ptr: address of generated code for the TB to execute
 897  *
 898  * Start executing code from a given translation block.
 899  * Where translation blocks have been linked, execution
 900  * may proceed from the given TB into successive ones.
 901  * Control eventually returns only when some action is needed
 902  * from the top-level loop: either control must pass to a TB
 903  * which has not yet been directly linked, or an asynchronous
 904  * event such as an interrupt needs handling.
 905  *
 906  * The return value is a pointer to the next TB to execute
 907  * (if known; otherwise zero). This pointer is assumed to be
 908  * 4-aligned, and the bottom two bits are used to return further
 909  * information:
 910  *  0, 1: the link between this TB and the next is via the specified
 911  *        TB index (0 or 1). That is, we left the TB via (the equivalent
 912  *        of) "goto_tb <index>". The main loop uses this to determine
 913  *        how to link the TB just executed to the next.
 914  *  2:    we are using instruction counting code generation, and we
 915  *        did not start executing this TB because the instruction counter
 916  *        would hit zero midway through it. In this case the next-TB pointer
 917  *        returned is the TB we were about to execute, and the caller must
 918  *        arrange to execute the remaining count of instructions.
 919  *  3:    we stopped because the CPU's exit_request flag was set
 920  *        (usually meaning that there is an interrupt that needs to be
 921  *        handled). The next-TB pointer returned is the TB we were
 922  *        about to execute when we noticed the pending exit request.
 923  *
 924  * If the bottom two bits indicate an exit-via-index then the CPU
 925  * state is correctly synchronised and ready for execution of the next
 926  * TB (and in particular the guest PC is the address to execute next).
 927  * Otherwise, we gave up on execution of this TB before it started, and
 928  * the caller must fix up the CPU state by calling the CPU's
 929  * synchronize_from_tb() method with the next-TB pointer we return (falling
 930  * back to calling the CPU's set_pc method with tb->pb if no
 931  * synchronize_from_tb() method exists).
 932  *
 933  * Note that TCG targets may use a different definition of tcg_qemu_tb_exec
 934  * to this default (which just calls the prologue.code emitted by
 935  * tcg_target_qemu_prologue()).
 936  */
 937 #define TB_EXIT_MASK 3
 938 #define TB_EXIT_IDX0 0
 939 #define TB_EXIT_IDX1 1
 940 #define TB_EXIT_ICOUNT_EXPIRED 2
 941 #define TB_EXIT_REQUESTED 3
 942
 943 #ifdef HAVE_TCG_QEMU_TB_EXEC
 944 uintptr_t tcg_qemu_tb_exec(CPUArchState *env, uint8_t *tb_ptr);
 945 #else
 946 # define tcg_qemu_tb_exec(env, tb_ptr) \
 947     ((uintptr_t (*)(void *, void *))tcg_ctx.code_gen_prologue)(env, tb_ptr)
 948 #endif
 949
 950 void tcg_register_jit(void *buf, size_t buf_size);
 951
 952 /*
 953  * Memory helpers that will be used by TCG generated code.
 954  */
 955 #ifdef CONFIG_SOFTMMU
 956 /* Value zero-extended to tcg register size.  */
 957 tcg_target_ulong helper_ret_ldub_mmu(CPUArchState *env, target_ulong addr,
 958                                      TCGMemOpIdx oi, uintptr_t retaddr);
 959 tcg_target_ulong helper_le_lduw_mmu(CPUArchState *env, target_ulong addr,
 960                                     TCGMemOpIdx oi, uintptr_t retaddr);
 961 tcg_target_ulong helper_le_ldul_mmu(CPUArchState *env, target_ulong addr,
 962                                     TCGMemOpIdx oi, uintptr_t retaddr);
 963 uint64_t helper_le_ldq_mmu(CPUArchState *env, target_ulong addr,
 964                            TCGMemOpIdx oi, uintptr_t retaddr);
 965 tcg_target_ulong helper_be_lduw_mmu(CPUArchState *env, target_ulong addr,
 966                                     TCGMemOpIdx oi, uintptr_t retaddr);
 967 tcg_target_ulong helper_be_ldul_mmu(CPUArchState *env, target_ulong addr,
 968                                     TCGMemOpIdx oi, uintptr_t retaddr);
 969 uint64_t helper_be_ldq_mmu(CPUArchState *env, target_ulong addr,
 970                            TCGMemOpIdx oi, uintptr_t retaddr);
 971
 972 /* Value sign-extended to tcg register size.  */
 973 tcg_target_ulong helper_ret_ldsb_mmu(CPUArchState *env, target_ulong addr,
 974                                      TCGMemOpIdx oi, uintptr_t retaddr);
 975 tcg_target_ulong helper_le_ldsw_mmu(CPUArchState *env, target_ulong addr,
 976                                     TCGMemOpIdx oi, uintptr_t retaddr);
 977 tcg_target_ulong helper_le_ldsl_mmu(CPUArchState *env, target_ulong addr,
 978                                     TCGMemOpIdx oi, uintptr_t retaddr);
 979 tcg_target_ulong helper_be_ldsw_mmu(CPUArchState *env, target_ulong addr,
 980                                     TCGMemOpIdx oi, uintptr_t retaddr);
 981 tcg_target_ulong helper_be_ldsl_mmu(CPUArchState *env, target_ulong addr,
 982                                     TCGMemOpIdx oi, uintptr_t retaddr);
 983
 984 void helper_ret_stb_mmu(CPUArchState *env, target_ulong addr, uint8_t val,
 985                         TCGMemOpIdx oi, uintptr_t retaddr);
 986 void helper_le_stw_mmu(CPUArchState *env, target_ulong addr, uint16_t val,
 987                        TCGMemOpIdx oi, uintptr_t retaddr);
 988 void helper_le_stl_mmu(CPUArchState *env, target_ulong addr, uint32_t val,
 989                        TCGMemOpIdx oi, uintptr_t retaddr);
 990 void helper_le_stq_mmu(CPUArchState *env, target_ulong addr, uint64_t val,
 991                        TCGMemOpIdx oi, uintptr_t retaddr);
 992 void helper_be_stw_mmu(CPUArchState *env, target_ulong addr, uint16_t val,
 993                        TCGMemOpIdx oi, uintptr_t retaddr);
 994 void helper_be_stl_mmu(CPUArchState *env, target_ulong addr, uint32_t val,
 995                        TCGMemOpIdx oi, uintptr_t retaddr);
 996 void helper_be_stq_mmu(CPUArchState *env, target_ulong addr, uint64_t val,
 997                        TCGMemOpIdx oi, uintptr_t retaddr);
 998
 999 uint8_t helper_ret_ldb_cmmu(CPUArchState *env, target_ulong addr,
1000                             TCGMemOpIdx oi, uintptr_t retaddr);
1001 uint16_t helper_le_ldw_cmmu(CPUArchState *env, target_ulong addr,
1002                             TCGMemOpIdx oi, uintptr_t retaddr);
1003 uint32_t helper_le_ldl_cmmu(CPUArchState *env, target_ulong addr,
1004                             TCGMemOpIdx oi, uintptr_t retaddr);
1005 uint64_t helper_le_ldq_cmmu(CPUArchState *env, target_ulong addr,
1006                             TCGMemOpIdx oi, uintptr_t retaddr);
1007 uint16_t helper_be_ldw_cmmu(CPUArchState *env, target_ulong addr,
1008                             TCGMemOpIdx oi, uintptr_t retaddr);
1009 uint32_t helper_be_ldl_cmmu(CPUArchState *env, target_ulong addr,
1010                             TCGMemOpIdx oi, uintptr_t retaddr);
1011 uint64_t helper_be_ldq_cmmu(CPUArchState *env, target_ulong addr,
1012                             TCGMemOpIdx oi, uintptr_t retaddr);
1013
1014 /* Temporary aliases until backends are converted.  */
1015 #ifdef TARGET_WORDS_BIGENDIAN
1016 # define helper_ret_ldsw_mmu  helper_be_ldsw_mmu
1017 # define helper_ret_lduw_mmu  helper_be_lduw_mmu
1018 # define helper_ret_ldsl_mmu  helper_be_ldsl_mmu
1019 # define helper_ret_ldul_mmu  helper_be_ldul_mmu
1020 # define helper_ret_ldl_mmu   helper_be_ldul_mmu
1021 # define helper_ret_ldq_mmu   helper_be_ldq_mmu
1022 # define helper_ret_stw_mmu   helper_be_stw_mmu
1023 # define helper_ret_stl_mmu   helper_be_stl_mmu
1024 # define helper_ret_stq_mmu   helper_be_stq_mmu
1025 # define helper_ret_ldw_cmmu  helper_be_ldw_cmmu
1026 # define helper_ret_ldl_cmmu  helper_be_ldl_cmmu
1027 # define helper_ret_ldq_cmmu  helper_be_ldq_cmmu
1028 #else
1029 # define helper_ret_ldsw_mmu  helper_le_ldsw_mmu
1030 # define helper_ret_lduw_mmu  helper_le_lduw_mmu
1031 # define helper_ret_ldsl_mmu  helper_le_ldsl_mmu
1032 # define helper_ret_ldul_mmu  helper_le_ldul_mmu
1033 # define helper_ret_ldl_mmu   helper_le_ldul_mmu
1034 # define helper_ret_ldq_mmu   helper_le_ldq_mmu
1035 # define helper_ret_stw_mmu   helper_le_stw_mmu
1036 # define helper_ret_stl_mmu   helper_le_stl_mmu
1037 # define helper_ret_stq_mmu   helper_le_stq_mmu
1038 # define helper_ret_ldw_cmmu  helper_le_ldw_cmmu
1039 # define helper_ret_ldl_cmmu  helper_le_ldl_cmmu
1040 # define helper_ret_ldq_cmmu  helper_le_ldq_cmmu
1041 #endif
1042
1043 #endif /* CONFIG_SOFTMMU */
1044
1045 #endif /* TCG_H */