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, and they always
 418    box and unbox via the MAKE_TCGV_* and GET_TCGV_* functions.
 419    Converting to and from intptr_t rather than int reduces the number
 420    of sign-extension instructions that get implied on 64-bit hosts.  */
 421
 422 typedef struct TCGv_i32_d *TCGv_i32;
 423 typedef struct TCGv_i64_d *TCGv_i64;
 424 typedef struct TCGv_ptr_d *TCGv_ptr;
 425 typedef TCGv_ptr TCGv_env;
 426 #if TARGET_LONG_BITS == 32
 427 #define TCGv TCGv_i32
 428 #elif TARGET_LONG_BITS == 64
 429 #define TCGv TCGv_i64
 430 #else
 431 #error Unhandled TARGET_LONG_BITS value
 432 #endif
 433
 434 static inline TCGv_i32 QEMU_ARTIFICIAL MAKE_TCGV_I32(intptr_t i)
 435 {
 436     return (TCGv_i32)i;
 437 }
 438
 439 static inline TCGv_i64 QEMU_ARTIFICIAL MAKE_TCGV_I64(intptr_t i)
 440 {
 441     return (TCGv_i64)i;
 442 }
 443
 444 static inline TCGv_ptr QEMU_ARTIFICIAL MAKE_TCGV_PTR(intptr_t i)
 445 {
 446     return (TCGv_ptr)i;
 447 }
 448
 449 static inline intptr_t QEMU_ARTIFICIAL GET_TCGV_I32(TCGv_i32 t)
 450 {
 451     return (intptr_t)t;
 452 }
 453
 454 static inline intptr_t QEMU_ARTIFICIAL GET_TCGV_I64(TCGv_i64 t)
 455 {
 456     return (intptr_t)t;
 457 }
 458
 459 static inline intptr_t QEMU_ARTIFICIAL GET_TCGV_PTR(TCGv_ptr t)
 460 {
 461     return (intptr_t)t;
 462 }
 463
 464 #if TCG_TARGET_REG_BITS == 32
 465 #define TCGV_LOW(t) MAKE_TCGV_I32(GET_TCGV_I64(t))
 466 #define TCGV_HIGH(t) MAKE_TCGV_I32(GET_TCGV_I64(t) + 1)
 467 #endif
 468
 469 #define TCGV_EQUAL_I32(a, b) (GET_TCGV_I32(a) == GET_TCGV_I32(b))
 470 #define TCGV_EQUAL_I64(a, b) (GET_TCGV_I64(a) == GET_TCGV_I64(b))
 471 #define TCGV_EQUAL_PTR(a, b) (GET_TCGV_PTR(a) == GET_TCGV_PTR(b))
 472
 473 /* Dummy definition to avoid compiler warnings.  */
 474 #define TCGV_UNUSED_I32(x) x = MAKE_TCGV_I32(-1)
 475 #define TCGV_UNUSED_I64(x) x = MAKE_TCGV_I64(-1)
 476 #define TCGV_UNUSED_PTR(x) x = MAKE_TCGV_PTR(-1)
 477
 478 #define TCGV_IS_UNUSED_I32(x) (GET_TCGV_I32(x) == -1)
 479 #define TCGV_IS_UNUSED_I64(x) (GET_TCGV_I64(x) == -1)
 480 #define TCGV_IS_UNUSED_PTR(x) (GET_TCGV_PTR(x) == -1)
 481
 482 /* call flags */
 483 /* Helper does not read globals (either directly or through an exception). It
 484    implies TCG_CALL_NO_WRITE_GLOBALS. */
 485 #define TCG_CALL_NO_READ_GLOBALS    0x0010
 486 /* Helper does not write globals */
 487 #define TCG_CALL_NO_WRITE_GLOBALS   0x0020
 488 /* Helper can be safely suppressed if the return value is not used. */
 489 #define TCG_CALL_NO_SIDE_EFFECTS    0x0040
 490
 491 /* convenience version of most used call flags */
 492 #define TCG_CALL_NO_RWG         TCG_CALL_NO_READ_GLOBALS
 493 #define TCG_CALL_NO_WG          TCG_CALL_NO_WRITE_GLOBALS
 494 #define TCG_CALL_NO_SE          TCG_CALL_NO_SIDE_EFFECTS
 495 #define TCG_CALL_NO_RWG_SE      (TCG_CALL_NO_RWG | TCG_CALL_NO_SE)
 496 #define TCG_CALL_NO_WG_SE       (TCG_CALL_NO_WG | TCG_CALL_NO_SE)
 497
 498 /* used to align parameters */
 499 #define TCG_CALL_DUMMY_ARG      ((TCGArg)(-1))
 500
 501 /* Conditions.  Note that these are laid out for easy manipulation by
 502    the functions below:
 503      bit 0 is used for inverting;
 504      bit 1 is signed,
 505      bit 2 is unsigned,
 506      bit 3 is used with bit 0 for swapping signed/unsigned.  */
 507 typedef enum {
 508     /* non-signed */
 509     TCG_COND_NEVER  = 0 | 0 | 0 | 0,
 510     TCG_COND_ALWAYS = 0 | 0 | 0 | 1,
 511     TCG_COND_EQ     = 8 | 0 | 0 | 0,
 512     TCG_COND_NE     = 8 | 0 | 0 | 1,
 513     /* signed */
 514     TCG_COND_LT     = 0 | 0 | 2 | 0,
 515     TCG_COND_GE     = 0 | 0 | 2 | 1,
 516     TCG_COND_LE     = 8 | 0 | 2 | 0,
 517     TCG_COND_GT     = 8 | 0 | 2 | 1,
 518     /* unsigned */
 519     TCG_COND_LTU    = 0 | 4 | 0 | 0,
 520     TCG_COND_GEU    = 0 | 4 | 0 | 1,
 521     TCG_COND_LEU    = 8 | 4 | 0 | 0,
 522     TCG_COND_GTU    = 8 | 4 | 0 | 1,
 523 } TCGCond;
 524
 525 /* Invert the sense of the comparison.  */
 526 static inline TCGCond tcg_invert_cond(TCGCond c)
 527 {
 528     return (TCGCond)(c ^ 1);
 529 }
 530
 531 /* Swap the operands in a comparison.  */
 532 static inline TCGCond tcg_swap_cond(TCGCond c)
 533 {
 534     return c & 6 ? (TCGCond)(c ^ 9) : c;
 535 }
 536
 537 /* Create an "unsigned" version of a "signed" comparison.  */
 538 static inline TCGCond tcg_unsigned_cond(TCGCond c)
 539 {
 540     return c & 2 ? (TCGCond)(c ^ 6) : c;
 541 }
 542
 543 /* Must a comparison be considered unsigned?  */
 544 static inline bool is_unsigned_cond(TCGCond c)
 545 {
 546     return (c & 4) != 0;
 547 }
 548
 549 /* Create a "high" version of a double-word comparison.
 550    This removes equality from a LTE or GTE comparison.  */
 551 static inline TCGCond tcg_high_cond(TCGCond c)
 552 {
 553     switch (c) {
 554     case TCG_COND_GE:
 555     case TCG_COND_LE:
 556     case TCG_COND_GEU:
 557     case TCG_COND_LEU:
 558         return (TCGCond)(c ^ 8);
 559     default:
 560         return c;
 561     }
 562 }
 563
 564 typedef enum TCGTempVal {
 565     TEMP_VAL_DEAD,
 566     TEMP_VAL_REG,
 567     TEMP_VAL_MEM,
 568     TEMP_VAL_CONST,
 569 } TCGTempVal;
 570
 571 typedef struct TCGTemp {
 572     TCGReg reg:8;
 573     TCGTempVal val_type:8;
 574     TCGType base_type:8;
 575     TCGType type:8;
 576     unsigned int fixed_reg:1;
 577     unsigned int indirect_reg:1;
 578     unsigned int indirect_base:1;
 579     unsigned int mem_coherent:1;
 580     unsigned int mem_allocated:1;
 581     /* If true, the temp is saved across both basic blocks and
 582        translation blocks.  */
 583     unsigned int temp_global:1;
 584     /* If true, the temp is saved across basic blocks but dead
 585        at the end of translation blocks.  If false, the temp is
 586        dead at the end of basic blocks.  */
 587     unsigned int temp_local:1;
 588     unsigned int temp_allocated:1;
 589
 590     tcg_target_long val;
 591     struct TCGTemp *mem_base;
 592     intptr_t mem_offset;
 593     const char *name;
 594
 595     /* Pass-specific information that can be stored for a temporary.
 596        One word worth of integer data, and one pointer to data
 597        allocated separately.  */
 598     uintptr_t state;
 599     void *state_ptr;
 600 } TCGTemp;
 601
 602 typedef struct TCGContext TCGContext;
 603
 604 typedef struct TCGTempSet {
 605     unsigned long l[BITS_TO_LONGS(TCG_MAX_TEMPS)];
 606 } TCGTempSet;
 607
 608 /* While we limit helpers to 6 arguments, for 32-bit hosts, with padding,
 609    this imples a max of 6*2 (64-bit in) + 2 (64-bit out) = 14 operands.
 610    There are never more than 2 outputs, which means that we can store all
 611    dead + sync data within 16 bits.  */
 612 #define DEAD_ARG  4
 613 #define SYNC_ARG  1
 614 typedef uint16_t TCGLifeData;
 615
 616 /* The layout here is designed to avoid a bitfield crossing of
 617    a 32-bit boundary, which would cause GCC to add extra padding.  */
 618 typedef struct TCGOp {
 619     TCGOpcode opc   : 8;        /*  8 */
 620
 621     /* The number of out and in parameter for a call.  */
 622     unsigned calli  : 4;        /* 12 */
 623     unsigned callo  : 2;        /* 14 */
 624     unsigned        : 2;        /* 16 */
 625
 626     /* Index of the prev/next op, or 0 for the end of the list.  */
 627     unsigned prev   : 16;       /* 32 */
 628     unsigned next   : 16;       /* 48 */
 629
 630     /* Lifetime data of the operands.  */
 631     unsigned life   : 16;       /* 64 */
 632
 633     /* Arguments for the opcode.  */
 634     TCGArg args[MAX_OPC_PARAM];
 635 } TCGOp;
 636
 637 /* Make sure that we don't expand the structure without noticing.  */
 638 QEMU_BUILD_BUG_ON(sizeof(TCGOp) != 8 + sizeof(TCGArg) * MAX_OPC_PARAM);
 639
 640 /* Make sure operands fit in the bitfields above.  */
 641 QEMU_BUILD_BUG_ON(NB_OPS > (1 << 8));
 642 QEMU_BUILD_BUG_ON(OPC_BUF_SIZE > (1 << 16));
 643
 644 struct TCGContext {
 645     uint8_t *pool_cur, *pool_end;
 646     TCGPool *pool_first, *pool_current, *pool_first_large;
 647     int nb_labels;
 648     int nb_globals;
 649     int nb_temps;
 650     int nb_indirects;
 651
 652     /* goto_tb support */
 653     tcg_insn_unit *code_buf;
 654     uint16_t *tb_jmp_reset_offset; /* tb->jmp_reset_offset */
 655     uintptr_t *tb_jmp_insn_offset; /* tb->jmp_target_arg if direct_jump */
 656     uintptr_t *tb_jmp_target_addr; /* tb->jmp_target_arg if !direct_jump */
 657
 658     TCGRegSet reserved_regs;
 659     intptr_t current_frame_offset;
 660     intptr_t frame_start;
 661     intptr_t frame_end;
 662     TCGTemp *frame_temp;
 663
 664     tcg_insn_unit *code_ptr;
 665
 666 #ifdef CONFIG_PROFILER
 667     /* profiling info */
 668     int64_t tb_count1;
 669     int64_t tb_count;
 670     int64_t op_count; /* total insn count */
 671     int op_count_max; /* max insn per TB */
 672     int64_t temp_count;
 673     int temp_count_max;
 674     int64_t del_op_count;
 675     int64_t code_in_len;
 676     int64_t code_out_len;
 677     int64_t search_out_len;
 678     int64_t interm_time;
 679     int64_t code_time;
 680     int64_t la_time;
 681     int64_t opt_time;
 682     int64_t restore_count;
 683     int64_t restore_time;
 684 #endif
 685
 686 #ifdef CONFIG_DEBUG_TCG
 687     int temps_in_use;
 688     int goto_tb_issue_mask;
 689 #endif
 690
 691     int gen_next_op_idx;
 692
 693     /* Code generation.  Note that we specifically do not use tcg_insn_unit
 694        here, because there's too much arithmetic throughout that relies
 695        on addition and subtraction working on bytes.  Rely on the GCC
 696        extension that allows arithmetic on void*.  */
 697     void *code_gen_prologue;
 698     void *code_gen_epilogue;
 699     void *code_gen_buffer;
 700     size_t code_gen_buffer_size;
 701     void *code_gen_ptr;
 702     void *data_gen_ptr;
 703
 704     /* Threshold to flush the translated code buffer.  */
 705     void *code_gen_highwater;
 706
 707     TBContext tb_ctx;
 708
 709     /* Track which vCPU triggers events */
 710     CPUState *cpu;                      /* *_trans */
 711     TCGv_env tcg_env;                   /* *_exec  */
 712
 713     /* These structures are private to tcg-target.inc.c.  */
 714 #ifdef TCG_TARGET_NEED_LDST_LABELS
 715     struct TCGLabelQemuLdst *ldst_labels;
 716 #endif
 717 #ifdef TCG_TARGET_NEED_POOL_LABELS
 718     struct TCGLabelPoolData *pool_labels;
 719 #endif
 720
 721     TCGTempSet free_temps[TCG_TYPE_COUNT * 2];
 722     TCGTemp temps[TCG_MAX_TEMPS]; /* globals first, temps after */
 723
 724     /* Tells which temporary holds a given register.
 725        It does not take into account fixed registers */
 726     TCGTemp *reg_to_temp[TCG_TARGET_NB_REGS];
 727
 728     TCGOp gen_op_buf[OPC_BUF_SIZE];
 729
 730     uint16_t gen_insn_end_off[TCG_MAX_INSNS];
 731     target_ulong gen_insn_data[TCG_MAX_INSNS][TARGET_INSN_START_WORDS];
 732 };
 733
 734 extern TCGContext tcg_ctx;
 735 extern bool parallel_cpus;
 736
 737 static inline size_t temp_idx(TCGTemp *ts)
 738 {
 739     ptrdiff_t n = ts - tcg_ctx.temps;
 740     tcg_debug_assert(n >= 0 && n < tcg_ctx.nb_temps);
 741     return n;
 742 }
 743
 744 static inline TCGArg temp_arg(TCGTemp *ts)
 745 {
 746     return temp_idx(ts);
 747 }
 748
 749 static inline TCGTemp *arg_temp(TCGArg a)
 750 {
 751     return a == TCG_CALL_DUMMY_ARG ? NULL : &tcg_ctx.temps[a];
 752 }
 753
 754 static inline size_t arg_index(TCGArg a)
 755 {
 756     return a;
 757 }
 758
 759 static inline TCGArg tcgv_i32_arg(TCGv_i32 t)
 760 {
 761     return (intptr_t)t;
 762 }
 763
 764 static inline TCGArg tcgv_i64_arg(TCGv_i64 t)
 765 {
 766     return (intptr_t)t;
 767 }
 768
 769 static inline TCGArg tcgv_ptr_arg(TCGv_ptr t)
 770 {
 771     return (intptr_t)t;
 772 }
 773
 774 static inline TCGTemp *tcgv_i32_temp(TCGv_i32 t)
 775 {
 776     return arg_temp(tcgv_i32_arg(t));
 777 }
 778
 779 static inline TCGTemp *tcgv_i64_temp(TCGv_i64 t)
 780 {
 781     return arg_temp(tcgv_i64_arg(t));
 782 }
 783
 784 static inline TCGTemp *tcgv_ptr_temp(TCGv_ptr t)
 785 {
 786     return arg_temp(tcgv_ptr_arg(t));
 787 }
 788
 789 static inline void tcg_set_insn_param(int op_idx, int arg, TCGArg v)
 790 {
 791     tcg_ctx.gen_op_buf[op_idx].args[arg] = v;
 792 }
 793
 794 /* The number of opcodes emitted so far.  */
 795 static inline int tcg_op_buf_count(void)
 796 {
 797     return tcg_ctx.gen_next_op_idx;
 798 }
 799
 800 /* Test for whether to terminate the TB for using too many opcodes.  */
 801 static inline bool tcg_op_buf_full(void)
 802 {
 803     return tcg_op_buf_count() >= OPC_MAX_SIZE;
 804 }
 805
 806 /* pool based memory allocation */
 807
 808 /* tb_lock must be held for tcg_malloc_internal. */
 809 void *tcg_malloc_internal(TCGContext *s, int size);
 810 void tcg_pool_reset(TCGContext *s);
 811 TranslationBlock *tcg_tb_alloc(TCGContext *s);
 812
 813 /* Called with tb_lock held.  */
 814 static inline void *tcg_malloc(int size)
 815 {
 816     TCGContext *s = &tcg_ctx;
 817     uint8_t *ptr, *ptr_end;
 818
 819     /* ??? This is a weak placeholder for minimum malloc alignment.  */
 820     size = QEMU_ALIGN_UP(size, 8);
 821
 822     ptr = s->pool_cur;
 823     ptr_end = ptr + size;
 824     if (unlikely(ptr_end > s->pool_end)) {
 825         return tcg_malloc_internal(&tcg_ctx, size);
 826     } else {
 827         s->pool_cur = ptr_end;
 828         return ptr;
 829     }
 830 }
 831
 832 void tcg_context_init(TCGContext *s);
 833 void tcg_prologue_init(TCGContext *s);
 834 void tcg_func_start(TCGContext *s);
 835
 836 int tcg_gen_code(TCGContext *s, TranslationBlock *tb);
 837
 838 void tcg_set_frame(TCGContext *s, TCGReg reg, intptr_t start, intptr_t size);
 839
 840 int tcg_global_mem_new_internal(TCGType, TCGv_ptr, intptr_t, const char *);
 841
 842 TCGv_i32 tcg_global_reg_new_i32(TCGReg reg, const char *name);
 843 TCGv_i64 tcg_global_reg_new_i64(TCGReg reg, const char *name);
 844
 845 TCGv_i32 tcg_temp_new_internal_i32(int temp_local);
 846 TCGv_i64 tcg_temp_new_internal_i64(int temp_local);
 847
 848 void tcg_temp_free_i32(TCGv_i32 arg);
 849 void tcg_temp_free_i64(TCGv_i64 arg);
 850
 851 static inline TCGv_i32 tcg_global_mem_new_i32(TCGv_ptr reg, intptr_t offset,
 852                                               const char *name)
 853 {
 854     int idx = tcg_global_mem_new_internal(TCG_TYPE_I32, reg, offset, name);
 855     return MAKE_TCGV_I32(idx);
 856 }
 857
 858 static inline TCGv_i32 tcg_temp_new_i32(void)
 859 {
 860     return tcg_temp_new_internal_i32(0);
 861 }
 862
 863 static inline TCGv_i32 tcg_temp_local_new_i32(void)
 864 {
 865     return tcg_temp_new_internal_i32(1);
 866 }
 867
 868 static inline TCGv_i64 tcg_global_mem_new_i64(TCGv_ptr reg, intptr_t offset,
 869                                               const char *name)
 870 {
 871     int idx = tcg_global_mem_new_internal(TCG_TYPE_I64, reg, offset, name);
 872     return MAKE_TCGV_I64(idx);
 873 }
 874
 875 static inline TCGv_i64 tcg_temp_new_i64(void)
 876 {
 877     return tcg_temp_new_internal_i64(0);
 878 }
 879
 880 static inline TCGv_i64 tcg_temp_local_new_i64(void)
 881 {
 882     return tcg_temp_new_internal_i64(1);
 883 }
 884
 885 #if defined(CONFIG_DEBUG_TCG)
 886 /* If you call tcg_clear_temp_count() at the start of a section of
 887  * code which is not supposed to leak any TCG temporaries, then
 888  * calling tcg_check_temp_count() at the end of the section will
 889  * return 1 if the section did in fact leak a temporary.
 890  */
 891 void tcg_clear_temp_count(void);
 892 int tcg_check_temp_count(void);
 893 #else
 894 #define tcg_clear_temp_count() do { } while (0)
 895 #define tcg_check_temp_count() 0
 896 #endif
 897
 898 void tcg_dump_info(FILE *f, fprintf_function cpu_fprintf);
 899 void tcg_dump_op_count(FILE *f, fprintf_function cpu_fprintf);
 900
 901 #define TCG_CT_ALIAS  0x80
 902 #define TCG_CT_IALIAS 0x40
 903 #define TCG_CT_NEWREG 0x20 /* output requires a new register */
 904 #define TCG_CT_REG    0x01
 905 #define TCG_CT_CONST  0x02 /* any constant of register size */
 906
 907 typedef struct TCGArgConstraint {
 908     uint16_t ct;
 909     uint8_t alias_index;
 910     union {
 911         TCGRegSet regs;
 912     } u;
 913 } TCGArgConstraint;
 914
 915 #define TCG_MAX_OP_ARGS 16
 916
 917 /* Bits for TCGOpDef->flags, 8 bits available.  */
 918 enum {
 919     /* Instruction defines the end of a basic block.  */
 920     TCG_OPF_BB_END       = 0x01,
 921     /* Instruction clobbers call registers and potentially update globals.  */
 922     TCG_OPF_CALL_CLOBBER = 0x02,
 923     /* Instruction has side effects: it cannot be removed if its outputs
 924        are not used, and might trigger exceptions.  */
 925     TCG_OPF_SIDE_EFFECTS = 0x04,
 926     /* Instruction operands are 64-bits (otherwise 32-bits).  */
 927     TCG_OPF_64BIT        = 0x08,
 928     /* Instruction is optional and not implemented by the host, or insn
 929        is generic and should not be implemened by the host.  */
 930     TCG_OPF_NOT_PRESENT  = 0x10,
 931 };
 932
 933 typedef struct TCGOpDef {
 934     const char *name;
 935     uint8_t nb_oargs, nb_iargs, nb_cargs, nb_args;
 936     uint8_t flags;
 937     TCGArgConstraint *args_ct;
 938     int *sorted_args;
 939 #if defined(CONFIG_DEBUG_TCG)
 940     int used;
 941 #endif
 942 } TCGOpDef;
 943
 944 extern TCGOpDef tcg_op_defs[];
 945 extern const size_t tcg_op_defs_max;
 946
 947 typedef struct TCGTargetOpDef {
 948     TCGOpcode op;
 949     const char *args_ct_str[TCG_MAX_OP_ARGS];
 950 } TCGTargetOpDef;
 951
 952 #define tcg_abort() \
 953 do {\
 954     fprintf(stderr, "%s:%d: tcg fatal error\n", __FILE__, __LINE__);\
 955     abort();\
 956 } while (0)
 957
 958 #if UINTPTR_MAX == UINT32_MAX
 959 #define TCGV_NAT_TO_PTR(n) MAKE_TCGV_PTR(GET_TCGV_I32(n))
 960 #define TCGV_PTR_TO_NAT(n) MAKE_TCGV_I32(GET_TCGV_PTR(n))
 961
 962 #define tcg_const_ptr(V) TCGV_NAT_TO_PTR(tcg_const_i32((intptr_t)(V)))
 963 #define tcg_global_reg_new_ptr(R, N) \
 964     TCGV_NAT_TO_PTR(tcg_global_reg_new_i32((R), (N)))
 965 #define tcg_global_mem_new_ptr(R, O, N) \
 966     TCGV_NAT_TO_PTR(tcg_global_mem_new_i32((R), (O), (N)))
 967 #define tcg_temp_new_ptr() TCGV_NAT_TO_PTR(tcg_temp_new_i32())
 968 #define tcg_temp_free_ptr(T) tcg_temp_free_i32(TCGV_PTR_TO_NAT(T))
 969 #else
 970 #define TCGV_NAT_TO_PTR(n) MAKE_TCGV_PTR(GET_TCGV_I64(n))
 971 #define TCGV_PTR_TO_NAT(n) MAKE_TCGV_I64(GET_TCGV_PTR(n))
 972
 973 #define tcg_const_ptr(V) TCGV_NAT_TO_PTR(tcg_const_i64((intptr_t)(V)))
 974 #define tcg_global_reg_new_ptr(R, N) \
 975     TCGV_NAT_TO_PTR(tcg_global_reg_new_i64((R), (N)))
 976 #define tcg_global_mem_new_ptr(R, O, N) \
 977     TCGV_NAT_TO_PTR(tcg_global_mem_new_i64((R), (O), (N)))
 978 #define tcg_temp_new_ptr() TCGV_NAT_TO_PTR(tcg_temp_new_i64())
 979 #define tcg_temp_free_ptr(T) tcg_temp_free_i64(TCGV_PTR_TO_NAT(T))
 980 #endif
 981
 982 bool tcg_op_supported(TCGOpcode op);
 983
 984 void tcg_gen_callN(void *func, TCGTemp *ret, int nargs, TCGTemp **args);
 985
 986 void tcg_op_remove(TCGContext *s, TCGOp *op);
 987 TCGOp *tcg_op_insert_before(TCGContext *s, TCGOp *op, TCGOpcode opc, int narg);
 988 TCGOp *tcg_op_insert_after(TCGContext *s, TCGOp *op, TCGOpcode opc, int narg);
 989
 990 void tcg_optimize(TCGContext *s);
 991
 992 /* only used for debugging purposes */
 993 void tcg_dump_ops(TCGContext *s);
 994
 995 TCGv_i32 tcg_const_i32(int32_t val);
 996 TCGv_i64 tcg_const_i64(int64_t val);
 997 TCGv_i32 tcg_const_local_i32(int32_t val);
 998 TCGv_i64 tcg_const_local_i64(int64_t val);
 999
