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