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:
12 * The above copyright notice and this permission notice shall be included in all
13 * copies or substantial portions of the Software.
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
36 typedef struct ir_value_s {
41 /* even the IR knows the subtype of a field */
43 /* and the output type of a function */
46 MEM_VECTOR_MAKE(struct ir_instr_s*, reads);
47 MEM_VECTOR_MAKE(struct ir_instr_s*, writes);
56 struct ir_value_s *vpointer;
57 struct ir_function_s *vfunc;
65 /* filled by the local-allocator */
69 /* For the temp allocator */
70 MEM_VECTOR_MAKE(ir_life_entry_t, life);
73 /* ir_value can be a variable, or created by an operation */
74 ir_value* ir_value_var(const char *name, int st, int vtype);
75 /* if a result of an operation: the function should store
76 * it to remember to delete it / garbage collect it
78 ir_value* ir_value_out(struct ir_function_s *owner, const char *name, int st, int vtype);
79 void ir_value_delete(ir_value*);
80 void ir_value_set_name(ir_value*, const char *name);
82 MEM_VECTOR_PROTO_ALL(ir_value, struct ir_instr_s*, reads);
83 MEM_VECTOR_PROTO_ALL(ir_value, struct ir_instr_s*, writes);
85 bool GMQCC_WARN ir_value_set_float(ir_value*, float f);
86 bool GMQCC_WARN ir_value_set_func(ir_value*, int f);
88 bool GMQCC_WARN ir_value_set_int(ir_value*, int i);
90 bool GMQCC_WARN ir_value_set_string(ir_value*, const char *s);
91 bool GMQCC_WARN ir_value_set_vector(ir_value*, vector v);
92 /*bool ir_value_set_pointer_v(ir_value*, ir_value* p); */
93 /*bool ir_value_set_pointer_i(ir_value*, int i); */
94 bool GMQCC_WARN ir_value_set_quaternion(ir_value*, quaternion v);
95 bool GMQCC_WARN ir_value_set_matrix(ir_value*, matrix v);
97 MEM_VECTOR_PROTO(ir_value, ir_life_entry_t, life);
98 /* merge an instruction into the life-range */
99 /* returns false if the lifepoint was already known */
100 bool ir_value_life_merge(ir_value*, size_t);
101 bool ir_value_life_merge_into(ir_value*, const ir_value*);
102 /* check if a value lives at a specific point */
103 bool ir_value_lives(ir_value*, size_t);
104 /* check if the life-range of 2 values overlaps */
105 bool ir_values_overlap(const ir_value*, const ir_value*);
107 void ir_value_dump(ir_value*, int (*oprintf)(const char*,...));
108 void ir_value_dump_life(ir_value *self, int (*oprintf)(const char*,...));
110 /* A vector of IR values */
112 MEM_VECTOR_MAKE(ir_value*, v);
114 MEM_VECTOR_PROTO(ir_value_vector, ir_value*, v);
117 typedef struct ir_phi_entry_s
120 struct ir_block_s *from;
124 typedef struct ir_instr_s
129 struct ir_block_s* (bops[2]);
131 MEM_VECTOR_MAKE(ir_phi_entry_t, phi);
132 MEM_VECTOR_MAKE(ir_value*, params);
134 /* For the temp-allocation */
137 struct ir_block_s *owner;
140 ir_instr* ir_instr_new(struct ir_block_s *owner, int opcode);
141 void ir_instr_delete(ir_instr*);
143 MEM_VECTOR_PROTO(ir_value, ir_phi_entry_t, phi);
144 bool GMQCC_WARN ir_instr_op(ir_instr*, int op, ir_value *value, bool writing);
146 MEM_VECTOR_PROTO(ir_value, ir_value*, params);
148 void ir_instr_dump(ir_instr* in, char *ind, int (*oprintf)(const char*,...));
151 typedef struct ir_block_s
155 bool final; /* once a jump is added we're done */
157 MEM_VECTOR_MAKE(ir_instr*, instr);
158 MEM_VECTOR_MAKE(struct ir_block_s*, entries);
159 MEM_VECTOR_MAKE(struct ir_block_s*, exits);
160 MEM_VECTOR_MAKE(ir_value*, living);
162 /* For the temp-allocation */
167 struct ir_function_s *owner;
173 ir_block* ir_block_new(struct ir_function_s *owner, const char *label);
174 void ir_block_delete(ir_block*);
176 bool ir_block_set_label(ir_block*, const char *label);
178 MEM_VECTOR_PROTO(ir_block, ir_instr*, instr);
179 MEM_VECTOR_PROTO_ALL(ir_block, ir_block*, exits);
180 MEM_VECTOR_PROTO_ALL(ir_block, ir_block*, entries);
182 ir_value* ir_block_create_binop(ir_block*, const char *label, int op,
183 ir_value *left, ir_value *right);
184 ir_value* ir_block_create_unary(ir_block*, const char *label, int op,
186 bool GMQCC_WARN ir_block_create_store_op(ir_block*, int op, ir_value *target, ir_value *what);
187 bool GMQCC_WARN ir_block_create_store(ir_block*, ir_value *target, ir_value *what);
188 bool GMQCC_WARN ir_block_create_storep(ir_block*, ir_value *target, ir_value *what);
190 /* field must be of TYPE_FIELD */
191 ir_value* ir_block_create_load_from_ent(ir_block*, const char *label, ir_value *ent, ir_value *field, int outype);
193 ir_value* ir_block_create_fieldaddress(ir_block*, const char *label, ir_value *entity, ir_value *field);
195 /* This is to create an instruction of the form
196 * <outtype>%label := opcode a, b
198 ir_value* ir_block_create_general_instr(ir_block *self, const char *label,
199 int op, ir_value *a, ir_value *b, int outype);
201 ir_value* ir_block_create_add(ir_block*, const char *label, ir_value *l, ir_value *r);
202 ir_value* ir_block_create_sub(ir_block*, const char *label, ir_value *l, ir_value *r);
203 ir_value* ir_block_create_mul(ir_block*, const char *label, ir_value *l, ir_value *r);
204 ir_value* ir_block_create_div(ir_block*, const char *label, ir_value *l, ir_value *r);
205 ir_instr* ir_block_create_phi(ir_block*, const char *label, int vtype);
206 ir_value* ir_phi_value(ir_instr*);
207 bool GMQCC_WARN ir_phi_add(ir_instr*, ir_block *b, ir_value *v);
208 ir_instr* ir_block_create_call(ir_block*, const char *label, ir_value *func);
209 ir_value* ir_call_value(ir_instr*);
210 bool GMQCC_WARN ir_call_param(ir_instr*, ir_value*);
212 bool GMQCC_WARN ir_block_create_return(ir_block*, ir_value *opt_value);
214 bool GMQCC_WARN ir_block_create_if(ir_block*, ir_value *cond,
215 ir_block *ontrue, ir_block *onfalse);
216 /* A 'goto' is an actual 'goto' coded in QC, whereas
217 * a 'jump' is a virtual construct which simply names the
218 * next block to go to.
219 * A goto usually becomes an OP_GOTO in the resulting code,
220 * whereas a 'jump' usually doesn't add any actual instruction.
222 bool GMQCC_WARN ir_block_create_jump(ir_block*, ir_block *to);
223 bool GMQCC_WARN ir_block_create_goto(ir_block*, ir_block *to);
225 MEM_VECTOR_PROTO_ALL(ir_block, ir_value*, living);
227 void ir_block_dump(ir_block*, char *ind, int (*oprintf)(const char*,...));
231 typedef struct ir_function_s
235 MEM_VECTOR_MAKE(int, params);
236 MEM_VECTOR_MAKE(ir_block*, blocks);
242 /* values generated from operations
243 * which might get optimized away, so anything
244 * in there needs to be deleted in the dtor.
246 MEM_VECTOR_MAKE(ir_value*, values);
248 /* locally defined variables */
249 MEM_VECTOR_MAKE(ir_value*, locals);
251 size_t allocated_locals;
258 /* for temp allocation */
261 struct ir_builder_s *owner;
264 ir_function* ir_function_new(struct ir_builder_s *owner, int returntype);
265 void ir_function_delete(ir_function*);
267 bool GMQCC_WARN ir_function_collect_value(ir_function*, ir_value *value);
269 bool ir_function_set_name(ir_function*, const char *name);
270 MEM_VECTOR_PROTO(ir_function, int, params);
271 MEM_VECTOR_PROTO(ir_function, ir_block*, blocks);
273 ir_value* ir_function_get_local(ir_function *self, const char *name);
274 ir_value* ir_function_create_local(ir_function *self, const char *name, int vtype, bool param);
276 bool GMQCC_WARN ir_function_finalize(ir_function*);
278 bool ir_function_naive_phi(ir_function*);
279 bool ir_function_enumerate(ir_function*);
280 bool ir_function_calculate_liferanges(ir_function*);
283 ir_block* ir_function_create_block(ir_function*, const char *label);
285 void ir_function_dump(ir_function*, char *ind, int (*oprintf)(const char*,...));
288 typedef struct ir_builder_s
291 MEM_VECTOR_MAKE(ir_function*, functions);
292 MEM_VECTOR_MAKE(ir_value*, globals);
295 ir_builder* ir_builder_new(const char *modulename);
296 void ir_builder_delete(ir_builder*);
298 bool ir_builder_set_name(ir_builder *self, const char *name);
300 MEM_VECTOR_PROTO(ir_builder, ir_function*, functions);
301 MEM_VECTOR_PROTO(ir_builder, ir_value*, globals);
303 ir_function* ir_builder_get_function(ir_builder*, const char *fun);
304 ir_function* ir_builder_create_function(ir_builder*, const char *name, int outtype);
306 ir_value* ir_builder_get_global(ir_builder*, const char *fun);
307 ir_value* ir_builder_create_global(ir_builder*, const char *name, int vtype);
309 bool ir_builder_generate(ir_builder *self, const char *filename);
311 void ir_builder_dump(ir_builder*, int (*oprintf)(const char*, ...));
313 /* This code assumes 32 bit floats while generating binary */
314 extern int check_int_and_float_size
315 [ (sizeof(int32_t) == sizeof(( (ir_value*)(NULL) )->constval.vvec.x)) ? 1 : -1 ];