[qemu.git] / tcg / tcg.h

/*
 * Tiny Code Generator for QEMU
 *
 * Copyright (c) 2008 Fabrice Bellard
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
#include "qemu-common.h"
#include "tcg-target.h"
#include "tcg-runtime.h"

#if TCG_TARGET_REG_BITS == 32
typedef int32_t tcg_target_long;
typedef uint32_t tcg_target_ulong;
#define TCG_PRIlx PRIx32
#define TCG_PRIld PRId32
#elif TCG_TARGET_REG_BITS == 64
typedef int64_t tcg_target_long;
typedef uint64_t tcg_target_ulong;
#define TCG_PRIlx PRIx64
#define TCG_PRIld PRId64
#else
#error unsupported
#endif

#if TCG_TARGET_NB_REGS <= 32
typedef uint32_t TCGRegSet;
#elif TCG_TARGET_NB_REGS <= 64
typedef uint64_t TCGRegSet;
#else
#error unsupported
#endif

typedef enum TCGOpcode {
#define DEF(s, n, copy_size) INDEX_op_ ## s,
#include "tcg-opc.h"
#undef DEF
    NB_OPS,
} TCGOpcode;

#define tcg_regset_clear(d) (d) = 0
#define tcg_regset_set(d, s) (d) = (s)
#define tcg_regset_set32(d, reg, val32) (d) |= (val32) << (reg)
#define tcg_regset_set_reg(d, r) (d) |= 1L << (r)
#define tcg_regset_reset_reg(d, r) (d) &= ~(1L << (r))
#define tcg_regset_test_reg(d, r) (((d) >> (r)) & 1)
#define tcg_regset_or(d, a, b) (d) = (a) | (b)
#define tcg_regset_and(d, a, b) (d) = (a) & (b)
#define tcg_regset_andnot(d, a, b) (d) = (a) & ~(b)
#define tcg_regset_not(d, a) (d) = ~(a)

typedef struct TCGRelocation {
    struct TCGRelocation *next;
    int type;
    uint8_t *ptr;
    tcg_target_long addend;
} TCGRelocation; 

typedef struct TCGLabel {
    int has_value;
    union {
        tcg_target_ulong value;
        TCGRelocation *first_reloc;
    } u;
} TCGLabel;

typedef struct TCGPool {
    struct TCGPool *next;
    int size;
    uint8_t data[0] __attribute__ ((aligned));
} TCGPool;

#define TCG_POOL_CHUNK_SIZE 32768

#define TCG_MAX_LABELS 512

#define TCG_MAX_TEMPS 512

/* when the size of the arguments of a called function is smaller than
   this value, they are statically allocated in the TB stack frame */
#define TCG_STATIC_CALL_ARGS_SIZE 128

typedef enum TCGType {
    TCG_TYPE_I32,
    TCG_TYPE_I64,
    TCG_TYPE_COUNT, /* number of different types */

#if TCG_TARGET_REG_BITS == 32
    TCG_TYPE_PTR = TCG_TYPE_I32,
#else
    TCG_TYPE_PTR = TCG_TYPE_I64,
#endif
#if TARGET_LONG_BITS == 64
    TCG_TYPE_TL = TCG_TYPE_I64,
#else
    TCG_TYPE_TL = TCG_TYPE_I32,
#endif
} TCGType;

typedef tcg_target_ulong TCGArg;

/* Define a type and accessor macros for varables.  Using a struct is
   nice because it gives some level of type safely.  Ideally the compiler
   be able to see through all this.  However in practice this is not true,
   expecially on targets with braindamaged ABIs (e.g. i386).
   We use plain int by default to avoid this runtime overhead.
   Users of tcg_gen_* don't need to know about any of this, and should
   treat TCGv as an opaque type.
   In additon we do typechecking for different types of variables.  TCGv_i32
   and TCGv_i64 are 32/64-bit variables respectively.  TCGv and TCGv_ptr
   are aliases for target_ulong and host pointer sized values respectively.
 */

#ifdef CONFIG_DEBUG_TCG
#define DEBUG_TCGV 1
#endif

#ifdef DEBUG_TCGV

typedef struct
{
    int i32;
} TCGv_i32;

typedef struct
{
    int i64;
} TCGv_i64;

#define MAKE_TCGV_I32(i) __extension__                  \
    ({ TCGv_i32 make_tcgv_tmp = {i}; make_tcgv_tmp;})
#define MAKE_TCGV_I64(i) __extension__                  \
    ({ TCGv_i64 make_tcgv_tmp = {i}; make_tcgv_tmp;})
#define GET_TCGV_I32(t) ((t).i32)
#define GET_TCGV_I64(t) ((t).i64)
#if TCG_TARGET_REG_BITS == 32
#define TCGV_LOW(t) MAKE_TCGV_I32(GET_TCGV_I64(t))
#define TCGV_HIGH(t) MAKE_TCGV_I32(GET_TCGV_I64(t) + 1)
#endif

#else /* !DEBUG_TCGV */

typedef int TCGv_i32;
typedef int TCGv_i64;
#define MAKE_TCGV_I32(x) (x)
#define MAKE_TCGV_I64(x) (x)
#define GET_TCGV_I32(t) (t)
#define GET_TCGV_I64(t) (t)

