xref: /openbmc/qemu/include/tcg/tcg.h (revision a9a5c473)
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         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_prologue;
625     void *code_gen_epilogue;
626     void *code_gen_buffer;
627     size_t code_gen_buffer_size;
628     void *code_gen_ptr;
629     void *data_gen_ptr;
630 
631     /* Threshold to flush the translated code buffer.  */
632     void *code_gen_highwater;
633 
634     size_t tb_phys_invalidate_count;
635 
636     /* Track which vCPU triggers events */
637     CPUState *cpu;                      /* *_trans */
638 
639     /* These structures are private to tcg-target.inc.c.  */
640 #ifdef TCG_TARGET_NEED_LDST_LABELS
641     QSIMPLEQ_HEAD(, TCGLabelQemuLdst) ldst_labels;
642 #endif
643 #ifdef TCG_TARGET_NEED_POOL_LABELS
644     struct TCGLabelPoolData *pool_labels;
645 #endif
646 
647     TCGLabel *exitreq_label;
648 
649 #ifdef CONFIG_PLUGIN
650     /*
651      * We keep one plugin_tb struct per TCGContext. Note that on every TB
652      * translation we clear but do not free its contents; this way we
653      * avoid a lot of malloc/free churn, since after a few TB's it's
654      * unlikely that we'll need to allocate either more instructions or more
655      * space for instructions (for variable-instruction-length ISAs).
656      */
657     struct qemu_plugin_tb *plugin_tb;
658 
659     /* descriptor of the instruction being translated */
660     struct qemu_plugin_insn *plugin_insn;
661 
662     /* list to quickly access the injected ops */
663     QSIMPLEQ_HEAD(, TCGOp) plugin_ops;
664 #endif
665 
666     TCGTempSet free_temps[TCG_TYPE_COUNT * 2];
667     TCGTemp temps[TCG_MAX_TEMPS]; /* globals first, temps after */
668 
669     QTAILQ_HEAD(, TCGOp) ops, free_ops;
670     QSIMPLEQ_HEAD(, TCGLabel) labels;
671 
672     /* Tells which temporary holds a given register.
673        It does not take into account fixed registers */
674     TCGTemp *reg_to_temp[TCG_TARGET_NB_REGS];
675 
676     uint16_t gen_insn_end_off[TCG_MAX_INSNS];
677     target_ulong gen_insn_data[TCG_MAX_INSNS][TARGET_INSN_START_WORDS];
678 };
679 
680 extern TCGContext tcg_init_ctx;
681 extern __thread TCGContext *tcg_ctx;
682 extern TCGv_env cpu_env;
683 
684 static inline size_t temp_idx(TCGTemp *ts)
685 {
686     ptrdiff_t n = ts - tcg_ctx->temps;
687     tcg_debug_assert(n >= 0 && n < tcg_ctx->nb_temps);
688     return n;
689 }
690 
691 static inline TCGArg temp_arg(TCGTemp *ts)
692 {
693     return (uintptr_t)ts;
694 }
695 
696 static inline TCGTemp *arg_temp(TCGArg a)
697 {
698     return (TCGTemp *)(uintptr_t)a;
699 }
700 
701 /* Using the offset of a temporary, relative to TCGContext, rather than
702    its index means that we don't use 0.  That leaves offset 0 free for
703    a NULL representation without having to leave index 0 unused.  */
704 static inline TCGTemp *tcgv_i32_temp(TCGv_i32 v)
705 {
706     uintptr_t o = (uintptr_t)v;
707     TCGTemp *t = (void *)tcg_ctx + o;
708     tcg_debug_assert(offsetof(TCGContext, temps[temp_idx(t)]) == o);
709     return t;
710 }
711 
712 static inline TCGTemp *tcgv_i64_temp(TCGv_i64 v)
713 {
714     return tcgv_i32_temp((TCGv_i32)v);
715 }
716 
717 static inline TCGTemp *tcgv_ptr_temp(TCGv_ptr v)
718 {
719     return tcgv_i32_temp((TCGv_i32)v);
720 }
721 
722 static inline TCGTemp *tcgv_vec_temp(TCGv_vec v)
723 {
724     return tcgv_i32_temp((TCGv_i32)v);
725 }
726 
727 static inline TCGArg tcgv_i32_arg(TCGv_i32 v)
728 {
729     return temp_arg(tcgv_i32_temp(v));
730 }
731 
732 static inline TCGArg tcgv_i64_arg(TCGv_i64 v)
733 {
734     return temp_arg(tcgv_i64_temp(v));
735 }
736 
737 static inline TCGArg tcgv_ptr_arg(TCGv_ptr v)
738 {
739     return temp_arg(tcgv_ptr_temp(v));
740 }
741 
742 static inline TCGArg tcgv_vec_arg(TCGv_vec v)
743 {
744     return temp_arg(tcgv_vec_temp(v));
745 }
746 
747 static inline TCGv_i32 temp_tcgv_i32(TCGTemp *t)
748 {
749     (void)temp_idx(t); /* trigger embedded assert */
750     return (TCGv_i32)((void *)t - (void *)tcg_ctx);
751 }
752 
753 static inline TCGv_i64 temp_tcgv_i64(TCGTemp *t)
754 {
755     return (TCGv_i64)temp_tcgv_i32(t);
756 }
757 
758 static inline TCGv_ptr temp_tcgv_ptr(TCGTemp *t)
759 {
760     return (TCGv_ptr)temp_tcgv_i32(t);
761 }
762 
763 static inline TCGv_vec temp_tcgv_vec(TCGTemp *t)
764 {
765     return (TCGv_vec)temp_tcgv_i32(t);
766 }
767 
768 #if TCG_TARGET_REG_BITS == 32
769 static inline TCGv_i32 TCGV_LOW(TCGv_i64 t)
770 {
771     return temp_tcgv_i32(tcgv_i64_temp(t));
772 }
773 
774 static inline TCGv_i32 TCGV_HIGH(TCGv_i64 t)
775 {
776     return temp_tcgv_i32(tcgv_i64_temp(t) + 1);
777 }
778 #endif
779 
780 static inline void tcg_set_insn_param(TCGOp *op, int arg, TCGArg v)
781 {
782     op->args[arg] = v;
783 }
784 
785 static inline void tcg_set_insn_start_param(TCGOp *op, int arg, target_ulong v)
786 {
787 #if TARGET_LONG_BITS <= TCG_TARGET_REG_BITS
788     tcg_set_insn_param(op, arg, v);
789 #else
790     tcg_set_insn_param(op, arg * 2, v);
791     tcg_set_insn_param(op, arg * 2 + 1, v >> 32);
792 #endif
793 }
794 
795 /* The last op that was emitted.  */
796 static inline TCGOp *tcg_last_op(void)
797 {
798     return QTAILQ_LAST(&tcg_ctx->ops);
799 }
800 
801 /* Test for whether to terminate the TB for using too many opcodes.  */
802 static inline bool tcg_op_buf_full(void)
803 {
804     /* This is not a hard limit, it merely stops translation when
805      * we have produced "enough" opcodes.  We want to limit TB size
806      * such that a RISC host can reasonably use a 16-bit signed
807      * branch within the TB.  We also need to be mindful of the
808      * 16-bit unsigned offsets, TranslationBlock.jmp_reset_offset[]
809      * and TCGContext.gen_insn_end_off[].
810      */
811     return tcg_ctx->nb_ops >= 4000;
812 }
813 
814 /* pool based memory allocation */
815 
816 /* user-mode: mmap_lock must be held for tcg_malloc_internal. */
817 void *tcg_malloc_internal(TCGContext *s, int size);
818 void tcg_pool_reset(TCGContext *s);
819 TranslationBlock *tcg_tb_alloc(TCGContext *s);
820 
821 void tcg_region_init(void);
822 void tcg_region_reset_all(void);
823 
824 size_t tcg_code_size(void);
825 size_t tcg_code_capacity(void);
826 
827 void tcg_tb_insert(TranslationBlock *tb);
828 void tcg_tb_remove(TranslationBlock *tb);
829 size_t tcg_tb_phys_invalidate_count(void);
830 TranslationBlock *tcg_tb_lookup(uintptr_t tc_ptr);
831 void tcg_tb_foreach(GTraverseFunc func, gpointer user_data);
832 size_t tcg_nb_tbs(void);
833 
834 /* user-mode: Called with mmap_lock held.  */
835 static inline void *tcg_malloc(int size)
836 {
837     TCGContext *s = tcg_ctx;
838     uint8_t *ptr, *ptr_end;
839 
840     /* ??? This is a weak placeholder for minimum malloc alignment.  */
841     size = QEMU_ALIGN_UP(size, 8);
842 
843     ptr = s->pool_cur;
844     ptr_end = ptr + size;
845     if (unlikely(ptr_end > s->pool_end)) {
846         return tcg_malloc_internal(tcg_ctx, size);
847     } else {
848         s->pool_cur = ptr_end;
849         return ptr;
850     }
851 }
852 
853 void tcg_context_init(TCGContext *s);
854 void tcg_register_thread(void);
855 void tcg_prologue_init(TCGContext *s);
856 void tcg_func_start(TCGContext *s);
857 
858 int tcg_gen_code(TCGContext *s, TranslationBlock *tb);
859 
860 void tcg_set_frame(TCGContext *s, TCGReg reg, intptr_t start, intptr_t size);
861 
862 TCGTemp *tcg_global_mem_new_internal(TCGType, TCGv_ptr,
863                                      intptr_t, const char *);
864 TCGTemp *tcg_temp_new_internal(TCGType, bool);
865 void tcg_temp_free_internal(TCGTemp *);
866 TCGv_vec tcg_temp_new_vec(TCGType type);
867 TCGv_vec tcg_temp_new_vec_matching(TCGv_vec match);
868 
869 static inline void tcg_temp_free_i32(TCGv_i32 arg)
870 {
871     tcg_temp_free_internal(tcgv_i32_temp(arg));
872 }
873 
874 static inline void tcg_temp_free_i64(TCGv_i64 arg)
875 {
876     tcg_temp_free_internal(tcgv_i64_temp(arg));
877 }
878 
879 static inline void tcg_temp_free_ptr(TCGv_ptr arg)
880 {
881     tcg_temp_free_internal(tcgv_ptr_temp(arg));
882 }
883 
884 static inline void tcg_temp_free_vec(TCGv_vec arg)
885 {
886     tcg_temp_free_internal(tcgv_vec_temp(arg));
887 }
888 
889 static inline TCGv_i32 tcg_global_mem_new_i32(TCGv_ptr reg, intptr_t offset,
890                                               const char *name)
891 {
892     TCGTemp *t = tcg_global_mem_new_internal(TCG_TYPE_I32, reg, offset, name);
893     return temp_tcgv_i32(t);
894 }
895 
896 static inline TCGv_i32 tcg_temp_new_i32(void)
897 {
898     TCGTemp *t = tcg_temp_new_internal(TCG_TYPE_I32, false);
899     return temp_tcgv_i32(t);
900 }
901 
902 static inline TCGv_i32 tcg_temp_local_new_i32(void)
903 {
904     TCGTemp *t = tcg_temp_new_internal(TCG_TYPE_I32, true);
905     return temp_tcgv_i32(t);
906 }
907 
908 static inline TCGv_i64 tcg_global_mem_new_i64(TCGv_ptr reg, intptr_t offset,
909                                               const char *name)
910 {
911     TCGTemp *t = tcg_global_mem_new_internal(TCG_TYPE_I64, reg, offset, name);
912     return temp_tcgv_i64(t);
913 }
914 
915 static inline TCGv_i64 tcg_temp_new_i64(void)
916 {
917     TCGTemp *t = tcg_temp_new_internal(TCG_TYPE_I64, false);
918     return temp_tcgv_i64(t);
919 }
920 
921 static inline TCGv_i64 tcg_temp_local_new_i64(void)
922 {
923     TCGTemp *t = tcg_temp_new_internal(TCG_TYPE_I64, true);
924     return temp_tcgv_i64(t);
925 }
926 
927 static inline TCGv_ptr tcg_global_mem_new_ptr(TCGv_ptr reg, intptr_t offset,
928                                               const char *name)
929 {
930     TCGTemp *t = tcg_global_mem_new_internal(TCG_TYPE_PTR, reg, offset, name);
931     return temp_tcgv_ptr(t);
932 }
933 
934 static inline TCGv_ptr tcg_temp_new_ptr(void)
935 {
936     TCGTemp *t = tcg_temp_new_internal(TCG_TYPE_PTR, false);
937     return temp_tcgv_ptr(t);
938 }
939 
940 static inline TCGv_ptr tcg_temp_local_new_ptr(void)
941 {
942     TCGTemp *t = tcg_temp_new_internal(TCG_TYPE_PTR, true);
943     return temp_tcgv_ptr(t);
944 }
945 
946 #if defined(CONFIG_DEBUG_TCG)
947 /* If you call tcg_clear_temp_count() at the start of a section of
948  * code which is not supposed to leak any TCG temporaries, then
949  * calling tcg_check_temp_count() at the end of the section will
950  * return 1 if the section did in fact leak a temporary.
951  */
952 void tcg_clear_temp_count(void);
953 int tcg_check_temp_count(void);
954 #else
955 #define tcg_clear_temp_count() do { } while (0)
956 #define tcg_check_temp_count() 0
957 #endif
958 
959 int64_t tcg_cpu_exec_time(void);
960 void tcg_dump_info(void);
961 void tcg_dump_op_count(void);
962 
963 #define TCG_CT_ALIAS  0x80
964 #define TCG_CT_IALIAS 0x40
965 #define TCG_CT_NEWREG 0x20 /* output requires a new register */
966 #define TCG_CT_REG    0x01
967 #define TCG_CT_CONST  0x02 /* any constant of register size */
968 
969 typedef struct TCGArgConstraint {
970     uint16_t ct;
971     uint8_t alias_index;
972     union {
973         TCGRegSet regs;
974     } u;
975 } TCGArgConstraint;
976 
977 #define TCG_MAX_OP_ARGS 16
978 
979 /* Bits for TCGOpDef->flags, 8 bits available.  */
980 enum {
981     /* Instruction exits the translation block.  */
982     TCG_OPF_BB_EXIT      = 0x01,
983     /* Instruction defines the end of a basic block.  */
984     TCG_OPF_BB_END       = 0x02,
985     /* Instruction clobbers call registers and potentially update globals.  */
986     TCG_OPF_CALL_CLOBBER = 0x04,
987     /* Instruction has side effects: it cannot be removed if its outputs
988        are not used, and might trigger exceptions.  */
989     TCG_OPF_SIDE_EFFECTS = 0x08,
990     /* Instruction operands are 64-bits (otherwise 32-bits).  */
991     TCG_OPF_64BIT        = 0x10,
992     /* Instruction is optional and not implemented by the host, or insn
993        is generic and should not be implemened by the host.  */
994     TCG_OPF_NOT_PRESENT  = 0x20,
995     /* Instruction operands are vectors.  */
996     TCG_OPF_VECTOR       = 0x40,
997 };
998 
999 typedef struct TCGOpDef {
1000     const char *name;
1001     uint8_t nb_oargs, nb_iargs, nb_cargs, nb_args;
1002     uint8_t flags;
1003     TCGArgConstraint *args_ct;
1004     int *sorted_args;
1005 #if defined(CONFIG_DEBUG_TCG)
1006     int used;
1007 #endif
1008 } TCGOpDef;
1009 
1010 extern TCGOpDef tcg_op_defs[];
1011 extern const size_t tcg_op_defs_max;
1012 
1013 typedef struct TCGTargetOpDef {
1014     TCGOpcode op;
1015     const char *args_ct_str[TCG_MAX_OP_ARGS];
1016 } TCGTargetOpDef;
1017 
1018 #define tcg_abort() \
1019 do {\
1020     fprintf(stderr, "%s:%d: tcg fatal error\n", __FILE__, __LINE__);\
1021     abort();\
1022 } while (0)
1023 
1024 bool tcg_op_supported(TCGOpcode op);
1025 
1026 void tcg_gen_callN(void *func, TCGTemp *ret, int nargs, TCGTemp **args);
1027 
1028 TCGOp *tcg_emit_op(TCGOpcode opc);
1029 void tcg_op_remove(TCGContext *s, TCGOp *op);
1030 TCGOp *tcg_op_insert_before(TCGContext *s, TCGOp *op, TCGOpcode opc);
1031 TCGOp *tcg_op_insert_after(TCGContext *s, TCGOp *op, TCGOpcode opc);
1032 
1033 void tcg_optimize(TCGContext *s);
1034 
1035 TCGv_i32 tcg_const_i32(int32_t val);
1036 TCGv_i64 tcg_const_i64(int64_t val);
1037 TCGv_i32 tcg_const_local_i32(int32_t val);
1038 TCGv_i64 tcg_const_local_i64(int64_t val);
1039 TCGv_vec tcg_const_zeros_vec(TCGType);
1040 TCGv_vec tcg_const_ones_vec(TCGType);
1041 TCGv_vec tcg_const_zeros_vec_matching(TCGv_vec);
1042 TCGv_vec tcg_const_ones_vec_matching(TCGv_vec);
1043 
1044 #if UINTPTR_MAX == UINT32_MAX
1045 # define tcg_const_ptr(x)        ((TCGv_ptr)tcg_const_i32((intptr_t)(x)))
1046 # define tcg_const_local_ptr(x)  ((TCGv_ptr)tcg_const_local_i32((intptr_t)(x)))
1047 #else
1048 # define tcg_const_ptr(x)        ((TCGv_ptr)tcg_const_i64((intptr_t)(x)))
1049 # define tcg_const_local_ptr(x)  ((TCGv_ptr)tcg_const_local_i64((intptr_t)(x)))
1050 #endif
1051 
1052 TCGLabel *gen_new_label(void);
1053 
1054 /**
1055  * label_arg
1056  * @l: label
1057  *
1058  * Encode a label for storage in the TCG opcode stream.
1059  */
1060 
1061 static inline TCGArg label_arg(TCGLabel *l)
1062 {
1063     return (uintptr_t)l;
1064 }
1065 
1066 /**
1067  * arg_label
1068  * @i: value
1069  *
1070  * The opposite of label_arg.  Retrieve a label from the
1071  * encoding of the TCG opcode stream.
1072  */
1073 
1074 static inline TCGLabel *arg_label(TCGArg i)
1075 {
1076     return (TCGLabel *)(uintptr_t)i;
1077 }
1078 
1079 /**
1080  * tcg_ptr_byte_diff
1081  * @a, @b: addresses to be differenced
1082  *
1083  * There are many places within the TCG backends where we need a byte
1084  * difference between two pointers.  While this can be accomplished
1085  * with local casting, it's easy to get wrong -- especially if one is
1086  * concerned with the signedness of the result.
1087  *
1088  * This version relies on GCC's void pointer arithmetic to get the
1089  * correct result.
1090  */
1091 
1092 static inline ptrdiff_t tcg_ptr_byte_diff(void *a, void *b)
1093 {
1094     return a - b;
1095 }
1096 
1097 /**
1098  * tcg_pcrel_diff
1099  * @s: the tcg context
1100  * @target: address of the target
1101  *
1102  * Produce a pc-relative difference, from the current code_ptr
1103  * to the destination address.
1104  */
1105 
1106 static inline ptrdiff_t tcg_pcrel_diff(TCGContext *s, void *target)
1107 {
1108     return tcg_ptr_byte_diff(target, s->code_ptr);
1109 }
1110 
1111 /**
1112  * tcg_current_code_size
1113  * @s: the tcg context
1114  *
1115  * Compute the current code size within the translation block.
1116  * This is used to fill in qemu's data structures for goto_tb.
1117  */
1118 
1119 static inline size_t tcg_current_code_size(TCGContext *s)
1120 {
1121     return tcg_ptr_byte_diff(s->code_ptr, s->code_buf);
1122 }
1123 
1124 /* Combine the MemOp and mmu_idx parameters into a single value.  */
1125 typedef uint32_t TCGMemOpIdx;
1126 
1127 /**
1128  * make_memop_idx
1129  * @op: memory operation
1130  * @idx: mmu index
1131  *
1132  * Encode these values into a single parameter.
1133  */
1134 static inline TCGMemOpIdx make_memop_idx(MemOp op, unsigned idx)
1135 {
1136     tcg_debug_assert(idx <= 15);
1137     return (op << 4) | idx;
1138 }
1139 
1140 /**
1141  * get_memop
1142  * @oi: combined op/idx parameter
1143  *
1144  * Extract the memory operation from the combined value.
1145  */
1146 static inline MemOp get_memop(TCGMemOpIdx oi)
1147 {
1148     return oi >> 4;
1149 }
1150 
1151 /**
1152  * get_mmuidx
1153  * @oi: combined op/idx parameter
1154  *
1155  * Extract the mmu index from the combined value.
1156  */
1157 static inline unsigned get_mmuidx(TCGMemOpIdx oi)
1158 {
1159     return oi & 15;
1160 }
1161 
1162 /**
1163  * tcg_qemu_tb_exec:
1164  * @env: pointer to CPUArchState for the CPU
1165  * @tb_ptr: address of generated code for the TB to execute
1166  *
1167  * Start executing code from a given translation block.
1168  * Where translation blocks have been linked, execution
1169  * may proceed from the given TB into successive ones.
1170  * Control eventually returns only when some action is needed
1171  * from the top-level loop: either control must pass to a TB
1172  * which has not yet been directly linked, or an asynchronous
1173  * event such as an interrupt needs handling.
1174  *
1175  * Return: The return value is the value passed to the corresponding
1176  * tcg_gen_exit_tb() at translation time of the last TB attempted to execute.
1177  * The value is either zero or a 4-byte aligned pointer to that TB combined
1178  * with additional information in its two least significant bits. The
1179  * additional information is encoded as follows:
1180  *  0, 1: the link between this TB and the next is via the specified
1181  *        TB index (0 or 1). That is, we left the TB via (the equivalent
1182  *        of) "goto_tb <index>". The main loop uses this to determine
1183  *        how to link the TB just executed to the next.
1184  *  2:    we are using instruction counting code generation, and we
1185  *        did not start executing this TB because the instruction counter
1186  *        would hit zero midway through it. In this case the pointer
1187  *        returned is the TB we were about to execute, and the caller must
1188  *        arrange to execute the remaining count of instructions.
1189  *  3:    we stopped because the CPU's exit_request flag was set
1190  *        (usually meaning that there is an interrupt that needs to be
1191  *        handled). The pointer returned is the TB we were about to execute
1192  *        when we noticed the pending exit request.
1193  *
1194  * If the bottom two bits indicate an exit-via-index then the CPU
1195  * state is correctly synchronised and ready for execution of the next
1196  * TB (and in particular the guest PC is the address to execute next).
1197  * Otherwise, we gave up on execution of this TB before it started, and
1198  * the caller must fix up the CPU state by calling the CPU's
1199  * synchronize_from_tb() method with the TB pointer we return (falling
1200  * back to calling the CPU's set_pc method with tb->pb if no
1201  * synchronize_from_tb() method exists).
1202  *
1203  * Note that TCG targets may use a different definition of tcg_qemu_tb_exec
1204  * to this default (which just calls the prologue.code emitted by
1205  * tcg_target_qemu_prologue()).
1206  */
1207 #define TB_EXIT_MASK      3
1208 #define TB_EXIT_IDX0      0
1209 #define TB_EXIT_IDX1      1
1210 #define TB_EXIT_IDXMAX    1
1211 #define TB_EXIT_REQUESTED 3
1212 
1213 #ifdef HAVE_TCG_QEMU_TB_EXEC
1214 uintptr_t tcg_qemu_tb_exec(CPUArchState *env, uint8_t *tb_ptr);
1215 #else
1216 # define tcg_qemu_tb_exec(env, tb_ptr) \
1217     ((uintptr_t (*)(void *, void *))tcg_ctx->code_gen_prologue)(env, tb_ptr)
1218 #endif
1219 
1220 void tcg_register_jit(void *buf, size_t buf_size);
1221 
1222 #if TCG_TARGET_MAYBE_vec
1223 /* Return zero if the tuple (opc, type, vece) is unsupportable;
1224    return > 0 if it is directly supportable;
1225    return < 0 if we must call tcg_expand_vec_op.  */
1226 int tcg_can_emit_vec_op(TCGOpcode, TCGType, unsigned);
1227 #else
1228 static inline int tcg_can_emit_vec_op(TCGOpcode o, TCGType t, unsigned ve)
1229 {
1230     return 0;
1231 }
1232 #endif
1233 
1234 /* Expand the tuple (opc, type, vece) on the given arguments.  */
1235 void tcg_expand_vec_op(TCGOpcode, TCGType, unsigned, TCGArg, ...);
1236 
1237 /* Replicate a constant C accoring to the log2 of the element size.  */
1238 uint64_t dup_const(unsigned vece, uint64_t c);
1239 
1240 #define dup_const(VECE, C)                                         \
1241     (__builtin_constant_p(VECE)                                    \
1242      ? (  (VECE) == MO_8  ? 0x0101010101010101ull * (uint8_t)(C)   \
1243         : (VECE) == MO_16 ? 0x0001000100010001ull * (uint16_t)(C)  \
1244         : (VECE) == MO_32 ? 0x0000000100000001ull * (uint32_t)(C)  \
1245         : dup_const(VECE, C))                                      \
1246      : dup_const(VECE, C))
1247 
1248 
1249 /*
1250  * Memory helpers that will be used by TCG generated code.
1251  */
1252 #ifdef CONFIG_SOFTMMU
1253 /* Value zero-extended to tcg register size.  */
1254 tcg_target_ulong helper_ret_ldub_mmu(CPUArchState *env, target_ulong addr,
1255                                      TCGMemOpIdx oi, uintptr_t retaddr);
1256 tcg_target_ulong helper_le_lduw_mmu(CPUArchState *env, target_ulong addr,
1257                                     TCGMemOpIdx oi, uintptr_t retaddr);
1258 tcg_target_ulong helper_le_ldul_mmu(CPUArchState *env, target_ulong addr,
1259                                     TCGMemOpIdx oi, uintptr_t retaddr);
1260 uint64_t helper_le_ldq_mmu(CPUArchState *env, target_ulong addr,
1261                            TCGMemOpIdx oi, uintptr_t retaddr);
1262 tcg_target_ulong helper_be_lduw_mmu(CPUArchState *env, target_ulong addr,
1263                                     TCGMemOpIdx oi, uintptr_t retaddr);
1264 tcg_target_ulong helper_be_ldul_mmu(CPUArchState *env, target_ulong addr,
1265                                     TCGMemOpIdx oi, uintptr_t retaddr);
1266 uint64_t helper_be_ldq_mmu(CPUArchState *env, target_ulong addr,
1267                            TCGMemOpIdx oi, uintptr_t retaddr);
1268 
1269 /* Value sign-extended to tcg register size.  */
1270 tcg_target_ulong helper_ret_ldsb_mmu(CPUArchState *env, target_ulong addr,
1271                                      TCGMemOpIdx oi, uintptr_t retaddr);
1272 tcg_target_ulong helper_le_ldsw_mmu(CPUArchState *env, target_ulong addr,
1273                                     TCGMemOpIdx oi, uintptr_t retaddr);
1274 tcg_target_ulong helper_le_ldsl_mmu(CPUArchState *env, target_ulong addr,
1275                                     TCGMemOpIdx oi, uintptr_t retaddr);
1276 tcg_target_ulong helper_be_ldsw_mmu(CPUArchState *env, target_ulong addr,
1277                                     TCGMemOpIdx oi, uintptr_t retaddr);
1278 tcg_target_ulong helper_be_ldsl_mmu(CPUArchState *env, target_ulong addr,
1279                                     TCGMemOpIdx oi, uintptr_t retaddr);
1280 
1281 void helper_ret_stb_mmu(CPUArchState *env, target_ulong addr, uint8_t val,
1282                         TCGMemOpIdx oi, uintptr_t retaddr);
1283 void helper_le_stw_mmu(CPUArchState *env, target_ulong addr, uint16_t val,
1284                        TCGMemOpIdx oi, uintptr_t retaddr);
1285 void helper_le_stl_mmu(CPUArchState *env, target_ulong addr, uint32_t val,
1286                        TCGMemOpIdx oi, uintptr_t retaddr);
1287 void helper_le_stq_mmu(CPUArchState *env, target_ulong addr, uint64_t val,
1288                        TCGMemOpIdx oi, uintptr_t retaddr);
1289 void helper_be_stw_mmu(CPUArchState *env, target_ulong addr, uint16_t val,
1290                        TCGMemOpIdx oi, uintptr_t retaddr);
1291 void helper_be_stl_mmu(CPUArchState *env, target_ulong addr, uint32_t val,
1292                        TCGMemOpIdx oi, uintptr_t retaddr);
1293 void helper_be_stq_mmu(CPUArchState *env, target_ulong addr, uint64_t val,
1294                        TCGMemOpIdx oi, uintptr_t retaddr);
1295 
1296 /* Temporary aliases until backends are converted.  */
1297 #ifdef TARGET_WORDS_BIGENDIAN
1298 # define helper_ret_ldsw_mmu  helper_be_ldsw_mmu
1299 # define helper_ret_lduw_mmu  helper_be_lduw_mmu
1300 # define helper_ret_ldsl_mmu  helper_be_ldsl_mmu
1301 # define helper_ret_ldul_mmu  helper_be_ldul_mmu
1302 # define helper_ret_ldl_mmu   helper_be_ldul_mmu
1303 # define helper_ret_ldq_mmu   helper_be_ldq_mmu
1304 # define helper_ret_stw_mmu   helper_be_stw_mmu
1305 # define helper_ret_stl_mmu   helper_be_stl_mmu
1306 # define helper_ret_stq_mmu   helper_be_stq_mmu
1307 #else
1308 # define helper_ret_ldsw_mmu  helper_le_ldsw_mmu
1309 # define helper_ret_lduw_mmu  helper_le_lduw_mmu
1310 # define helper_ret_ldsl_mmu  helper_le_ldsl_mmu
1311 # define helper_ret_ldul_mmu  helper_le_ldul_mmu
1312 # define helper_ret_ldl_mmu   helper_le_ldul_mmu
1313 # define helper_ret_ldq_mmu   helper_le_ldq_mmu
1314 # define helper_ret_stw_mmu   helper_le_stw_mmu
1315 # define helper_ret_stl_mmu   helper_le_stl_mmu
1316 # define helper_ret_stq_mmu   helper_le_stq_mmu
1317 #endif
1318 
1319 uint32_t helper_atomic_cmpxchgb_mmu(CPUArchState *env, target_ulong addr,
1320                                     uint32_t cmpv, uint32_t newv,
1321                                     TCGMemOpIdx oi, uintptr_t retaddr);
1322 uint32_t helper_atomic_cmpxchgw_le_mmu(CPUArchState *env, target_ulong addr,
1323                                        uint32_t cmpv, uint32_t newv,
1324                                        TCGMemOpIdx oi, uintptr_t retaddr);
1325 uint32_t helper_atomic_cmpxchgl_le_mmu(CPUArchState *env, target_ulong addr,
1326                                        uint32_t cmpv, uint32_t newv,
1327                                        TCGMemOpIdx oi, uintptr_t retaddr);
1328 uint64_t helper_atomic_cmpxchgq_le_mmu(CPUArchState *env, target_ulong addr,
1329                                        uint64_t cmpv, uint64_t newv,
1330                                        TCGMemOpIdx oi, uintptr_t retaddr);
1331 uint32_t helper_atomic_cmpxchgw_be_mmu(CPUArchState *env, target_ulong addr,
1332                                        uint32_t cmpv, uint32_t newv,
1333                                        TCGMemOpIdx oi, uintptr_t retaddr);
1334 uint32_t helper_atomic_cmpxchgl_be_mmu(CPUArchState *env, target_ulong addr,
1335                                        uint32_t cmpv, uint32_t newv,
1336                                        TCGMemOpIdx oi, uintptr_t retaddr);
1337 uint64_t helper_atomic_cmpxchgq_be_mmu(CPUArchState *env, target_ulong addr,
1338                                        uint64_t cmpv, uint64_t newv,
1339                                        TCGMemOpIdx oi, uintptr_t retaddr);
1340 
1341 #define GEN_ATOMIC_HELPER(NAME, TYPE, SUFFIX)         \
1342 TYPE helper_atomic_ ## NAME ## SUFFIX ## _mmu         \
1343     (CPUArchState *env, target_ulong addr, TYPE val,  \
1344      TCGMemOpIdx oi, uintptr_t retaddr);
1345 
1346 #ifdef CONFIG_ATOMIC64
1347 #define GEN_ATOMIC_HELPER_ALL(NAME)          \
1348     GEN_ATOMIC_HELPER(NAME, uint32_t, b)     \
1349     GEN_ATOMIC_HELPER(NAME, uint32_t, w_le)  \
1350     GEN_ATOMIC_HELPER(NAME, uint32_t, w_be)  \
1351     GEN_ATOMIC_HELPER(NAME, uint32_t, l_le)  \
1352     GEN_ATOMIC_HELPER(NAME, uint32_t, l_be)  \
1353     GEN_ATOMIC_HELPER(NAME, uint64_t, q_le)  \
1354     GEN_ATOMIC_HELPER(NAME, uint64_t, q_be)
1355 #else
1356 #define GEN_ATOMIC_HELPER_ALL(NAME)          \
1357     GEN_ATOMIC_HELPER(NAME, uint32_t, b)     \
1358     GEN_ATOMIC_HELPER(NAME, uint32_t, w_le)  \
1359     GEN_ATOMIC_HELPER(NAME, uint32_t, w_be)  \
1360     GEN_ATOMIC_HELPER(NAME, uint32_t, l_le)  \
1361     GEN_ATOMIC_HELPER(NAME, uint32_t, l_be)
1362 #endif
1363 
1364 GEN_ATOMIC_HELPER_ALL(fetch_add)
1365 GEN_ATOMIC_HELPER_ALL(fetch_sub)
1366 GEN_ATOMIC_HELPER_ALL(fetch_and)
1367 GEN_ATOMIC_HELPER_ALL(fetch_or)
1368 GEN_ATOMIC_HELPER_ALL(fetch_xor)
1369 GEN_ATOMIC_HELPER_ALL(fetch_smin)
1370 GEN_ATOMIC_HELPER_ALL(fetch_umin)
1371 GEN_ATOMIC_HELPER_ALL(fetch_smax)
1372 GEN_ATOMIC_HELPER_ALL(fetch_umax)
1373 
1374 GEN_ATOMIC_HELPER_ALL(add_fetch)
1375 GEN_ATOMIC_HELPER_ALL(sub_fetch)
1376 GEN_ATOMIC_HELPER_ALL(and_fetch)
1377 GEN_ATOMIC_HELPER_ALL(or_fetch)
1378 GEN_ATOMIC_HELPER_ALL(xor_fetch)
1379 GEN_ATOMIC_HELPER_ALL(smin_fetch)
1380 GEN_ATOMIC_HELPER_ALL(umin_fetch)
1381 GEN_ATOMIC_HELPER_ALL(smax_fetch)
1382 GEN_ATOMIC_HELPER_ALL(umax_fetch)
1383 
1384 GEN_ATOMIC_HELPER_ALL(xchg)
1385 
1386 #undef GEN_ATOMIC_HELPER_ALL
1387 #undef GEN_ATOMIC_HELPER
1388 #endif /* CONFIG_SOFTMMU */
1389 
1390 /*
1391  * These aren't really a "proper" helpers because TCG cannot manage Int128.
1392  * However, use the same format as the others, for use by the backends.
1393  *
1394  * The cmpxchg functions are only defined if HAVE_CMPXCHG128;
1395  * the ld/st functions are only defined if HAVE_ATOMIC128,
1396  * as defined by <qemu/atomic128.h>.
1397  */
1398 Int128 helper_atomic_cmpxchgo_le_mmu(CPUArchState *env, target_ulong addr,
1399                                      Int128 cmpv, Int128 newv,
1400                                      TCGMemOpIdx oi, uintptr_t retaddr);
1401 Int128 helper_atomic_cmpxchgo_be_mmu(CPUArchState *env, target_ulong addr,
1402                                      Int128 cmpv, Int128 newv,
1403                                      TCGMemOpIdx oi, uintptr_t retaddr);
1404 
1405 Int128 helper_atomic_ldo_le_mmu(CPUArchState *env, target_ulong addr,
1406                                 TCGMemOpIdx oi, uintptr_t retaddr);
1407 Int128 helper_atomic_ldo_be_mmu(CPUArchState *env, target_ulong addr,
1408                                 TCGMemOpIdx oi, uintptr_t retaddr);
1409 void helper_atomic_sto_le_mmu(CPUArchState *env, target_ulong addr, Int128 val,
1410                               TCGMemOpIdx oi, uintptr_t retaddr);
1411 void helper_atomic_sto_be_mmu(CPUArchState *env, target_ulong addr, Int128 val,
1412                               TCGMemOpIdx oi, uintptr_t retaddr);
1413 
1414 #ifdef CONFIG_DEBUG_TCG
1415 void tcg_assert_listed_vecop(TCGOpcode);
1416 #else
1417 static inline void tcg_assert_listed_vecop(TCGOpcode op) { }
1418 #endif
1419 
1420 static inline const TCGOpcode *tcg_swap_vecop_list(const TCGOpcode *n)
1421 {
1422 #ifdef CONFIG_DEBUG_TCG
1423     const TCGOpcode *o = tcg_ctx->vecop_list;
1424     tcg_ctx->vecop_list = n;
1425     return o;
1426 #else
1427     return NULL;
1428 #endif
1429 }
1430 
1431 bool tcg_can_emit_vecop_list(const TCGOpcode *, TCGType, unsigned);
1432 
1433 #endif /* TCG_H */
1434