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     /* even the IR knows the subtype of a field */
  42     int       fieldtype;
  43
  44     MEM_VECTOR_MAKE(struct ir_instr_s*, reads);
  45     MEM_VECTOR_MAKE(struct ir_instr_s*, writes);
  46
  47     /* constantvalues */
  48     bool isconst;
  49     union {
  50         float    vfloat;
  51         int      vint;
  52         vector   vvec;
  53         char    *vstring;
  54         struct ir_value_s *vpointer;
  55         struct ir_function_s *vfunc;
  56     } constval;
  57
  58     struct {
  59         int32_t globaladdr;
  60         int32_t name;
  61     } code;
  62
  63     /* For the temp allocator */
  64     MEM_VECTOR_MAKE(ir_life_entry_t, life);
  65 } ir_value;
  66
  67 /* ir_value can be a variable, or created by an operation */
  68 ir_value* ir_value_var(const char *name, int st, int vtype);
  69 /* if a result of an operation: the function should store
  70  * it to remember to delete it / garbage collect it
  71  */
  72 ir_value* ir_value_out(struct ir_function_s *owner, const char *name, int st, int vtype);
  73 void      ir_value_delete(ir_value*);
  74 void      ir_value_set_name(ir_value*, const char *name);
  75
  76 MEM_VECTOR_PROTO_ALL(ir_value, struct ir_instr_s*, reads);
  77 MEM_VECTOR_PROTO_ALL(ir_value, struct ir_instr_s*, writes);
  78
  79 bool GMQCC_WARN ir_value_set_float(ir_value*, float f);
  80 #if 0
  81 bool GMQCC_WARN ir_value_set_int(ir_value*, int i);
  82 #endif
  83 bool GMQCC_WARN ir_value_set_string(ir_value*, const char *s);
  84 bool GMQCC_WARN ir_value_set_vector(ir_value*, vector v);
  85 /*bool   ir_value_set_pointer_v(ir_value*, ir_value* p); */
  86 /*bool   ir_value_set_pointer_i(ir_value*, int i);       */
  87
  88 MEM_VECTOR_PROTO(ir_value, ir_life_entry_t, life);
  89 /* merge an instruction into the life-range */
  90 /* returns false if the lifepoint was already known */
  91 bool ir_value_life_merge(ir_value*, size_t);
  92 bool ir_value_life_merge_into(ir_value*, const ir_value*);
  93 /* check if a value lives at a specific point */
  94 bool ir_value_lives(ir_value*, size_t);
  95 /* check if the life-range of 2 values overlaps */
  96 bool ir_values_overlap(ir_value*, ir_value*);
  97
  98 void ir_value_dump(ir_value*, int (*oprintf)(const char*,...));
  99 void ir_value_dump_life(ir_value *self, int (*oprintf)(const char*,...));
 100
 101 typedef struct ir_phi_entry_s
 102 {
 103     ir_value          *value;
 104     struct ir_block_s *from;
 105 } ir_phi_entry_t;
 106
 107 /* instruction */
 108 typedef struct ir_instr_s
 109 {
 110     int       opcode;
 111     lex_ctx   context;
 112     ir_value* (_ops[3]);
 113     struct ir_block_s* (bops[2]);
 114
 115     MEM_VECTOR_MAKE(ir_phi_entry_t, phi);
 116
 117     /* For the temp-allocation */
 118     size_t eid;
 119
 120     struct ir_block_s *owner;
 121 } ir_instr;
 122
 123 ir_instr* ir_instr_new(struct ir_block_s *owner, int opcode);
 124 void      ir_instr_delete(ir_instr*);
 125
 126 MEM_VECTOR_PROTO(ir_value, ir_phi_entry_t, phi);
 127 bool GMQCC_WARN ir_instr_op(ir_instr*, int op, ir_value *value, bool writing);
 128
 129 void ir_instr_dump(ir_instr* in, char *ind, int (*oprintf)(const char*,...));
 130
 131 /* block */
 132 typedef struct ir_block_s
 133 {
 134     char      *label;
 135     lex_ctx    context;
 136     bool       final; /* once a jump is added we're done */
 137
 138     MEM_VECTOR_MAKE(ir_instr*, instr);
 139     MEM_VECTOR_MAKE(struct ir_block_s*, entries);
 140     MEM_VECTOR_MAKE(struct ir_block_s*, exits);
 141     MEM_VECTOR_MAKE(ir_value*, living);
 142
 143     /* For the temp-allocation */
 144     size_t eid;
 145     bool   is_return;
 146     size_t run_id;
 147
 148     struct ir_function_s *owner;
 149
 150     bool   generated;
 151     size_t code_start;
 152 } ir_block;
 153
 154 ir_block* ir_block_new(struct ir_function_s *owner, const char *label);
 155 void      ir_block_delete(ir_block*);
 156
 157 bool      ir_block_set_label(ir_block*, const char *label);
 158
 159 MEM_VECTOR_PROTO(ir_block, ir_instr*, instr);
 160 MEM_VECTOR_PROTO_ALL(ir_block, ir_block*, exits);
 161 MEM_VECTOR_PROTO_ALL(ir_block, ir_block*, entries);
 162
 163 ir_value* ir_block_create_binop(ir_block*, const char *label, int op,
 164                                 ir_value *left, ir_value *right);
 165 bool GMQCC_WARN ir_block_create_store_op(ir_block*, int op, ir_value *target, ir_value *what);
 166 bool GMQCC_WARN ir_block_create_store(ir_block*, ir_value *target, ir_value *what);
 167 bool GMQCC_WARN ir_block_create_storep(ir_block*, ir_value *target, ir_value *what);
 168
 169 /* field must be of TYPE_FIELD */
 170 ir_value* ir_block_create_load_from_ent(ir_block*, const char *label, ir_value *ent, ir_value *field, int outype);
 171
 172 ir_value* ir_block_create_fieldaddress(ir_block*, const char *label, ir_value *entity, ir_value *field);
 173
 174 /* This is to create an instruction of the form
 175  * <outtype>%label := opcode a, b
 176  */
 177 ir_value* ir_block_create_general_instr(ir_block *self, const char *label,
 178                                         int op, ir_value *a, ir_value *b, int outype);
 179
 180 ir_value* ir_block_create_add(ir_block*, const char *label, ir_value *l, ir_value *r);
 181 ir_value* ir_block_create_sub(ir_block*, const char *label, ir_value *l, ir_value *r);
 182 ir_value* ir_block_create_mul(ir_block*, const char *label, ir_value *l, ir_value *r);
 183 ir_value* ir_block_create_div(ir_block*, const char *label, ir_value *l, ir_value *r);
 184 ir_instr* ir_block_create_phi(ir_block*, const char *label, int vtype);
 185 ir_value* ir_phi_value(ir_instr*);
 186 bool GMQCC_WARN ir_phi_add(ir_instr*, ir_block *b, ir_value *v);
 187
 188 bool GMQCC_WARN ir_block_create_return(ir_block*, ir_value *opt_value);
 189
 190 bool GMQCC_WARN ir_block_create_if(ir_block*, ir_value *cond,
 191                                    ir_block *ontrue, ir_block *onfalse);
 192 /* A 'goto' is an actual 'goto' coded in QC, whereas
 193  * a 'jump' is a virtual construct which simply names the
 194  * next block to go to.
 195  * A goto usually becomes an OP_GOTO in the resulting code,
 196  * whereas a 'jump' usually doesn't add any actual instruction.
 197  */
 198 bool GMQCC_WARN ir_block_create_jump(ir_block*, ir_block *to);
 199 bool GMQCC_WARN ir_block_create_goto(ir_block*, ir_block *to);
 200
 201 MEM_VECTOR_PROTO_ALL(ir_block, ir_value*, living);
 202
 203 void ir_block_dump(ir_block*, char *ind, int (*oprintf)(const char*,...));
 204
 205 /* function */
 206
 207 typedef struct ir_function_s
 208 {
 209     char *name;
 210     int   retype;
 211     MEM_VECTOR_MAKE(int, params);
 212     MEM_VECTOR_MAKE(ir_block*, blocks);
 213
 214     /* values generated from operations
 215      * which might get optimized away, so anything
 216      * in there needs to be deleted in the dtor.
 217      */
 218     MEM_VECTOR_MAKE(ir_value*, values);
 219
 220     /* locally defined variables */
 221     MEM_VECTOR_MAKE(ir_value*, locals);
 222
 223     ir_block*     first;
 224     ir_block*     last;
 225
 226     lex_ctx       context;
 227
 228     /* for temp allocation */
 229     size_t run_id;
 230
 231     struct ir_builder_s *owner;
 232 } ir_function;
 233
 234 ir_function* ir_function_new(struct ir_builder_s *owner);
 235 void         ir_function_delete(ir_function*);
 236
 237 bool GMQCC_WARN ir_function_collect_value(ir_function*, ir_value *value);
 238
 239 bool ir_function_set_name(ir_function*, const char *name);
 240 MEM_VECTOR_PROTO(ir_function, int, params);
 241 MEM_VECTOR_PROTO(ir_function, ir_block*, blocks);
 242
 243 ir_value* ir_function_get_local(ir_function *self, const char *name);
 244 ir_value* ir_function_create_local(ir_function *self, const char *name, int vtype);
 245
 246 bool GMQCC_WARN ir_function_finalize(ir_function*);
 247 /*
 248 bool ir_function_naive_phi(ir_function*);
 249 bool ir_function_enumerate(ir_function*);
 250 bool ir_function_calculate_liferanges(ir_function*);
 251 */
 252
 253 ir_block* ir_function_create_block(ir_function*, const char *label);
 254
 255 void ir_function_dump(ir_function*, char *ind, int (*oprintf)(const char*,...));
 256
 257 /* builder */
 258 typedef struct ir_builder_s
 259 {
 260     char *name;
 261     MEM_VECTOR_MAKE(ir_function*, functions);
 262     MEM_VECTOR_MAKE(ir_value*, globals);
 263 } ir_builder;
 264
 265 ir_builder* ir_builder_new(const char *modulename);
 266 void        ir_builder_delete(ir_builder*);
 267
 268 bool ir_builder_set_name(ir_builder *self, const char *name);
 269
 270 MEM_VECTOR_PROTO(ir_builder, ir_function*, functions);
 271 MEM_VECTOR_PROTO(ir_builder, ir_value*, globals);
 272
 273 ir_function* ir_builder_get_function(ir_builder*, const char *fun);
 274 ir_function* ir_builder_create_function(ir_builder*, const char *name);
 275
 276 ir_value* ir_builder_get_global(ir_builder*, const char *fun);
 277 ir_value* ir_builder_create_global(ir_builder*, const char *name, int vtype);
 278
 279 bool ir_builder_generate(ir_builder *self, const char *filename);
 280
 281 void ir_builder_dump(ir_builder*, int (*oprintf)(const char*, ...));
 282
 283 /* This code assumes 32 bit floats while generating binary */
 284 extern int check_int_and_float_size
 285 [ (sizeof(int32_t) == sizeof(( (ir_value*)(NULL) )->constval.vvec.x)) ? 1 : -1 ];
 286
 287 #endif