#if TCG_TARGET_REG_BITS == 32
#define TCGV_LOW(t) (t)
#define TCGV_HIGH(t) ((t) + 1)
#endif

#endif /* DEBUG_TCGV */

#define TCGV_EQUAL_I32(a, b) (GET_TCGV_I32(a) == GET_TCGV_I32(b))
#define TCGV_EQUAL_I64(a, b) (GET_TCGV_I64(a) == GET_TCGV_I64(b))

/* Dummy definition to avoid compiler warnings.  */
#define TCGV_UNUSED_I32(x) x = MAKE_TCGV_I32(-1)
#define TCGV_UNUSED_I64(x) x = MAKE_TCGV_I64(-1)

/* call flags */
#define TCG_CALL_TYPE_MASK      0x000f
#define TCG_CALL_TYPE_STD       0x0000 /* standard C call */
#define TCG_CALL_TYPE_REGPARM_1 0x0001 /* i386 style regparm call (1 reg) */
#define TCG_CALL_TYPE_REGPARM_2 0x0002 /* i386 style regparm call (2 regs) */
#define TCG_CALL_TYPE_REGPARM   0x0003 /* i386 style regparm call (3 regs) */
/* A pure function only reads its arguments and TCG global variables
   and cannot raise exceptions. Hence a call to a pure function can be
   safely suppressed if the return value is not used. */
#define TCG_CALL_PURE           0x0010 
/* A const function only reads its arguments and does not use TCG
   global variables. Hence a call to such a function does not
   save TCG global variables back to their canonical location. */
#define TCG_CALL_CONST          0x0020

/* used to align parameters */
#define TCG_CALL_DUMMY_TCGV     MAKE_TCGV_I32(-1)
#define TCG_CALL_DUMMY_ARG      ((TCGArg)(-1))

typedef enum {
    TCG_COND_EQ,
    TCG_COND_NE,
    TCG_COND_LT,
    TCG_COND_GE,
    TCG_COND_LE,
    TCG_COND_GT,
    /* unsigned */
    TCG_COND_LTU,
    TCG_COND_GEU,
    TCG_COND_LEU,
    TCG_COND_GTU,
} TCGCond;

/* Invert the sense of the comparison.  */
static inline TCGCond tcg_invert_cond(TCGCond c)
{
    return (TCGCond)(c ^ 1);
}

/* Swap the operands in a comparison.  */
static inline TCGCond tcg_swap_cond(TCGCond c)
{
    int mask = (c < TCG_COND_LT ? 0 : c < TCG_COND_LTU ? 7 : 15);
    return (TCGCond)(c ^ mask);
}

static inline TCGCond tcg_unsigned_cond(TCGCond c)
{
    return (c >= TCG_COND_LT && c <= TCG_COND_GT ? c + 4 : c);
}

#define TEMP_VAL_DEAD  0
#define TEMP_VAL_REG   1
#define TEMP_VAL_MEM   2
#define TEMP_VAL_CONST 3

/* XXX: optimize memory layout */
typedef struct TCGTemp {
    TCGType base_type;
    TCGType type;
    int val_type;
    int reg;
    tcg_target_long val;
    int mem_reg;
    tcg_target_long mem_offset;
    unsigned int fixed_reg:1;
    unsigned int mem_coherent:1;
    unsigned int mem_allocated:1;
    unsigned int temp_local:1; /* If true, the temp is saved accross
                                  basic blocks. Otherwise, it is not
                                  preserved accross basic blocks. */
    unsigned int temp_allocated:1; /* never used for code gen */
    /* index of next free temp of same base type, -1 if end */
    int next_free_temp;
    const char *name;
} TCGTemp;

typedef struct TCGHelperInfo {
    tcg_target_ulong func;
    const char *name;
} TCGHelperInfo;

typedef struct TCGContext TCGContext;

struct TCGContext {
    uint8_t *pool_cur, *pool_end;
    TCGPool *pool_first, *pool_current;
    TCGLabel *labels;
    int nb_labels;
    TCGTemp *temps; /* globals first, temps after */
    int nb_globals;
    int nb_temps;
    /* index of free temps, -1 if none */
    int first_free_temp[TCG_TYPE_COUNT * 2]; 

    /* goto_tb support */
    uint8_t *code_buf;
    unsigned long *tb_next;
    uint16_t *tb_next_offset;
    uint16_t *tb_jmp_offset; /* != NULL if USE_DIRECT_JUMP */

    /* liveness analysis */
    uint16_t *op_dead_iargs; /* for each operation, each bit tells if the
                                corresponding input argument is dead */
    
    /* tells in which temporary a given register is. It does not take
       into account fixed registers */
    int reg_to_temp[TCG_TARGET_NB_REGS];
    TCGRegSet reserved_regs;
    tcg_target_long current_frame_offset;
    tcg_target_long frame_start;
    tcg_target_long frame_end;
    int frame_reg;

    uint8_t *code_ptr;
    TCGTemp static_temps[TCG_MAX_TEMPS];

