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