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