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