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