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