1000 TCGLabel *gen_new_label(void);
1001
1002 /**
1003  * label_arg
1004  * @l: label
1005  *
1006  * Encode a label for storage in the TCG opcode stream.
1007  */
1008
1009 static inline TCGArg label_arg(TCGLabel *l)
1010 {
1011     return (uintptr_t)l;
1012 }
1013
1014 /**
1015  * arg_label
1016  * @i: value
1017  *
1018  * The opposite of label_arg.  Retrieve a label from the
1019  * encoding of the TCG opcode stream.
1020  */
1021
1022 static inline TCGLabel *arg_label(TCGArg i)
1023 {
1024     return (TCGLabel *)(uintptr_t)i;
1025 }
1026
1027 /**
1028  * tcg_ptr_byte_diff
1029  * @a, @b: addresses to be differenced
1030  *
1031  * There are many places within the TCG backends where we need a byte
1032  * difference between two pointers.  While this can be accomplished
1033  * with local casting, it's easy to get wrong -- especially if one is
1034  * concerned with the signedness of the result.
1035  *
1036  * This version relies on GCC's void pointer arithmetic to get the
1037  * correct result.
1038  */
1039
1040 static inline ptrdiff_t tcg_ptr_byte_diff(void *a, void *b)
1041 {
1042     return a - b;
1043 }
1044
1045 /**
1046  * tcg_pcrel_diff
1047  * @s: the tcg context
1048  * @target: address of the target
1049  *
1050  * Produce a pc-relative difference, from the current code_ptr
1051  * to the destination address.
1052  */
1053
1054 static inline ptrdiff_t tcg_pcrel_diff(TCGContext *s, void *target)
1055 {
1056     return tcg_ptr_byte_diff(target, s->code_ptr);
1057 }
1058
1059 /**
1060  * tcg_current_code_size
1061  * @s: the tcg context
1062  *
1063  * Compute the current code size within the translation block.
1064  * This is used to fill in qemu's data structures for goto_tb.
1065  */
1066
1067 static inline size_t tcg_current_code_size(TCGContext *s)
1068 {
1069     return tcg_ptr_byte_diff(s->code_ptr, s->code_buf);
1070 }
1071
1072 /* Combine the TCGMemOp and mmu_idx parameters into a single value.  */
1073 typedef uint32_t TCGMemOpIdx;
1074
1075 /**
1076  * make_memop_idx
1077  * @op: memory operation
1078  * @idx: mmu index
1079  *
1080  * Encode these values into a single parameter.
1081  */
1082 static inline TCGMemOpIdx make_memop_idx(TCGMemOp op, unsigned idx)
1083 {
1084     tcg_debug_assert(idx <= 15);
1085     return (op << 4) | idx;
1086 }
1087
1088 /**
1089  * get_memop
1090  * @oi: combined op/idx parameter
1091  *
1092  * Extract the memory operation from the combined value.
1093  */
1094 static inline TCGMemOp get_memop(TCGMemOpIdx oi)
1095 {
1096     return oi >> 4;
1097 }
1098
1099 /**
1100  * get_mmuidx
1101  * @oi: combined op/idx parameter
1102  *
1103  * Extract the mmu index from the combined value.
1104  */
1105 static inline unsigned get_mmuidx(TCGMemOpIdx oi)
1106 {
1107     return oi & 15;
1108 }
1109
1110 /**
1111  * tcg_qemu_tb_exec:
1112  * @env: pointer to CPUArchState for the CPU
1113  * @tb_ptr: address of generated code for the TB to execute
1114  *
1115  * Start executing code from a given translation block.
1116  * Where translation blocks have been linked, execution
1117  * may proceed from the given TB into successive ones.
1118  * Control eventually returns only when some action is needed
1119  * from the top-level loop: either control must pass to a TB
1120  * which has not yet been directly linked, or an asynchronous
1121  * event such as an interrupt needs handling.
1122  *
1123  * Return: The return value is the value passed to the corresponding
1124  * tcg_gen_exit_tb() at translation time of the last TB attempted to execute.
1125  * The value is either zero or a 4-byte aligned pointer to that TB combined
1126  * with additional information in its two least significant bits. The
1127  * additional information is encoded as follows:
1128  *  0, 1: the link between this TB and the next is via the specified
1129  *        TB index (0 or 1). That is, we left the TB via (the equivalent
1130  *        of) "goto_tb <index>". The main loop uses this to determine
1131  *        how to link the TB just executed to the next.
1132  *  2:    we are using instruction counting code generation, and we
1133  *        did not start executing this TB because the instruction counter
1134  *        would hit zero midway through it. In this case the pointer
1135  *        returned is the TB we were about to execute, and the caller must
1136  *        arrange to execute the remaining count of instructions.
1137  *  3:    we stopped because the CPU's exit_request flag was set
1138  *        (usually meaning that there is an interrupt that needs to be
1139  *        handled). The pointer returned is the TB we were about to execute
1140  *        when we noticed the pending exit request.
1141  *
1142  * If the bottom two bits indicate an exit-via-index then the CPU
1143  * state is correctly synchronised and ready for execution of the next
1144  * TB (and in particular the guest PC is the address to execute next).
1145  * Otherwise, we gave up on execution of this TB before it started, and
1146  * the caller must fix up the CPU state by calling the CPU's
1147  * synchronize_from_tb() method with the TB pointer we return (falling
1148  * back to calling the CPU's set_pc method with tb->pb if no
1149  * synchronize_from_tb() method exists).
1150  *
1151  * Note that TCG targets may use a different definition of tcg_qemu_tb_exec
1152  * to this default (which just calls the prologue.code emitted by
1153  * tcg_target_qemu_prologue()).
1154  */
1155 #define TB_EXIT_MASK 3
1156 #define TB_EXIT_IDX0 0
1157 #define TB_EXIT_IDX1 1
1158 #define TB_EXIT_REQUESTED 3
1159
1160 #ifdef HAVE_TCG_QEMU_TB_EXEC
1161 uintptr_t tcg_qemu_tb_exec(CPUArchState *env, uint8_t *tb_ptr);
1162 #else
1163 # define tcg_qemu_tb_exec(env, tb_ptr) \
1164     ((uintptr_t (*)(void *, void *))tcg_ctx.code_gen_prologue)(env, tb_ptr)
1165 #endif
1166
1167 void tcg_register_jit(void *buf, size_t buf_size);
1168
1169 /*
1170  * Memory helpers that will be used by TCG generated code.
1171  */
1172 #ifdef CONFIG_SOFTMMU
1173 /* Value zero-extended to tcg register size.  */
1174 tcg_target_ulong helper_ret_ldub_mmu(CPUArchState *env, target_ulong addr,
1175                                      TCGMemOpIdx oi, uintptr_t retaddr);
1176 tcg_target_ulong helper_le_lduw_mmu(CPUArchState *env, target_ulong addr,
1177                                     TCGMemOpIdx oi, uintptr_t retaddr);
1178 tcg_target_ulong helper_le_ldul_mmu(CPUArchState *env, target_ulong addr,
1179                                     TCGMemOpIdx oi, uintptr_t retaddr);
1180 uint64_t helper_le_ldq_mmu(CPUArchState *env, target_ulong addr,
1181                            TCGMemOpIdx oi, uintptr_t retaddr);
1182 tcg_target_ulong helper_be_lduw_mmu(CPUArchState *env, target_ulong addr,
1183                                     TCGMemOpIdx oi, uintptr_t retaddr);
1184 tcg_target_ulong helper_be_ldul_mmu(CPUArchState *env, target_ulong addr,
1185                                     TCGMemOpIdx oi, uintptr_t retaddr);
1186 uint64_t helper_be_ldq_mmu(CPUArchState *env, target_ulong addr,
1187                            TCGMemOpIdx oi, uintptr_t retaddr);
1188
1189 /* Value sign-extended to tcg register size.  */
1190 tcg_target_ulong helper_ret_ldsb_mmu(CPUArchState *env, target_ulong addr,
1191                                      TCGMemOpIdx oi, uintptr_t retaddr);
1192 tcg_target_ulong helper_le_ldsw_mmu(CPUArchState *env, target_ulong addr,
1193                                     TCGMemOpIdx oi, uintptr_t retaddr);
1194 tcg_target_ulong helper_le_ldsl_mmu(CPUArchState *env, target_ulong addr,
1195                                     TCGMemOpIdx oi, uintptr_t retaddr);
1196 tcg_target_ulong helper_be_ldsw_mmu(CPUArchState *env, target_ulong addr,
1197                                     TCGMemOpIdx oi, uintptr_t retaddr);
1198 tcg_target_ulong helper_be_ldsl_mmu(CPUArchState *env, target_ulong addr,
1199                                     TCGMemOpIdx oi, uintptr_t retaddr);
1200
1201 void helper_ret_stb_mmu(CPUArchState *env, target_ulong addr, uint8_t val,
1202                         TCGMemOpIdx oi, uintptr_t retaddr);
1203 void helper_le_stw_mmu(CPUArchState *env, target_ulong addr, uint16_t val,
1204                        TCGMemOpIdx oi, uintptr_t retaddr);
1205 void helper_le_stl_mmu(CPUArchState *env, target_ulong addr, uint32_t val,
1206                        TCGMemOpIdx oi, uintptr_t retaddr);
1207 void helper_le_stq_mmu(CPUArchState *env, target_ulong addr, uint64_t val,
1208                        TCGMemOpIdx oi, uintptr_t retaddr);
1209 void helper_be_stw_mmu(CPUArchState *env, target_ulong addr, uint16_t val,
1210                        TCGMemOpIdx oi, uintptr_t retaddr);
1211 void helper_be_stl_mmu(CPUArchState *env, target_ulong addr, uint32_t val,
1212                        TCGMemOpIdx oi, uintptr_t retaddr);
1213 void helper_be_stq_mmu(CPUArchState *env, target_ulong addr, uint64_t val,
1214                        TCGMemOpIdx oi, uintptr_t retaddr);
1215
1216 uint8_t helper_ret_ldb_cmmu(CPUArchState *env, target_ulong addr,
1217                             TCGMemOpIdx oi, uintptr_t retaddr);
1218 uint16_t helper_le_ldw_cmmu(CPUArchState *env, target_ulong addr,
1219                             TCGMemOpIdx oi, uintptr_t retaddr);
1220 uint32_t helper_le_ldl_cmmu(CPUArchState *env, target_ulong addr,
1221                             TCGMemOpIdx oi, uintptr_t retaddr);
1222 uint64_t helper_le_ldq_cmmu(CPUArchState *env, target_ulong addr,
1223                             TCGMemOpIdx oi, uintptr_t retaddr);
1224 uint16_t helper_be_ldw_cmmu(CPUArchState *env, target_ulong addr,
1225                             TCGMemOpIdx oi, uintptr_t retaddr);
1226 uint32_t helper_be_ldl_cmmu(CPUArchState *env, target_ulong addr,
1227                             TCGMemOpIdx oi, uintptr_t retaddr);
1228 uint64_t helper_be_ldq_cmmu(CPUArchState *env, target_ulong addr,
1229                             TCGMemOpIdx oi, uintptr_t retaddr);
1230
1231 /* Temporary aliases until backends are converted.  */
1232 #ifdef TARGET_WORDS_BIGENDIAN
1233 # define helper_ret_ldsw_mmu  helper_be_ldsw_mmu
1234 # define helper_ret_lduw_mmu  helper_be_lduw_mmu
1235 # define helper_ret_ldsl_mmu  helper_be_ldsl_mmu
1236 # define helper_ret_ldul_mmu  helper_be_ldul_mmu
1237 # define helper_ret_ldl_mmu   helper_be_ldul_mmu
1238 # define helper_ret_ldq_mmu   helper_be_ldq_mmu
1239 # define helper_ret_stw_mmu   helper_be_stw_mmu
1240 # define helper_ret_stl_mmu   helper_be_stl_mmu
1241 # define helper_ret_stq_mmu   helper_be_stq_mmu
1242 # define helper_ret_ldw_cmmu  helper_be_ldw_cmmu
1243 # define helper_ret_ldl_cmmu  helper_be_ldl_cmmu
1244 # define helper_ret_ldq_cmmu  helper_be_ldq_cmmu
1245 #else
1246 # define helper_ret_ldsw_mmu  helper_le_ldsw_mmu
1247 # define helper_ret_lduw_mmu  helper_le_lduw_mmu
1248 # define helper_ret_ldsl_mmu  helper_le_ldsl_mmu
1249 # define helper_ret_ldul_mmu  helper_le_ldul_mmu
1250 # define helper_ret_ldl_mmu   helper_le_ldul_mmu
1251 # define helper_ret_ldq_mmu   helper_le_ldq_mmu
1252 # define helper_ret_stw_mmu   helper_le_stw_mmu
1253 # define helper_ret_stl_mmu   helper_le_stl_mmu
1254 # define helper_ret_stq_mmu   helper_le_stq_mmu
1255 # define helper_ret_ldw_cmmu  helper_le_ldw_cmmu
1256 # define helper_ret_ldl_cmmu  helper_le_ldl_cmmu
1257 # define helper_ret_ldq_cmmu  helper_le_ldq_cmmu
1258 #endif
1259
1260 uint32_t helper_atomic_cmpxchgb_mmu(CPUArchState *env, target_ulong addr,
1261                                     uint32_t cmpv, uint32_t newv,
1262                                     TCGMemOpIdx oi, uintptr_t retaddr);
1263 uint32_t helper_atomic_cmpxchgw_le_mmu(CPUArchState *env, target_ulong addr,
1264                                        uint32_t cmpv, uint32_t newv,
1265                                        TCGMemOpIdx oi, uintptr_t retaddr);
1266 uint32_t helper_atomic_cmpxchgl_le_mmu(CPUArchState *env, target_ulong addr,
1267                                        uint32_t cmpv, uint32_t newv,
1268                                        TCGMemOpIdx oi, uintptr_t retaddr);
1269 uint64_t helper_atomic_cmpxchgq_le_mmu(CPUArchState *env, target_ulong addr,
1270                                        uint64_t cmpv, uint64_t newv,
1271                                        TCGMemOpIdx oi, uintptr_t retaddr);
1272 uint32_t helper_atomic_cmpxchgw_be_mmu(CPUArchState *env, target_ulong addr,
1273                                        uint32_t cmpv, uint32_t newv,
1274                                        TCGMemOpIdx oi, uintptr_t retaddr);
1275 uint32_t helper_atomic_cmpxchgl_be_mmu(CPUArchState *env, target_ulong addr,
1276                                        uint32_t cmpv, uint32_t newv,
1277                                        TCGMemOpIdx oi, uintptr_t retaddr);
1278 uint64_t helper_atomic_cmpxchgq_be_mmu(CPUArchState *env, target_ulong addr,
1279                                        uint64_t cmpv, uint64_t newv,
1280                                        TCGMemOpIdx oi, uintptr_t retaddr);
1281
1282 #define GEN_ATOMIC_HELPER(NAME, TYPE, SUFFIX)         \
1283 TYPE helper_atomic_ ## NAME ## SUFFIX ## _mmu         \
1284     (CPUArchState *env, target_ulong addr, TYPE val,  \
1285      TCGMemOpIdx oi, uintptr_t retaddr);
1286
1287 #ifdef CONFIG_ATOMIC64
1288 #define GEN_ATOMIC_HELPER_ALL(NAME)          \
1289     GEN_ATOMIC_HELPER(NAME, uint32_t, b)     \
1290     GEN_ATOMIC_HELPER(NAME, uint32_t, w_le)  \
1291     GEN_ATOMIC_HELPER(NAME, uint32_t, w_be)  \
1292     GEN_ATOMIC_HELPER(NAME, uint32_t, l_le)  \
1293     GEN_ATOMIC_HELPER(NAME, uint32_t, l_be)  \
1294     GEN_ATOMIC_HELPER(NAME, uint64_t, q_le)  \
1295     GEN_ATOMIC_HELPER(NAME, uint64_t, q_be)
1296 #else
1297 #define GEN_ATOMIC_HELPER_ALL(NAME)          \
1298     GEN_ATOMIC_HELPER(NAME, uint32_t, b)     \
1299     GEN_ATOMIC_HELPER(NAME, uint32_t, w_le)  \
1300     GEN_ATOMIC_HELPER(NAME, uint32_t, w_be)  \
1301     GEN_ATOMIC_HELPER(NAME, uint32_t, l_le)  \
1302     GEN_ATOMIC_HELPER(NAME, uint32_t, l_be)
1303 #endif
1304
1305 GEN_ATOMIC_HELPER_ALL(fetch_add)
1306 GEN_ATOMIC_HELPER_ALL(fetch_sub)
1307 GEN_ATOMIC_HELPER_ALL(fetch_and)
1308 GEN_ATOMIC_HELPER_ALL(fetch_or)
1309 GEN_ATOMIC_HELPER_ALL(fetch_xor)
1310
1311 GEN_ATOMIC_HELPER_ALL(add_fetch)
1312 GEN_ATOMIC_HELPER_ALL(sub_fetch)
1313 GEN_ATOMIC_HELPER_ALL(and_fetch)
1314 GEN_ATOMIC_HELPER_ALL(or_fetch)
1315 GEN_ATOMIC_HELPER_ALL(xor_fetch)
1316
1317 GEN_ATOMIC_HELPER_ALL(xchg)
1318
1319 #undef GEN_ATOMIC_HELPER_ALL
1320 #undef GEN_ATOMIC_HELPER
1321 #endif /* CONFIG_SOFTMMU */
1322
1323 #ifdef CONFIG_ATOMIC128
1324 #include "qemu/int128.h"
1325
1326 /* These aren't really a "proper" helpers because TCG cannot manage Int128.
1327    However, use the same format as the others, for use by the backends. */
1328 Int128 helper_atomic_cmpxchgo_le_mmu(CPUArchState *env, target_ulong addr,
1329                                      Int128 cmpv, Int128 newv,
1330                                      TCGMemOpIdx oi, uintptr_t retaddr);
1331 Int128 helper_atomic_cmpxchgo_be_mmu(CPUArchState *env, target_ulong addr,
1332                                      Int128 cmpv, Int128 newv,
1333                                      TCGMemOpIdx oi, uintptr_t retaddr);
1334
1335 Int128 helper_atomic_ldo_le_mmu(CPUArchState *env, target_ulong addr,
1336                                 TCGMemOpIdx oi, uintptr_t retaddr);
1337 Int128 helper_atomic_ldo_be_mmu(CPUArchState *env, target_ulong addr,
1338                                 TCGMemOpIdx oi, uintptr_t retaddr);
1339 void helper_atomic_sto_le_mmu(CPUArchState *env, target_ulong addr, Int128 val,
1340                               TCGMemOpIdx oi, uintptr_t retaddr);
1341 void helper_atomic_sto_be_mmu(CPUArchState *env, target_ulong addr, Int128 val,
1342                               TCGMemOpIdx oi, uintptr_t retaddr);
1343
1344 #endif /* CONFIG_ATOMIC128 */
1345
1346 #endif /* TCG_H */