2 * Copyright (C) 2012, 2013
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 */
70 /* to generate field-addresses early */
74 /* for acessing vectors */
75 struct ir_value_s *members[3];
76 struct ir_value_s *memberof;
78 /* arrays will never overlap with temps */
80 /* temps living during a CALL must be locked */
84 /* For the temp allocator */
85 ir_life_entry_t *life;
88 int32_t ir_value_code_addr(const ir_value*);
90 /* ir_value can be a variable, or created by an operation */
91 ir_value* ir_value_var(const char *name, int st, int vtype);
92 /* if a result of an operation: the function should store
93 * it to remember to delete it / garbage collect it
95 ir_value* ir_value_out(struct ir_function_s *owner, const char *name, int st, int vtype);
96 void ir_value_delete(ir_value*);
97 bool ir_value_set_name(ir_value*, const char *name);
98 ir_value* ir_value_vector_member(ir_value*, unsigned int member);
100 bool GMQCC_WARN vec_ir_value_find(ir_value **vec, const ir_value *what, size_t *idx);
102 bool GMQCC_WARN ir_value_set_float(ir_value*, float f);
103 bool GMQCC_WARN ir_value_set_func(ir_value*, int f);
105 bool GMQCC_WARN ir_value_set_int(ir_value*, int i);
107 bool GMQCC_WARN ir_value_set_string(ir_value*, const char *s);
108 bool GMQCC_WARN ir_value_set_vector(ir_value*, vector v);
109 bool GMQCC_WARN ir_value_set_field(ir_value*, ir_value *fld);
110 /*bool ir_value_set_pointer_v(ir_value*, ir_value* p); */
111 /*bool ir_value_set_pointer_i(ir_value*, int i); */
113 /* merge an instruction into the life-range */
114 /* returns false if the lifepoint was already known */
115 bool ir_value_life_merge(ir_value*, size_t);
116 bool ir_value_life_merge_into(ir_value*, const ir_value*);
117 /* check if a value lives at a specific point */
118 bool ir_value_lives(ir_value*, size_t);
119 /* check if the life-range of 2 values overlaps */
120 bool ir_values_overlap(const ir_value*, const ir_value*);
122 void ir_value_dump(ir_value*, int (*oprintf)(const char*,...));
123 void ir_value_dump_life(const ir_value *self, int (*oprintf)(const char*,...));
126 typedef struct ir_phi_entry_s
129 struct ir_block_s *from;
133 typedef struct ir_instr_s
138 struct ir_block_s* (bops[2]);
143 /* For the temp-allocation */
149 struct ir_block_s *owner;
152 ir_instr* ir_instr_new(lex_ctx ctx, struct ir_block_s *owner, int opcode);
153 void ir_instr_delete(ir_instr*);
155 bool GMQCC_WARN vec_ir_instr_find(ir_instr **vec, ir_instr *what, size_t *idx);
157 bool ir_instr_op(ir_instr*, int op, ir_value *value, bool writing);
159 void ir_instr_dump(ir_instr* in, char *ind, int (*oprintf)(const char*,...));
162 typedef struct ir_block_s
166 bool final; /* once a jump is added we're done */
169 struct ir_block_s **entries;
170 struct ir_block_s **exits;
173 /* For the temp-allocation */
179 struct ir_function_s *owner;
185 ir_block* ir_block_new(struct ir_function_s *owner, const char *label);
186 void ir_block_delete(ir_block*);
188 bool ir_block_set_label(ir_block*, const char *label);
190 ir_value* ir_block_create_binop(ir_block*, lex_ctx, const char *label, int op,
191 ir_value *left, ir_value *right);
192 ir_value* ir_block_create_unary(ir_block*, lex_ctx, const char *label, int op,
194 bool GMQCC_WARN ir_block_create_store_op(ir_block*, lex_ctx, int op, ir_value *target, ir_value *what);
195 bool GMQCC_WARN ir_block_create_store(ir_block*, lex_ctx, ir_value *target, ir_value *what);
196 bool GMQCC_WARN ir_block_create_storep(ir_block*, lex_ctx, ir_value *target, ir_value *what);
198 /* field must be of TYPE_FIELD */
199 ir_value* ir_block_create_load_from_ent(ir_block*, lex_ctx, const char *label, ir_value *ent, ir_value *field, int outype);
201 ir_value* ir_block_create_fieldaddress(ir_block*, lex_ctx, const char *label, ir_value *entity, ir_value *field);
203 /* This is to create an instruction of the form
204 * <outtype>%label := opcode a, b
206 ir_value* ir_block_create_general_instr(ir_block *self, lex_ctx, const char *label,
207 int op, ir_value *a, ir_value *b, int outype);
209 ir_instr* ir_block_create_phi(ir_block*, lex_ctx, const char *label, int vtype);
210 ir_value* ir_phi_value(ir_instr*);
211 void ir_phi_add(ir_instr*, ir_block *b, ir_value *v);
212 ir_instr* ir_block_create_call(ir_block*, lex_ctx, const char *label, ir_value *func, bool noreturn);
213 ir_value* ir_call_value(ir_instr*);
214 void ir_call_param(ir_instr*, ir_value*);
216 bool GMQCC_WARN ir_block_create_return(ir_block*, lex_ctx, ir_value *opt_value);
218 bool GMQCC_WARN ir_block_create_if(ir_block*, lex_ctx, ir_value *cond,
219 ir_block *ontrue, ir_block *onfalse);
220 /* A 'goto' is an actual 'goto' coded in QC, whereas
221 * a 'jump' is a virtual construct which simply names the
222 * next block to go to.
223 * A goto usually becomes an OP_GOTO in the resulting code,
224 * whereas a 'jump' usually doesn't add any actual instruction.
226 bool GMQCC_WARN ir_block_create_jump(ir_block*, lex_ctx, ir_block *to);
227 bool GMQCC_WARN ir_block_create_goto(ir_block*, lex_ctx, ir_block *to);
229 void ir_block_dump(ir_block*, char *ind, int (*oprintf)(const char*,...));
233 typedef struct ir_function_s
246 /* values generated from operations
247 * which might get optimized away, so anything
248 * in there needs to be deleted in the dtor.
252 /* locally defined variables */
255 size_t allocated_locals;
263 /* for prototypes - first we generate all the
264 * globals, and we remember teh function-defs
265 * so we can later fill in the entry pos
269 qcint code_function_def;
271 /* for temp allocation */
274 struct ir_builder_s *owner;
276 #define IR_FLAG_HAS_ARRAYS (1<<1)
277 #define IR_FLAG_HAS_UNINITIALIZED (1<<2)
278 #define IR_FLAG_HAS_GOTO (1<<3)
279 #define IR_FLAG_MASK_NO_OVERLAP (IR_FLAG_HAS_ARRAYS | IR_FLAG_HAS_UNINITIALIZED)
281 ir_function* ir_function_new(struct ir_builder_s *owner, int returntype);
282 void ir_function_delete(ir_function*);
284 void ir_function_collect_value(ir_function*, ir_value *value);
286 bool ir_function_set_name(ir_function*, const char *name);
288 ir_value* ir_function_create_local(ir_function *self, const char *name, int vtype, bool param);
290 bool GMQCC_WARN ir_function_finalize(ir_function*);
292 bool ir_function_naive_phi(ir_function*);
293 bool ir_function_enumerate(ir_function*);
294 bool ir_function_calculate_liferanges(ir_function*);
297 ir_block* ir_function_create_block(lex_ctx ctx, ir_function*, const char *label);
299 void ir_function_dump(ir_function*, char *ind, int (*oprintf)(const char*,...));
302 #define IR_HT_SIZE 1024
303 typedef struct ir_builder_s
306 ir_function **functions;
314 ir_value **extparams;
315 ir_value **extparam_protos;
317 /* the highest func->allocated_locals */
319 size_t max_globaltemps;
320 uint32_t first_common_local;
321 uint32_t first_common_globaltemp;
323 const char **filenames;
325 /* we cache the #IMMEDIATE string here */
327 /* there should just be this one nil */
331 ir_builder* ir_builder_new(const char *modulename);
332 void ir_builder_delete(ir_builder*);
334 bool ir_builder_set_name(ir_builder *self, const char *name);
336 ir_function* ir_builder_get_function(ir_builder*, const char *fun);
337 ir_function* ir_builder_create_function(ir_builder*, const char *name, int outtype);
339 ir_value* ir_builder_get_global(ir_builder*, const char *fun);
340 ir_value* ir_builder_create_global(ir_builder*, const char *name, int vtype);
341 ir_value* ir_builder_get_field(ir_builder*, const char *fun);
342 ir_value* ir_builder_create_field(ir_builder*, const char *name, int vtype);
344 bool ir_builder_generate(ir_builder *self, const char *filename);
346 void ir_builder_dump(ir_builder*, int (*oprintf)(const char*, ...));
348 /* This code assumes 32 bit floats while generating binary */
349 extern int check_int_and_float_size
350 [ (sizeof(int32_t) == sizeof(qcfloat)) ? 1 : -1 ];