ir.h

   1 #ifndef QCIR_H__
   2 #define QCIR_H__
   3
   4 #include "astir.h"
   5
   6 /* ir_value */
   7
   8 typedef struct
   9 {
  10         /* both inclusive */
  11         size_t start;
  12         size_t end;
  13 } ir_life_entry_t;
  14
  15 struct ir_function_s;
  16 typedef struct ir_value_s {
  17         const char *_name;
  18         ir_type_t  vtype;
  19         ir_store_t store;
  20         filecontext_t context;
  21
  22         /*
  23         size_t     read_use;
  24         size_t     write_use;
  25         */
  26         MAKE_VEC(struct ir_instr_s*, reads);
  27         MAKE_VEC(struct ir_instr_s*, writes);
  28
  29         /* constantvalues */
  30         union {
  31                 float vfloat;
  32                 int   vint;
  33                 qc_vec_t vvec;
  34                 struct ir_value_s *vpointer;
  35                 const char *vstring;
  36         } cvalue;
  37         ir_bool has_constval;
  38
  39         /* For the temp allocator */
  40         MAKE_VEC(ir_life_entry_t, life);
  41 } ir_value;
  42
  43 /* ir_value can be a variable, or created by an operation */
  44 ir_value* ir_value_var(const char *name, ir_store_t st, ir_type_t vtype);
  45 /* if a result of an operation: the function should store
  46  * it to remember to delete it / garbage collect it
  47  */
  48 ir_value* ir_value_out(struct ir_function_s *owner, const char *name, ir_store_t st, ir_type_t vtype);
  49 void      ir_value_delete(ir_value*);
  50 void      ir_value_set_name(ir_value*, const char *name);
  51
  52 void    ir_value_reads_add(ir_value*, struct ir_instr_s*);
  53 void    ir_value_writes_add(ir_value*, struct ir_instr_s*);
  54
  55 ir_bool ir_value_set_float(ir_value*, float f);
  56 ir_bool ir_value_set_int(ir_value*, int i);
  57 ir_bool ir_value_set_string(ir_value*, const char *s);
  58 ir_bool ir_value_set_vector(ir_value*, qc_vec_t v);
  59 /*ir_bool ir_value_set_pointer_v(ir_value*, ir_value* p); */
  60 /*ir_bool ir_value_set_pointer_i(ir_value*, int i);       */
  61
  62 void ir_value_life_add(ir_value*, ir_life_entry_t e);
  63 /* merge an instruction into the life-range */
  64 /* returns false if the lifepoint was already known */
  65 ir_bool ir_value_life_merge(ir_value*, size_t);
  66 /* check if a value lives at a specific point */
  67 ir_bool ir_value_lives(ir_value*, size_t);
  68
  69 void ir_value_dump(ir_value*, int (*oprintf)(const char*,...));
  70 void ir_value_dump_life(ir_value *self, int (*oprintf)(const char*,...));
  71
  72 typedef struct ir_phi_entry_s
  73 {
  74         ir_value          *value;
  75         struct ir_block_s *from;
  76 } ir_phi_entry_t;
  77
  78 /* instruction */
  79 typedef struct ir_instr_s
  80 {
  81         ir_op_t       opcode;
  82         filecontext_t context;
  83         ir_value*     (_ops[3]);
  84         struct ir_block_s* (bops[2]);
  85
  86         MAKE_VEC(ir_phi_entry_t, phi);
  87
  88         /* For the temp-allocation */
  89         size_t eid;
  90
  91         struct ir_block_s *owner;
  92 } ir_instr;
  93
  94 ir_instr* ir_instr_new(struct ir_block_s *owner, ir_op_t opcode);
  95 void      ir_instr_delete(ir_instr*);
  96
  97 void ir_instr_phi_add(ir_instr*, ir_phi_entry_t e);
  98 void ir_instr_op(ir_instr*, int op, ir_value *value, ir_bool writing);
  99
 100 void ir_instr_dump(ir_instr* in, char *ind, int (*oprintf)(const char*,...));
 101
 102 /* block */
 103 typedef struct ir_block_s
 104 {
 105         const char    *_label;
 106         filecontext_t context;
 107         ir_bool         final; /* once a jump is added we're done */
 108
 109         MAKE_VEC(ir_instr*, instr);
 110         MAKE_VEC(struct ir_block_s*, entries);
 111         MAKE_VEC(struct ir_block_s*, exits);
 112         MAKE_VEC(ir_value*, living);
 113
 114         /* For the temp-allocation */
 115         size_t eid;
 116         ir_bool is_return;
 117         size_t run_id;
 118
 119         struct ir_function_s *owner;
 120 } ir_block;
 121
 122 ir_block* ir_block_new(struct ir_function_s *owner, const char *label);
 123 void      ir_block_delete(ir_block*);
 124
 125 void      ir_block_set_label(ir_block*, const char *label);
 126
 127 void      ir_block_instr_add(ir_block*, ir_instr *instr);
 128 void      ir_block_instr_remove(ir_block*, size_t idx);
 129 void      ir_block_exits_add(ir_block*, ir_block *b);
 130 void      ir_block_entries_add(ir_block*, ir_block *b);
 131 ir_bool   ir_block_entries_find(ir_block*, ir_block *b, size_t *idx);
 132
 133 ir_value* ir_block_create_binop(ir_block*, const char *label, ir_op_t op,
 134                                 ir_value *left, ir_value *right);
 135 ir_bool   ir_block_create_store_op(ir_block*, ir_op_t op, ir_value *target, ir_value *what);
 136 ir_bool   ir_block_create_store(ir_block*, ir_value *target, ir_value *what);
 137
 138 ir_value* ir_block_create_add(ir_block*, const char *label, ir_value *l, ir_value *r);
 139 ir_value* ir_block_create_sub(ir_block*, const char *label, ir_value *l, ir_value *r);
 140 ir_value* ir_block_create_mul(ir_block*, const char *label, ir_value *l, ir_value *r);
 141 ir_value* ir_block_create_div(ir_block*, const char *label, ir_value *l, ir_value *r);
 142 ir_instr* ir_block_create_phi(ir_block*, const char *label, ir_type_t vtype);
 143 ir_value* ir_phi_value(ir_instr*);
 144 void      ir_phi_add(ir_instr*, ir_block *b, ir_value *v);
 145
 146 void      ir_block_create_return(ir_block*, ir_value *opt_value);
 147
 148 void      ir_block_create_if(ir_block*, ir_value *cond,
 149                              ir_block *ontrue, ir_block *onfalse);
 150 /* A 'goto' is an actual 'goto' coded in QC, whereas
 151  * a 'jump' is a virtual construct which simply names the
 152  * next block to go to.
 153  * A goto usually becomes an OP_GOTO in the resulting code,
 154  * whereas a 'jump' usually doesn't add any actual instruction.
 155  */
 156 void      ir_block_create_jump(ir_block*, ir_block *to);
 157 void      ir_block_create_goto(ir_block*, ir_block *to);
 158
 159 void      ir_block_living_add(ir_block*, ir_value*);
 160 void      ir_block_living_remove(ir_block*, size_t idx);
 161 ir_bool   ir_block_living_find(ir_block*, ir_value*, size_t *idx);
 162
 163 void ir_block_dump(ir_block*, char *ind, int (*oprintf)(const char*,...));
 164
 165 /* function */
 166
 167 typedef struct ir_function_s
 168 {
 169         const char    *_name;
 170         ir_type_t     retype;
 171         MAKE_VEC(ir_type_t, params);
 172         MAKE_VEC(ir_block*, blocks);
 173
 174         /* values generated from operations
 175          * which might get optimized away, so anything
 176          * in there needs to be deleted in the dtor.
 177          */
 178         MAKE_VEC(ir_value*, values);
 179
 180         /* locally defined variables */
 181         MAKE_VEC(ir_value*, locals);
 182
 183         ir_block*     first;
 184         ir_block*     last;
 185
 186         filecontext_t context;
 187
 188         /* for temp allocation */
 189         size_t run_id;
 190
 191         struct ir_builder_s *owner;
 192 } ir_function;
 193
 194 ir_function* ir_function_new(struct ir_builder_s *owner);
 195 void         ir_function_delete(ir_function*);
 196
 197 void ir_function_collect_value(ir_function*, ir_value *value);
 198
 199 void ir_function_set_name(ir_function*, const char *name);
 200 void ir_function_params_add(ir_function*, ir_type_t p);
 201 void ir_function_blocks_add(ir_function*, ir_block *b);
 202
 203 ir_value* ir_function_get_local(ir_function *self, const char *name);
 204 ir_value* ir_function_create_local(ir_function *self, const char *name, ir_type_t vtype);
 205
 206 void ir_function_finalize(ir_function*);
 207 /*
 208 void ir_function_naive_phi(ir_function*);
 209 void ir_function_enumerate(ir_function*);
 210 void ir_function_calculate_liferanges(ir_function*);
 211 */
 212
 213 ir_block* ir_function_create_block(ir_function*, const char *label);
 214
 215 void ir_function_dump(ir_function*, char *ind, int (*oprintf)(const char*,...));
 216
 217 /* builder */
 218 typedef struct ir_builder_s
 219 {
 220         const char     *_name;
 221         MAKE_VEC(ir_function*, functions);
 222         MAKE_VEC(ir_value*, globals);
 223 } ir_builder;
 224
 225 ir_builder* ir_builder_new(const char *modulename);
 226 void        ir_builder_delete(ir_builder*);
 227
 228 void ir_builder_set_name(ir_builder *self, const char *name);
 229
 230 void ir_builder_functions_add(ir_builder* b, ir_function* f);
 231 void ir_builder_globals_add(ir_builder* b, ir_value* f);
 232
 233 ir_function* ir_builder_get_function(ir_builder*, const char *fun);
 234 ir_function* ir_builder_create_function(ir_builder*, const char *name);
 235
 236 ir_value* ir_builder_get_global(ir_builder*, const char *fun);
 237 ir_value* ir_builder_create_global(ir_builder*, const char *name, ir_type_t vtype);
 238
 239 void ir_builder_dump(ir_builder*, int (*oprintf)(const char*, ...));
 240
 241 #endif