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