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