    TCGHelperInfo *helpers;
    int nb_helpers;
    int allocated_helpers;
    int helpers_sorted;

#ifdef CONFIG_PROFILER
    /* profiling info */
    int64_t tb_count1;
    int64_t tb_count;
    int64_t op_count; /* total insn count */
    int op_count_max; /* max insn per TB */
    int64_t temp_count;
    int temp_count_max;
    int64_t del_op_count;
    int64_t code_in_len;
    int64_t code_out_len;
    int64_t interm_time;
    int64_t code_time;
    int64_t la_time;
    int64_t restore_count;
    int64_t restore_time;
#endif
};

extern TCGContext tcg_ctx;
extern uint16_t *gen_opc_ptr;
extern TCGArg *gen_opparam_ptr;
extern uint16_t gen_opc_buf[];
extern TCGArg gen_opparam_buf[];

/* pool based memory allocation */

void *tcg_malloc_internal(TCGContext *s, int size);
void tcg_pool_reset(TCGContext *s);
void tcg_pool_delete(TCGContext *s);

static inline void *tcg_malloc(int size)
{
    TCGContext *s = &tcg_ctx;
    uint8_t *ptr, *ptr_end;
    size = (size + sizeof(long) - 1) & ~(sizeof(long) - 1);
    ptr = s->pool_cur;
    ptr_end = ptr + size;
    if (unlikely(ptr_end > s->pool_end)) {
        return tcg_malloc_internal(&tcg_ctx, size);
    } else {
        s->pool_cur = ptr_end;
        return ptr;
    }
}

void tcg_context_init(TCGContext *s);
void tcg_prologue_init(TCGContext *s);
void tcg_func_start(TCGContext *s);

int tcg_gen_code(TCGContext *s, uint8_t *gen_code_buf);
int tcg_gen_code_search_pc(TCGContext *s, uint8_t *gen_code_buf, long offset);

void tcg_set_frame(TCGContext *s, int reg,
                   tcg_target_long start, tcg_target_long size);

TCGv_i32 tcg_global_reg_new_i32(int reg, const char *name);
TCGv_i32 tcg_global_mem_new_i32(int reg, tcg_target_long offset,
                                const char *name);
TCGv_i32 tcg_temp_new_internal_i32(int temp_local);
static inline TCGv_i32 tcg_temp_new_i32(void)
{
    return tcg_temp_new_internal_i32(0);
}
static inline TCGv_i32 tcg_temp_local_new_i32(void)
{
    return tcg_temp_new_internal_i32(1);
}
void tcg_temp_free_i32(TCGv_i32 arg);
char *tcg_get_arg_str_i32(TCGContext *s, char *buf, int buf_size, TCGv_i32 arg);

TCGv_i64 tcg_global_reg_new_i64(int reg, const char *name);
TCGv_i64 tcg_global_mem_new_i64(int reg, tcg_target_long offset,
                                const char *name);
TCGv_i64 tcg_temp_new_internal_i64(int temp_local);
static inline TCGv_i64 tcg_temp_new_i64(void)
{
    return tcg_temp_new_internal_i64(0);
}
static inline TCGv_i64 tcg_temp_local_new_i64(void)
{
    return tcg_temp_new_internal_i64(1);
}
void tcg_temp_free_i64(TCGv_i64 arg);
char *tcg_get_arg_str_i64(TCGContext *s, char *buf, int buf_size, TCGv_i64 arg);

void tcg_dump_info(FILE *f,
                   int (*cpu_fprintf)(FILE *f, const char *fmt, ...));

#define TCG_CT_ALIAS  0x80
#define TCG_CT_IALIAS 0x40
#define TCG_CT_REG    0x01
#define TCG_CT_CONST  0x02 /* any constant of register size */

typedef struct TCGArgConstraint {
    uint16_t ct;
    uint8_t alias_index;
    union {
        TCGRegSet regs;
    } u;
} TCGArgConstraint;

#define TCG_MAX_OP_ARGS 16

#define TCG_OPF_BB_END     0x01 /* instruction defines the end of a basic
                                   block */
#define TCG_OPF_CALL_CLOBBER 0x02 /* instruction clobbers call registers 
                                   and potentially update globals. */
#define TCG_OPF_SIDE_EFFECTS 0x04 /* instruction has side effects : it
                                     cannot be removed if its output
                                     are not used */

typedef struct TCGOpDef {
    const char *name;
    uint8_t nb_oargs, nb_iargs, nb_cargs, nb_args;
    uint8_t flags;
    uint16_t copy_size;
    TCGArgConstraint *args_ct;
    int *sorted_args;
#if defined(CONFIG_DEBUG_TCG)
    int used;
#endif
} TCGOpDef;
        
typedef struct TCGTargetOpDef {
    TCGOpcode op;
    const char *args_ct_str[TCG_MAX_OP_ARGS];
} TCGTargetOpDef;

void tcg_target_init(TCGContext *s);
void tcg_target_qemu_prologue(TCGContext *s);

#define tcg_abort() \
do {\
    fprintf(stderr, "%s:%d: tcg fatal error\n", __FILE__, __LINE__);\
    abort();\
} while (0)

void tcg_add_target_add_op_defs(const TCGTargetOpDef *tdefs);

