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 "cpu.h"
  30 #include "exec/tb-context.h"
  31 #include "qemu/bitops.h"
  32 #include "tcg-mo.h"
  33 #include "tcg-target.h"
  34
  35 /* XXX: make safe guess about sizes */
  36 #define MAX_OP_PER_INSTR 266
  37
  38 #if HOST_LONG_BITS == 32
  39 #define MAX_OPC_PARAM_PER_ARG 2
  40 #else
  41 #define MAX_OPC_PARAM_PER_ARG 1
  42 #endif
  43 #define MAX_OPC_PARAM_IARGS 5
  44 #define MAX_OPC_PARAM_OARGS 1
  45 #define MAX_OPC_PARAM_ARGS (MAX_OPC_PARAM_IARGS + MAX_OPC_PARAM_OARGS)
  46
  47 /* A Call op needs up to 4 + 2N parameters on 32-bit archs,
  48  * and up to 4 + N parameters on 64-bit archs
  49  * (N = number of input arguments + output arguments).  */
  50 #define MAX_OPC_PARAM (4 + (MAX_OPC_PARAM_PER_ARG * MAX_OPC_PARAM_ARGS))
  51 #define OPC_BUF_SIZE 640
  52 #define OPC_MAX_SIZE (OPC_BUF_SIZE - MAX_OP_PER_INSTR)
  53
  54 #define CPU_TEMP_BUF_NLONGS 128
  55
  56 /* Default target word size to pointer size.  */
  57 #ifndef TCG_TARGET_REG_BITS
  58 # if UINTPTR_MAX == UINT32_MAX
  59 #  define TCG_TARGET_REG_BITS 32
  60 # elif UINTPTR_MAX == UINT64_MAX
  61 #  define TCG_TARGET_REG_BITS 64
  62 # else
  63 #  error Unknown pointer size for tcg target
  64 # endif
  65 #endif
  66
  67 #if TCG_TARGET_REG_BITS == 32
  68 typedef int32_t tcg_target_long;
  69 typedef uint32_t tcg_target_ulong;
  70 #define TCG_PRIlx PRIx32
  71 #define TCG_PRIld PRId32
  72 #elif TCG_TARGET_REG_BITS == 64
  73 typedef int64_t tcg_target_long;
  74 typedef uint64_t tcg_target_ulong;
  75 #define TCG_PRIlx PRIx64
  76 #define TCG_PRIld PRId64
  77 #else
  78 #error unsupported
  79 #endif
  80
  81 /* Oversized TCG guests make things like MTTCG hard
  82  * as we can't use atomics for cputlb updates.
  83  */
  84 #if TARGET_LONG_BITS > TCG_TARGET_REG_BITS
  85 #define TCG_OVERSIZED_GUEST 1
  86 #else
  87 #define TCG_OVERSIZED_GUEST 0
  88 #endif
  89
  90 #if TCG_TARGET_NB_REGS <= 32
  91 typedef uint32_t TCGRegSet;
  92 #elif TCG_TARGET_NB_REGS <= 64
  93 typedef uint64_t TCGRegSet;
  94 #else
  95 #error unsupported
  96 #endif
  97
  98 #if TCG_TARGET_REG_BITS == 32
  99 /* Turn some undef macros into false macros.  */
 100 #define TCG_TARGET_HAS_extrl_i64_i32    0
 101 #define TCG_TARGET_HAS_extrh_i64_i32    0
 102 #define TCG_TARGET_HAS_div_i64          0
 103 #define TCG_TARGET_HAS_rem_i64          0
 104 #define TCG_TARGET_HAS_div2_i64         0
 105 #define TCG_TARGET_HAS_rot_i64          0
 106 #define TCG_TARGET_HAS_ext8s_i64        0
 107 #define TCG_TARGET_HAS_ext16s_i64       0
 108 #define TCG_TARGET_HAS_ext32s_i64       0
 109 #define TCG_TARGET_HAS_ext8u_i64        0
 110 #define TCG_TARGET_HAS_ext16u_i64       0
 111 #define TCG_TARGET_HAS_ext32u_i64       0
 112 #define TCG_TARGET_HAS_bswap16_i64      0
 113 #define TCG_TARGET_HAS_bswap32_i64      0
 114 #define TCG_TARGET_HAS_bswap64_i64      0
 115 #define TCG_TARGET_HAS_neg_i64          0
 116 #define TCG_TARGET_HAS_not_i64          0
 117 #define TCG_TARGET_HAS_andc_i64         0
 118 #define TCG_TARGET_HAS_orc_i64          0
 119 #define TCG_TARGET_HAS_eqv_i64          0
 120 #define TCG_TARGET_HAS_nand_i64         0
 121 #define TCG_TARGET_HAS_nor_i64          0
 122 #define TCG_TARGET_HAS_clz_i64          0
 123 #define TCG_TARGET_HAS_ctz_i64          0
 124 #define TCG_TARGET_HAS_ctpop_i64        0
 125 #define TCG_TARGET_HAS_deposit_i64      0
 126 #define TCG_TARGET_HAS_extract_i64      0
 127 #define TCG_TARGET_HAS_sextract_i64     0
 128 #define TCG_TARGET_HAS_movcond_i64      0
 129 #define TCG_TARGET_HAS_add2_i64         0
 130 #define TCG_TARGET_HAS_sub2_i64         0
 131 #define TCG_TARGET_HAS_mulu2_i64        0
 132 #define TCG_TARGET_HAS_muls2_i64        0
 133 #define TCG_TARGET_HAS_muluh_i64        0
 134 #define TCG_TARGET_HAS_mulsh_i64        0
 135 /* Turn some undef macros into true macros.  */
 136 #define TCG_TARGET_HAS_add2_i32         1
 137 #define TCG_TARGET_HAS_sub2_i32         1
 138 #endif
 139
 140 #ifndef TCG_TARGET_deposit_i32_valid
 141 #define TCG_TARGET_deposit_i32_valid(ofs, len) 1
 142 #endif
 143 #ifndef TCG_TARGET_deposit_i64_valid
 144 #define TCG_TARGET_deposit_i64_valid(ofs, len) 1
 145 #endif
 146 #ifndef TCG_TARGET_extract_i32_valid
 147 #define TCG_TARGET_extract_i32_valid(ofs, len) 1
 148 #endif
 149 #ifndef TCG_TARGET_extract_i64_valid
 150 #define TCG_TARGET_extract_i64_valid(ofs, len) 1
 151 #endif
 152
 153 /* Only one of DIV or DIV2 should be defined.  */
 154 #if defined(TCG_TARGET_HAS_div_i32)
 155 #define TCG_TARGET_HAS_div2_i32         0
 156 #elif defined(TCG_TARGET_HAS_div2_i32)
 157 #define TCG_TARGET_HAS_div_i32          0
 158 #define TCG_TARGET_HAS_rem_i32          0
 159 #endif
 160 #if defined(TCG_TARGET_HAS_div_i64)
 161 #define TCG_TARGET_HAS_div2_i64         0
 162 #elif defined(TCG_TARGET_HAS_div2_i64)
 163 #define TCG_TARGET_HAS_div_i64          0
 164 #define TCG_TARGET_HAS_rem_i64          0
 165 #endif
 166
 167 /* For 32-bit targets, some sort of unsigned widening multiply is required.  */
 168 #if TCG_TARGET_REG_BITS == 32 \
 169     && !(defined(TCG_TARGET_HAS_mulu2_i32) \
 170          || defined(TCG_TARGET_HAS_muluh_i32))
 171 # error "Missing unsigned widening multiply"
 172 #endif
 173
 174 #ifndef TARGET_INSN_START_EXTRA_WORDS
 175 # define TARGET_INSN_START_WORDS 1
 176 #else
 177 # define TARGET_INSN_START_WORDS (1 + TARGET_INSN_START_EXTRA_WORDS)
 178 #endif
 179
 180 typedef enum TCGOpcode {
 181 #define DEF(name, oargs, iargs, cargs, flags) INDEX_op_ ## name,
 182 #include "tcg-opc.h"
 183 #undef DEF
 184     NB_OPS,
 185 } TCGOpcode;
 186
 187 #define tcg_regset_set_reg(d, r)   ((d) |= (TCGRegSet)1 << (r))
 188 #define tcg_regset_reset_reg(d, r) ((d) &= ~((TCGRegSet)1 << (r)))
 189 #define tcg_regset_test_reg(d, r)  (((d) >> (r)) & 1)
 190
 191 #ifndef TCG_TARGET_INSN_UNIT_SIZE
 192 # error "Missing TCG_TARGET_INSN_UNIT_SIZE"
 193 #elif TCG_TARGET_INSN_UNIT_SIZE == 1
 194 typedef uint8_t tcg_insn_unit;
 195 #elif TCG_TARGET_INSN_UNIT_SIZE == 2
 196 typedef uint16_t tcg_insn_unit;
 197 #elif TCG_TARGET_INSN_UNIT_SIZE == 4
 198 typedef uint32_t tcg_insn_unit;
 199 #elif TCG_TARGET_INSN_UNIT_SIZE == 8
 200 typedef uint64_t tcg_insn_unit;
 201 #else
 202 /* The port better have done this.  */
 203 #endif
 204
 205
 206 #if defined CONFIG_DEBUG_TCG || defined QEMU_STATIC_ANALYSIS
 207 # define tcg_debug_assert(X) do { assert(X); } while (0)
 208 #elif QEMU_GNUC_PREREQ(4, 5)
 209 # define tcg_debug_assert(X) \
 210     do { if (!(X)) { __builtin_unreachable(); } } while (0)
 211 #else
 212 # define tcg_debug_assert(X) do { (void)(X); } while (0)
 213 #endif
 214
 215 typedef struct TCGRelocation {
 216     struct TCGRelocation *next;
 217     int type;
 218     tcg_insn_unit *ptr;
 219     intptr_t addend;
 220 } TCGRelocation;
 221
 222 typedef struct TCGLabel {
 223     unsigned has_value : 1;
 224     unsigned id : 31;
 225     union {
 226         uintptr_t value;
 227         tcg_insn_unit *value_ptr;
 228         TCGRelocation *first_reloc;
 229     } u;
 230 } TCGLabel;
 231
 232 typedef struct TCGPool {
 233     struct TCGPool *next;
 234     int size;
 235     uint8_t data[0] __attribute__ ((aligned));
 236 } TCGPool;
 237
 238 #define TCG_POOL_CHUNK_SIZE 32768
 239
 240 #define TCG_MAX_TEMPS 512
 241 #define TCG_MAX_INSNS 512
 242
 243 /* when the size of the arguments of a called function is smaller than
 244    this value, they are statically allocated in the TB stack frame */
 245 #define TCG_STATIC_CALL_ARGS_SIZE 128
 246
 247 typedef enum TCGType {
 248     TCG_TYPE_I32,
 249     TCG_TYPE_I64,
 250     TCG_TYPE_COUNT, /* number of different types */
 251
 252     /* An alias for the size of the host register.  */
 253 #if TCG_TARGET_REG_BITS == 32
 254     TCG_TYPE_REG = TCG_TYPE_I32,
 255 #else
 256     TCG_TYPE_REG = TCG_TYPE_I64,
 257 #endif
 258
 259     /* An alias for the size of the native pointer.  */
 260 #if UINTPTR_MAX == UINT32_MAX
 261     TCG_TYPE_PTR = TCG_TYPE_I32,
 262 #else
 263     TCG_TYPE_PTR = TCG_TYPE_I64,
 264 #endif
 265
 266     /* An alias for the size of the target "long", aka register.  */
 267 #if TARGET_LONG_BITS == 64
 268     TCG_TYPE_TL = TCG_TYPE_I64,
 269 #else
 270     TCG_TYPE_TL = TCG_TYPE_I32,
 271 #endif
 272 } TCGType;
 273
 274 /* Constants for qemu_ld and qemu_st for the Memory Operation field.  */
 275 typedef enum TCGMemOp {
 276     MO_8     = 0,
 277     MO_16    = 1,
 278     MO_32    = 2,
 279     MO_64    = 3,
 280     MO_SIZE  = 3,   /* Mask for the above.  */
 281
 282     MO_SIGN  = 4,   /* Sign-extended, otherwise zero-extended.  */
 283
 284     MO_BSWAP = 8,   /* Host reverse endian.  */
 285 #ifdef HOST_WORDS_BIGENDIAN
 286     MO_LE    = MO_BSWAP,
 287     MO_BE    = 0,
 288 #else
 289     MO_LE    = 0,
 290     MO_BE    = MO_BSWAP,
 291 #endif
 292 #ifdef TARGET_WORDS_BIGENDIAN
 293     MO_TE    = MO_BE,
 294 #else
 295     MO_TE    = MO_LE,
 296 #endif
 297
 298     /* MO_UNALN accesses are never checked for alignment.
 299      * MO_ALIGN accesses will result in a call to the CPU's
 300      * do_unaligned_access hook if the guest address is not aligned.
 301      * The default depends on whether the target CPU defines ALIGNED_ONLY.
 302      *
 303      * Some architectures (e.g. ARMv8) need the address which is aligned
 304      * to a size more than the size of the memory access.
 305      * Some architectures (e.g. SPARCv9) need an address which is aligned,
 306      * but less strictly than the natural alignment.
 307      *
 308      * MO_ALIGN supposes the alignment size is the size of a memory access.
 309      *
 310      * There are three options:
 311      * - unaligned access permitted (MO_UNALN).
 312      * - an alignment to the size of an access (MO_ALIGN);
 313      * - an alignment to a specified size, which may be more or less than
 314      *   the access size (MO_ALIGN_x where 'x' is a size in bytes);
 315      */
 316     MO_ASHIFT = 4,
 317     MO_AMASK = 7 << MO_ASHIFT,
 318 #ifdef ALIGNED_ONLY
 319     MO_ALIGN = 0,
 320     MO_UNALN = MO_AMASK,
 321 #else
 322     MO_ALIGN = MO_AMASK,
 323     MO_UNALN = 0,
 324 #endif
 325     MO_ALIGN_2  = 1 << MO_ASHIFT,
 326     MO_ALIGN_4  = 2 << MO_ASHIFT,
 327     MO_ALIGN_8  = 3 << MO_ASHIFT,
 328     MO_ALIGN_16 = 4 << MO_ASHIFT,
 329     MO_ALIGN_32 = 5 << MO_ASHIFT,
 330     MO_ALIGN_64 = 6 << MO_ASHIFT,
 331
 332     /* Combinations of the above, for ease of use.  */
 333     MO_UB    = MO_8,
 334     MO_UW    = MO_16,
 335     MO_UL    = MO_32,
 336     MO_SB    = MO_SIGN | MO_8,
 337     MO_SW    = MO_SIGN | MO_16,
 338     MO_SL    = MO_SIGN | MO_32,
 339     MO_Q     = MO_64,
 340
 341     MO_LEUW  = MO_LE | MO_UW,
 342     MO_LEUL  = MO_LE | MO_UL,
 343     MO_LESW  = MO_LE | MO_SW,
 344     MO_LESL  = MO_LE | MO_SL,
 345     MO_LEQ   = MO_LE | MO_Q,
 346
 347     MO_BEUW  = MO_BE | MO_UW,
 348     MO_BEUL  = MO_BE | MO_UL,
 349     MO_BESW  = MO_BE | MO_SW,
 350     MO_BESL  = MO_BE | MO_SL,
 351     MO_BEQ   = MO_BE | MO_Q,
 352
 353     MO_TEUW  = MO_TE | MO_UW,
 354     MO_TEUL  = MO_TE | MO_UL,
 355     MO_TESW  = MO_TE | MO_SW,
 356     MO_TESL  = MO_TE | MO_SL,
 357     MO_TEQ   = MO_TE | MO_Q,
 358
 359     MO_SSIZE = MO_SIZE | MO_SIGN,
 360 } TCGMemOp;
 361
 362 /**
 363  * get_alignment_bits
 364  * @memop: TCGMemOp value
 365  *
 366  * Extract the alignment size from the memop.
 367  */
 368 static inline unsigned get_alignment_bits(TCGMemOp memop)
 369 {
 370     unsigned a = memop & MO_AMASK;
 371
 372     if (a == MO_UNALN) {
 373         /* No alignment required.  */
 374         a = 0;
 375     } else if (a == MO_ALIGN) {
 376         /* A natural alignment requirement.  */
 377         a = memop & MO_SIZE;
 378     } else {
 379         /* A specific alignment requirement.  */
 380         a = a >> MO_ASHIFT;
 381     }
 382 #if defined(CONFIG_SOFTMMU)
 383     /* The requested alignment cannot overlap the TLB flags.  */
 384     tcg_debug_assert((TLB_FLAGS_MASK & ((1 << a) - 1)) == 0);
 385 #endif
 386     return a;
 387 }
 388
 389 typedef tcg_target_ulong TCGArg;
 390
 391 /* Define type and accessor macros for TCG variables.
 392
 393    TCG variables are the inputs and outputs of TCG ops, as described
 394    in tcg/README. Target CPU front-end code uses these types to deal
 395    with TCG variables as it emits TCG code via the tcg_gen_* functions.
 396    They come in several flavours:
 397     * TCGv_i32 : 32 bit integer type
 398     * TCGv_i64 : 64 bit integer type
 399     * TCGv_ptr : a host pointer type
 400     * TCGv : an integer type the same size as target_ulong
 401              (an alias for either TCGv_i32 or TCGv_i64)
 402    The compiler's type checking will complain if you mix them
 403    up and pass the wrong sized TCGv to a function.
 404
 405    Users of tcg_gen_* don't need to know about any of the internal
 406    details of these, and should treat them as opaque types.
 407    You won't be able to look inside them in a debugger either.
 408
 409    Internal implementation details follow:
 410
 411    Note that there is no definition of the structs TCGv_i32_d etc anywhere.
 412    This is deliberate, because the values we store in variables of type
 413    TCGv_i32 are not really pointers-to-structures. They're just small
 414    integers, but keeping them in pointer types like this means that the
 415    compiler will complain if you accidentally pass a TCGv_i32 to a
 416    function which takes a TCGv_i64, and so on. Only the internals of
 417    TCG need to care about the actual contents of the types.  */
 418
 419 typedef struct TCGv_i32_d *TCGv_i32;
 420 typedef struct TCGv_i64_d *TCGv_i64;
 421 typedef struct TCGv_ptr_d *TCGv_ptr;
 422 typedef TCGv_ptr TCGv_env;
 423 #if TARGET_LONG_BITS == 32
 424 #define TCGv TCGv_i32
 425 #elif TARGET_LONG_BITS == 64
 426 #define TCGv TCGv_i64
 427 #else
 428 #error Unhandled TARGET_LONG_BITS value
 429 #endif
 430
 431 /* See the comment before tcgv_i32_temp.  */
 432 #define TCGV_UNUSED_I32(x) (x = (TCGv_i32)NULL)
 433 #define TCGV_UNUSED_I64(x) (x = (TCGv_i64)NULL)
 434 #define TCGV_UNUSED_PTR(x) (x = (TCGv_ptr)NULL)
 435
 436 #define TCGV_IS_UNUSED_I32(x) ((x) == (TCGv_i32)NULL)
 437 #define TCGV_IS_UNUSED_I64(x) ((x) == (TCGv_i64)NULL)
 438 #define TCGV_IS_UNUSED_PTR(x) ((x) == (TCGv_ptr)NULL)
 439
 440 /* call flags */
 441 /* Helper does not read globals (either directly or through an exception). It
 442    implies TCG_CALL_NO_WRITE_GLOBALS. */
 443 #define TCG_CALL_NO_READ_GLOBALS    0x0010
 444 /* Helper does not write globals */
 445 #define TCG_CALL_NO_WRITE_GLOBALS   0x0020
 446 /* Helper can be safely suppressed if the return value is not used. */
 447 #define TCG_CALL_NO_SIDE_EFFECTS    0x0040
 448
 449 /* convenience version of most used call flags */
 450 #define TCG_CALL_NO_RWG         TCG_CALL_NO_READ_GLOBALS
 451 #define TCG_CALL_NO_WG          TCG_CALL_NO_WRITE_GLOBALS
 452 #define TCG_CALL_NO_SE          TCG_CALL_NO_SIDE_EFFECTS
 453 #define TCG_CALL_NO_RWG_SE      (TCG_CALL_NO_RWG | TCG_CALL_NO_SE)
 454 #define TCG_CALL_NO_WG_SE       (TCG_CALL_NO_WG | TCG_CALL_NO_SE)
 455
 456 /* Used to align parameters.  See the comment before tcgv_i32_temp.  */
 457 #define TCG_CALL_DUMMY_ARG      ((TCGArg)0)
 458
 459 /* Conditions.  Note that these are laid out for easy manipulation by
 460    the functions below:
 461      bit 0 is used for inverting;
 462      bit 1 is signed,
 463      bit 2 is unsigned,
 464      bit 3 is used with bit 0 for swapping signed/unsigned.  */
 465 typedef enum {
 466     /* non-signed */
 467     TCG_COND_NEVER  = 0 | 0 | 0 | 0,
 468     TCG_COND_ALWAYS = 0 | 0 | 0 | 1,
 469     TCG_COND_EQ     = 8 | 0 | 0 | 0,
 470     TCG_COND_NE     = 8 | 0 | 0 | 1,
 471     /* signed */
 472     TCG_COND_LT     = 0 | 0 | 2 | 0,
 473     TCG_COND_GE     = 0 | 0 | 2 | 1,
 474     TCG_COND_LE     = 8 | 0 | 2 | 0,
 475     TCG_COND_GT     = 8 | 0 | 2 | 1,
 476     /* unsigned */
 477     TCG_COND_LTU    = 0 | 4 | 0 | 0,
 478     TCG_COND_GEU    = 0 | 4 | 0 | 1,
 479     TCG_COND_LEU    = 8 | 4 | 0 | 0,
 480     TCG_COND_GTU    = 8 | 4 | 0 | 1,
 481 } TCGCond;
 482
 483 /* Invert the sense of the comparison.  */
 484 static inline TCGCond tcg_invert_cond(TCGCond c)
 485 {
 486     return (TCGCond)(c ^ 1);
 487 }
 488
 489 /* Swap the operands in a comparison.  */
 490 static inline TCGCond tcg_swap_cond(TCGCond c)
 491 {
 492     return c & 6 ? (TCGCond)(c ^ 9) : c;
 493 }
 494
 495 /* Create an "unsigned" version of a "signed" comparison.  */
 496 static inline TCGCond tcg_unsigned_cond(TCGCond c)
 497 {
 498     return c & 2 ? (TCGCond)(c ^ 6) : c;
 499 }
 500
 501 /* Must a comparison be considered unsigned?  */
 502 static inline bool is_unsigned_cond(TCGCond c)
 503 {
 504     return (c & 4) != 0;
 505 }
 506
 507 /* Create a "high" version of a double-word comparison.
 508    This removes equality from a LTE or GTE comparison.  */
 509 static inline TCGCond tcg_high_cond(TCGCond c)
 510 {
 511     switch (c) {
 512     case TCG_COND_GE:
 513     case TCG_COND_LE:
 514     case TCG_COND_GEU:
 515     case TCG_COND_LEU:
 516         return (TCGCond)(c ^ 8);
 517     default:
 518         return c;
 519     }
 520 }
 521
 522 typedef enum TCGTempVal {
 523     TEMP_VAL_DEAD,
 524     TEMP_VAL_REG,
 525     TEMP_VAL_MEM,
 526     TEMP_VAL_CONST,
 527 } TCGTempVal;
 528
 529 typedef struct TCGTemp {
 530     TCGReg reg:8;
 531     TCGTempVal val_type:8;
 532     TCGType base_type:8;
 533     TCGType type:8;
 534     unsigned int fixed_reg:1;
 535     unsigned int indirect_reg:1;
 536     unsigned int indirect_base:1;
 537     unsigned int mem_coherent:1;
 538     unsigned int mem_allocated:1;
 539     /* If true, the temp is saved across both basic blocks and
 540        translation blocks.  */
 541     unsigned int temp_global:1;
 542     /* If true, the temp is saved across basic blocks but dead
 543        at the end of translation blocks.  If false, the temp is
 544        dead at the end of basic blocks.  */
 545     unsigned int temp_local:1;
 546     unsigned int temp_allocated:1;
 547
 548     tcg_target_long val;
 549     struct TCGTemp *mem_base;
 550     intptr_t mem_offset;
 551     const char *name;
 552
 553     /* Pass-specific information that can be stored for a temporary.
 554        One word worth of integer data, and one pointer to data
 555        allocated separately.  */
 556     uintptr_t state;
 557     void *state_ptr;
 558 } TCGTemp;
 559
 560 typedef struct TCGContext TCGContext;
 561
 562 typedef struct TCGTempSet {
 563     unsigned long l[BITS_TO_LONGS(TCG_MAX_TEMPS)];
 564 } TCGTempSet;
 565
 566 /* While we limit helpers to 6 arguments, for 32-bit hosts, with padding,
 567    this imples a max of 6*2 (64-bit in) + 2 (64-bit out) = 14 operands.
 568    There are never more than 2 outputs, which means that we can store all
 569    dead + sync data within 16 bits.  */
 570 #define DEAD_ARG  4
 571 #define SYNC_ARG  1
 572 typedef uint16_t TCGLifeData;
 573
 574 /* The layout here is designed to avoid a bitfield crossing of
 575    a 32-bit boundary, which would cause GCC to add extra padding.  */
 576 typedef struct TCGOp {
 577     TCGOpcode opc   : 8;        /*  8 */
 578
 579     /* The number of out and in parameter for a call.  */
 580     unsigned calli  : 4;        /* 12 */
 581     unsigned callo  : 2;        /* 14 */
 582     unsigned        : 2;        /* 16 */
 583
 584     /* Index of the prev/next op, or 0 for the end of the list.  */
 585     unsigned prev   : 16;       /* 32 */
 586     unsigned next   : 16;       /* 48 */
 587
 588     /* Lifetime data of the operands.  */
 589     unsigned life   : 16;       /* 64 */
 590
 591     /* Arguments for the opcode.  */
 592     TCGArg args[MAX_OPC_PARAM];
 593 } TCGOp;
 594
 595 /* Make sure that we don't expand the structure without noticing.  */
 596 QEMU_BUILD_BUG_ON(sizeof(TCGOp) != 8 + sizeof(TCGArg) * MAX_OPC_PARAM);
 597
 598 /* Make sure operands fit in the bitfields above.  */
 599 QEMU_BUILD_BUG_ON(NB_OPS > (1 << 8));
 600 QEMU_BUILD_BUG_ON(OPC_BUF_SIZE > (1 << 16));
 601
 602 typedef struct TCGProfile {
 603     int64_t tb_count1;
 604     int64_t tb_count;
 605     int64_t op_count; /* total insn count */
 606     int op_count_max; /* max insn per TB */
 607     int64_t temp_count;
 608     int temp_count_max;
 609     int64_t del_op_count;
 610     int64_t code_in_len;
 611     int64_t code_out_len;
 612     int64_t search_out_len;
 613     int64_t interm_time;
 614     int64_t code_time;
 615     int64_t la_time;
 616     int64_t opt_time;
 617     int64_t restore_count;
 618     int64_t restore_time;
 619     int64_t table_op_count[NB_OPS];
 620 } TCGProfile;
 621
 622 struct TCGContext {
 623     uint8_t *pool_cur, *pool_end;
 624     TCGPool *pool_first, *pool_current, *pool_first_large;
 625     int nb_labels;
 626     int nb_globals;
 627     int nb_temps;
 628     int nb_indirects;
 629
 630     /* goto_tb support */
 631     tcg_insn_unit *code_buf;
 632     uint16_t *tb_jmp_reset_offset; /* tb->jmp_reset_offset */
 633     uintptr_t *tb_jmp_insn_offset; /* tb->jmp_target_arg if direct_jump */
 634     uintptr_t *tb_jmp_target_addr; /* tb->jmp_target_arg if !direct_jump */
 635
 636     TCGRegSet reserved_regs;
 637     uint32_t tb_cflags; /* cflags of the current TB */
 638     intptr_t current_frame_offset;
 639     intptr_t frame_start;
 640     intptr_t frame_end;
 641     TCGTemp *frame_temp;
 642
 643     tcg_insn_unit *code_ptr;
 644
 645 #ifdef CONFIG_PROFILER
 646     TCGProfile prof;
 647 #endif
 648
 649 #ifdef CONFIG_DEBUG_TCG
 650     int temps_in_use;
 651     int goto_tb_issue_mask;
 652 #endif
 653
 654     int gen_next_op_idx;
 655
 656     /* Code generation.  Note that we specifically do not use tcg_insn_unit
 657        here, because there's too much arithmetic throughout that relies
 658        on addition and subtraction working on bytes.  Rely on the GCC
 659        extension that allows arithmetic on void*.  */
 660     void *code_gen_prologue;
 661     void *code_gen_epilogue;
 662     void *code_gen_buffer;
 663     size_t code_gen_buffer_size;
 664     void *code_gen_ptr;
 665     void *data_gen_ptr;
 666
 667     /* Threshold to flush the translated code buffer.  */
 668     void *code_gen_highwater;
 669
 670     /* Track which vCPU triggers events */
 671     CPUState *cpu;                      /* *_trans */
 672
 673     /* These structures are private to tcg-target.inc.c.  */
 674 #ifdef TCG_TARGET_NEED_LDST_LABELS
 675     struct TCGLabelQemuLdst *ldst_labels;
 676 #endif
 677 #ifdef TCG_TARGET_NEED_POOL_LABELS
 678     struct TCGLabelPoolData *pool_labels;
 679 #endif
 680
 681     TCGLabel *exitreq_label;
 682
 683     TCGTempSet free_temps[TCG_TYPE_COUNT * 2];
 684     TCGTemp temps[TCG_MAX_TEMPS]; /* globals first, temps after */
 685
 686     /* Tells which temporary holds a given register.
 687        It does not take into account fixed registers */
 688     TCGTemp *reg_to_temp[TCG_TARGET_NB_REGS];
 689
 690     TCGOp gen_op_buf[OPC_BUF_SIZE];
 691
 692     uint16_t gen_insn_end_off[TCG_MAX_INSNS];
 693     target_ulong gen_insn_data[TCG_MAX_INSNS][TARGET_INSN_START_WORDS];
 694 };
 695
 696 extern TCGContext tcg_init_ctx;
 697 extern __thread TCGContext *tcg_ctx;
 698 extern TCGv_env cpu_env;
 699
 700 static inline size_t temp_idx(TCGTemp *ts)
 701 {
 702     ptrdiff_t n = ts - tcg_ctx->temps;
 703     tcg_debug_assert(n >= 0 && n < tcg_ctx->nb_temps);
 704     return n;
 705 }
 706
 707 static inline TCGArg temp_arg(TCGTemp *ts)
 708 {
 709     return (uintptr_t)ts;
 710 }
 711
 712 static inline TCGTemp *arg_temp(TCGArg a)
 713 {
 714     return (TCGTemp *)(uintptr_t)a;
 715 }
 716
 717 /* Using the offset of a temporary, relative to TCGContext, rather than
 718    its index means that we don't use 0.  That leaves offset 0 free for
 719    a NULL representation without having to leave index 0 unused.  */
 720 static inline TCGTemp *tcgv_i32_temp(TCGv_i32 v)
 721 {
 722     uintptr_t o = (uintptr_t)v;
 723     TCGTemp *t = (void *)tcg_ctx + o;
 724     tcg_debug_assert(offsetof(TCGContext, temps[temp_idx(t)]) == o);
 725     return t;
 726 }
 727
 728 static inline TCGTemp *tcgv_i64_temp(TCGv_i64 v)
 729 {
 730     return tcgv_i32_temp((TCGv_i32)v);
 731 }
 732
 733 static inline TCGTemp *tcgv_ptr_temp(TCGv_ptr v)
 734 {
 735     return tcgv_i32_temp((TCGv_i32)v);
 736 }
 737
 738 static inline TCGArg tcgv_i32_arg(TCGv_i32 v)
 739 {
 740     return temp_arg(tcgv_i32_temp(v));
 741 }
 742
 743 static inline TCGArg tcgv_i64_arg(TCGv_i64 v)
 744 {
 745     return temp_arg(tcgv_i64_temp(v));
 746 }
 747
 748 static inline TCGArg tcgv_ptr_arg(TCGv_ptr v)
 749 {
 750     return temp_arg(tcgv_ptr_temp(v));
 751 }
 752
 753 static inline TCGv_i32 temp_tcgv_i32(TCGTemp *t)
 754 {
 755     (void)temp_idx(t); /* trigger embedded assert */
 756     return (TCGv_i32)((void *)t - (void *)tcg_ctx);
 757 }
 758
 759 static inline TCGv_i64 temp_tcgv_i64(TCGTemp *t)
 760 {
 761     return (TCGv_i64)temp_tcgv_i32(t);
 762 }
 763
 764 static inline TCGv_ptr temp_tcgv_ptr(TCGTemp *t)
 765 {
 766     return (TCGv_ptr)temp_tcgv_i32(t);
 767 }
 768
 769 #if TCG_TARGET_REG_BITS == 32
 770 static inline TCGv_i32 TCGV_LOW(TCGv_i64 t)
 771 {
 772     return temp_tcgv_i32(tcgv_i64_temp(t));
 773 }
 774
 775 static inline TCGv_i32 TCGV_HIGH(TCGv_i64 t)
 776 {
 777     return temp_tcgv_i32(tcgv_i64_temp(t) + 1);
 778 }
 779 #endif
 780
 781 static inline void tcg_set_insn_param(int op_idx, int arg, TCGArg v)
 782 {
 783     tcg_ctx->gen_op_buf[op_idx].args[arg] = v;
 784 }
 785
 786 /* The number of opcodes emitted so far.  */
 787 static inline int tcg_op_buf_count(void)
 788 {
 789     return tcg_ctx->gen_next_op_idx;
 790 }
 791
 792 /* Test for whether to terminate the TB for using too many opcodes.  */
 793 static inline bool tcg_op_buf_full(void)
 794 {
 795     return tcg_op_buf_count() >= OPC_MAX_SIZE;
 796 }
 797
 798 /* pool based memory allocation */
 799
 800 /* user-mode: tb_lock must be held for tcg_malloc_internal. */
 801 void *tcg_malloc_internal(TCGContext *s, int size);
 802 void tcg_pool_reset(TCGContext *s);
 803 TranslationBlock *tcg_tb_alloc(TCGContext *s);
 804
 805 void tcg_region_init(void);
 806 void tcg_region_reset_all(void);
 807
 808 size_t tcg_code_size(void);
 809 size_t tcg_code_capacity(void);
 810
 811 /* user-mode: Called with tb_lock held.  */
 812 static inline void *tcg_malloc(int size)
 813 {
 814     TCGContext *s = tcg_ctx;
 815     uint8_t *ptr, *ptr_end;
 816
 817     /* ??? This is a weak placeholder for minimum malloc alignment.  */
 818     size = QEMU_ALIGN_UP(size, 8);
 819
 820     ptr = s->pool_cur;
 821     ptr_end = ptr + size;
 822     if (unlikely(ptr_end > s->pool_end)) {
 823         return tcg_malloc_internal(tcg_ctx, size);
 824     } else {
 825         s->pool_cur = ptr_end;
 826         return ptr;
 827     }
 828 }
 829
 830 void tcg_context_init(TCGContext *s);
 831 void tcg_register_thread(void);
 832 void tcg_prologue_init(TCGContext *s);
 833 void tcg_func_start(TCGContext *s);
 834
 835 int tcg_gen_code(TCGContext *s, TranslationBlock *tb);
 836
 837 void tcg_set_frame(TCGContext *s, TCGReg reg, intptr_t start, intptr_t size);
 838
 839 TCGTemp *tcg_global_mem_new_internal(TCGType, TCGv_ptr,
 840                                      intptr_t, const char *);
 841
 842 TCGv_i32 tcg_temp_new_internal_i32(int temp_local);
 843 TCGv_i64 tcg_temp_new_internal_i64(int temp_local);
 844
 845 void tcg_temp_free_i32(TCGv_i32 arg);
 846 void tcg_temp_free_i64(TCGv_i64 arg);
 847
 848 static inline TCGv_i32 tcg_global_mem_new_i32(TCGv_ptr reg, intptr_t offset,
 849                                               const char *name)
 850 {
 851     TCGTemp *t = tcg_global_mem_new_internal(TCG_TYPE_I32, reg, offset, name);
 852     return temp_tcgv_i32(t);
 853 }
 854
 855 static inline TCGv_i32 tcg_temp_new_i32(void)
 856 {
 857     return tcg_temp_new_internal_i32(0);
 858 }
 859
 860 static inline TCGv_i32 tcg_temp_local_new_i32(void)
 861 {
 862     return tcg_temp_new_internal_i32(1);
 863 }
 864
 865 static inline TCGv_i64 tcg_global_mem_new_i64(TCGv_ptr reg, intptr_t offset,
 866                                               const char *name)
 867 {
 868     TCGTemp *t = tcg_global_mem_new_internal(TCG_TYPE_I64, reg, offset, name);
 869     return temp_tcgv_i64(t);
 870 }
 871
 872 static inline TCGv_i64 tcg_temp_new_i64(void)
 873 {
 874     return tcg_temp_new_internal_i64(0);
 875 }
 876
 877 static inline TCGv_i64 tcg_temp_local_new_i64(void)
 878 {
 879     return tcg_temp_new_internal_i64(1);
 880 }
 881
 882 #if defined(CONFIG_DEBUG_TCG)
 883 /* If you call tcg_clear_temp_count() at the start of a section of
 884  * code which is not supposed to leak any TCG temporaries, then
 885  * calling tcg_check_temp_count() at the end of the section will
 886  * return 1 if the section did in fact leak a temporary.
 887  */
 888 void tcg_clear_temp_count(void);
 889 int tcg_check_temp_count(void);
 890 #else
 891 #define tcg_clear_temp_count() do { } while (0)
 892 #define tcg_check_temp_count() 0
 893 #endif
 894
 895 void tcg_dump_info(FILE *f, fprintf_function cpu_fprintf);
 896 void tcg_dump_op_count(FILE *f, fprintf_function cpu_fprintf);
 897
 898 #define TCG_CT_ALIAS  0x80
 899 #define TCG_CT_IALIAS 0x40
 900 #define TCG_CT_NEWREG 0x20 /* output requires a new register */
 901 #define TCG_CT_REG    0x01
 902 #define TCG_CT_CONST  0x02 /* any constant of register size */
 903
 904 typedef struct TCGArgConstraint {
 905     uint16_t ct;
 906     uint8_t alias_index;
 907     union {
 908         TCGRegSet regs;
 909     } u;
 910 } TCGArgConstraint;
 911
 912 #define TCG_MAX_OP_ARGS 16
 913
 914 /* Bits for TCGOpDef->flags, 8 bits available.  */
 915 enum {
 916     /* Instruction defines the end of a basic block.  */
 917     TCG_OPF_BB_END       = 0x01,
 918     /* Instruction clobbers call registers and potentially update globals.  */
 919     TCG_OPF_CALL_CLOBBER = 0x02,
 920     /* Instruction has side effects: it cannot be removed if its outputs
 921        are not used, and might trigger exceptions.  */
 922     TCG_OPF_SIDE_EFFECTS = 0x04,
 923     /* Instruction operands are 64-bits (otherwise 32-bits).  */
 924     TCG_OPF_64BIT        = 0x08,
 925     /* Instruction is optional and not implemented by the host, or insn
 926        is generic and should not be implemened by the host.  */
 927     TCG_OPF_NOT_PRESENT  = 0x10,
 928 };
 929
 930 typedef struct TCGOpDef {
 931     const char *name;
 932     uint8_t nb_oargs, nb_iargs, nb_cargs, nb_args;
 933     uint8_t flags;
 934     TCGArgConstraint *args_ct;
 935     int *sorted_args;
 936 #if defined(CONFIG_DEBUG_TCG)
 937     int used;
 938 #endif
 939 } TCGOpDef;
 940
 941 extern TCGOpDef tcg_op_defs[];
 942 extern const size_t tcg_op_defs_max;
 943
 944 typedef struct TCGTargetOpDef {
 945     TCGOpcode op;
 946     const char *args_ct_str[TCG_MAX_OP_ARGS];
 947 } TCGTargetOpDef;
 948
 949 #define tcg_abort() \
 950 do {\
 951     fprintf(stderr, "%s:%d: tcg fatal error\n", __FILE__, __LINE__);\
 952     abort();\
 953 } while (0)
 954
 955 #if UINTPTR_MAX == UINT32_MAX
 956 static inline TCGv_ptr TCGV_NAT_TO_PTR(TCGv_i32 n) { return (TCGv_ptr)n; }
 957 static inline TCGv_i32 TCGV_PTR_TO_NAT(TCGv_ptr n) { return (TCGv_i32)n; }
 958
 959 #define tcg_const_ptr(V) TCGV_NAT_TO_PTR(tcg_const_i32((intptr_t)(V)))
 960 #define tcg_global_mem_new_ptr(R, O, N) \
 961     TCGV_NAT_TO_PTR(tcg_global_mem_new_i32((R), (O), (N)))
 962 #define tcg_temp_new_ptr() TCGV_NAT_TO_PTR(tcg_temp_new_i32())
 963 #define tcg_temp_free_ptr(T) tcg_temp_free_i32(TCGV_PTR_TO_NAT(T))
 964 #else
 965 static inline TCGv_ptr TCGV_NAT_TO_PTR(TCGv_i64 n) { return (TCGv_ptr)n; }
 966 static inline TCGv_i64 TCGV_PTR_TO_NAT(TCGv_ptr n) { return (TCGv_i64)n; }
 967
 968 #define tcg_const_ptr(V) TCGV_NAT_TO_PTR(tcg_const_i64((intptr_t)(V)))
 969 #define tcg_global_mem_new_ptr(R, O, N) \
 970     TCGV_NAT_TO_PTR(tcg_global_mem_new_i64((R), (O), (N)))
 971 #define tcg_temp_new_ptr() TCGV_NAT_TO_PTR(tcg_temp_new_i64())
 972 #define tcg_temp_free_ptr(T) tcg_temp_free_i64(TCGV_PTR_TO_NAT(T))
 973 #endif
 974
 975 bool tcg_op_supported(TCGOpcode op);
 976
 977 void tcg_gen_callN(void *func, TCGTemp *ret, int nargs, TCGTemp **args);
 978
 979 void tcg_op_remove(TCGContext *s, TCGOp *op);
 980 TCGOp *tcg_op_insert_before(TCGContext *s, TCGOp *op, TCGOpcode opc, int narg);
 981 TCGOp *tcg_op_insert_after(TCGContext *s, TCGOp *op, TCGOpcode opc, int narg);
 982
 983 void tcg_optimize(TCGContext *s);
 984
 985 /* only used for debugging purposes */
 986 void tcg_dump_ops(TCGContext *s);
 987
 988 TCGv_i32 tcg_const_i32(int32_t val);
 989 TCGv_i64 tcg_const_i64(int64_t val);
 990 TCGv_i32 tcg_const_local_i32(int32_t val);
 991 TCGv_i64 tcg_const_local_i64(int64_t val);
 992
 993 TCGLabel *gen_new_label(void);
 994
 995 /**
 996  * label_arg
 997  * @l: label
 998  *
 999  * Encode a label for storage in the TCG opcode stream.
1000  */
1001
1002 static inline TCGArg label_arg(TCGLabel *l)
1003 {
1004     return (uintptr_t)l;
1005 }
1006
1007 /**
1008  * arg_label
1009  * @i: value
1010  *
1011  * The opposite of label_arg.  Retrieve a label from the
1012  * encoding of the TCG opcode stream.
1013  */
1014
1015 static inline TCGLabel *arg_label(TCGArg i)
1016 {
1017     return (TCGLabel *)(uintptr_t)i;
1018 }
1019
1020 /**
1021  * tcg_ptr_byte_diff
1022  * @a, @b: addresses to be differenced
1023  *
1024  * There are many places within the TCG backends where we need a byte
1025  * difference between two pointers.  While this can be accomplished
1026  * with local casting, it's easy to get wrong -- especially if one is
1027  * concerned with the signedness of the result.
1028  *
1029  * This version relies on GCC's void pointer arithmetic to get the
1030  * correct result.
1031  */
1032
1033 static inline ptrdiff_t tcg_ptr_byte_diff(void *a, void *b)
1034 {
1035     return a - b;
1036 }
1037
1038 /**
1039  * tcg_pcrel_diff
1040  * @s: the tcg context
1041  * @target: address of the target
1042  *
1043  * Produce a pc-relative difference, from the current code_ptr
1044  * to the destination address.
1045  */
1046
1047 static inline ptrdiff_t tcg_pcrel_diff(TCGContext *s, void *target)
1048 {
1049     return tcg_ptr_byte_diff(target, s->code_ptr);
1050 }
1051
1052 /**
1053  * tcg_current_code_size
1054  * @s: the tcg context
1055  *
1056  * Compute the current code size within the translation block.
1057  * This is used to fill in qemu's data structures for goto_tb.
1058  */
1059
1060 static inline size_t tcg_current_code_size(TCGContext *s)
1061 {
1062     return tcg_ptr_byte_diff(s->code_ptr, s->code_buf);
1063 }
1064
1065 /* Combine the TCGMemOp and mmu_idx parameters into a single value.  */
1066 typedef uint32_t TCGMemOpIdx;
1067
1068 /**
1069  * make_memop_idx
1070  * @op: memory operation
1071  * @idx: mmu index
1072  *
1073  * Encode these values into a single parameter.
1074  */
1075 static inline TCGMemOpIdx make_memop_idx(TCGMemOp op, unsigned idx)
1076 {
1077     tcg_debug_assert(idx <= 15);
1078     return (op << 4) | idx;
1079 }
1080
1081 /**
1082  * get_memop
1083  * @oi: combined op/idx parameter
1084  *
1085  * Extract the memory operation from the combined value.
1086  */
1087 static inline TCGMemOp get_memop(TCGMemOpIdx oi)
1088 {
1089     return oi >> 4;
1090 }
1091
1092 /**
1093  * get_mmuidx
1094  * @oi: combined op/idx parameter
1095  *
1096  * Extract the mmu index from the combined value.
1097  */
1098 static inline unsigned get_mmuidx(TCGMemOpIdx oi)
1099 {
1100     return oi & 15;
1101 }
1102
1103 /**
1104  * tcg_qemu_tb_exec:
1105  * @env: pointer to CPUArchState for the CPU
1106  * @tb_ptr: address of generated code for the TB to execute
1107  *
1108  * Start executing code from a given translation block.
1109  * Where translation blocks have been linked, execution
1110  * may proceed from the given TB into successive ones.
1111  * Control eventually returns only when some action is needed
1112  * from the top-level loop: either control must pass to a TB
1113  * which has not yet been directly linked, or an asynchronous
1114  * event such as an interrupt needs handling.
1115  *
1116  * Return: The return value is the value passed to the corresponding
1117  * tcg_gen_exit_tb() at translation time of the last TB attempted to execute.
1118  * The value is either zero or a 4-byte aligned pointer to that TB combined
1119  * with additional information in its two least significant bits. The
1120  * additional information is encoded as follows:
1121  *  0, 1: the link between this TB and the next is via the specified
1122  *        TB index (0 or 1). That is, we left the TB via (the equivalent
1123  *        of) "goto_tb <index>". The main loop uses this to determine
1124  *        how to link the TB just executed to the next.
1125  *  2:    we are using instruction counting code generation, and we
1126  *        did not start executing this TB because the instruction counter
1127  *        would hit zero midway through it. In this case the pointer
1128  *        returned is the TB we were about to execute, and the caller must
1129  *        arrange to execute the remaining count of instructions.
1130  *  3:    we stopped because the CPU's exit_request flag was set
1131  *        (usually meaning that there is an interrupt that needs to be
1132  *        handled). The pointer returned is the TB we were about to execute
1133  *        when we noticed the pending exit request.
1134  *
1135  * If the bottom two bits indicate an exit-via-index then the CPU
1136  * state is correctly synchronised and ready for execution of the next
1137  * TB (and in particular the guest PC is the address to execute next).
1138  * Otherwise, we gave up on execution of this TB before it started, and
1139  * the caller must fix up the CPU state by calling the CPU's
1140  * synchronize_from_tb() method with the TB pointer we return (falling
1141  * back to calling the CPU's set_pc method with tb->pb if no
1142  * synchronize_from_tb() method exists).
1143  *
1144  * Note that TCG targets may use a different definition of tcg_qemu_tb_exec
1145  * to this default (which just calls the prologue.code emitted by
1146  * tcg_target_qemu_prologue()).
1147  */
1148 #define TB_EXIT_MASK 3
1149 #define TB_EXIT_IDX0 0
1150 #define TB_EXIT_IDX1 1
1151 #define TB_EXIT_REQUESTED 3
1152
1153 #ifdef HAVE_TCG_QEMU_TB_EXEC
1154 uintptr_t tcg_qemu_tb_exec(CPUArchState *env, uint8_t *tb_ptr);
1155 #else
1156 # define tcg_qemu_tb_exec(env, tb_ptr) \
1157     ((uintptr_t (*)(void *, void *))tcg_ctx->code_gen_prologue)(env, tb_ptr)
1158 #endif
1159
1160 void tcg_register_jit(void *buf, size_t buf_size);
1161
1162 /*
1163  * Memory helpers that will be used by TCG generated code.
1164  */
1165 #ifdef CONFIG_SOFTMMU
1166 /* Value zero-extended to tcg register size.  */
1167 tcg_target_ulong helper_ret_ldub_mmu(CPUArchState *env, target_ulong addr,
1168                                      TCGMemOpIdx oi, uintptr_t retaddr);
1169 tcg_target_ulong helper_le_lduw_mmu(CPUArchState *env, target_ulong addr,
1170                                     TCGMemOpIdx oi, uintptr_t retaddr);
1171 tcg_target_ulong helper_le_ldul_mmu(CPUArchState *env, target_ulong addr,
1172                                     TCGMemOpIdx oi, uintptr_t retaddr);
1173 uint64_t helper_le_ldq_mmu(CPUArchState *env, target_ulong addr,
1174                            TCGMemOpIdx oi, uintptr_t retaddr);
1175 tcg_target_ulong helper_be_lduw_mmu(CPUArchState *env, target_ulong addr,
1176                                     TCGMemOpIdx oi, uintptr_t retaddr);
1177 tcg_target_ulong helper_be_ldul_mmu(CPUArchState *env, target_ulong addr,
1178                                     TCGMemOpIdx oi, uintptr_t retaddr);
1179 uint64_t helper_be_ldq_mmu(CPUArchState *env, target_ulong addr,
1180                            TCGMemOpIdx oi, uintptr_t retaddr);
1181
1182 /* Value sign-extended to tcg register size.  */
1183 tcg_target_ulong helper_ret_ldsb_mmu(CPUArchState *env, target_ulong addr,
1184                                      TCGMemOpIdx oi, uintptr_t retaddr);
1185 tcg_target_ulong helper_le_ldsw_mmu(CPUArchState *env, target_ulong addr,
1186                                     TCGMemOpIdx oi, uintptr_t retaddr);
1187 tcg_target_ulong helper_le_ldsl_mmu(CPUArchState *env, target_ulong addr,
1188                                     TCGMemOpIdx oi, uintptr_t retaddr);
1189 tcg_target_ulong helper_be_ldsw_mmu(CPUArchState *env, target_ulong addr,
1190                                     TCGMemOpIdx oi, uintptr_t retaddr);
1191 tcg_target_ulong helper_be_ldsl_mmu(CPUArchState *env, target_ulong addr,
1192                                     TCGMemOpIdx oi, uintptr_t retaddr);
1193
1194 void helper_ret_stb_mmu(CPUArchState *env, target_ulong addr, uint8_t val,
1195                         TCGMemOpIdx oi, uintptr_t retaddr);
1196 void helper_le_stw_mmu(CPUArchState *env, target_ulong addr, uint16_t val,
1197                        TCGMemOpIdx oi, uintptr_t retaddr);
1198 void helper_le_stl_mmu(CPUArchState *env, target_ulong addr, uint32_t val,
1199                        TCGMemOpIdx oi, uintptr_t retaddr);
1200 void helper_le_stq_mmu(CPUArchState *env, target_ulong addr, uint64_t val,
1201                        TCGMemOpIdx oi, uintptr_t retaddr);
1202 void helper_be_stw_mmu(CPUArchState *env, target_ulong addr, uint16_t val,
1203                        TCGMemOpIdx oi, uintptr_t retaddr);
1204 void helper_be_stl_mmu(CPUArchState *env, target_ulong addr, uint32_t val,
1205                        TCGMemOpIdx oi, uintptr_t retaddr);
1206 void helper_be_stq_mmu(CPUArchState *env, target_ulong addr, uint64_t val,
1207                        TCGMemOpIdx oi, uintptr_t retaddr);
1208
1209 uint8_t helper_ret_ldb_cmmu(CPUArchState *env, target_ulong addr,
1210                             TCGMemOpIdx oi, uintptr_t retaddr);
1211 uint16_t helper_le_ldw_cmmu(CPUArchState *env, target_ulong addr,
1212                             TCGMemOpIdx oi, uintptr_t retaddr);
1213 uint32_t helper_le_ldl_cmmu(CPUArchState *env, target_ulong addr,
1214                             TCGMemOpIdx oi, uintptr_t retaddr);
1215 uint64_t helper_le_ldq_cmmu(CPUArchState *env, target_ulong addr,
1216                             TCGMemOpIdx oi, uintptr_t retaddr);
1217 uint16_t helper_be_ldw_cmmu(CPUArchState *env, target_ulong addr,
1218                             TCGMemOpIdx oi, uintptr_t retaddr);
1219 uint32_t helper_be_ldl_cmmu(CPUArchState *env, target_ulong addr,
1220                             TCGMemOpIdx oi, uintptr_t retaddr);
1221 uint64_t helper_be_ldq_cmmu(CPUArchState *env, target_ulong addr,
1222                             TCGMemOpIdx oi, uintptr_t retaddr);
1223
1224 /* Temporary aliases until backends are converted.  */
1225 #ifdef TARGET_WORDS_BIGENDIAN
1226 # define helper_ret_ldsw_mmu  helper_be_ldsw_mmu
1227 # define helper_ret_lduw_mmu  helper_be_lduw_mmu
1228 # define helper_ret_ldsl_mmu  helper_be_ldsl_mmu
1229 # define helper_ret_ldul_mmu  helper_be_ldul_mmu
1230 # define helper_ret_ldl_mmu   helper_be_ldul_mmu
1231 # define helper_ret_ldq_mmu   helper_be_ldq_mmu
1232 # define helper_ret_stw_mmu   helper_be_stw_mmu
1233 # define helper_ret_stl_mmu   helper_be_stl_mmu
1234 # define helper_ret_stq_mmu   helper_be_stq_mmu
1235 # define helper_ret_ldw_cmmu  helper_be_ldw_cmmu
1236 # define helper_ret_ldl_cmmu  helper_be_ldl_cmmu
1237 # define helper_ret_ldq_cmmu  helper_be_ldq_cmmu
1238 #else
1239 # define helper_ret_ldsw_mmu  helper_le_ldsw_mmu
1240 # define helper_ret_lduw_mmu  helper_le_lduw_mmu
1241 # define helper_ret_ldsl_mmu  helper_le_ldsl_mmu
1242 # define helper_ret_ldul_mmu  helper_le_ldul_mmu
1243 # define helper_ret_ldl_mmu   helper_le_ldul_mmu
1244 # define helper_ret_ldq_mmu   helper_le_ldq_mmu
1245 # define helper_ret_stw_mmu   helper_le_stw_mmu
1246 # define helper_ret_stl_mmu   helper_le_stl_mmu
1247 # define helper_ret_stq_mmu   helper_le_stq_mmu
1248 # define helper_ret_ldw_cmmu  helper_le_ldw_cmmu
1249 # define helper_ret_ldl_cmmu  helper_le_ldl_cmmu
1250 # define helper_ret_ldq_cmmu  helper_le_ldq_cmmu
1251 #endif
1252
1253 uint32_t helper_atomic_cmpxchgb_mmu(CPUArchState *env, target_ulong addr,
1254                                     uint32_t cmpv, uint32_t newv,
1255                                     TCGMemOpIdx oi, uintptr_t retaddr);
1256 uint32_t helper_atomic_cmpxchgw_le_mmu(CPUArchState *env, target_ulong addr,
1257                                        uint32_t cmpv, uint32_t newv,
1258                                        TCGMemOpIdx oi, uintptr_t retaddr);
1259 uint32_t helper_atomic_cmpxchgl_le_mmu(CPUArchState *env, target_ulong addr,
1260                                        uint32_t cmpv, uint32_t newv,
1261                                        TCGMemOpIdx oi, uintptr_t retaddr);
1262 uint64_t helper_atomic_cmpxchgq_le_mmu(CPUArchState *env, target_ulong addr,
1263                                        uint64_t cmpv, uint64_t newv,
1264                                        TCGMemOpIdx oi, uintptr_t retaddr);
1265 uint32_t helper_atomic_cmpxchgw_be_mmu(CPUArchState *env, target_ulong addr,
1266                                        uint32_t cmpv, uint32_t newv,
1267                                        TCGMemOpIdx oi, uintptr_t retaddr);
1268 uint32_t helper_atomic_cmpxchgl_be_mmu(CPUArchState *env, target_ulong addr,
1269                                        uint32_t cmpv, uint32_t newv,
1270                                        TCGMemOpIdx oi, uintptr_t retaddr);
1271 uint64_t helper_atomic_cmpxchgq_be_mmu(CPUArchState *env, target_ulong addr,
1272                                        uint64_t cmpv, uint64_t newv,
1273                                        TCGMemOpIdx oi, uintptr_t retaddr);
1274
1275 #define GEN_ATOMIC_HELPER(NAME, TYPE, SUFFIX)         \
1276 TYPE helper_atomic_ ## NAME ## SUFFIX ## _mmu         \
1277     (CPUArchState *env, target_ulong addr, TYPE val,  \
1278      TCGMemOpIdx oi, uintptr_t retaddr);
1279
1280 #ifdef CONFIG_ATOMIC64
1281 #define GEN_ATOMIC_HELPER_ALL(NAME)          \
1282     GEN_ATOMIC_HELPER(NAME, uint32_t, b)     \
1283     GEN_ATOMIC_HELPER(NAME, uint32_t, w_le)  \
1284     GEN_ATOMIC_HELPER(NAME, uint32_t, w_be)  \
1285     GEN_ATOMIC_HELPER(NAME, uint32_t, l_le)  \
1286     GEN_ATOMIC_HELPER(NAME, uint32_t, l_be)  \
1287     GEN_ATOMIC_HELPER(NAME, uint64_t, q_le)  \
1288     GEN_ATOMIC_HELPER(NAME, uint64_t, q_be)
1289 #else
1290 #define GEN_ATOMIC_HELPER_ALL(NAME)          \
1291     GEN_ATOMIC_HELPER(NAME, uint32_t, b)     \
1292     GEN_ATOMIC_HELPER(NAME, uint32_t, w_le)  \
1293     GEN_ATOMIC_HELPER(NAME, uint32_t, w_be)  \
1294     GEN_ATOMIC_HELPER(NAME, uint32_t, l_le)  \
1295     GEN_ATOMIC_HELPER(NAME, uint32_t, l_be)
1296 #endif
1297
1298 GEN_ATOMIC_HELPER_ALL(fetch_add)
1299 GEN_ATOMIC_HELPER_ALL(fetch_sub)
1300 GEN_ATOMIC_HELPER_ALL(fetch_and)
1301 GEN_ATOMIC_HELPER_ALL(fetch_or)
1302 GEN_ATOMIC_HELPER_ALL(fetch_xor)
1303
1304 GEN_ATOMIC_HELPER_ALL(add_fetch)
1305 GEN_ATOMIC_HELPER_ALL(sub_fetch)
1306 GEN_ATOMIC_HELPER_ALL(and_fetch)
1307 GEN_ATOMIC_HELPER_ALL(or_fetch)
1308 GEN_ATOMIC_HELPER_ALL(xor_fetch)
1309
1310 GEN_ATOMIC_HELPER_ALL(xchg)
1311
1312 #undef GEN_ATOMIC_HELPER_ALL
1313 #undef GEN_ATOMIC_HELPER
1314 #endif /* CONFIG_SOFTMMU */
1315
1316 #ifdef CONFIG_ATOMIC128
1317 #include "qemu/int128.h"
1318
1319 /* These aren't really a "proper" helpers because TCG cannot manage Int128.
1320    However, use the same format as the others, for use by the backends. */
1321 Int128 helper_atomic_cmpxchgo_le_mmu(CPUArchState *env, target_ulong addr,
1322                                      Int128 cmpv, Int128 newv,
1323                                      TCGMemOpIdx oi, uintptr_t retaddr);
1324 Int128 helper_atomic_cmpxchgo_be_mmu(CPUArchState *env, target_ulong addr,
1325                                      Int128 cmpv, Int128 newv,
1326                                      TCGMemOpIdx oi, uintptr_t retaddr);
1327
1328 Int128 helper_atomic_ldo_le_mmu(CPUArchState *env, target_ulong addr,
1329                                 TCGMemOpIdx oi, uintptr_t retaddr);
1330 Int128 helper_atomic_ldo_be_mmu(CPUArchState *env, target_ulong addr,
1331                                 TCGMemOpIdx oi, uintptr_t retaddr);
1332 void helper_atomic_sto_le_mmu(CPUArchState *env, target_ulong addr, Int128 val,
1333                               TCGMemOpIdx oi, uintptr_t retaddr);
1334 void helper_atomic_sto_be_mmu(CPUArchState *env, target_ulong addr, Int128 val,
1335                               TCGMemOpIdx oi, uintptr_t retaddr);
1336
1337 #endif /* CONFIG_ATOMIC128 */
1338
1339 #endif /* TCG_H */