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