#if TCG_TARGET_REG_BITS == 32
#define tcg_const_ptr tcg_const_i32
#define tcg_add_ptr tcg_add_i32
#define tcg_sub_ptr tcg_sub_i32
#define TCGv_ptr TCGv_i32
#define GET_TCGV_PTR GET_TCGV_I32
#define tcg_global_reg_new_ptr tcg_global_reg_new_i32
#define tcg_global_mem_new_ptr tcg_global_mem_new_i32
#define tcg_temp_new_ptr tcg_temp_new_i32
#define tcg_temp_free_ptr tcg_temp_free_i32
#else
#define tcg_const_ptr tcg_const_i64
#define tcg_add_ptr tcg_add_i64
#define tcg_sub_ptr tcg_sub_i64
#define TCGv_ptr TCGv_i64
#define GET_TCGV_PTR GET_TCGV_I64
#define tcg_global_reg_new_ptr tcg_global_reg_new_i64
#define tcg_global_mem_new_ptr tcg_global_mem_new_i64
#define tcg_temp_new_ptr tcg_temp_new_i64
#define tcg_temp_free_ptr tcg_temp_free_i64
#endif

void tcg_gen_callN(TCGContext *s, TCGv_ptr func, unsigned int flags,
                   int sizemask, TCGArg ret, int nargs, TCGArg *args);

void tcg_gen_shifti_i64(TCGv_i64 ret, TCGv_i64 arg1,
                        int c, int right, int arith);

/* only used for debugging purposes */
void tcg_register_helper(void *func, const char *name);
const char *tcg_helper_get_name(TCGContext *s, void *func);
void tcg_dump_ops(TCGContext *s, FILE *outfile);

void dump_ops(const uint16_t *opc_buf, const TCGArg *opparam_buf);
TCGv_i32 tcg_const_i32(int32_t val);
TCGv_i64 tcg_const_i64(int64_t val);
TCGv_i32 tcg_const_local_i32(int32_t val);
TCGv_i64 tcg_const_local_i64(int64_t val);

extern uint8_t code_gen_prologue[];
#if defined(_ARCH_PPC) && !defined(_ARCH_PPC64)
#define tcg_qemu_tb_exec(tb_ptr) \
    ((long REGPARM __attribute__ ((longcall)) (*)(void *))code_gen_prologue)(tb_ptr)
#else
#define tcg_qemu_tb_exec(tb_ptr) ((long REGPARM (*)(void *))code_gen_prologue)(tb_ptr)
#endif
Commit	Line	Data
c896fe29 FB	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	*/
f8393946	24	#include "qemu-common.h"
c896fe29	25	#include "tcg-target.h"
96e132e2	26	#include "tcg-runtime.h"
c896fe29 FB	27
	28	#if TCG_TARGET_REG_BITS == 32
	29	typedef int32_t tcg_target_long;
	30	typedef uint32_t tcg_target_ulong;
	31	#define TCG_PRIlx PRIx32
	32	#define TCG_PRIld PRId32
	33	#elif TCG_TARGET_REG_BITS == 64
	34	typedef int64_t tcg_target_long;
	35	typedef uint64_t tcg_target_ulong;
	36	#define TCG_PRIlx PRIx64
	37	#define TCG_PRIld PRId64
	38	#else
	39	#error unsupported
	40	#endif
	41
	42	#if TCG_TARGET_NB_REGS <= 32
	43	typedef uint32_t TCGRegSet;
	44	#elif TCG_TARGET_NB_REGS <= 64
	45	typedef uint64_t TCGRegSet;
	46	#else
	47	#error unsupported
	48	#endif
	49
a9751609	50	typedef enum TCGOpcode {
c896fe29 FB	51	#define DEF(s, n, copy_size) INDEX_op_ ## s,
	52	#include "tcg-opc.h"
	53	#undef DEF
	54	NB_OPS,
a9751609	55	} TCGOpcode;
c896fe29 FB	56
	57	#define tcg_regset_clear(d) (d) = 0
	58	#define tcg_regset_set(d, s) (d) = (s)
	59	#define tcg_regset_set32(d, reg, val32) (d) \|= (val32) << (reg)
7d301752 AJ	60	#define tcg_regset_set_reg(d, r) (d) \|= 1L << (r)
7d301752 AJ	61	#define tcg_regset_reset_reg(d, r) (d) &= ~(1L << (r))
c896fe29 FB	62	#define tcg_regset_test_reg(d, r) (((d) >> (r)) & 1)
	63	#define tcg_regset_or(d, a, b) (d) = (a) \| (b)
	64	#define tcg_regset_and(d, a, b) (d) = (a) & (b)
	65	#define tcg_regset_andnot(d, a, b) (d) = (a) & ~(b)
	66	#define tcg_regset_not(d, a) (d) = ~(a)
	67
	68	typedef struct TCGRelocation {
	69	struct TCGRelocation *next;
	70	int type;
	71	uint8_t *ptr;
	72	tcg_target_long addend;
	73	} TCGRelocation;
	74
	75	typedef struct TCGLabel {
c44f945a	76	int has_value;
c896fe29 FB	77	union {
	78	tcg_target_ulong value;
	79	TCGRelocation *first_reloc;
	80	} u;
	81	} TCGLabel;
	82
	83	typedef struct TCGPool {
	84	struct TCGPool *next;
c44f945a BS	85	int size;
c44f945a BS	86	uint8_t data[0] __attribute__ ((aligned));
c896fe29 FB	87	} TCGPool;
	88
	89	#define TCG_POOL_CHUNK_SIZE 32768
	90
	91	#define TCG_MAX_LABELS 512
	92
