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