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