c4071c90	93	#define TCG_MAX_TEMPS 512
c896fe29	94
b03cce8e FB	95	/* when the size of the arguments of a called function is smaller than
	96	this value, they are statically allocated in the TB stack frame */
	97	#define TCG_STATIC_CALL_ARGS_SIZE 128
	98
c02244a5 RH	99	typedef enum TCGType {
	100	TCG_TYPE_I32,
	101	TCG_TYPE_I64,
	102	TCG_TYPE_COUNT, /* number of different types */
c896fe29 FB	103
c896fe29 FB	104	#if TCG_TARGET_REG_BITS == 32
c02244a5 RH	105	TCG_TYPE_PTR = TCG_TYPE_I32,
	106	#else
	107	TCG_TYPE_PTR = TCG_TYPE_I64,
	108	#endif
	109	#if TARGET_LONG_BITS == 64
	110	TCG_TYPE_TL = TCG_TYPE_I64,
c896fe29	111	#else
c02244a5	112	TCG_TYPE_TL = TCG_TYPE_I32,
c896fe29	113	#endif
c02244a5	114	} TCGType;
c896fe29 FB	115
	116	typedef tcg_target_ulong TCGArg;
	117
ac56dd48 PB	118	/* Define a type and accessor macros for varables. Using a struct is
	119	nice because it gives some level of type safely. Ideally the compiler
	120	be able to see through all this. However in practice this is not true,
	121	expecially on targets with braindamaged ABIs (e.g. i386).
	122	We use plain int by default to avoid this runtime overhead.
	123	Users of tcg_gen_* don't need to know about any of this, and should
a7812ae4 PB	124	treat TCGv as an opaque type.
	125	In additon we do typechecking for different types of variables. TCGv_i32
	126	and TCGv_i64 are 32/64-bit variables respectively. TCGv and TCGv_ptr
	127	are aliases for target_ulong and host pointer sized values respectively.
	128	*/
ac56dd48	129
092c73ee	130	#ifdef CONFIG_DEBUG_TCG
f8393946 AJ	131	#define DEBUG_TCGV 1
f8393946 AJ	132	#endif
ac56dd48 PB	133
	134	#ifdef DEBUG_TCGV
	135
	136	typedef struct
	137	{
a810a2de	138	int i32;
a7812ae4	139	} TCGv_i32;
ac56dd48	140
a7812ae4 PB	141	typedef struct
a7812ae4 PB	142	{
a810a2de	143	int i64;
a7812ae4 PB	144	} TCGv_i64;
	145
	146	#define MAKE_TCGV_I32(i) __extension__ \
	147	({ TCGv_i32 make_tcgv_tmp = {i}; make_tcgv_tmp;})
	148	#define MAKE_TCGV_I64(i) __extension__ \
	149	({ TCGv_i64 make_tcgv_tmp = {i}; make_tcgv_tmp;})
a810a2de BS	150	#define GET_TCGV_I32(t) ((t).i32)
a810a2de BS	151	#define GET_TCGV_I64(t) ((t).i64)
ac56dd48	152	#if TCG_TARGET_REG_BITS == 32
a7812ae4 PB	153	#define TCGV_LOW(t) MAKE_TCGV_I32(GET_TCGV_I64(t))
a7812ae4 PB	154	#define TCGV_HIGH(t) MAKE_TCGV_I32(GET_TCGV_I64(t) + 1)
ac56dd48 PB	155	#endif
	156
	157	#else /* !DEBUG_TCGV */
	158
a7812ae4 PB	159	typedef int TCGv_i32;
	160	typedef int TCGv_i64;
	161	#define MAKE_TCGV_I32(x) (x)
	162	#define MAKE_TCGV_I64(x) (x)
	163	#define GET_TCGV_I32(t) (t)
	164	#define GET_TCGV_I64(t) (t)
44e6acb0	165
ac56dd48	166	#if TCG_TARGET_REG_BITS == 32
a7812ae4	167	#define TCGV_LOW(t) (t)
ac56dd48 PB	168	#define TCGV_HIGH(t) ((t) + 1)
	169	#endif
	170
	171	#endif /* DEBUG_TCGV */
	172
43e860ef AJ	173	#define TCGV_EQUAL_I32(a, b) (GET_TCGV_I32(a) == GET_TCGV_I32(b))
	174	#define TCGV_EQUAL_I64(a, b) (GET_TCGV_I64(a) == GET_TCGV_I64(b))
	175
