Remove ir_block_create_{add,sub,mul,div}, they're not used; STOREP instructions don...
[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         /* to generate field-addresses early */
71         int32_t fieldaddr;
72     } code;
73
74     /* for acessing vectors */
75     struct ir_value_s *members[3];
76     struct ir_value_s *memberof;
77
78     /* arrays will never overlap with temps */
79     bool unique_life;
80
81     /* For the temp allocator */
82     ir_life_entry_t *life;
83 } ir_value;
84
85 int32_t ir_value_code_addr(const ir_value*);
86
87 /* ir_value can be a variable, or created by an operation */
88 ir_value* ir_value_var(const char *name, int st, int vtype);
89 /* if a result of an operation: the function should store
90  * it to remember to delete it / garbage collect it
91  */
92 ir_value* ir_value_out(struct ir_function_s *owner, const char *name, int st, int vtype);
93 void      ir_value_delete(ir_value*);
94 bool      ir_value_set_name(ir_value*, const char *name);
95 ir_value* ir_value_vector_member(ir_value*, unsigned int member);
96
97 bool GMQCC_WARN vec_ir_value_find(ir_value **vec, ir_value *what, size_t *idx);
98
99 bool GMQCC_WARN ir_value_set_float(ir_value*, float f);
100 bool GMQCC_WARN ir_value_set_func(ir_value*, int f);
101 #if 0
102 bool GMQCC_WARN ir_value_set_int(ir_value*, int i);
103 #endif
104 bool GMQCC_WARN ir_value_set_string(ir_value*, const char *s);
105 bool GMQCC_WARN ir_value_set_vector(ir_value*, vector v);
106 bool GMQCC_WARN ir_value_set_field(ir_value*, ir_value *fld);
107 /*bool   ir_value_set_pointer_v(ir_value*, ir_value* p); */
108 /*bool   ir_value_set_pointer_i(ir_value*, int i);       */
109
110 /* merge an instruction into the life-range */
111 /* returns false if the lifepoint was already known */
112 bool ir_value_life_merge(ir_value*, size_t);
113 bool ir_value_life_merge_into(ir_value*, const ir_value*);
114 /* check if a value lives at a specific point */
115 bool ir_value_lives(ir_value*, size_t);
116 /* check if the life-range of 2 values overlaps */
117 bool ir_values_overlap(const ir_value*, const ir_value*);
118
119 void ir_value_dump(ir_value*, int (*oprintf)(const char*,...));
120 void ir_value_dump_life(const ir_value *self, int (*oprintf)(const char*,...));
121
122 /* PHI data */
123 typedef struct ir_phi_entry_s
124 {
125     ir_value          *value;
126     struct ir_block_s *from;
127 } ir_phi_entry_t;
128
129 /* instruction */
130 typedef struct ir_instr_s
131 {
132     int       opcode;
133     lex_ctx   context;
134     ir_value* (_ops[3]);
135     struct ir_block_s* (bops[2]);
136
137     ir_phi_entry_t *phi;
138     ir_value      **params;
139
140     /* For the temp-allocation */
141     size_t eid;
142
143     /* For IFs */
144     bool   likely;
145
146     struct ir_block_s *owner;
147 } ir_instr;
148
149 ir_instr* ir_instr_new(lex_ctx ctx, struct ir_block_s *owner, int opcode);
150 void      ir_instr_delete(ir_instr*);
151
152 bool GMQCC_WARN vec_ir_instr_find(ir_instr **vec, ir_instr *what, size_t *idx);
153
154 bool GMQCC_WARN ir_instr_op(ir_instr*, int op, ir_value *value, bool writing);
155
156 void ir_instr_dump(ir_instr* in, char *ind, int (*oprintf)(const char*,...));
157
158 /* block */
159 typedef struct ir_block_s
160 {
161     char      *label;
162     lex_ctx    context;
163     bool       final; /* once a jump is added we're done */
164
165     ir_instr          **instr;
166     struct ir_block_s **entries;
167     struct ir_block_s **exits;
168     ir_value          **living;
169
170     /* For the temp-allocation */
171     size_t eid;
172     bool   is_return;
173     size_t run_id;
174
175     struct ir_function_s *owner;
176
177     bool   generated;
178     size_t code_start;
179 } ir_block;
180
181 ir_block* ir_block_new(struct ir_function_s *owner, const char *label);
182 void      ir_block_delete(ir_block*);
183
184 bool      ir_block_set_label(ir_block*, const char *label);
185
186 ir_value* ir_block_create_binop(ir_block*, lex_ctx, const char *label, int op,
187                                 ir_value *left, ir_value *right);
188 ir_value* ir_block_create_unary(ir_block*, lex_ctx, const char *label, int op,
189                                 ir_value *operand);
190 bool GMQCC_WARN ir_block_create_store_op(ir_block*, lex_ctx, int op, ir_value *target, ir_value *what);
191 bool GMQCC_WARN ir_block_create_store(ir_block*, lex_ctx, ir_value *target, ir_value *what);
192 bool GMQCC_WARN ir_block_create_storep(ir_block*, lex_ctx, ir_value *target, ir_value *what);
193
194 /* field must be of TYPE_FIELD */
195 ir_value* ir_block_create_load_from_ent(ir_block*, lex_ctx, const char *label, ir_value *ent, ir_value *field, int outype);
196
197 ir_value* ir_block_create_fieldaddress(ir_block*, lex_ctx, const char *label, ir_value *entity, ir_value *field);
198
199 /* This is to create an instruction of the form
200  * <outtype>%label := opcode a, b
201  */
202 ir_value* ir_block_create_general_instr(ir_block *self, lex_ctx, const char *label,
203                                         int op, ir_value *a, ir_value *b, int outype);
204
205 ir_instr* ir_block_create_phi(ir_block*, lex_ctx, const char *label, int vtype);
206 ir_value* ir_phi_value(ir_instr*);
207 void ir_phi_add(ir_instr*, ir_block *b, ir_value *v);
208 ir_instr* ir_block_create_call(ir_block*, lex_ctx, const char *label, ir_value *func, bool noreturn);
209 ir_value* ir_call_value(ir_instr*);
210 void ir_call_param(ir_instr*, ir_value*);
211
212 bool GMQCC_WARN ir_block_create_return(ir_block*, lex_ctx, ir_value *opt_value);
213
214 bool GMQCC_WARN ir_block_create_if(ir_block*, lex_ctx, 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*, lex_ctx, ir_block *to);
223 bool GMQCC_WARN ir_block_create_goto(ir_block*, lex_ctx, ir_block *to);
224
225 void ir_block_dump(ir_block*, char *ind, int (*oprintf)(const char*,...));
226
227 /* function */
228
229 typedef struct ir_function_s
230 {
231     char      *name;
232     int        outtype;
233     int       *params;
234     ir_block **blocks;
235
236     uint32_t   flags;
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     ir_value **values;
247
248     /* locally defined variables */
249     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 prototypes - first we generate all the
259      * globals, and we remember teh function-defs
260      * so we can later fill in the entry pos
261      *
262      * remember the ID:
263      */
264     qcint code_function_def;
265
266     /* for temp allocation */
267     size_t run_id;
268
269     struct ir_builder_s *owner;
270 } ir_function;
271 #define IR_FLAG_HAS_ARRAYS        (1<<1)
272 #define IR_FLAG_HAS_UNINITIALIZED (1<<2)
273 #define IR_FLAG_HAS_GOTO          (1<<3)
274 #define IR_FLAG_MASK_NO_OVERLAP (IR_FLAG_HAS_ARRAYS | IR_FLAG_HAS_UNINITIALIZED)
275
276 ir_function* ir_function_new(struct ir_builder_s *owner, int returntype);
277 void         ir_function_delete(ir_function*);
278
279 void ir_function_collect_value(ir_function*, ir_value *value);
280
281 bool ir_function_set_name(ir_function*, const char *name);
282
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(lex_ctx ctx, ir_function*, const char *label);
293
294 void ir_function_dump(ir_function*, char *ind, int (*oprintf)(const char*,...));
295
296 /* builder */
297 #define IR_HT_SIZE 1024
298 typedef struct ir_builder_s
299 {
300     char *name;
301     ir_function **functions;
302     ir_value    **globals;
303     ir_value    **fields;
304
305     ht            htfunctions;
306     ht            htglobals;
307     ht            htfields;
308
309     ir_value    **extparams;
310
311     /* the highest func->allocated_locals */
312     size_t        max_locals;
313     uint32_t      first_common_local;
314
315     const char **filenames;
316     qcint       *filestrings;
317     /* we cache the #IMMEDIATE string here */
318     qcint str_immediate;
319 } ir_builder;
320
321 ir_builder* ir_builder_new(const char *modulename);
322 void        ir_builder_delete(ir_builder*);
323
324 bool ir_builder_set_name(ir_builder *self, const char *name);
325
326 ir_function* ir_builder_get_function(ir_builder*, const char *fun);
327 ir_function* ir_builder_create_function(ir_builder*, const char *name, int outtype);
328
329 ir_value* ir_builder_get_global(ir_builder*, const char *fun);
330 ir_value* ir_builder_create_global(ir_builder*, const char *name, int vtype);
331 ir_value* ir_builder_get_field(ir_builder*, const char *fun);
332 ir_value* ir_builder_create_field(ir_builder*, const char *name, int vtype);
333
334 bool ir_builder_generate(ir_builder *self, const char *filename);
335
336 void ir_builder_dump(ir_builder*, int (*oprintf)(const char*, ...));
337
338 /* This code assumes 32 bit floats while generating binary */
339 extern int check_int_and_float_size
340 [ (sizeof(int32_t) == sizeof(qcfloat)) ? 1 : -1 ];
341
342 #endif