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 /* check if a value lives at a specific point */
  93 bool ir_value_lives(ir_value*, size_t);
  94 /* check if the life-range of 2 values overlaps */
  95 bool ir_values_overlap(ir_value*, ir_value*);
  96
  97 void ir_value_dump(ir_value*, int (*oprintf)(const char*,...));
  98 void ir_value_dump_life(ir_value *self, int (*oprintf)(const char*,...));
  99
 100 typedef struct ir_phi_entry_s
 101 {
 102     ir_value          *value;
 103     struct ir_block_s *from;
 104 } ir_phi_entry_t;
 105
 106 /* instruction */
 107 typedef struct ir_instr_s
 108 {
 109     int       opcode;
 110     lex_ctx   context;
 111     ir_value* (_ops[3]);
 112     struct ir_block_s* (bops[2]);
 113
 114     MEM_VECTOR_MAKE(ir_phi_entry_t, phi);
 115
 116     /* For the temp-allocation */
 117     size_t eid;
 118
 119     struct ir_block_s *owner;
 120 } ir_instr;
 121
 122 ir_instr* ir_instr_new(struct ir_block_s *owner, int opcode);
 123 void      ir_instr_delete(ir_instr*);
 124
 125 MEM_VECTOR_PROTO(ir_value, ir_phi_entry_t, phi);
 126 bool GMQCC_WARN ir_instr_op(ir_instr*, int op, ir_value *value, bool writing);
 127
 128 void ir_instr_dump(ir_instr* in, char *ind, int (*oprintf)(const char*,...));
 129
 130 /* block */
 131 typedef struct ir_block_s
 132 {
 133     char      *label;
 134     lex_ctx    context;
 135     bool       final; /* once a jump is added we're done */
 136
 137     MEM_VECTOR_MAKE(ir_instr*, instr);
 138     MEM_VECTOR_MAKE(struct ir_block_s*, entries);
 139     MEM_VECTOR_MAKE(struct ir_block_s*, exits);
 140     MEM_VECTOR_MAKE(ir_value*, living);
 141
 142     /* For the temp-allocation */
 143     size_t eid;
 144     bool   is_return;
 145     size_t run_id;
 146
 147     struct ir_function_s *owner;
 148
 149     bool   generated;
 150     size_t code_start;
 151 } ir_block;
 152
 153 ir_block* ir_block_new(struct ir_function_s *owner, const char *label);
 154 void      ir_block_delete(ir_block*);
 155
 156 bool      ir_block_set_label(ir_block*, const char *label);
 157
 158 MEM_VECTOR_PROTO(ir_block, ir_instr*, instr);
 159 MEM_VECTOR_PROTO_ALL(ir_block, ir_block*, exits);
 160 MEM_VECTOR_PROTO_ALL(ir_block, ir_block*, entries);
 161
 162 ir_value* ir_block_create_binop(ir_block*, const char *label, int op,
 163                                 ir_value *left, ir_value *right);
 164 bool GMQCC_WARN ir_block_create_store_op(ir_block*, int op, ir_value *target, ir_value *what);
 165 bool GMQCC_WARN ir_block_create_store(ir_block*, ir_value *target, ir_value *what);
 166 bool GMQCC_WARN ir_block_create_storep(ir_block*, ir_value *target, ir_value *what);
 167
 168 /* field must be of TYPE_FIELD */
 169 ir_value* ir_block_create_load_from_ent(ir_block*, const char *label, ir_value *ent, ir_value *field, int outype);
 170
 171 ir_value* ir_block_create_fieldaddress(ir_block*, const char *label, ir_value *entity, ir_value *field);
 172
 173 /* This is to create an instruction of the form
 174  * <outtype>%label := opcode a, b
 175  */
 176 ir_value* ir_block_create_general_instr(ir_block *self, const char *label,
 177                                         int op, ir_value *a, ir_value *b, int outype);
 178
 179 ir_value* ir_block_create_add(ir_block*, const char *label, ir_value *l, ir_value *r);
 180 ir_value* ir_block_create_sub(ir_block*, const char *label, ir_value *l, ir_value *r);
 181 ir_value* ir_block_create_mul(ir_block*, const char *label, ir_value *l, ir_value *r);
 182 ir_value* ir_block_create_div(ir_block*, const char *label, ir_value *l, ir_value *r);
 183 ir_instr* ir_block_create_phi(ir_block*, const char *label, int vtype);
 184 ir_value* ir_phi_value(ir_instr*);
 185 bool GMQCC_WARN ir_phi_add(ir_instr*, ir_block *b, ir_value *v);
 186
 187 bool GMQCC_WARN ir_block_create_return(ir_block*, ir_value *opt_value);
 188
 189 bool GMQCC_WARN ir_block_create_if(ir_block*, ir_value *cond,
 190                                    ir_block *ontrue, ir_block *onfalse);
 191 /* A 'goto' is an actual 'goto' coded in QC, whereas
 192  * a 'jump' is a virtual construct which simply names the
 193  * next block to go to.
 194  * A goto usually becomes an OP_GOTO in the resulting code,
 195  * whereas a 'jump' usually doesn't add any actual instruction.
 196  */
 197 bool GMQCC_WARN ir_block_create_jump(ir_block*, ir_block *to);
 198 bool GMQCC_WARN ir_block_create_goto(ir_block*, ir_block *to);
 199
 200 MEM_VECTOR_PROTO_ALL(ir_block, ir_value*, living);
 201
 202 void ir_block_dump(ir_block*, char *ind, int (*oprintf)(const char*,...));
 203
 204 /* function */
 205
 206 typedef struct ir_function_s
 207 {
 208     char *name;
 209     int   retype;
 210     MEM_VECTOR_MAKE(int, params);
 211     MEM_VECTOR_MAKE(ir_block*, blocks);
 212
 213     /* values generated from operations
 214      * which might get optimized away, so anything
 215      * in there needs to be deleted in the dtor.
 216      */
 217     MEM_VECTOR_MAKE(ir_value*, values);
 218
 219     /* locally defined variables */
 220     MEM_VECTOR_MAKE(ir_value*, locals);
 221
 222     ir_block*     first;
 223     ir_block*     last;
 224
 225     lex_ctx       context;
 226
 227     /* for temp allocation */
 228     size_t run_id;
 229
 230     struct ir_builder_s *owner;
 231 } ir_function;
 232
 233 ir_function* ir_function_new(struct ir_builder_s *owner);
 234 void         ir_function_delete(ir_function*);
 235
 236 bool GMQCC_WARN ir_function_collect_value(ir_function*, ir_value *value);
 237
 238 bool ir_function_set_name(ir_function*, const char *name);
 239 MEM_VECTOR_PROTO(ir_function, int, params);
 240 MEM_VECTOR_PROTO(ir_function, ir_block*, blocks);
 241
 242 ir_value* ir_function_get_local(ir_function *self, const char *name);
 243 ir_value* ir_function_create_local(ir_function *self, const char *name, int vtype);
 244
 245 bool GMQCC_WARN ir_function_finalize(ir_function*);
 246 /*
 247 bool ir_function_naive_phi(ir_function*);
 248 bool ir_function_enumerate(ir_function*);
 249 bool ir_function_calculate_liferanges(ir_function*);
 250 */
 251
 252 ir_block* ir_function_create_block(ir_function*, const char *label);
 253
 254 void ir_function_dump(ir_function*, char *ind, int (*oprintf)(const char*,...));
 255
 256 /* builder */
 257 typedef struct ir_builder_s
 258 {
 259     char *name;
 260     MEM_VECTOR_MAKE(ir_function*, functions);
 261     MEM_VECTOR_MAKE(ir_value*, globals);
 262 } ir_builder;
 263
 264 ir_builder* ir_builder_new(const char *modulename);
 265 void        ir_builder_delete(ir_builder*);
 266
 267 bool ir_builder_set_name(ir_builder *self, const char *name);
 268
 269 MEM_VECTOR_PROTO(ir_builder, ir_function*, functions);
 270 MEM_VECTOR_PROTO(ir_builder, ir_value*, globals);
 271
 272 ir_function* ir_builder_get_function(ir_builder*, const char *fun);
 273 ir_function* ir_builder_create_function(ir_builder*, const char *name);
 274
 275 ir_value* ir_builder_get_global(ir_builder*, const char *fun);
 276 ir_value* ir_builder_create_global(ir_builder*, const char *name, int vtype);
 277
 278 bool ir_builder_generate(ir_builder *self, const char *filename);
 279
 280 void ir_builder_dump(ir_builder*, int (*oprintf)(const char*, ...));
 281
 282 /* This code assumes 32 bit floats while generating binary */
 283 extern int check_int_and_float_size
 284 [ (sizeof(int32_t) == sizeof(( (ir_value*)(NULL) )->constval.vvec.x)) ? 1 : -1 ];
 285
 286 #endif