don't just store a 'bool constant' in the ast/ir, store the complete qualifier: ...
[xonotic/gmqcc.git] / ir.h
1 /*
2  * Copyright (C) 2012
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
26 /* ir_value */
27
28 typedef struct
29 {
30     /* both inclusive */
31     size_t start;
32     size_t end;
33 } ir_life_entry_t;
34
35 struct ir_function_s;
36 typedef struct ir_value_s {
37     char      *name;
38     int       vtype;
39     int       store;
40     lex_ctx   context;
41     /* even the IR knows the subtype of a field */
42     int       fieldtype;
43     /* and the output type of a function */
44     int       outtype;
45     /* 'const' vs 'var' qualifier */
46     int       cvq;
47
48     struct ir_instr_s **reads;
49     struct ir_instr_s **writes;
50
51     /* constantvalues */
52     bool hasvalue;
53     union {
54         float    vfloat;
55         int      vint;
56         vector   vvec;
57         int32_t  ivec[3];
58         char    *vstring;
59         struct ir_value_s *vpointer;
60         struct ir_function_s *vfunc;
61     } constval;
62
63     struct {
64         int32_t globaladdr;
65         int32_t name;
66         /* filled by the local-allocator */
67         int32_t local;
68         /* added for members */
69         int32_t addroffset;
70     } code;
71
72     /* for acessing vectors */
73     struct ir_value_s *members[3];
74     struct ir_value_s *memberof;
75
76     /* For the temp allocator */
77     ir_life_entry_t *life;
78 } ir_value;
79
80 int32_t ir_value_code_addr(const ir_value*);
81
82 /* ir_value can be a variable, or created by an operation */
83 ir_value* ir_value_var(const char *name, int st, int vtype);
84 /* if a result of an operation: the function should store
85  * it to remember to delete it / garbage collect it
86  */
87 ir_value* ir_value_out(struct ir_function_s *owner, const char *name, int st, int vtype);
88 void      ir_value_delete(ir_value*);
89 bool      ir_value_set_name(ir_value*, const char *name);
90 ir_value* ir_value_vector_member(ir_value*, unsigned int member);
91
92 bool GMQCC_WARN vec_ir_value_find(ir_value **vec, ir_value *what, size_t *idx);
93
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 #if 0
97 bool GMQCC_WARN ir_value_set_int(ir_value*, int i);
98 #endif
99 bool GMQCC_WARN ir_value_set_string(ir_value*, const char *s);
100 bool GMQCC_WARN ir_value_set_vector(ir_value*, vector v);
101 bool GMQCC_WARN ir_value_set_field(ir_value*, ir_value *fld);
102 /*bool   ir_value_set_pointer_v(ir_value*, ir_value* p); */
103 /*bool   ir_value_set_pointer_i(ir_value*, int i);       */
104
105 /* merge an instruction into the life-range */
106 /* returns false if the lifepoint was already known */
107 bool ir_value_life_merge(ir_value*, size_t);
108 bool ir_value_life_merge_into(ir_value*, const ir_value*);
109 /* check if a value lives at a specific point */
110 bool ir_value_lives(ir_value*, size_t);
111 /* check if the life-range of 2 values overlaps */
112 bool ir_values_overlap(const ir_value*, const ir_value*);
113
114 void ir_value_dump(ir_value*, int (*oprintf)(const char*,...));
115 void ir_value_dump_life(const ir_value *self, int (*oprintf)(const char*,...));
116
117 /* PHI data */
118 typedef struct ir_phi_entry_s
119 {
120     ir_value          *value;
121     struct ir_block_s *from;
122 } ir_phi_entry_t;
123
124 /* instruction */
125 typedef struct ir_instr_s
126 {
127     int       opcode;
128     lex_ctx   context;
129     ir_value* (_ops[3]);
130     struct ir_block_s* (bops[2]);
131
132     ir_phi_entry_t *phi;
133     ir_value      **params;
134
135     /* For the temp-allocation */
136     size_t eid;
137
138     /* For IFs */
139     bool   likely;
140
141     struct ir_block_s *owner;
142 } ir_instr;
143
144 ir_instr* ir_instr_new(struct ir_block_s *owner, int opcode);
145 void      ir_instr_delete(ir_instr*);
146
147 bool GMQCC_WARN vec_ir_instr_find(ir_instr **vec, ir_instr *what, size_t *idx);
148
149 bool GMQCC_WARN ir_instr_op(ir_instr*, int op, ir_value *value, bool writing);
150
151 void ir_instr_dump(ir_instr* in, char *ind, int (*oprintf)(const char*,...));
152
153 /* block */
154 typedef struct ir_block_s
155 {
156     char      *label;
157     lex_ctx    context;
158     bool       final; /* once a jump is added we're done */
159
160     ir_instr          **instr;
161     struct ir_block_s **entries;
162     struct ir_block_s **exits;
163     ir_value          **living;
164
165     /* For the temp-allocation */
166     size_t eid;
167     bool   is_return;
168     size_t run_id;
169
170     struct ir_function_s *owner;
171
172     bool   generated;
173     size_t code_start;
174 } ir_block;
175
176 ir_block* ir_block_new(struct ir_function_s *owner, const char *label);
177 void      ir_block_delete(ir_block*);
178
179 bool      ir_block_set_label(ir_block*, const char *label);
180
181 ir_value* ir_block_create_binop(ir_block*, const char *label, int op,
182                                 ir_value *left, ir_value *right);
183 ir_value* ir_block_create_unary(ir_block*, const char *label, int op,
184                                 ir_value *operand);
185 bool GMQCC_WARN ir_block_create_store_op(ir_block*, int op, ir_value *target, ir_value *what);
186 bool GMQCC_WARN ir_block_create_store(ir_block*, ir_value *target, ir_value *what);
187 bool GMQCC_WARN ir_block_create_storep(ir_block*, ir_value *target, ir_value *what);
188
189 /* field must be of TYPE_FIELD */
190 ir_value* ir_block_create_load_from_ent(ir_block*, const char *label, ir_value *ent, ir_value *field, int outype);
191
192 ir_value* ir_block_create_fieldaddress(ir_block*, const char *label, ir_value *entity, ir_value *field);
193
194 /* This is to create an instruction of the form
195  * <outtype>%label := opcode a, b
196  */
197 ir_value* ir_block_create_general_instr(ir_block *self, const char *label,
198                                         int op, ir_value *a, ir_value *b, int outype);
199
200 ir_value* ir_block_create_add(ir_block*, const char *label, ir_value *l, ir_value *r);
201 ir_value* ir_block_create_sub(ir_block*, const char *label, ir_value *l, ir_value *r);
202 ir_value* ir_block_create_mul(ir_block*, const char *label, ir_value *l, ir_value *r);
203 ir_value* ir_block_create_div(ir_block*, const char *label, ir_value *l, ir_value *r);
204 ir_instr* ir_block_create_phi(ir_block*, const char *label, int vtype);
205 ir_value* ir_phi_value(ir_instr*);
206 void ir_phi_add(ir_instr*, ir_block *b, ir_value *v);
207 ir_instr* ir_block_create_call(ir_block*, const char *label, ir_value *func);
208 ir_value* ir_call_value(ir_instr*);
209 void ir_call_param(ir_instr*, ir_value*);
210
211 bool GMQCC_WARN ir_block_create_return(ir_block*, ir_value *opt_value);
212
213 bool GMQCC_WARN ir_block_create_if(ir_block*, ir_value *cond,
214                                    ir_block *ontrue, ir_block *onfalse);
215 /* A 'goto' is an actual 'goto' coded in QC, whereas
216  * a 'jump' is a virtual construct which simply names the
217  * next block to go to.
218  * A goto usually becomes an OP_GOTO in the resulting code,
219  * whereas a 'jump' usually doesn't add any actual instruction.
220  */
221 bool GMQCC_WARN ir_block_create_jump(ir_block*, ir_block *to);
222 bool GMQCC_WARN ir_block_create_goto(ir_block*, ir_block *to);
223
224 void ir_block_dump(ir_block*, char *ind, int (*oprintf)(const char*,...));
225
226 /* function */
227
228 typedef struct ir_function_s
229 {
230     char      *name;
231     int        outtype;
232     int       *params;
233     ir_block **blocks;
234
235     int builtin;
236
237     ir_value *value;
238
239     /* values generated from operations
240      * which might get optimized away, so anything
241      * in there needs to be deleted in the dtor.
242      */
243     ir_value **values;
244
245     /* locally defined variables */
246     ir_value **locals;
247
248     size_t allocated_locals;
249
250     ir_block*     first;
251     ir_block*     last;
252
253     lex_ctx       context;
254
255     /* for prototypes - first we generate all the
256      * globals, and we remember teh function-defs
257      * so we can later fill in the entry pos
258      *
259      * remember the ID:
260      */
261     qcint code_function_def;
262
263     /* for temp allocation */
264     size_t run_id;
265
266     struct ir_builder_s *owner;
267 } ir_function;
268
269 ir_function* ir_function_new(struct ir_builder_s *owner, int returntype);
270 void         ir_function_delete(ir_function*);
271
272 void ir_function_collect_value(ir_function*, ir_value *value);
273
274 bool ir_function_set_name(ir_function*, const char *name);
275
276 ir_value* ir_function_create_local(ir_function *self, const char *name, int vtype, bool param);
277
278 bool GMQCC_WARN ir_function_finalize(ir_function*);
279 /*
280 bool ir_function_naive_phi(ir_function*);
281 bool ir_function_enumerate(ir_function*);
282 bool ir_function_calculate_liferanges(ir_function*);
283 */
284
285 ir_block* ir_function_create_block(lex_ctx ctx, ir_function*, const char *label);
286
287 void ir_function_dump(ir_function*, char *ind, int (*oprintf)(const char*,...));
288
289 /* builder */
290 #define IR_HT_SIZE 1024
291 typedef struct ir_builder_s
292 {
293     char *name;
294     ir_function **functions;
295     ir_value    **globals;
296     ir_value    **fields;
297
298     ht            htfunctions;
299     ht            htglobals;
300     ht            htfields;
301
302     ir_value    **extparams;
303
304     const char **filenames;
305     qcint       *filestrings;
306     /* we cache the #IMMEDIATE string here */
307     qcint str_immediate;
308 } ir_builder;
309
310 ir_builder* ir_builder_new(const char *modulename);
311 void        ir_builder_delete(ir_builder*);
312
313 bool ir_builder_set_name(ir_builder *self, const char *name);
314
315 ir_function* ir_builder_get_function(ir_builder*, const char *fun);
316 ir_function* ir_builder_create_function(ir_builder*, const char *name, int outtype);
317
318 ir_value* ir_builder_get_global(ir_builder*, const char *fun);
319 ir_value* ir_builder_create_global(ir_builder*, const char *name, int vtype);
320 ir_value* ir_builder_get_field(ir_builder*, const char *fun);
321 ir_value* ir_builder_create_field(ir_builder*, const char *name, int vtype);
322
323 bool ir_builder_generate(ir_builder *self, const char *filename);
324
325 void ir_builder_dump(ir_builder*, int (*oprintf)(const char*, ...));
326
327 /* This code assumes 32 bit floats while generating binary */
328 extern int check_int_and_float_size
329 [ (sizeof(int32_t) == sizeof(qcfloat)) ? 1 : -1 ];
330
331 #endif