it's not undefined, stupid
[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
46     MEM_VECTOR_MAKE(struct ir_instr_s*, reads);
47     MEM_VECTOR_MAKE(struct ir_instr_s*, writes);
48
49     /* constantvalues */
50     bool isconst;
51     union {
52         float    vfloat;
53         int      vint;
54         vector   vvec;
55         char    *vstring;
56         struct ir_value_s *vpointer;
57         struct ir_function_s *vfunc;
58     } constval;
59
60     struct {
61         int32_t globaladdr;
62         int32_t name;
63         /* filled by the local-allocator */
64         int32_t local;
65         /* added for members */
66         int32_t addroffset;
67     } code;
68
69     /* for acessing vectors */
70     struct ir_value_s *members[3];
71
72     /* For the temp allocator */
73     MEM_VECTOR_MAKE(ir_life_entry_t, life);
74 } ir_value;
75
76 int32_t ir_value_code_addr(const ir_value*);
77
78 /* ir_value can be a variable, or created by an operation */
79 ir_value* ir_value_var(const char *name, int st, int vtype);
80 /* if a result of an operation: the function should store
81  * it to remember to delete it / garbage collect it
82  */
83 ir_value* ir_value_out(struct ir_function_s *owner, const char *name, int st, int vtype);
84 void      ir_value_delete(ir_value*);
85 void      ir_value_set_name(ir_value*, const char *name);
86 ir_value* ir_value_vector_member(ir_value*, unsigned int member);
87
88 MEM_VECTOR_PROTO_ALL(ir_value, struct ir_instr_s*, reads);
89 MEM_VECTOR_PROTO_ALL(ir_value, struct ir_instr_s*, writes);
90
91 bool GMQCC_WARN ir_value_set_float(ir_value*, float f);
92 bool GMQCC_WARN ir_value_set_func(ir_value*, int f);
93 #if 0
94 bool GMQCC_WARN ir_value_set_int(ir_value*, int i);
95 #endif
96 bool GMQCC_WARN ir_value_set_string(ir_value*, const char *s);
97 bool GMQCC_WARN ir_value_set_vector(ir_value*, vector v);
98 bool GMQCC_WARN ir_value_set_field(ir_value*, ir_value *fld);
99 /*bool   ir_value_set_pointer_v(ir_value*, ir_value* p); */
100 /*bool   ir_value_set_pointer_i(ir_value*, int i);       */
101
102 MEM_VECTOR_PROTO(ir_value, ir_life_entry_t, life);
103 /* merge an instruction into the life-range */
104 /* returns false if the lifepoint was already known */
105 bool ir_value_life_merge(ir_value*, size_t);
106 bool ir_value_life_merge_into(ir_value*, const ir_value*);
107 /* check if a value lives at a specific point */
108 bool ir_value_lives(ir_value*, size_t);
109 /* check if the life-range of 2 values overlaps */
110 bool ir_values_overlap(const ir_value*, const ir_value*);
111
112 void ir_value_dump(ir_value*, int (*oprintf)(const char*,...));
113 void ir_value_dump_life(ir_value *self, int (*oprintf)(const char*,...));
114
115 /* A vector of IR values */
116 typedef struct {
117     MEM_VECTOR_MAKE(ir_value*, v);
118 } ir_value_vector;
119 MEM_VECTOR_PROTO(ir_value_vector, ir_value*, v);
120
121 /* PHI data */
122 typedef struct ir_phi_entry_s
123 {
124     ir_value          *value;
125     struct ir_block_s *from;
126 } ir_phi_entry_t;
127
128 /* instruction */
129 typedef struct ir_instr_s
130 {
131     int       opcode;
132     lex_ctx   context;
133     ir_value* (_ops[3]);
134     struct ir_block_s* (bops[2]);
135
136     MEM_VECTOR_MAKE(ir_phi_entry_t, phi);
137     MEM_VECTOR_MAKE(ir_value*, params);
138
139     /* For the temp-allocation */
140     size_t eid;
141
142     struct ir_block_s *owner;
143 } ir_instr;
144
145 ir_instr* ir_instr_new(struct ir_block_s *owner, int opcode);
146 void      ir_instr_delete(ir_instr*);
147
148 MEM_VECTOR_PROTO(ir_value, ir_phi_entry_t, phi);
149 bool GMQCC_WARN ir_instr_op(ir_instr*, int op, ir_value *value, bool writing);
150
151 MEM_VECTOR_PROTO(ir_value, ir_value*, params);
152
153 void ir_instr_dump(ir_instr* in, char *ind, int (*oprintf)(const char*,...));
154
155 /* block */
156 typedef struct ir_block_s
157 {
158     char      *label;
159     lex_ctx    context;
160     bool       final; /* once a jump is added we're done */
161
162     MEM_VECTOR_MAKE(ir_instr*, instr);
163     MEM_VECTOR_MAKE(struct ir_block_s*, entries);
164     MEM_VECTOR_MAKE(struct ir_block_s*, exits);
165     MEM_VECTOR_MAKE(ir_value*, living);
166
167     /* For the temp-allocation */
168     size_t eid;
169     bool   is_return;
170     size_t run_id;
171
172     struct ir_function_s *owner;
173
174     bool   generated;
175     size_t code_start;
176 } ir_block;
177
178 ir_block* ir_block_new(struct ir_function_s *owner, const char *label);
179 void      ir_block_delete(ir_block*);
180
181 bool      ir_block_set_label(ir_block*, const char *label);
182
183 MEM_VECTOR_PROTO(ir_block, ir_instr*, instr);
184 MEM_VECTOR_PROTO_ALL(ir_block, ir_block*, exits);
185 MEM_VECTOR_PROTO_ALL(ir_block, ir_block*, entries);
186
187 ir_value* ir_block_create_binop(ir_block*, const char *label, int op,
188                                 ir_value *left, ir_value *right);
189 ir_value* ir_block_create_unary(ir_block*, const char *label, int op,
190                                 ir_value *operand);
191 bool GMQCC_WARN ir_block_create_store_op(ir_block*, int op, ir_value *target, ir_value *what);
192 bool GMQCC_WARN ir_block_create_store(ir_block*, ir_value *target, ir_value *what);
193 bool GMQCC_WARN ir_block_create_storep(ir_block*, ir_value *target, ir_value *what);
194
195 /* field must be of TYPE_FIELD */
196 ir_value* ir_block_create_load_from_ent(ir_block*, const char *label, ir_value *ent, ir_value *field, int outype);
197
198 ir_value* ir_block_create_fieldaddress(ir_block*, const char *label, ir_value *entity, ir_value *field);
199
200 /* This is to create an instruction of the form
201  * <outtype>%label := opcode a, b
202  */
203 ir_value* ir_block_create_general_instr(ir_block *self, const char *label,
204                                         int op, ir_value *a, ir_value *b, int outype);
205
206 ir_value* ir_block_create_add(ir_block*, const char *label, ir_value *l, ir_value *r);
207 ir_value* ir_block_create_sub(ir_block*, const char *label, ir_value *l, ir_value *r);
208 ir_value* ir_block_create_mul(ir_block*, const char *label, ir_value *l, ir_value *r);
209 ir_value* ir_block_create_div(ir_block*, const char *label, ir_value *l, ir_value *r);
210 ir_instr* ir_block_create_phi(ir_block*, const char *label, int vtype);
211 ir_value* ir_phi_value(ir_instr*);
212 bool GMQCC_WARN ir_phi_add(ir_instr*, ir_block *b, ir_value *v);
213 ir_instr* ir_block_create_call(ir_block*, const char *label, ir_value *func);
214 ir_value* ir_call_value(ir_instr*);
215 bool GMQCC_WARN ir_call_param(ir_instr*, ir_value*);
216
217 bool GMQCC_WARN ir_block_create_return(ir_block*, ir_value *opt_value);
218
219 bool GMQCC_WARN ir_block_create_if(ir_block*, 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.
226  */
227 bool GMQCC_WARN ir_block_create_jump(ir_block*, ir_block *to);
228 bool GMQCC_WARN ir_block_create_goto(ir_block*, ir_block *to);
229
230 MEM_VECTOR_PROTO_ALL(ir_block, ir_value*, living);
231
232 void ir_block_dump(ir_block*, char *ind, int (*oprintf)(const char*,...));
233
234 /* function */
235
236 typedef struct ir_function_s
237 {
238     char *name;
239     int   outtype;
240     MEM_VECTOR_MAKE(int, params);
241     MEM_VECTOR_MAKE(ir_block*, blocks);
242
243     int builtin;
244
245     ir_value *value;
246
247     /* values generated from operations
248      * which might get optimized away, so anything
249      * in there needs to be deleted in the dtor.
250      */
251     MEM_VECTOR_MAKE(ir_value*, values);
252
253     /* locally defined variables */
254     MEM_VECTOR_MAKE(ir_value*, locals);
255
256     size_t allocated_locals;
257
258     ir_block*     first;
259     ir_block*     last;
260
261     lex_ctx       context;
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 bool GMQCC_WARN ir_function_collect_value(ir_function*, ir_value *value);
273
274 bool ir_function_set_name(ir_function*, const char *name);
275 MEM_VECTOR_PROTO(ir_function, int, params);
276 MEM_VECTOR_PROTO(ir_function, ir_block*, blocks);
277
278 ir_value* ir_function_get_local(ir_function *self, const char *name);
279 ir_value* ir_function_create_local(ir_function *self, const char *name, int vtype, bool param);
280
281 bool GMQCC_WARN ir_function_finalize(ir_function*);
282 /*
283 bool ir_function_naive_phi(ir_function*);
284 bool ir_function_enumerate(ir_function*);
285 bool ir_function_calculate_liferanges(ir_function*);
286 */
287
288 ir_block* ir_function_create_block(ir_function*, const char *label);
289
290 void ir_function_dump(ir_function*, char *ind, int (*oprintf)(const char*,...));
291
292 /* builder */
293 typedef struct ir_builder_s
294 {
295     char *name;
296     MEM_VECTOR_MAKE(ir_function*, functions);
297     MEM_VECTOR_MAKE(ir_value*, globals);
298     MEM_VECTOR_MAKE(ir_value*, fields);
299 } ir_builder;
300
301 ir_builder* ir_builder_new(const char *modulename);
302 void        ir_builder_delete(ir_builder*);
303
304 bool ir_builder_set_name(ir_builder *self, const char *name);
305
306 MEM_VECTOR_PROTO(ir_builder, ir_function*, functions);
307 MEM_VECTOR_PROTO(ir_builder, ir_value*, globals);
308 MEM_VECTOR_PROTO(ir_builder, ir_value*, fields);
309
310 ir_function* ir_builder_get_function(ir_builder*, const char *fun);
311 ir_function* ir_builder_create_function(ir_builder*, const char *name, int outtype);
312
313 ir_value* ir_builder_get_global(ir_builder*, const char *fun);
314 ir_value* ir_builder_create_global(ir_builder*, const char *name, int vtype);
315 ir_value* ir_builder_get_field(ir_builder*, const char *fun);
316 ir_value* ir_builder_create_field(ir_builder*, const char *name, int vtype);
317
318 bool ir_builder_generate(ir_builder *self, const char *filename);
319
320 void ir_builder_dump(ir_builder*, int (*oprintf)(const char*, ...));
321
322 /* This code assumes 32 bit floats while generating binary */
323 extern int check_int_and_float_size
324 [ (sizeof(int32_t) == sizeof(qcfloat)) ? 1 : -1 ];
325
326 #endif