a50f5b91	176	/* Dummy definition to avoid compiler warnings. */
a7812ae4 PB	177	#define TCGV_UNUSED_I32(x) x = MAKE_TCGV_I32(-1)
a7812ae4 PB	178	#define TCGV_UNUSED_I64(x) x = MAKE_TCGV_I64(-1)
a50f5b91	179
c896fe29 FB	180	/* call flags */
	181	#define TCG_CALL_TYPE_MASK 0x000f
	182	#define TCG_CALL_TYPE_STD 0x0000 /* standard C call */
	183	#define TCG_CALL_TYPE_REGPARM_1 0x0001 /* i386 style regparm call (1 reg) */
	184	#define TCG_CALL_TYPE_REGPARM_2 0x0002 /* i386 style regparm call (2 regs) */
	185	#define TCG_CALL_TYPE_REGPARM 0x0003 /* i386 style regparm call (3 regs) */
3e00b3f5	186	/* A pure function only reads its arguments and TCG global variables
34d5a9ff	187	and cannot raise exceptions. Hence a call to a pure function can be
c6e113f5 FB	188	safely suppressed if the return value is not used. */
c6e113f5 FB	189	#define TCG_CALL_PURE 0x0010
b9c18f56	190	/* A const function only reads its arguments and does not use TCG
3e00b3f5 AJ	191	global variables. Hence a call to such a function does not
3e00b3f5 AJ	192	save TCG global variables back to their canonical location. */
b9c18f56	193	#define TCG_CALL_CONST 0x0020
c896fe29	194
39cf05d3	195	/* used to align parameters */
a7812ae4	196	#define TCG_CALL_DUMMY_TCGV MAKE_TCGV_I32(-1)
39cf05d3 FB	197	#define TCG_CALL_DUMMY_ARG ((TCGArg)(-1))
39cf05d3 FB	198
c896fe29 FB	199	typedef enum {
	200	TCG_COND_EQ,
	201	TCG_COND_NE,
	202	TCG_COND_LT,
	203	TCG_COND_GE,
	204	TCG_COND_LE,
	205	TCG_COND_GT,
	206	/* unsigned */
	207	TCG_COND_LTU,
	208	TCG_COND_GEU,
	209	TCG_COND_LEU,
	210	TCG_COND_GTU,
	211	} TCGCond;
	212
1c086220	213	/* Invert the sense of the comparison. */
401d466d RH	214	static inline TCGCond tcg_invert_cond(TCGCond c)
	215	{
	216	return (TCGCond)(c ^ 1);
	217	}
	218
1c086220 RH	219	/* Swap the operands in a comparison. */
	220	static inline TCGCond tcg_swap_cond(TCGCond c)
	221	{
	222	int mask = (c < TCG_COND_LT ? 0 : c < TCG_COND_LTU ? 7 : 15);
	223	return (TCGCond)(c ^ mask);
	224	}
	225
ff44c2f3 RH	226	static inline TCGCond tcg_unsigned_cond(TCGCond c)
	227	{
	228	return (c >= TCG_COND_LT && c <= TCG_COND_GT ? c + 4 : c);
	229	}
	230
c896fe29 FB	231	#define TEMP_VAL_DEAD 0
	232	#define TEMP_VAL_REG 1
	233	#define TEMP_VAL_MEM 2
	234	#define TEMP_VAL_CONST 3
	235
	236	/* XXX: optimize memory layout */
	237	typedef struct TCGTemp {
	238	TCGType base_type;
	239	TCGType type;
	240	int val_type;
	241	int reg;
	242	tcg_target_long val;
	243	int mem_reg;
	244	tcg_target_long mem_offset;
	245	unsigned int fixed_reg:1;
	246	unsigned int mem_coherent:1;
	247	unsigned int mem_allocated:1;
641d5fbe FB	248	unsigned int temp_local:1; /* If true, the temp is saved accross
	249	basic blocks. Otherwise, it is not
	250	preserved accross basic blocks. */
e8996ee0 FB	251	unsigned int temp_allocated:1; /* never used for code gen */
	252	/* index of next free temp of same base type, -1 if end */
	253	int next_free_temp;
c896fe29 FB	254	const char *name;
	255	} TCGTemp;
	256
	257	typedef struct TCGHelperInfo {
4dc81f28	258	tcg_target_ulong func;
c896fe29 FB	259	const char *name;
	260	} TCGHelperInfo;
	261
	262	typedef struct TCGContext TCGContext;
	263
