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];
  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
 102 #if TCG_TARGET_REG_BITS == 32
 103 #define TCG_TYPE_PTR TCG_TYPE_I32
 104 #else
 105 #define TCG_TYPE_PTR TCG_TYPE_I64
 106 #endif
 107
 108 typedef tcg_target_ulong TCGArg;
 109
 110 /* Define a type and accessor macros for varables.  Using a struct is
 111    nice because it gives some level of type safely.  Ideally the compiler
 112    be able to see through all this.  However in practice this is not true,
 113    expecially on targets with braindamaged ABIs (e.g. i386).
 114    We use plain int by default to avoid this runtime overhead.
 115    Users of tcg_gen_* don't need to know about any of this, and should
 116    treat TCGv as an opaque type.  */
 117
 118 //#define DEBUG_TCGV 1
 119
 120 #ifdef DEBUG_TCGV
 121
 122 typedef struct
 123 {
 124     int n;
 125 } TCGv;
 126
 127 #define MAKE_TCGV(i) __extension__ \
 128   ({ TCGv make_tcgv_tmp = {i}; make_tcgv_tmp;})
 129 #define GET_TCGV(t) ((t).n)
 130 #if TCG_TARGET_REG_BITS == 32
 131 #define TCGV_HIGH(t) MAKE_TCGV(GET_TCGV(t) + 1)
 132 #endif
 133
 134 #else /* !DEBUG_TCGV */
 135
 136 typedef int TCGv;
 137 #define MAKE_TCGV(x) (x)
 138 #define GET_TCGV(t) (t)
 139 #if TCG_TARGET_REG_BITS == 32
 140 #define TCGV_HIGH(t) ((t) + 1)
 141 #endif
 142
 143 #endif /* DEBUG_TCGV */
 144
 145 /* call flags */
 146 #define TCG_CALL_TYPE_MASK      0x000f
 147 #define TCG_CALL_TYPE_STD       0x0000 /* standard C call */
 148 #define TCG_CALL_TYPE_REGPARM_1 0x0001 /* i386 style regparm call (1 reg) */
 149 #define TCG_CALL_TYPE_REGPARM_2 0x0002 /* i386 style regparm call (2 regs) */
 150 #define TCG_CALL_TYPE_REGPARM   0x0003 /* i386 style regparm call (3 regs) */
 151 /* A pure function only reads its arguments and globals variables and
 152    cannot raise exceptions. Hence a call to a pure function can be
 153    safely suppressed if the return value is not used. */
 154 #define TCG_CALL_PURE           0x0010
 155
 156 typedef enum {
 157     TCG_COND_EQ,
 158     TCG_COND_NE,
 159     TCG_COND_LT,
 160     TCG_COND_GE,
 161     TCG_COND_LE,
 162     TCG_COND_GT,
 163     /* unsigned */
 164     TCG_COND_LTU,
 165     TCG_COND_GEU,
 166     TCG_COND_LEU,
 167     TCG_COND_GTU,
 168 } TCGCond;
 169
 170 #define TEMP_VAL_DEAD  0
 171 #define TEMP_VAL_REG   1
 172 #define TEMP_VAL_MEM   2
 173 #define TEMP_VAL_CONST 3
 174
 175 /* XXX: optimize memory layout */
 176 typedef struct TCGTemp {
 177     TCGType base_type;
 178     TCGType type;
 179     int val_type;
 180     int reg;
 181     tcg_target_long val;
 182     int mem_reg;
 183     tcg_target_long mem_offset;
 184     unsigned int fixed_reg:1;
 185     unsigned int mem_coherent:1;
 186     unsigned int mem_allocated:1;
 187     const char *name;
 188 } TCGTemp;
 189
 190 typedef struct TCGHelperInfo {
 191     void *func;
 192     const char *name;
 193 } TCGHelperInfo;
 194
 195 typedef struct TCGContext TCGContext;
 196
 197 typedef void TCGMacroFunc(TCGContext *s, int macro_id, const int *dead_args);
 198
 199 struct TCGContext {
 200     uint8_t *pool_cur, *pool_end;
 201     TCGPool *pool_first, *pool_current;
 202     TCGLabel *labels;
 203     int nb_labels;
 204     TCGTemp *temps; /* globals first, temps after */
 205     int nb_globals;
 206     int nb_temps;
 207     /* constant indexes (end of temp array) */
 208     int const_start;
 209     int const_end;
 210
 211     /* goto_tb support */
 212     uint8_t *code_buf;
 213     unsigned long *tb_next;
 214     uint16_t *tb_next_offset;
 215     uint16_t *tb_jmp_offset; /* != NULL if USE_DIRECT_JUMP */
 216
 217     uint16_t *op_dead_iargs; /* for each operation, each bit tells if the
 218                                 corresponding input argument is dead */
 219     /* tells in which temporary a given register is. It does not take
 220        into account fixed registers */
 221     int reg_to_temp[TCG_TARGET_NB_REGS];
 222     TCGRegSet reserved_regs;
 223     tcg_target_long current_frame_offset;
 224     tcg_target_long frame_start;
 225     tcg_target_long frame_end;
 226     int frame_reg;
 227
 228     uint8_t *code_ptr;
 229     TCGTemp static_temps[TCG_MAX_TEMPS];
 230
 231     TCGMacroFunc *macro_func;
 232     TCGHelperInfo *helpers;
 233     int nb_helpers;
 234     int allocated_helpers;
 235 };
 236
 237 extern TCGContext tcg_ctx;
 238 extern uint16_t *gen_opc_ptr;
 239 extern TCGArg *gen_opparam_ptr;
 240 extern uint16_t gen_opc_buf[];
 241 extern TCGArg gen_opparam_buf[];
 242
 243 /* pool based memory allocation */
 244
 245 void *tcg_malloc_internal(TCGContext *s, int size);
 246 void tcg_pool_reset(TCGContext *s);
 247 void tcg_pool_delete(TCGContext *s);
 248
 249 static inline void *tcg_malloc(int size)
 250 {
 251     TCGContext *s = &tcg_ctx;
 252     uint8_t *ptr, *ptr_end;
 253     size = (size + sizeof(long) - 1) & ~(sizeof(long) - 1);
 254     ptr = s->pool_cur;
 255     ptr_end = ptr + size;
 256     if (unlikely(ptr_end > s->pool_end)) {
 257         return tcg_malloc_internal(&tcg_ctx, size);
 258     } else {
 259         s->pool_cur = ptr_end;
 260         return ptr;
 261     }
 262 }
 263
 264 void tcg_context_init(TCGContext *s);
 265 void tcg_func_start(TCGContext *s);
 266
 267 int dyngen_code(TCGContext *s, uint8_t *gen_code_buf);
 268 int dyngen_code_search_pc(TCGContext *s, uint8_t *gen_code_buf, long offset);
 269
 270 void tcg_set_frame(TCGContext *s, int reg,
 271                    tcg_target_long start, tcg_target_long size);
 272 void tcg_set_macro_func(TCGContext *s, TCGMacroFunc *func);
 273 TCGv tcg_global_reg_new(TCGType type, int reg, const char *name);
 274 TCGv tcg_global_reg2_new_hack(TCGType type, int reg1, int reg2,
 275                               const char *name);
 276 TCGv tcg_global_mem_new(TCGType type, int reg, tcg_target_long offset,
 277                         const char *name);
 278 TCGv tcg_temp_new(TCGType type);
 279 char *tcg_get_arg_str(TCGContext *s, char *buf, int buf_size, TCGv arg);
 280
 281 #define TCG_CT_ALIAS  0x80
 282 #define TCG_CT_IALIAS 0x40
 283 #define TCG_CT_REG    0x01
 284 #define TCG_CT_CONST  0x02 /* any constant of register size */
 285
 286 typedef struct TCGArgConstraint {
 287     uint16_t ct;
 288     uint8_t alias_index;
 289     union {
 290         TCGRegSet regs;
 291     } u;
 292 } TCGArgConstraint;
 293
 294 #define TCG_MAX_OP_ARGS 16
 295
 296 #define TCG_OPF_BB_END     0x01 /* instruction defines the end of a basic
 297                                    block */
 298 #define TCG_OPF_CALL_CLOBBER 0x02 /* instruction clobbers call registers
 299                                    and potentially update globals. */
 300 #define TCG_OPF_SIDE_EFFECTS 0x04 /* instruction has side effects : it
 301                                      cannot be removed if its output
 302                                      are not used */
 303
 304 typedef struct TCGOpDef {
 305     const char *name;
 306     uint8_t nb_oargs, nb_iargs, nb_cargs, nb_args;
 307     uint8_t flags;
 308     uint16_t copy_size;
 309     TCGArgConstraint *args_ct;
 310     int *sorted_args;
 311 } TCGOpDef;
 312
 313 typedef struct TCGTargetOpDef {
 314     int op;
 315     const char *args_ct_str[TCG_MAX_OP_ARGS];
 316 } TCGTargetOpDef;
 317
 318 extern TCGOpDef tcg_op_defs[];
 319
 320 void tcg_target_init(TCGContext *s);
 321 void tcg_target_qemu_prologue(TCGContext *s);
 322
 323 #define tcg_abort() \
 324 do {\
 325     fprintf(stderr, "%s:%d: tcg fatal error\n", __FILE__, __LINE__);\
 326     abort();\
 327 } while (0)
 328
 329 void tcg_add_target_add_op_defs(const TCGTargetOpDef *tdefs);
 330
 331 void tcg_gen_call(TCGContext *s, TCGv func, unsigned int flags,
 332                   unsigned int nb_rets, const TCGv *rets,
 333                   unsigned int nb_params, const TCGv *args1);
 334 void tcg_gen_shifti_i64(TCGv ret, TCGv arg1,
 335                         int c, int right, int arith);
 336
 337 /* only used for debugging purposes */
 338 void tcg_register_helper(void *func, const char *name);
 339 #define TCG_HELPER(func) tcg_register_helper(func, #func)
 340 const char *tcg_helper_get_name(TCGContext *s, void *func);
 341 void tcg_dump_ops(TCGContext *s, FILE *outfile);
 342
 343 void dump_ops(const uint16_t *opc_buf, const TCGArg *opparam_buf);
 344 TCGv tcg_const_i32(int32_t val);
 345 TCGv tcg_const_i64(int64_t val);
 346
 347 #if TCG_TARGET_REG_BITS == 32
 348 #define tcg_const_ptr tcg_const_i32
 349 #define tcg_add_ptr tcg_add_i32
 350 #define tcg_sub_ptr tcg_sub_i32
 351 #else
 352 #define tcg_const_ptr tcg_const_i64
 353 #define tcg_add_ptr tcg_add_i64
 354 #define tcg_sub_ptr tcg_sub_i64
 355 #endif
 356
 357 void tcg_out_reloc(TCGContext *s, uint8_t *code_ptr, int type,
 358                    int label_index, long addend);
 359 void tcg_reg_alloc_start(TCGContext *s);
 360 void tcg_reg_alloc_bb_end(TCGContext *s);
 361 void tcg_liveness_analysis(TCGContext *s);
 362 const TCGArg *tcg_gen_code_op(TCGContext *s, int opc, const TCGArg *args1,
 363                               unsigned int dead_iargs);
 364
 365 const TCGArg *dyngen_op(TCGContext *s, int opc, const TCGArg *opparam_ptr);
 366
 367 /* tcg-runtime.c */
 368 int64_t tcg_helper_shl_i64(int64_t arg1, int64_t arg2);
 369 int64_t tcg_helper_shr_i64(int64_t arg1, int64_t arg2);
 370 int64_t tcg_helper_sar_i64(int64_t arg1, int64_t arg2);
 371 int64_t tcg_helper_div_i64(int64_t arg1, int64_t arg2);
 372 int64_t tcg_helper_rem_i64(int64_t arg1, int64_t arg2);
 373 uint64_t tcg_helper_divu_i64(uint64_t arg1, uint64_t arg2);
 374 uint64_t tcg_helper_remu_i64(uint64_t arg1, uint64_t arg2);
 375
 376 extern uint8_t code_gen_prologue[];
 377 #define tcg_qemu_tb_exec(tb_ptr) ((long REGPARM (*)(void *))code_gen_prologue)(tb_ptr)