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