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 struct ir_instr_s **reads;
47 struct ir_instr_s **writes;
57 struct ir_value_s *vpointer;
58 struct ir_function_s *vfunc;
64 /* filled by the local-allocator */
66 /* added for members */
70 /* for acessing vectors */
71 struct ir_value_s *members[3];
72 struct ir_value_s *memberof;
74 /* For the temp allocator */
75 ir_life_entry_t *life;
78 int32_t ir_value_code_addr(const ir_value*);
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
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);
90 bool GMQCC_WARN vec_ir_value_find(ir_value **vec, ir_value *what, size_t *idx);
92 bool GMQCC_WARN ir_value_set_float(ir_value*, float f);
93 bool GMQCC_WARN ir_value_set_func(ir_value*, int f);
95 bool GMQCC_WARN ir_value_set_int(ir_value*, int i);
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); */
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*);
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*,...));
116 typedef struct ir_phi_entry_s
119 struct ir_block_s *from;
123 typedef struct ir_instr_s
128 struct ir_block_s* (bops[2]);
133 /* For the temp-allocation */
136 struct ir_block_s *owner;
139 ir_instr* ir_instr_new(struct ir_block_s *owner, int opcode);
140 void ir_instr_delete(ir_instr*);
142 bool GMQCC_WARN vec_ir_instr_find(ir_instr **vec, ir_instr *what, size_t *idx);
144 bool GMQCC_WARN ir_instr_op(ir_instr*, int op, ir_value *value, bool writing);
146 void ir_instr_dump(ir_instr* in, char *ind, int (*oprintf)(const char*,...));
149 typedef struct ir_block_s
153 bool final; /* once a jump is added we're done */
156 struct ir_block_s **entries;
157 struct ir_block_s **exits;
160 /* For the temp-allocation */
165 struct ir_function_s *owner;
171 ir_block* ir_block_new(struct ir_function_s *owner, const char *label);
172 void ir_block_delete(ir_block*);
174 bool ir_block_set_label(ir_block*, const char *label);
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,
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);
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);
187 ir_value* ir_block_create_fieldaddress(ir_block*, const char *label, ir_value *entity, ir_value *field);
189 /* This is to create an instruction of the form
190 * <outtype>%label := opcode a, b
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);
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*);
206 bool GMQCC_WARN ir_block_create_return(ir_block*, ir_value *opt_value);
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.
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);
219 void ir_block_dump(ir_block*, char *ind, int (*oprintf)(const char*,...));
223 typedef struct ir_function_s
234 /* values generated from operations
235 * which might get optimized away, so anything
236 * in there needs to be deleted in the dtor.
240 /* locally defined variables */
243 size_t allocated_locals;
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
256 qcint code_function_def;
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 void ir_function_collect_value(ir_function*, ir_value *value);
269 bool ir_function_set_name(ir_function*, const char *name);
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);
274 bool GMQCC_WARN ir_function_finalize(ir_function*);
276 bool ir_function_naive_phi(ir_function*);
277 bool ir_function_enumerate(ir_function*);
278 bool ir_function_calculate_liferanges(ir_function*);
281 ir_block* ir_function_create_block(ir_function*, const char *label);
283 void ir_function_dump(ir_function*, char *ind, int (*oprintf)(const char*,...));
286 typedef struct ir_builder_s
289 ir_function **functions;
293 const char **filenames;
295 /* we cache the #IMMEDIATE string here */
299 ir_builder* ir_builder_new(const char *modulename);
300 void ir_builder_delete(ir_builder*);
302 bool ir_builder_set_name(ir_builder *self, const char *name);
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);
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);
312 bool ir_builder_generate(ir_builder *self, const char *filename);
314 void ir_builder_dump(ir_builder*, int (*oprintf)(const char*, ...));
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 ];