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 */
45 /* 'const' vs 'var' qualifier */
48 struct ir_instr_s **reads;
49 struct ir_instr_s **writes;
59 struct ir_value_s *vpointer;
60 struct ir_function_s *vfunc;
66 /* filled by the local-allocator */
68 /* added for members */
72 /* for acessing vectors */
73 struct ir_value_s *members[3];
74 struct ir_value_s *memberof;
76 /* For the temp allocator */
77 ir_life_entry_t *life;
80 int32_t ir_value_code_addr(const ir_value*);
82 /* ir_value can be a variable, or created by an operation */
83 ir_value* ir_value_var(const char *name, int st, int vtype);
84 /* if a result of an operation: the function should store
85 * it to remember to delete it / garbage collect it
87 ir_value* ir_value_out(struct ir_function_s *owner, const char *name, int st, int vtype);
88 void ir_value_delete(ir_value*);
89 bool ir_value_set_name(ir_value*, const char *name);
90 ir_value* ir_value_vector_member(ir_value*, unsigned int member);
92 bool GMQCC_WARN vec_ir_value_find(ir_value **vec, ir_value *what, size_t *idx);
94 bool GMQCC_WARN ir_value_set_float(ir_value*, float f);
95 bool GMQCC_WARN ir_value_set_func(ir_value*, int f);
97 bool GMQCC_WARN ir_value_set_int(ir_value*, int i);
99 bool GMQCC_WARN ir_value_set_string(ir_value*, const char *s);
100 bool GMQCC_WARN ir_value_set_vector(ir_value*, vector v);
101 bool GMQCC_WARN ir_value_set_field(ir_value*, ir_value *fld);
102 /*bool ir_value_set_pointer_v(ir_value*, ir_value* p); */
103 /*bool ir_value_set_pointer_i(ir_value*, int i); */
105 /* merge an instruction into the life-range */
106 /* returns false if the lifepoint was already known */
107 bool ir_value_life_merge(ir_value*, size_t);
108 bool ir_value_life_merge_into(ir_value*, const ir_value*);
109 /* check if a value lives at a specific point */
110 bool ir_value_lives(ir_value*, size_t);
111 /* check if the life-range of 2 values overlaps */
112 bool ir_values_overlap(const ir_value*, const ir_value*);
114 void ir_value_dump(ir_value*, int (*oprintf)(const char*,...));
115 void ir_value_dump_life(const ir_value *self, int (*oprintf)(const char*,...));
118 typedef struct ir_phi_entry_s
121 struct ir_block_s *from;
125 typedef struct ir_instr_s
130 struct ir_block_s* (bops[2]);
135 /* For the temp-allocation */
141 struct ir_block_s *owner;
144 ir_instr* ir_instr_new(struct ir_block_s *owner, int opcode);
145 void ir_instr_delete(ir_instr*);
147 bool GMQCC_WARN vec_ir_instr_find(ir_instr **vec, ir_instr *what, size_t *idx);
149 bool GMQCC_WARN ir_instr_op(ir_instr*, int op, ir_value *value, bool writing);
151 void ir_instr_dump(ir_instr* in, char *ind, int (*oprintf)(const char*,...));
154 typedef struct ir_block_s
158 bool final; /* once a jump is added we're done */
161 struct ir_block_s **entries;
162 struct ir_block_s **exits;
165 /* For the temp-allocation */
170 struct ir_function_s *owner;
176 ir_block* ir_block_new(struct ir_function_s *owner, const char *label);
177 void ir_block_delete(ir_block*);
179 bool ir_block_set_label(ir_block*, const char *label);
181 ir_value* ir_block_create_binop(ir_block*, const char *label, int op,
182 ir_value *left, ir_value *right);
183 ir_value* ir_block_create_unary(ir_block*, const char *label, int op,
185 bool GMQCC_WARN ir_block_create_store_op(ir_block*, int op, ir_value *target, ir_value *what);
186 bool GMQCC_WARN ir_block_create_store(ir_block*, ir_value *target, ir_value *what);
187 bool GMQCC_WARN ir_block_create_storep(ir_block*, ir_value *target, ir_value *what);
189 /* field must be of TYPE_FIELD */
190 ir_value* ir_block_create_load_from_ent(ir_block*, const char *label, ir_value *ent, ir_value *field, int outype);
192 ir_value* ir_block_create_fieldaddress(ir_block*, const char *label, ir_value *entity, ir_value *field);
194 /* This is to create an instruction of the form
195 * <outtype>%label := opcode a, b
197 ir_value* ir_block_create_general_instr(ir_block *self, const char *label,
198 int op, ir_value *a, ir_value *b, int outype);
200 ir_value* ir_block_create_add(ir_block*, const char *label, ir_value *l, ir_value *r);
201 ir_value* ir_block_create_sub(ir_block*, const char *label, ir_value *l, ir_value *r);
202 ir_value* ir_block_create_mul(ir_block*, const char *label, ir_value *l, ir_value *r);
203 ir_value* ir_block_create_div(ir_block*, const char *label, ir_value *l, ir_value *r);
204 ir_instr* ir_block_create_phi(ir_block*, const char *label, int vtype);
205 ir_value* ir_phi_value(ir_instr*);
206 void ir_phi_add(ir_instr*, ir_block *b, ir_value *v);
207 ir_instr* ir_block_create_call(ir_block*, const char *label, ir_value *func);
208 ir_value* ir_call_value(ir_instr*);
209 void ir_call_param(ir_instr*, ir_value*);
211 bool GMQCC_WARN ir_block_create_return(ir_block*, ir_value *opt_value);
213 bool GMQCC_WARN ir_block_create_if(ir_block*, ir_value *cond,
214 ir_block *ontrue, ir_block *onfalse);
215 /* A 'goto' is an actual 'goto' coded in QC, whereas
216 * a 'jump' is a virtual construct which simply names the
217 * next block to go to.
218 * A goto usually becomes an OP_GOTO in the resulting code,
219 * whereas a 'jump' usually doesn't add any actual instruction.
221 bool GMQCC_WARN ir_block_create_jump(ir_block*, ir_block *to);
222 bool GMQCC_WARN ir_block_create_goto(ir_block*, ir_block *to);
224 void ir_block_dump(ir_block*, char *ind, int (*oprintf)(const char*,...));
228 typedef struct ir_function_s
239 /* values generated from operations
240 * which might get optimized away, so anything
241 * in there needs to be deleted in the dtor.
245 /* locally defined variables */
248 size_t allocated_locals;
255 /* for prototypes - first we generate all the
256 * globals, and we remember teh function-defs
257 * so we can later fill in the entry pos
261 qcint code_function_def;
263 /* for temp allocation */
266 struct ir_builder_s *owner;
269 ir_function* ir_function_new(struct ir_builder_s *owner, int returntype);
270 void ir_function_delete(ir_function*);
272 void ir_function_collect_value(ir_function*, ir_value *value);
274 bool ir_function_set_name(ir_function*, const char *name);
276 ir_value* ir_function_create_local(ir_function *self, const char *name, int vtype, bool param);
278 bool GMQCC_WARN ir_function_finalize(ir_function*);
280 bool ir_function_naive_phi(ir_function*);
281 bool ir_function_enumerate(ir_function*);
282 bool ir_function_calculate_liferanges(ir_function*);
285 ir_block* ir_function_create_block(lex_ctx ctx, ir_function*, const char *label);
287 void ir_function_dump(ir_function*, char *ind, int (*oprintf)(const char*,...));
290 #define IR_HT_SIZE 1024
291 typedef struct ir_builder_s
294 ir_function **functions;
302 ir_value **extparams;
304 const char **filenames;
306 /* we cache the #IMMEDIATE string here */
310 ir_builder* ir_builder_new(const char *modulename);
311 void ir_builder_delete(ir_builder*);
313 bool ir_builder_set_name(ir_builder *self, const char *name);
315 ir_function* ir_builder_get_function(ir_builder*, const char *fun);
316 ir_function* ir_builder_create_function(ir_builder*, const char *name, int outtype);
318 ir_value* ir_builder_get_global(ir_builder*, const char *fun);
319 ir_value* ir_builder_create_global(ir_builder*, const char *name, int vtype);
320 ir_value* ir_builder_get_field(ir_builder*, const char *fun);
321 ir_value* ir_builder_create_field(ir_builder*, const char *name, int vtype);
323 bool ir_builder_generate(ir_builder *self, const char *filename);
325 void ir_builder_dump(ir_builder*, int (*oprintf)(const char*, ...));
327 /* This code assumes 32 bit floats while generating binary */
328 extern int check_int_and_float_size
329 [ (sizeof(int32_t) == sizeof(qcfloat)) ? 1 : -1 ];