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 QCIR_H__
  24 #define QCIR_H__
  25
  26 #include "astir.h"
  27
  28 /* ir_value */
  29
  30 typedef struct
  31 {
  32     /* both inclusive */
  33     size_t start;
  34     size_t end;
  35 } ir_life_entry_t;
  36
  37 struct ir_function_s;
  38 typedef struct ir_value_s {
  39     char      *name;
  40     int       vtype;
  41     int       store;
  42     lex_ctx_t context;
  43
  44     MEM_VECTOR_MAKE(struct ir_instr_s*, reads);
  45     MEM_VECTOR_MAKE(struct ir_instr_s*, writes);
  46
  47     /* constantvalues */
  48     bool isconst;
  49     union {
  50         float    vfloat;
  51         int      vint;
  52         vector_t vvec;
  53         char    *vstring;
  54         struct ir_value_s *vpointer;
  55     } constval;
  56
  57     /* For the temp allocator */
  58     MEM_VECTOR_MAKE(ir_life_entry_t, life);
  59 } ir_value;
  60
  61 /* ir_value can be a variable, or created by an operation */
  62 ir_value* ir_value_var(const char *name, int st, int vtype);
  63 /* if a result of an operation: the function should store
  64  * it to remember to delete it / garbage collect it
  65  */
  66 ir_value* ir_value_out(struct ir_function_s *owner, const char *name, int st, int vtype);
  67 void      ir_value_delete(ir_value*);
  68 void      ir_value_set_name(ir_value*, const char *name);
  69
  70 MEM_VECTOR_PROTO(ir_value, struct ir_instr_s*, reads)
  71 MEM_VECTOR_PROTO(ir_value, struct ir_instr_s*, writes)
  72
  73 bool   ir_value_set_float(ir_value*, float f);
  74 bool   ir_value_set_int(ir_value*, int i);
  75 bool   ir_value_set_string(ir_value*, const char *s);
  76 bool   ir_value_set_vector(ir_value*, vector_t v);
  77 /*bool   ir_value_set_pointer_v(ir_value*, ir_value* p); */
  78 /*bool   ir_value_set_pointer_i(ir_value*, int i);       */
  79
  80 MEM_VECTOR_PROTO(ir_value, ir_life_entry_t, life)
  81 /* merge an instruction into the life-range */
  82 /* returns false if the lifepoint was already known */
  83 bool ir_value_life_merge(ir_value*, size_t);
  84 /* check if a value lives at a specific point */
  85 bool ir_value_lives(ir_value*, size_t);
  86
  87 void ir_value_dump(ir_value*, int (*oprintf)(const char*,...));
  88 void ir_value_dump_life(ir_value *self, int (*oprintf)(const char*,...));
  89
  90 typedef struct ir_phi_entry_s
  91 {
  92     ir_value          *value;
  93     struct ir_block_s *from;
  94 } ir_phi_entry_t;
  95
  96 /* instruction */
  97 typedef struct ir_instr_s
  98 {
  99     int       opcode;
 100     lex_ctx_t context;
 101     ir_value* (_ops[3]);
 102     struct ir_block_s* (bops[2]);
 103
 104     MEM_VECTOR_MAKE(ir_phi_entry_t, phi);
 105
 106     /* For the temp-allocation */
 107     size_t eid;
 108
 109     struct ir_block_s *owner;
 110 } ir_instr;
 111
 112 ir_instr* ir_instr_new(struct ir_block_s *owner, int opcode);
 113 void      ir_instr_delete(ir_instr*);
 114
 115 MEM_VECTOR_PROTO(ir_value, ir_phi_entry_t, phi)
 116 void ir_instr_op(ir_instr*, int op, ir_value *value, bool writing);
 117
 118 void ir_instr_dump(ir_instr* in, char *ind, int (*oprintf)(const char*,...));
 119
 120 /* block */
 121 typedef struct ir_block_s
 122 {
 123     char      *label;
 124     lex_ctx_t  context;
 125     bool       final; /* once a jump is added we're done */
 126
 127     MEM_VECTOR_MAKE(ir_instr*, instr);
 128     MEM_VECTOR_MAKE(struct ir_block_s*, entries);
 129     MEM_VECTOR_MAKE(struct ir_block_s*, exits);
 130     MEM_VECTOR_MAKE(ir_value*, living);
 131
 132     /* For the temp-allocation */
 133     size_t eid;
 134     bool   is_return;
 135     size_t run_id;
 136
 137     struct ir_function_s *owner;
 138 } ir_block;
 139
 140 ir_block* ir_block_new(struct ir_function_s *owner, const char *label);
 141 void      ir_block_delete(ir_block*);
 142
 143 void      ir_block_set_label(ir_block*, const char *label);
 144
 145 MEM_VECTOR_PROTO(ir_block, ir_instr*, instr)
 146 MEM_VECTOR_PROTO_ALL(ir_block, ir_block*, exits)
 147 MEM_VECTOR_PROTO_ALL(ir_block, ir_block*, entries)
 148
 149 ir_value* ir_block_create_binop(ir_block*, const char *label, int op,
 150                                 ir_value *left, ir_value *right);
 151 bool   ir_block_create_store_op(ir_block*, int op, ir_value *target, ir_value *what);
 152 bool   ir_block_create_store(ir_block*, ir_value *target, ir_value *what);
 153
 154 ir_value* ir_block_create_add(ir_block*, const char *label, ir_value *l, ir_value *r);
 155 ir_value* ir_block_create_sub(ir_block*, const char *label, ir_value *l, ir_value *r);
 156 ir_value* ir_block_create_mul(ir_block*, const char *label, ir_value *l, ir_value *r);
 157 ir_value* ir_block_create_div(ir_block*, const char *label, ir_value *l, ir_value *r);
 158 ir_instr* ir_block_create_phi(ir_block*, const char *label, int vtype);
 159 ir_value* ir_phi_value(ir_instr*);
 160 void      ir_phi_add(ir_instr*, ir_block *b, ir_value *v);
 161
 162 void      ir_block_create_return(ir_block*, ir_value *opt_value);
 163
 164 void      ir_block_create_if(ir_block*, ir_value *cond,
 165                              ir_block *ontrue, ir_block *onfalse);
 166 /* A 'goto' is an actual 'goto' coded in QC, whereas
 167  * a 'jump' is a virtual construct which simply names the
 168  * next block to go to.
 169  * A goto usually becomes an OP_GOTO in the resulting code,
 170  * whereas a 'jump' usually doesn't add any actual instruction.
 171  */
 172 void      ir_block_create_jump(ir_block*, ir_block *to);
 173 void      ir_block_create_goto(ir_block*, ir_block *to);
 174
 175 MEM_VECTOR_PROTO_ALL(ir_block, ir_value*, living)
 176
 177 void ir_block_dump(ir_block*, char *ind, int (*oprintf)(const char*,...));
 178
 179 /* function */
 180
 181 typedef struct ir_function_s
 182 {
 183     char *name;
 184     int   retype;
 185     MEM_VECTOR_MAKE(int, params);
 186     MEM_VECTOR_MAKE(ir_block*, blocks);
 187
 188     /* values generated from operations
 189      * which might get optimized away, so anything
 190      * in there needs to be deleted in the dtor.
 191      */
 192     MEM_VECTOR_MAKE(ir_value*, values);
 193
 194     /* locally defined variables */
 195     MEM_VECTOR_MAKE(ir_value*, locals);
 196
 197     ir_block*     first;
 198     ir_block*     last;
 199
 200     lex_ctx_t     context;
 201
 202     /* for temp allocation */
 203     size_t run_id;
 204
 205     struct ir_builder_s *owner;
 206 } ir_function;
 207
 208 ir_function* ir_function_new(struct ir_builder_s *owner);
 209 void         ir_function_delete(ir_function*);
 210
 211 void ir_function_collect_value(ir_function*, ir_value *value);
 212
 213 void ir_function_set_name(ir_function*, const char *name);
 214 MEM_VECTOR_PROTO(ir_function, int, params)
 215 MEM_VECTOR_PROTO(ir_function, ir_block*, blocks)
 216
 217 ir_value* ir_function_get_local(ir_function *self, const char *name);
 218 ir_value* ir_function_create_local(ir_function *self, const char *name, int vtype);
 219
 220 void ir_function_finalize(ir_function*);
 221 /*
 222 void ir_function_naive_phi(ir_function*);
 223 void ir_function_enumerate(ir_function*);
 224 void ir_function_calculate_liferanges(ir_function*);
 225 */
 226
 227 ir_block* ir_function_create_block(ir_function*, const char *label);
 228
 229 void ir_function_dump(ir_function*, char *ind, int (*oprintf)(const char*,...));
 230
 231 /* builder */
 232 typedef struct ir_builder_s
 233 {
 234     char *name;
 235     MEM_VECTOR_MAKE(ir_function*, functions);
 236     MEM_VECTOR_MAKE(ir_value*, globals);
 237 } ir_builder;
 238
 239 ir_builder* ir_builder_new(const char *modulename);
 240 void        ir_builder_delete(ir_builder*);
 241
 242 void ir_builder_set_name(ir_builder *self, const char *name);
 243
 244 MEM_VECTOR_PROTO(ir_builder, ir_function*, functions)
 245 MEM_VECTOR_PROTO(ir_builder, ir_value*, globals)
 246
 247 ir_function* ir_builder_get_function(ir_builder*, const char *fun);
 248 ir_function* ir_builder_create_function(ir_builder*, const char *name);
 249
 250 ir_value* ir_builder_get_global(ir_builder*, const char *fun);
 251 ir_value* ir_builder_create_global(ir_builder*, const char *name, int vtype);
 252
 253 void ir_builder_dump(ir_builder*, int (*oprintf)(const char*, ...));
 254
 255 #endif