c896fe29 FB	264	struct TCGContext {
	265	uint8_t pool_cur, pool_end;
	266	TCGPool pool_first, pool_current;
	267	TCGLabel *labels;
	268	int nb_labels;
	269	TCGTemp temps; / globals first, temps after */
	270	int nb_globals;
	271	int nb_temps;
641d5fbe FB	272	/* index of free temps, -1 if none */
641d5fbe FB	273	int first_free_temp[TCG_TYPE_COUNT * 2];
c896fe29 FB	274
	275	/* goto_tb support */
	276	uint8_t *code_buf;
	277	unsigned long *tb_next;
	278	uint16_t *tb_next_offset;
	279	uint16_t tb_jmp_offset; / != NULL if USE_DIRECT_JUMP */
	280
641d5fbe	281	/* liveness analysis */
c896fe29 FB	282	uint16_t op_dead_iargs; / for each operation, each bit tells if the
c896fe29 FB	283	corresponding input argument is dead */
641d5fbe	284
c896fe29 FB	285	/* tells in which temporary a given register is. It does not take
	286	into account fixed registers */
	287	int reg_to_temp[TCG_TARGET_NB_REGS];
	288	TCGRegSet reserved_regs;
	289	tcg_target_long current_frame_offset;
	290	tcg_target_long frame_start;
	291	tcg_target_long frame_end;
	292	int frame_reg;
	293
	294	uint8_t *code_ptr;
	295	TCGTemp static_temps[TCG_MAX_TEMPS];
	296
c896fe29 FB	297	TCGHelperInfo *helpers;
	298	int nb_helpers;
	299	int allocated_helpers;
e8996ee0	300	int helpers_sorted;
a23a9ec6 FB	301
	302	#ifdef CONFIG_PROFILER
	303	/* profiling info */
	304	int64_t tb_count1;
	305	int64_t tb_count;
	306	int64_t op_count; /* total insn count */
	307	int op_count_max; /* max insn per TB */
	308	int64_t temp_count;
	309	int temp_count_max;
a23a9ec6 FB	310	int64_t del_op_count;
	311	int64_t code_in_len;
	312	int64_t code_out_len;
	313	int64_t interm_time;
	314	int64_t code_time;
	315	int64_t la_time;
	316	int64_t restore_count;
	317	int64_t restore_time;
	318	#endif
c896fe29 FB	319	};
	320
	321	extern TCGContext tcg_ctx;
	322	extern uint16_t *gen_opc_ptr;
	323	extern TCGArg *gen_opparam_ptr;
	324	extern uint16_t gen_opc_buf[];
	325	extern TCGArg gen_opparam_buf[];
	326
	327	/* pool based memory allocation */
	328
	329	void tcg_malloc_internal(TCGContext s, int size);
	330	void tcg_pool_reset(TCGContext *s);
	331	void tcg_pool_delete(TCGContext *s);
	332
	333	static inline void *tcg_malloc(int size)
	334	{
	335	TCGContext *s = &tcg_ctx;
	336	uint8_t ptr, ptr_end;
	337	size = (size + sizeof(long) - 1) & ~(sizeof(long) - 1);
	338	ptr = s->pool_cur;
	339	ptr_end = ptr + size;
	340	if (unlikely(ptr_end > s->pool_end)) {
	341	return tcg_malloc_internal(&tcg_ctx, size);
	342	} else {
	343	s->pool_cur = ptr_end;
	344	return ptr;
	345	}
	346	}
	347
	348	void tcg_context_init(TCGContext *s);
9002ec79	349	void tcg_prologue_init(TCGContext *s);
c896fe29 FB	350	void tcg_func_start(TCGContext *s);
c896fe29 FB	351
54604f74 AJ	352	int tcg_gen_code(TCGContext s, uint8_t gen_code_buf);
54604f74 AJ	353	int tcg_gen_code_search_pc(TCGContext s, uint8_t gen_code_buf, long offset);
c896fe29 FB	354
	355	void tcg_set_frame(TCGContext *s, int reg,
	356	tcg_target_long start, tcg_target_long size);
a7812ae4 PB	357
	358	TCGv_i32 tcg_global_reg_new_i32(int reg, const char *name);
	359	TCGv_i32 tcg_global_mem_new_i32(int reg, tcg_target_long offset,
	360	const char *name);
	361	TCGv_i32 tcg_temp_new_internal_i32(int temp_local);
	362	static inline TCGv_i32 tcg_temp_new_i32(void)
	363	{
	364	return tcg_temp_new_internal_i32(0);
	365	}
	366	static inline TCGv_i32 tcg_temp_local_new_i32(void)
	367	{
	368	return tcg_temp_new_internal_i32(1);
	369	}
	370	void tcg_temp_free_i32(TCGv_i32 arg);
	371	char tcg_get_arg_str_i32(TCGContext s, char *buf, int buf_size, TCGv_i32 arg);
	372
	373	TCGv_i64 tcg_global_reg_new_i64(int reg, const char *name);
	374	TCGv_i64 tcg_global_mem_new_i64(int reg, tcg_target_long offset,
	375	const char *name);
	376	TCGv_i64 tcg_temp_new_internal_i64(int temp_local);
	377	static inline TCGv_i64 tcg_temp_new_i64(void)
641d5fbe	378	{
a7812ae4	379	return tcg_temp_new_internal_i64(0);
641d5fbe	380	}
a7812ae4	381	static inline TCGv_i64 tcg_temp_local_new_i64(void)
641d5fbe	382	{
a7812ae4	383	return tcg_temp_new_internal_i64(1);
641d5fbe	384	}
a7812ae4 PB	385	void tcg_temp_free_i64(TCGv_i64 arg);
	386	char tcg_get_arg_str_i64(TCGContext s, char *buf, int buf_size, TCGv_i64 arg);
	387
