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
35 typedef struct ir_value_s {
40 /* even the IR knows the subtype of a field */
42 /* and the output type of a function */
44 /* '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 /* ir_value can be a variable, or created by an operation */
89 /* if a result of an operation: the function should store
90 * it to remember to delete it / garbage collect it
92 void ir_value_delete(ir_value*);
93 ir_value* ir_value_vector_member(ir_value*, unsigned int member);
94 bool GMQCC_WARN ir_value_set_float(ir_value*, float f);
95 bool GMQCC_WARN ir_value_set_func(ir_value*, int f);
96 bool GMQCC_WARN ir_value_set_string(ir_value*, const char *s);
97 bool GMQCC_WARN ir_value_set_vector(ir_value*, vec3_t v);
98 bool GMQCC_WARN ir_value_set_field(ir_value*, ir_value *fld);
99 bool ir_value_lives(ir_value*, size_t);
100 void ir_value_dump_life(const ir_value *self, int (*oprintf)(const char*,...));
103 typedef struct ir_phi_entry_s
106 struct ir_block_s *from;
110 typedef struct ir_instr_s
115 struct ir_block_s* (bops[2]);
120 /* For the temp-allocation */
126 struct ir_block_s *owner;
130 typedef struct ir_block_s
134 bool final; /* once a jump is added we're done */
137 struct ir_block_s **entries;
138 struct ir_block_s **exits;
141 /* For the temp-allocation */
146 struct ir_function_s *owner;
152 ir_value* ir_block_create_binop(ir_block*, lex_ctx_t, const char *label, int op, ir_value *left, ir_value *right);
153 ir_value* ir_block_create_unary(ir_block*, lex_ctx_t, const char *label, int op, ir_value *operand);
154 bool GMQCC_WARN ir_block_create_store_op(ir_block*, lex_ctx_t, int op, ir_value *target, ir_value *what);
155 bool GMQCC_WARN ir_block_create_storep(ir_block*, lex_ctx_t, ir_value *target, ir_value *what);
156 ir_value* ir_block_create_load_from_ent(ir_block*, lex_ctx_t, const char *label, ir_value *ent, ir_value *field, int outype);
157 ir_value* ir_block_create_fieldaddress(ir_block*, lex_ctx_t, const char *label, ir_value *entity, ir_value *field);
159 /* This is to create an instruction of the form
160 * <outtype>%label := opcode a, b
162 ir_instr* ir_block_create_phi(ir_block*, lex_ctx_t, const char *label, int vtype);
163 ir_value* ir_phi_value(ir_instr*);
164 void ir_phi_add(ir_instr*, ir_block *b, ir_value *v);
165 ir_instr* ir_block_create_call(ir_block*, lex_ctx_t, const char *label, ir_value *func, bool noreturn);
166 ir_value* ir_call_value(ir_instr*);
167 void ir_call_param(ir_instr*, ir_value*);
169 bool GMQCC_WARN ir_block_create_return(ir_block*, lex_ctx_t, ir_value *opt_value);
171 bool GMQCC_WARN ir_block_create_if(ir_block*, lex_ctx_t, ir_value *cond,
172 ir_block *ontrue, ir_block *onfalse);
173 /* A 'goto' is an actual 'goto' coded in QC, whereas
174 * a 'jump' is a virtual construct which simply names the
175 * next block to go to.
176 * A goto usually becomes an OP_GOTO in the resulting code,
177 * whereas a 'jump' usually doesn't add any actual instruction.
179 bool GMQCC_WARN ir_block_create_jump(ir_block*, lex_ctx_t, ir_block *to);
180 bool GMQCC_WARN ir_block_create_goto(ir_block*, lex_ctx_t, ir_block *to);
183 typedef struct ir_function_s
196 /* values generated from operations
197 * which might get optimized away, so anything
198 * in there needs to be deleted in the dtor.
202 /* locally defined variables */
205 size_t allocated_locals;
213 /* for prototypes - first we generate all the
214 * globals, and we remember teh function-defs
215 * so we can later fill in the entry pos
219 qcint_t code_function_def;
221 /* for temp allocation */
224 struct ir_builder_s *owner;
226 /* vararg support: */
230 #define IR_FLAG_HAS_ARRAYS (1<<1)
231 #define IR_FLAG_HAS_UNINITIALIZED (1<<2)
232 #define IR_FLAG_HAS_GOTO (1<<3)
233 #define IR_FLAG_INCLUDE_DEF (1<<4)
234 #define IR_FLAG_MASK_NO_OVERLAP (IR_FLAG_HAS_ARRAYS | IR_FLAG_HAS_UNINITIALIZED)
235 #define IR_FLAG_MASK_NO_LOCAL_TEMPS (IR_FLAG_HAS_ARRAYS | IR_FLAG_HAS_UNINITIALIZED)
237 ir_value* ir_function_create_local(ir_function *self, const char *name, int vtype, bool param);
238 bool GMQCC_WARN ir_function_finalize(ir_function*);
239 ir_block* ir_function_create_block(lex_ctx_t ctx, ir_function*, const char *label);
242 #define IR_HT_SIZE 1024
243 #define IR_MAX_VINSTR_TEMPS 1
244 typedef struct ir_builder_s
247 ir_function **functions;
255 ir_value **extparams;
256 ir_value **extparam_protos;
258 /* the highest func->allocated_locals */
260 size_t max_globaltemps;
261 uint32_t first_common_local;
262 uint32_t first_common_globaltemp;
264 const char **filenames;
265 qcint_t *filestrings;
266 /* we cache the #IMMEDIATE string here */
267 qcint_t str_immediate;
268 /* there should just be this one nil */
270 ir_value *reserved_va_count;
271 /* some virtual instructions require temps, and their code is isolated
272 * so that we don't need to keep track of their liveness.
274 ir_value *vinstr_temp[IR_MAX_VINSTR_TEMPS];
280 ir_builder* ir_builder_new(const char *modulename);
281 void ir_builder_delete(ir_builder*);
282 ir_function* ir_builder_create_function(ir_builder*, const char *name, int outtype);
283 ir_value* ir_builder_create_global(ir_builder*, const char *name, int vtype);
284 ir_value* ir_builder_create_field(ir_builder*, const char *name, int vtype);
285 ir_value* ir_builder_get_va_count(ir_builder*);
286 bool ir_builder_generate(ir_builder *self, const char *filename);
287 void ir_builder_dump(ir_builder*, int (*oprintf)(const char*, ...));
290 * This code assumes 32 bit floats while generating binary
291 * Blub: don't use extern here, it's annoying and shows up in nm
294 typedef int static_assert_is_32bit_float [(sizeof(int32_t) == 4)?1:-1];
295 typedef int static_assert_is_32bit_integer[(sizeof(qcfloat_t) == 4)?1:-1];