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 */
49 struct ir_instr_s **reads;
50 struct ir_instr_s **writes;
60 struct ir_value_s *vpointer;
61 struct ir_function_s *vfunc;
67 /* filled by the local-allocator */
69 /* added for members */
71 /* to generate field-addresses early */
75 /* for acessing vectors */
76 struct ir_value_s *members[3];
77 struct ir_value_s *memberof;
79 /* arrays will never overlap with temps */
81 /* temps living during a CALL must be locked */
85 /* For the temp allocator */
86 ir_life_entry_t *life;
89 int32_t ir_value_code_addr(const ir_value*);
91 /* ir_value can be a variable, or created by an operation */
92 ir_value* ir_value_var(const char *name, int st, int vtype);
93 /* if a result of an operation: the function should store
94 * it to remember to delete it / garbage collect it
96 ir_value* ir_value_out(struct ir_function_s *owner, const char *name, int st, int vtype);
97 void ir_value_delete(ir_value*);
98 bool ir_value_set_name(ir_value*, const char *name);
99 ir_value* ir_value_vector_member(ir_value*, unsigned int member);
101 bool GMQCC_WARN vec_ir_value_find(ir_value **vec, const ir_value *what, size_t *idx);
103 bool GMQCC_WARN ir_value_set_float(ir_value*, float f);
104 bool GMQCC_WARN ir_value_set_func(ir_value*, int f);
106 bool GMQCC_WARN ir_value_set_int(ir_value*, int i);
108 bool GMQCC_WARN ir_value_set_string(ir_value*, const char *s);
109 bool GMQCC_WARN ir_value_set_vector(ir_value*, vector v);
110 bool GMQCC_WARN ir_value_set_field(ir_value*, ir_value *fld);
111 /*bool ir_value_set_pointer_v(ir_value*, ir_value* p); */
112 /*bool ir_value_set_pointer_i(ir_value*, int i); */
114 /* merge an instruction into the life-range */
115 /* returns false if the lifepoint was already known */
116 bool ir_value_life_merge(ir_value*, size_t);
117 bool ir_value_life_merge_into(ir_value*, const ir_value*);
118 /* check if a value lives at a specific point */
119 bool ir_value_lives(ir_value*, size_t);
120 /* check if the life-range of 2 values overlaps */
121 bool ir_values_overlap(const ir_value*, const ir_value*);
123 void ir_value_dump(ir_value*, int (*oprintf)(const char*,...));
124 void ir_value_dump_life(const ir_value *self, int (*oprintf)(const char*,...));
127 typedef struct ir_phi_entry_s
130 struct ir_block_s *from;
134 typedef struct ir_instr_s
139 struct ir_block_s* (bops[2]);
144 /* For the temp-allocation */
150 struct ir_block_s *owner;
153 ir_instr* ir_instr_new(lex_ctx ctx, struct ir_block_s *owner, int opcode);
154 void ir_instr_delete(ir_instr*);
156 bool GMQCC_WARN vec_ir_instr_find(ir_instr **vec, ir_instr *what, size_t *idx);
158 bool ir_instr_op(ir_instr*, int op, ir_value *value, bool writing);
160 void ir_instr_dump(ir_instr* in, char *ind, int (*oprintf)(const char*,...));
163 typedef struct ir_block_s
167 bool final; /* once a jump is added we're done */
170 struct ir_block_s **entries;
171 struct ir_block_s **exits;
174 /* For the temp-allocation */
180 struct ir_function_s *owner;
186 ir_block* ir_block_new(struct ir_function_s *owner, const char *label);
187 void ir_block_delete(ir_block*);
189 bool ir_block_set_label(ir_block*, const char *label);
191 ir_value* ir_block_create_binop(ir_block*, lex_ctx, const char *label, int op,
192 ir_value *left, ir_value *right);
193 ir_value* ir_block_create_unary(ir_block*, lex_ctx, const char *label, int op,
195 bool GMQCC_WARN ir_block_create_store_op(ir_block*, lex_ctx, int op, ir_value *target, ir_value *what);
196 bool GMQCC_WARN ir_block_create_store(ir_block*, lex_ctx, ir_value *target, ir_value *what);
197 bool GMQCC_WARN ir_block_create_storep(ir_block*, lex_ctx, ir_value *target, ir_value *what);
199 /* field must be of TYPE_FIELD */
200 ir_value* ir_block_create_load_from_ent(ir_block*, lex_ctx, const char *label, ir_value *ent, ir_value *field, int outype);
202 ir_value* ir_block_create_fieldaddress(ir_block*, lex_ctx, const char *label, ir_value *entity, ir_value *field);
204 /* This is to create an instruction of the form
205 * <outtype>%label := opcode a, b
207 ir_value* ir_block_create_general_instr(ir_block *self, lex_ctx, const char *label,
208 int op, ir_value *a, ir_value *b, int outype);
210 ir_instr* ir_block_create_phi(ir_block*, lex_ctx, const char *label, int vtype);
211 ir_value* ir_phi_value(ir_instr*);
212 void ir_phi_add(ir_instr*, ir_block *b, ir_value *v);
213 ir_instr* ir_block_create_call(ir_block*, lex_ctx, const char *label, ir_value *func, bool noreturn);
214 ir_value* ir_call_value(ir_instr*);
215 void ir_call_param(ir_instr*, ir_value*);
217 bool GMQCC_WARN ir_block_create_return(ir_block*, lex_ctx, ir_value *opt_value);
219 bool GMQCC_WARN ir_block_create_if(ir_block*, lex_ctx, ir_value *cond,
220 ir_block *ontrue, ir_block *onfalse);
221 /* A 'goto' is an actual 'goto' coded in QC, whereas
222 * a 'jump' is a virtual construct which simply names the
223 * next block to go to.
224 * A goto usually becomes an OP_GOTO in the resulting code,
225 * whereas a 'jump' usually doesn't add any actual instruction.
227 bool GMQCC_WARN ir_block_create_jump(ir_block*, lex_ctx, ir_block *to);
228 bool GMQCC_WARN ir_block_create_goto(ir_block*, lex_ctx, ir_block *to);
230 void ir_block_dump(ir_block*, char *ind, int (*oprintf)(const char*,...));
234 typedef struct ir_function_s
247 /* values generated from operations
248 * which might get optimized away, so anything
249 * in there needs to be deleted in the dtor.
253 /* locally defined variables */
256 size_t allocated_locals;
264 /* for prototypes - first we generate all the
265 * globals, and we remember teh function-defs
266 * so we can later fill in the entry pos
270 qcint code_function_def;
272 /* for temp allocation */
275 struct ir_builder_s *owner;
277 /* vararg support: */
280 #define IR_FLAG_HAS_ARRAYS (1<<1)
281 #define IR_FLAG_HAS_UNINITIALIZED (1<<2)
282 #define IR_FLAG_HAS_GOTO (1<<3)
283 #define IR_FLAG_INCLUDE_DEF (1<<4)
284 #define IR_FLAG_MASK_NO_OVERLAP (IR_FLAG_HAS_ARRAYS | IR_FLAG_HAS_UNINITIALIZED)
285 #define IR_FLAG_MASK_NO_LOCAL_TEMPS (IR_FLAG_HAS_ARRAYS | IR_FLAG_HAS_UNINITIALIZED)
287 ir_function* ir_function_new(struct ir_builder_s *owner, int returntype);
288 void ir_function_delete(ir_function*);
290 void ir_function_collect_value(ir_function*, ir_value *value);
292 bool ir_function_set_name(ir_function*, const char *name);
294 ir_value* ir_function_create_local(ir_function *self, const char *name, int vtype, bool param);
296 bool GMQCC_WARN ir_function_finalize(ir_function*);
298 bool ir_function_naive_phi(ir_function*);
299 bool ir_function_enumerate(ir_function*);
300 bool ir_function_calculate_liferanges(ir_function*);
303 ir_block* ir_function_create_block(lex_ctx ctx, ir_function*, const char *label);
305 void ir_function_dump(ir_function*, char *ind, int (*oprintf)(const char*,...));
308 #define IR_HT_SIZE 1024
309 typedef struct ir_builder_s
312 ir_function **functions;
320 ir_value **extparams;
321 ir_value **extparam_protos;
323 /* the highest func->allocated_locals */
325 size_t max_globaltemps;
326 uint32_t first_common_local;
327 uint32_t first_common_globaltemp;
329 const char **filenames;
331 /* we cache the #IMMEDIATE string here */
333 /* there should just be this one nil */
335 ir_value *reserved_va_count;
338 ir_builder* ir_builder_new(const char *modulename);
339 void ir_builder_delete(ir_builder*);
341 bool ir_builder_set_name(ir_builder *self, const char *name);
343 ir_function* ir_builder_get_function(ir_builder*, const char *fun);
344 ir_function* ir_builder_create_function(ir_builder*, const char *name, int outtype);
346 ir_value* ir_builder_get_global(ir_builder*, const char *fun);
347 ir_value* ir_builder_create_global(ir_builder*, const char *name, int vtype);
348 ir_value* ir_builder_get_field(ir_builder*, const char *fun);
349 ir_value* ir_builder_create_field(ir_builder*, const char *name, int vtype);
351 ir_value* ir_builder_get_va_count(ir_builder*);
353 bool ir_builder_generate(ir_builder *self, const char *filename);
355 void ir_builder_dump(ir_builder*, int (*oprintf)(const char*, ...));
357 /* This code assumes 32 bit floats while generating binary */
358 extern int check_int_and_float_size
359 [ (sizeof(int32_t) == sizeof(qcfloat)) ? 1 : -1 ];