a23a9ec6 FB	388	void tcg_dump_info(FILE *f,
a23a9ec6 FB	389	int (cpu_fprintf)(FILE f, const char *fmt, ...));
c896fe29 FB	390
	391	#define TCG_CT_ALIAS 0x80
	392	#define TCG_CT_IALIAS 0x40
	393	#define TCG_CT_REG 0x01
	394	#define TCG_CT_CONST 0x02 /* any constant of register size */
	395
	396	typedef struct TCGArgConstraint {
5ff9d6a4 FB	397	uint16_t ct;
5ff9d6a4 FB	398	uint8_t alias_index;
c896fe29 FB	399	union {
	400	TCGRegSet regs;
	401	} u;
	402	} TCGArgConstraint;
	403
	404	#define TCG_MAX_OP_ARGS 16
	405
	406	#define TCG_OPF_BB_END 0x01 /* instruction defines the end of a basic
	407	block */
b03cce8e FB	408	#define TCG_OPF_CALL_CLOBBER 0x02 /* instruction clobbers call registers
	409	and potentially update globals. */
	410	#define TCG_OPF_SIDE_EFFECTS 0x04 /* instruction has side effects : it
	411	cannot be removed if its output
	412	are not used */
c896fe29 FB	413
	414	typedef struct TCGOpDef {
	415	const char *name;
	416	uint8_t nb_oargs, nb_iargs, nb_cargs, nb_args;
	417	uint8_t flags;
	418	uint16_t copy_size;
	419	TCGArgConstraint *args_ct;
	420	int *sorted_args;
c68aaa18 SW	421	#if defined(CONFIG_DEBUG_TCG)
	422	int used;
	423	#endif
c896fe29 FB	424	} TCGOpDef;
	425
	426	typedef struct TCGTargetOpDef {
a9751609	427	TCGOpcode op;
c896fe29 FB	428	const char *args_ct_str[TCG_MAX_OP_ARGS];
	429	} TCGTargetOpDef;
	430
c896fe29	431	void tcg_target_init(TCGContext *s);
b03cce8e	432	void tcg_target_qemu_prologue(TCGContext *s);
c896fe29 FB	433
	434	#define tcg_abort() \
	435	do {\
	436	fprintf(stderr, "%s:%d: tcg fatal error\n", __FILE__, __LINE__);\
	437	abort();\
	438	} while (0)
	439
	440	void tcg_add_target_add_op_defs(const TCGTargetOpDef *tdefs);
	441
c896fe29 FB	442	#if TCG_TARGET_REG_BITS == 32
	443	#define tcg_const_ptr tcg_const_i32
	444	#define tcg_add_ptr tcg_add_i32
	445	#define tcg_sub_ptr tcg_sub_i32
a7812ae4 PB	446	#define TCGv_ptr TCGv_i32
	447	#define GET_TCGV_PTR GET_TCGV_I32
	448	#define tcg_global_reg_new_ptr tcg_global_reg_new_i32
	449	#define tcg_global_mem_new_ptr tcg_global_mem_new_i32
	450	#define tcg_temp_new_ptr tcg_temp_new_i32
	451	#define tcg_temp_free_ptr tcg_temp_free_i32
c896fe29 FB	452	#else
	453	#define tcg_const_ptr tcg_const_i64
	454	#define tcg_add_ptr tcg_add_i64
	455	#define tcg_sub_ptr tcg_sub_i64
a7812ae4 PB	456	#define TCGv_ptr TCGv_i64
	457	#define GET_TCGV_PTR GET_TCGV_I64
	458	#define tcg_global_reg_new_ptr tcg_global_reg_new_i64
	459	#define tcg_global_mem_new_ptr tcg_global_mem_new_i64
	460	#define tcg_temp_new_ptr tcg_temp_new_i64
	461	#define tcg_temp_free_ptr tcg_temp_free_i64
c896fe29 FB	462	#endif
c896fe29 FB	463
a7812ae4 PB	464	void tcg_gen_callN(TCGContext *s, TCGv_ptr func, unsigned int flags,
	465	int sizemask, TCGArg ret, int nargs, TCGArg *args);
	466
	467	void tcg_gen_shifti_i64(TCGv_i64 ret, TCGv_i64 arg1,
	468	int c, int right, int arith);
	469
	470	/* only used for debugging purposes */
	471	void tcg_register_helper(void func, const char name);
	472	const char tcg_helper_get_name(TCGContext s, void *func);
	473	void tcg_dump_ops(TCGContext s, FILE outfile);
	474
	475	void dump_ops(const uint16_t opc_buf, const TCGArg opparam_buf);
	476	TCGv_i32 tcg_const_i32(int32_t val);
	477	TCGv_i64 tcg_const_i64(int64_t val);
	478	TCGv_i32 tcg_const_local_i32(int32_t val);
	479	TCGv_i64 tcg_const_local_i64(int64_t val);
	480
b03cce8e	481	extern uint8_t code_gen_prologue[];
e58ffeb3	482	#if defined(_ARCH_PPC) && !defined(_ARCH_PPC64)
932a6909 FB	483	#define tcg_qemu_tb_exec(tb_ptr) \
	484	((long REGPARM __attribute__ ((longcall)) ()(void ))code_gen_prologue)(tb_ptr)
	485	#else
b03cce8e	486	#define tcg_qemu_tb_exec(tb_ptr) ((long REGPARM ()(void ))code_gen_prologue)(tb_ptr)
932a6909	487	#endif