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