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