VINSTR_NRCALL, translated like any other call for now; to be used to mark a call...
[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_value* ir_block_create_add(ir_block*, lex_ctx, const char *label, ir_value *l, ir_value *r);
206 ir_value* ir_block_create_sub(ir_block*, lex_ctx, const char *label, ir_value *l, ir_value *r);
207 ir_value* ir_block_create_mul(ir_block*, lex_ctx, const char *label, ir_value *l, ir_value *r);
208 ir_value* ir_block_create_div(ir_block*, lex_ctx, const char *label, ir_value *l, ir_value *r);
209 ir_instr* ir_block_create_phi(ir_block*, lex_ctx, const char *label, int vtype);
210 ir_value* ir_phi_value(ir_instr*);
211 void ir_phi_add(ir_instr*, ir_block *b, ir_value *v);
212 ir_instr* ir_block_create_call(ir_block*, lex_ctx, const char *label, ir_value *func, bool noreturn);
213 ir_value* ir_call_value(ir_instr*);
214 void ir_call_param(ir_instr*, ir_value*);
215
216 bool GMQCC_WARN ir_block_create_return(ir_block*, lex_ctx, ir_value *opt_value);
217
218 bool GMQCC_WARN ir_block_create_if(ir_block*, lex_ctx, ir_value *cond,
219                                    ir_block *ontrue, ir_block *onfalse);
220 /* A 'goto' is an actual 'goto' coded in QC, whereas
221  * a 'jump' is a virtual construct which simply names the
222  * next block to go to.
223  * A goto usually becomes an OP_GOTO in the resulting code,
224  * whereas a 'jump' usually doesn't add any actual instruction.
225  */
226 bool GMQCC_WARN ir_block_create_jump(ir_block*, lex_ctx, ir_block *to);
227 bool GMQCC_WARN ir_block_create_goto(ir_block*, lex_ctx, ir_block *to);
228
229 void ir_block_dump(ir_block*, char *ind, int (*oprintf)(const char*,...));
230
231 /* function */
232
233 typedef struct ir_function_s
234 {
235     char      *name;
236     int        outtype;
237     int       *params;
238     ir_block **blocks;
239
240     int builtin;
241
242     ir_value *value;
243
244     /* values generated from operations
245      * which might get optimized away, so anything
246      * in there needs to be deleted in the dtor.
247      */
248     ir_value **values;
249
250     /* locally defined variables */
251     ir_value **locals;
252
253     size_t allocated_locals;
254
255     ir_block*     first;
256     ir_block*     last;
257
258     lex_ctx       context;
259
260     /* for prototypes - first we generate all the
261      * globals, and we remember teh function-defs
262      * so we can later fill in the entry pos
263      *
264      * remember the ID:
265      */
266     qcint code_function_def;
267
268     /* for temp allocation */
269     size_t run_id;
270
271     struct ir_builder_s *owner;
272 } ir_function;
273
274 ir_function* ir_function_new(struct ir_builder_s *owner, int returntype);
275 void         ir_function_delete(ir_function*);
276
277 void ir_function_collect_value(ir_function*, ir_value *value);
278
279 bool ir_function_set_name(ir_function*, const char *name);
280
281 ir_value* ir_function_create_local(ir_function *self, const char *name, int vtype, bool param);
282
283 bool GMQCC_WARN ir_function_finalize(ir_function*);
284 /*
285 bool ir_function_naive_phi(ir_function*);
286 bool ir_function_enumerate(ir_function*);
287 bool ir_function_calculate_liferanges(ir_function*);
288 */
289
290 ir_block* ir_function_create_block(lex_ctx ctx, ir_function*, const char *label);
291
292 void ir_function_dump(ir_function*, char *ind, int (*oprintf)(const char*,...));
293
294 /* builder */
295 #define IR_HT_SIZE 1024
296 typedef struct ir_builder_s
297 {
298     char *name;
299     ir_function **functions;
300     ir_value    **globals;
301     ir_value    **fields;
302
303     ht            htfunctions;
304     ht            htglobals;
305     ht            htfields;
306
307     ir_value    **extparams;
308
309     const char **filenames;
310     qcint       *filestrings;
311     /* we cache the #IMMEDIATE string here */
312     qcint str_immediate;
313 } ir_builder;
314
315 ir_builder* ir_builder_new(const char *modulename);
316 void        ir_builder_delete(ir_builder*);
317
318 bool ir_builder_set_name(ir_builder *self, const char *name);
319
320 ir_function* ir_builder_get_function(ir_builder*, const char *fun);
321 ir_function* ir_builder_create_function(ir_builder*, const char *name, int outtype);
322
323 ir_value* ir_builder_get_global(ir_builder*, const char *fun);
324 ir_value* ir_builder_create_global(ir_builder*, const char *name, int vtype);
325 ir_value* ir_builder_get_field(ir_builder*, const char *fun);
326 ir_value* ir_builder_create_field(ir_builder*, const char *name, int vtype);
327
328 bool ir_builder_generate(ir_builder *self, const char *filename);
329
330 void ir_builder_dump(ir_builder*, int (*oprintf)(const char*, ...));
331
332 /* This code assumes 32 bit floats while generating binary */
333 extern int check_int_and_float_size
334 [ (sizeof(int32_t) == sizeof(qcfloat)) ? 1 : -1 ];
335
336 #endif