ir.h

   1 /*
   2  * Copyright (C) 2012
   3  *     Wolfgang Bumiller
   4  *
   5  * Permission is hereby granted, free of charge, to any person obtaining a copy of
   6  * this software and associated documentation files (the "Software"), to deal in
   7  * the Software without restriction, including without limitation the rights to
   8  * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
   9  * of the Software, and to permit persons to whom the Software is furnished to do
  10  * so, subject to the following conditions:
  11  *
  12  * The above copyright notice and this permission notice shall be included in all
  13  * copies or substantial portions of the Software.
  14  *
  15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  18  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  19  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  20  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  21  * SOFTWARE.
  22  */
  23 #ifndef GMQCC_IR_HDR
  24 #define GMQCC_IR_HDR
  25
  26 /* ir_value */
  27
  28 typedef struct
  29 {
  30     /* both inclusive */
  31     size_t start;
  32     size_t end;
  33 } ir_life_entry_t;
  34
  35 struct ir_function_s;
  36 typedef struct ir_value_s {
  37     char      *name;
  38     int       vtype;
  39     int       store;
  40     lex_ctx   context;
  41
  42     MEM_VECTOR_MAKE(struct ir_instr_s*, reads);
  43     MEM_VECTOR_MAKE(struct ir_instr_s*, writes);
  44
  45     /* constantvalues */
  46     bool isconst;
  47     union {
  48         float    vfloat;
  49         int      vint;
  50         vector   vvec;
  51         char    *vstring;
  52         struct ir_value_s *vpointer;
  53     } constval;
  54
  55     /* For the temp allocator */
  56     MEM_VECTOR_MAKE(ir_life_entry_t, life);
  57 } ir_value;
  58
  59 /* ir_value can be a variable, or created by an operation */
  60 ir_value* ir_value_var(const char *name, int st, int vtype);
  61 /* if a result of an operation: the function should store
  62  * it to remember to delete it / garbage collect it
  63  */
  64 ir_value* ir_value_out(struct ir_function_s *owner, const char *name, int st, int vtype);
  65 void      ir_value_delete(ir_value*);
  66 void      ir_value_set_name(ir_value*, const char *name);
  67
  68 MEM_VECTOR_PROTO_ALL(ir_value, struct ir_instr_s*, reads);
  69 MEM_VECTOR_PROTO_ALL(ir_value, struct ir_instr_s*, writes);
  70
  71 bool GMQCC_WARN ir_value_set_float(ir_value*, float f);
  72 #if 0
  73 bool GMQCC_WARN ir_value_set_int(ir_value*, int i);
  74 #endif
  75 bool GMQCC_WARN ir_value_set_string(ir_value*, const char *s);
  76 bool GMQCC_WARN ir_value_set_vector(ir_value*, vector v);
  77 /*bool   ir_value_set_pointer_v(ir_value*, ir_value* p); */
  78 /*bool   ir_value_set_pointer_i(ir_value*, int i);       */
  79
  80 MEM_VECTOR_PROTO(ir_value, ir_life_entry_t, life);
  81 /* merge an instruction into the life-range */
  82 /* returns false if the lifepoint was already known */
  83 bool ir_value_life_merge(ir_value*, size_t);
  84 /* check if a value lives at a specific point */
  85 bool ir_value_lives(ir_value*, size_t);
  86 /* check if the life-range of 2 values overlaps */
  87 bool ir_values_overlap(ir_value*, ir_value*);
  88
  89 void ir_value_dump(ir_value*, int (*oprintf)(const char*,...));
  90 void ir_value_dump_life(ir_value *self, int (*oprintf)(const char*,...));
  91
  92 typedef struct ir_phi_entry_s
  93 {
  94     ir_value          *value;
  95     struct ir_block_s *from;
  96 } ir_phi_entry_t;
  97
  98 /* instruction */
  99 typedef struct ir_instr_s
 100 {
 101     int       opcode;
 102     lex_ctx   context;
 103     ir_value* (_ops[3]);
 104     struct ir_block_s* (bops[2]);
 105
 106     MEM_VECTOR_MAKE(ir_phi_entry_t, phi);
 107
 108     /* For the temp-allocation */
 109     size_t eid;
 110
 111     struct ir_block_s *owner;
 112 } ir_instr;
 113
 114 ir_instr* ir_instr_new(struct ir_block_s *owner, int opcode);
 115 void      ir_instr_delete(ir_instr*);
 116
 117 MEM_VECTOR_PROTO(ir_value, ir_phi_entry_t, phi);
 118 bool GMQCC_WARN ir_instr_op(ir_instr*, int op, ir_value *value, bool writing);
 119
 120 void ir_instr_dump(ir_instr* in, char *ind, int (*oprintf)(const char*,...));
 121
 122 /* block */
 123 typedef struct ir_block_s
 124 {
 125     char      *label;
 126     lex_ctx    context;
 127     bool       final; /* once a jump is added we're done */
 128
 129     MEM_VECTOR_MAKE(ir_instr*, instr);
 130     MEM_VECTOR_MAKE(struct ir_block_s*, entries);
 131     MEM_VECTOR_MAKE(struct ir_block_s*, exits);
 132     MEM_VECTOR_MAKE(ir_value*, living);
 133
 134     /* For the temp-allocation */
 135     size_t eid;
 136     bool   is_return;
 137     size_t run_id;
 138
 139     struct ir_function_s *owner;
 140 } ir_block;
 141
 142 ir_block* ir_block_new(struct ir_function_s *owner, const char *label);
 143 void      ir_block_delete(ir_block*);
 144
 145 bool      ir_block_set_label(ir_block*, const char *label);
 146
 147 MEM_VECTOR_PROTO(ir_block, ir_instr*, instr);
 148 MEM_VECTOR_PROTO_ALL(ir_block, ir_block*, exits);
 149 MEM_VECTOR_PROTO_ALL(ir_block, ir_block*, entries);
 150
 151 ir_value* ir_block_create_binop(ir_block*, const char *label, int op,
 152                                 ir_value *left, ir_value *right);
 153 bool GMQCC_WARN ir_block_create_store_op(ir_block*, int op, ir_value *target, ir_value *what);
 154 bool GMQCC_WARN ir_block_create_store(ir_block*, ir_value *target, ir_value *what);
 155 bool GMQCC_WARN ir_block_create_storep(ir_block*, ir_value *target, ir_value *what);
 156
 157 /* field must be of TYPE_FIELD */
 158 ir_value* ir_block_create_load_from_ent(ir_block*, const char *label, ir_value *ent, ir_value *field, int outype);
 159
 160 ir_value* ir_block_create_fieldaddress(ir_block*, const char *label, ir_value *entity, ir_value *field);
 161
 162 ir_value* ir_block_create_add(ir_block*, const char *label, ir_value *l, ir_value *r);
 163 ir_value* ir_block_create_sub(ir_block*, const char *label, ir_value *l, ir_value *r);
 164 ir_value* ir_block_create_mul(ir_block*, const char *label, ir_value *l, ir_value *r);
 165 ir_value* ir_block_create_div(ir_block*, const char *label, ir_value *l, ir_value *r);
 166 ir_instr* ir_block_create_phi(ir_block*, const char *label, int vtype);
 167 ir_value* ir_phi_value(ir_instr*);
 168 bool GMQCC_WARN ir_phi_add(ir_instr*, ir_block *b, ir_value *v);
 169
 170 bool GMQCC_WARN ir_block_create_return(ir_block*, ir_value *opt_value);
 171
 172 bool GMQCC_WARN ir_block_create_if(ir_block*, ir_value *cond,
 173                                    ir_block *ontrue, ir_block *onfalse);
 174 /* A 'goto' is an actual 'goto' coded in QC, whereas
 175  * a 'jump' is a virtual construct which simply names the
 176  * next block to go to.
 177  * A goto usually becomes an OP_GOTO in the resulting code,
 178  * whereas a 'jump' usually doesn't add any actual instruction.
 179  */
 180 bool GMQCC_WARN ir_block_create_jump(ir_block*, ir_block *to);
 181 bool GMQCC_WARN ir_block_create_goto(ir_block*, ir_block *to);
 182
 183 MEM_VECTOR_PROTO_ALL(ir_block, ir_value*, living);
 184
 185 void ir_block_dump(ir_block*, char *ind, int (*oprintf)(const char*,...));
 186
 187 /* function */
 188
 189 typedef struct ir_function_s
 190 {
 191     char *name;
 192     int   retype;
 193     MEM_VECTOR_MAKE(int, params);
 194     MEM_VECTOR_MAKE(ir_block*, blocks);
 195
 196     /* values generated from operations
 197      * which might get optimized away, so anything
 198      * in there needs to be deleted in the dtor.
 199      */
 200     MEM_VECTOR_MAKE(ir_value*, values);
 201
 202     /* locally defined variables */
 203     MEM_VECTOR_MAKE(ir_value*, locals);
 204
 205     ir_block*     first;
 206     ir_block*     last;
 207
 208     lex_ctx       context;
 209
 210     /* for temp allocation */
 211     size_t run_id;
 212
 213     struct ir_builder_s *owner;
 214 } ir_function;
 215
 216 ir_function* ir_function_new(struct ir_builder_s *owner);
 217 void         ir_function_delete(ir_function*);
 218
 219 bool GMQCC_WARN ir_function_collect_value(ir_function*, ir_value *value);
 220
 221 bool ir_function_set_name(ir_function*, const char *name);
 222 MEM_VECTOR_PROTO(ir_function, int, params);
 223 MEM_VECTOR_PROTO(ir_function, ir_block*, blocks);
 224
 225 ir_value* ir_function_get_local(ir_function *self, const char *name);
 226 ir_value* ir_function_create_local(ir_function *self, const char *name, int vtype);
 227
 228 bool GMQCC_WARN ir_function_finalize(ir_function*);
 229 /*
 230 bool ir_function_naive_phi(ir_function*);
 231 bool ir_function_enumerate(ir_function*);
 232 bool ir_function_calculate_liferanges(ir_function*);
 233 */
 234
 235 ir_block* ir_function_create_block(ir_function*, const char *label);
 236
 237 void ir_function_dump(ir_function*, char *ind, int (*oprintf)(const char*,...));
 238
 239 /* builder */
 240 typedef struct ir_builder_s
 241 {
 242     char *name;
 243     MEM_VECTOR_MAKE(ir_function*, functions);
 244     MEM_VECTOR_MAKE(ir_value*, globals);
 245 } ir_builder;
 246
 247 ir_builder* ir_builder_new(const char *modulename);
 248 void        ir_builder_delete(ir_builder*);
 249
 250 bool ir_builder_set_name(ir_builder *self, const char *name);
 251
 252 MEM_VECTOR_PROTO(ir_builder, ir_function*, functions);
 253 MEM_VECTOR_PROTO(ir_builder, ir_value*, globals);
 254
 255 ir_function* ir_builder_get_function(ir_builder*, const char *fun);
 256 ir_function* ir_builder_create_function(ir_builder*, const char *name);
 257
 258 ir_value* ir_builder_get_global(ir_builder*, const char *fun);
 259 ir_value* ir_builder_create_global(ir_builder*, const char *name, int vtype);
 260
 261 void ir_builder_dump(ir_builder*, int (*oprintf)(const char*, ...));
 262
 263 #endif