Make it a function
[xonotic/gmqcc.git] / ir.h
1 /*
2  * Copyright (C) 2012, 2013, 2014
3  *     Wolfgang Bumiller
4  *
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:
11  *
12  * The above copyright notice and this permission notice shall be included in all
13  * copies or substantial portions of the Software.
14  *
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
21  * SOFTWARE.
22  */
23 #ifndef GMQCC_IR_HDR
24 #define GMQCC_IR_HDR
25 #include "gmqcc.h"
26
27 /*
28  * Type large enough to hold all the possible IR flags. This should be
29  * changed if the static assertion at the end of this file fails.
30  */
31 typedef uint8_t ir_flag_t;
32
33 typedef struct ir_value_s    ir_value;
34 typedef struct ir_instr_s    ir_instr;
35 typedef struct ir_block_s    ir_block;
36 typedef struct ir_function_s ir_function;
37 typedef struct ir_builder_s  ir_builder;
38
39 typedef struct {
40     /* both inclusive */
41     size_t start;
42     size_t end;
43 } ir_life_entry_t;
44
45 enum {
46     IR_FLAG_HAS_ARRAYS           = 1 << 0,
47     IR_FLAG_HAS_UNINITIALIZED    = 1 << 1,
48     IR_FLAG_HAS_GOTO             = 1 << 2,
49     IR_FLAG_INCLUDE_DEF          = 1 << 3,
50     IR_FLAG_ERASEABLE            = 1 << 4,
51     IR_FLAG_BLOCK_COVERAGE       = 1 << 5,
52
53     IR_FLAG_LAST,
54     IR_FLAG_MASK_NO_OVERLAP      = (IR_FLAG_HAS_ARRAYS | IR_FLAG_HAS_UNINITIALIZED),
55     IR_FLAG_MASK_NO_LOCAL_TEMPS  = (IR_FLAG_HAS_ARRAYS | IR_FLAG_HAS_UNINITIALIZED)
56 };
57
58 struct ir_value_s {
59     char      *name;
60     int        vtype;
61     int        store;
62     lex_ctx_t  context;
63
64
65     int       fieldtype; /* even the IR knows the subtype of a field */
66     int       outtype;   /* and the output type of a function        */
67     int       cvq;       /* 'const' vs 'var' qualifier               */
68     ir_flag_t flags;
69
70     ir_instr **reads;
71     ir_instr **writes;
72
73     /* constantvalues */
74     bool hasvalue;
75     union {
76         qcfloat_t   vfloat;
77         int         vint;
78         vec3_t      vvec;
79         int32_t     ivec[3];
80         char        *vstring;
81         ir_value    *vpointer;
82         ir_function *vfunc;
83     } constval;
84
85     struct {
86         int32_t globaladdr;
87         int32_t name;
88         int32_t local;         /* filled by the local-allocator     */
89         int32_t addroffset;    /* added for members                 */
90         int32_t fieldaddr;     /* to generate field-addresses early */
91     } code;
92
93     /* for acessing vectors */
94     ir_value *members[3];
95     ir_value *memberof;
96
97
98     bool unique_life;      /* arrays will never overlap with temps      */
99     bool locked;           /* temps living during a CALL must be locked */
100     bool callparam;
101
102     ir_life_entry_t *life; /* For the temp allocator */
103 };
104
105 /*
106  * ir_value can be a variable, or created by an operation
107  * if a result of an operation: the function should store
108  * it to remember to delete it / garbage collect it
109  */
110 void            ir_value_delete(ir_value*);
111 ir_value*       ir_value_vector_member(ir_value*, unsigned int member);
112 bool GMQCC_WARN ir_value_set_float(ir_value*, float f);
113 bool GMQCC_WARN ir_value_set_func(ir_value*, int f);
114 bool GMQCC_WARN ir_value_set_string(ir_value*, const char *s);
115 bool GMQCC_WARN ir_value_set_vector(ir_value*, vec3_t v);
116 bool GMQCC_WARN ir_value_set_field(ir_value*, ir_value *fld);
117 bool            ir_value_lives(ir_value*, size_t);
118 void            ir_value_dump_life(const ir_value *self, int (*oprintf)(const char*,...));
119
120 /* PHI data */
121 typedef struct ir_phi_entry_s {
122     ir_value *value;
123     ir_block *from;
124 } ir_phi_entry_t;
125
126 /* instruction */
127 struct ir_instr_s {
128     int        opcode;
129     lex_ctx_t  context;
130     ir_value* (_ops[3]);
131     ir_block* (bops[2]);
132
133     ir_phi_entry_t *phi;
134     ir_value      **params;
135
136     /* For the temp-allocation */
137     size_t eid;
138
139     /* For IFs */
140     bool   likely;
141
142     ir_block *owner;
143 };
144
145 /* block */
146 struct ir_block_s {
147     char      *label;
148     lex_ctx_t  context;
149     bool       final; /* once a jump is added we're done */
150
151     ir_instr **instr;
152     ir_block **entries;
153     ir_block **exits;
154     ir_value **living;
155
156     /* For the temp-allocation */
157     size_t entry_id;
158     size_t eid;
159     bool   is_return;
160
161     ir_function *owner;
162
163     bool   generated;
164     size_t code_start;
165 };
166
167 ir_value*       ir_block_create_binop(ir_block*, lex_ctx_t, const char *label, int op, ir_value *left, ir_value *right);
168 ir_value*       ir_block_create_unary(ir_block*, lex_ctx_t, const char *label, int op, ir_value *operand);
169 bool GMQCC_WARN ir_block_create_store_op(ir_block*, lex_ctx_t, int op, ir_value *target, ir_value *what);
170 bool GMQCC_WARN ir_block_create_storep(ir_block*, lex_ctx_t, ir_value *target, ir_value *what);
171 ir_value*       ir_block_create_load_from_ent(ir_block*, lex_ctx_t, const char *label, ir_value *ent, ir_value *field, int outype);
172 ir_value*       ir_block_create_fieldaddress(ir_block*, lex_ctx_t, const char *label, ir_value *entity, ir_value *field);
173 bool GMQCC_WARN ir_block_create_state_op(ir_block*, lex_ctx_t, ir_value *frame, ir_value *think);
174
175 /* This is to create an instruction of the form
176  * <outtype>%label := opcode a, b
177  */
178 ir_instr* ir_block_create_phi(ir_block*, lex_ctx_t, const char *label, int vtype);
179 ir_value* ir_phi_value(ir_instr*);
180 void ir_phi_add(ir_instr*, ir_block *b, ir_value *v);
181 ir_instr* ir_block_create_call(ir_block*, lex_ctx_t, const char *label, ir_value *func, bool noreturn);
182 ir_value* ir_call_value(ir_instr*);
183 void ir_call_param(ir_instr*, ir_value*);
184
185 bool GMQCC_WARN ir_block_create_return(ir_block*, lex_ctx_t, ir_value *opt_value);
186
187 bool GMQCC_WARN ir_block_create_if(ir_block*, lex_ctx_t, ir_value *cond,
188                                    ir_block *ontrue, ir_block *onfalse);
189 /*
190  * A 'goto' is an actual 'goto' coded in QC, whereas
191  * a 'jump' is a virtual construct which simply names the
192  * next block to go to.
193  * A goto usually becomes an OP_GOTO in the resulting code,
194  * whereas a 'jump' usually doesn't add any actual instruction.
195  */
196 bool GMQCC_WARN ir_block_create_jump(ir_block*, lex_ctx_t, ir_block *to);
197 bool GMQCC_WARN ir_block_create_goto(ir_block*, lex_ctx_t, ir_block *to);
198
199 /* function */
200 struct ir_function_s {
201     char      *name;
202     int        outtype;
203     int       *params;
204     ir_block **blocks;
205     ir_flag_t  flags;
206     int        builtin;
207
208     /*
209      * values generated from operations
210      * which might get optimized away, so anything
211      * in there needs to be deleted in the dtor.
212      */
213     ir_value **values;
214     ir_value **locals;     /* locally defined variables */
215     ir_value *value;
216
217     size_t allocated_locals;
218     size_t globaltemps;
219
220     ir_block*  first;
221     ir_block*  last;
222
223     lex_ctx_t  context;
224
225     /*
226      * for prototypes - first we generate all the
227      * globals, and we remember teh function-defs
228      * so we can later fill in the entry pos
229      *
230      * remember the ID:
231      */
232     qcint_t code_function_def;
233
234     /* for temp allocation */
235     size_t run_id;
236
237     ir_builder *owner;
238
239     /* vararg support: */
240     size_t max_varargs;
241 };
242
243
244 ir_value*       ir_function_create_local(ir_function *self, const char *name, int vtype, bool param);
245 bool GMQCC_WARN ir_function_finalize(ir_function*);
246 ir_block*       ir_function_create_block(lex_ctx_t ctx, ir_function*, const char *label);
247
248 /* builder */
249 #define IR_HT_SIZE          1024
250 #define IR_MAX_VINSTR_TEMPS 1
251
252 struct ir_builder_s {
253     char *name;
254     ir_function **functions;
255     ir_value    **globals;
256     ir_value    **fields;
257
258     ht            htfunctions;
259     ht            htglobals;
260     ht            htfields;
261
262     ir_value    **extparams;
263     ir_value    **extparam_protos;
264
265     /* the highest func->allocated_locals */
266     size_t        max_locals;
267     size_t        max_globaltemps;
268     uint32_t      first_common_local;
269     uint32_t      first_common_globaltemp;
270
271     const char **filenames;
272     qcint_t     *filestrings;
273     /* we cache the #IMMEDIATE string here */
274     qcint_t      str_immediate;
275     /* there should just be this one nil */
276     ir_value    *nil;
277     ir_value    *reserved_va_count;
278     ir_value    *coverage_func;
279     /* some virtual instructions require temps, and their code is isolated
280      * so that we don't need to keep track of their liveness.
281      */
282     ir_value    *vinstr_temp[IR_MAX_VINSTR_TEMPS];
283
284     /* code generator */
285     code_t      *code;
286 };
287
288 ir_builder*  ir_builder_new(const char *modulename);
289 void         ir_builder_delete(ir_builder*);
290 ir_function* ir_builder_create_function(ir_builder*, const char *name, int outtype);
291 ir_value*    ir_builder_create_global(ir_builder*, const char *name, int vtype);
292 ir_value*    ir_builder_create_field(ir_builder*, const char *name, int vtype);
293 ir_value*    ir_builder_get_va_count(ir_builder*);
294 bool         ir_builder_generate(ir_builder *self, const char *filename);
295 void         ir_builder_dump(ir_builder*, int (*oprintf)(const char*, ...));
296
297 /*
298  * This code assumes 32 bit floats while generating binary
299  * Blub: don't use extern here, it's annoying and shows up in nm
300  * for some reason :P
301  */
302 typedef int static_assert_is_32bit_float  [(sizeof(int32_t) == 4)   ? 1 : -1];
303 typedef int static_assert_is_32bit_integer[(sizeof(qcfloat_t) == 4) ? 1 : -1];
304
305 /*
306  * If the condition creates a situation where this becomes -1 size it means there are
307  * more IR_FLAGs than the type ir_flag_t is capable of holding. So either eliminate
308  * the IR flag count or change the ir_flag_t typedef to a type large enough to accomodate
309  * all the flags.
310  */
311 typedef int static_assert_is_ir_flag_safe [((IR_FLAG_LAST) <= (ir_flag_t)(-1)) ? 1 : -1];
312
313 #endif