moving -Olocal-temps to -O4 until the issues are solved
[xonotic/gmqcc.git] / ast.h
1 /*
2  * Copyright (C) 2012, 2013
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_AST_HDR
24 #define GMQCC_AST_HDR
25 #include "ir.h"
26
27 /* Note: I will not be using a _t suffix for the
28  * "main" ast node types for now.
29  */
30
31 typedef union ast_node_u ast_node;
32 typedef union ast_expression_u ast_expression;
33
34 typedef struct ast_value_s       ast_value;
35 typedef struct ast_function_s    ast_function;
36 typedef struct ast_block_s       ast_block;
37 typedef struct ast_binary_s      ast_binary;
38 typedef struct ast_store_s       ast_store;
39 typedef struct ast_binstore_s    ast_binstore;
40 typedef struct ast_entfield_s    ast_entfield;
41 typedef struct ast_ifthen_s      ast_ifthen;
42 typedef struct ast_ternary_s     ast_ternary;
43 typedef struct ast_loop_s        ast_loop;
44 typedef struct ast_call_s        ast_call;
45 typedef struct ast_unary_s       ast_unary;
46 typedef struct ast_return_s      ast_return;
47 typedef struct ast_member_s      ast_member;
48 typedef struct ast_array_index_s ast_array_index;
49 typedef struct ast_breakcont_s   ast_breakcont;
50 typedef struct ast_switch_s      ast_switch;
51 typedef struct ast_label_s       ast_label;
52 typedef struct ast_goto_s        ast_goto;
53
54 enum {
55     TYPE_ast_node,        /*  0 */
56     TYPE_ast_expression,  /*  1 */
57     TYPE_ast_value,       /*  2 */
58     TYPE_ast_function,    /*  3 */
59     TYPE_ast_block,       /*  4 */
60     TYPE_ast_binary,      /*  5 */
61     TYPE_ast_store,       /*  6 */
62     TYPE_ast_binstore,    /*  7 */
63     TYPE_ast_entfield,    /*  8 */
64     TYPE_ast_ifthen,      /*  9 */
65     TYPE_ast_ternary,     /* 10 */
66     TYPE_ast_loop,        /* 11 */
67     TYPE_ast_call,        /* 12 */
68     TYPE_ast_unary,       /* 13 */
69     TYPE_ast_return,      /* 14 */
70     TYPE_ast_member,      /* 15 */
71     TYPE_ast_array_index, /* 16 */
72     TYPE_ast_breakcont,   /* 17 */
73     TYPE_ast_switch,      /* 18 */
74     TYPE_ast_label,       /* 19 */
75     TYPE_ast_goto         /* 20 */
76 };
77
78 #define ast_istype(x, t) ( ((ast_node_common*)x)->nodetype == (TYPE_##t) )
79 #define ast_ctx(node) (((ast_node_common*)(node))->context)
80 #define ast_side_effects(node) (((ast_node_common*)(node))->side_effects)
81
82 /* Node interface with common components
83  */
84 typedef void ast_node_delete(ast_node*);
85 typedef struct
86 {
87     lex_ctx          context;
88     /* I don't feel comfortable using keywords like 'delete' as names... */
89     ast_node_delete *destroy;
90     int              nodetype;
91     /* keep: if a node contains this node, 'keep'
92      * prevents its dtor from destroying this node as well.
93      */
94     bool             keep;
95     bool             side_effects;
96 } ast_node_common;
97
98 #define ast_delete(x) (*( ((ast_node*)(x))->node.destroy ))((ast_node*)(x))
99 #define ast_unref(x) do                     \
100 {                                           \
101     if (! (((ast_node*)(x))->node.keep) ) { \
102         ast_delete(x);                      \
103     }                                       \
104 } while(0)
105
106 /* Expression interface
107  *
108  * Any expression or block returns an ir_value, and needs
109  * to know the current function.
110  */
111 typedef bool ast_expression_codegen(ast_expression*,
112                                     ast_function*,
113                                     bool lvalue,
114                                     ir_value**);
115 /* TODO: the codegen function should take an output-type parameter
116  * indicating whether a variable, type, label etc. is expected, and
117  * an environment!
118  * Then later an ast_ident could have a codegen using this to figure
119  * out what to look for.
120  * eg. in code which uses a not-yet defined variable, the expression
121  * would take an ast_ident, and the codegen would be called with
122  * type `expression`, so the ast_ident's codegen would search for
123  * variables through the environment (or functions, constants...).
124  */
125 typedef struct
126 {
127     ast_node_common         node;
128     ast_expression_codegen *codegen;
129     int                     vtype;
130     ast_expression         *next;
131     /* arrays get a member-count */
132     size_t                  count;
133     ast_value*             *params;
134     uint32_t                flags;
135     /* The codegen functions should store their output values
136      * so we can call it multiple times without re-evaluating.
137      * Store lvalue and rvalue seperately though. So that
138      * ast_entfield for example can generate both if required.
139      */
140     ir_value               *outl;
141     ir_value               *outr;
142 } ast_expression_common;
143 #define AST_FLAG_VARIADIC     (1<<0)
144 #define AST_FLAG_NORETURN     (1<<1)
145 #define AST_FLAG_INLINE       (1<<2)
146 #define AST_FLAG_INITIALIZED  (1<<3)
147 #define AST_FLAG_DEPRECATED   (1<<4)
148 #define AST_FLAG_TYPE_MASK (AST_FLAG_VARIADIC | AST_FLAG_NORETURN)
149
150 /* Value
151  *
152  * Types are also values, both have a type and a name.
153  * especially considering possible constructs like typedefs.
154  * typedef float foo;
155  * is like creating a 'float foo', foo serving as the type's name.
156  */
157 struct ast_value_s
158 {
159     ast_expression_common expression;
160
161     const char *name;
162     const char *desc;
163
164     /*
165     int         vtype;
166     ast_value  *next;
167     */
168
169     int  cvq;     /* const/var qualifier */
170     bool isfield; /* this declares a field */
171     bool hasvalue;
172     union {
173         double        vfloat;
174         int           vint;
175         vector        vvec;
176         const char   *vstring;
177         int           ventity;
178         ast_function *vfunc;
179         ast_value    *vfield;
180     } constval;
181
182     /* usecount for the parser */
183     size_t uses;
184
185     ir_value *ir_v;
186     ir_value **ir_values;
187     size_t   ir_value_count;
188
189     /* ONLY for arrays in progs version up to 6 */
190     ast_value *setter;
191     ast_value *getter;
192 };
193
194 ast_value* ast_value_new(lex_ctx ctx, const char *name, int qctype);
195 ast_value* ast_value_copy(const ast_value *self);
196 /* This will NOT delete an underlying ast_function */
197 void ast_value_delete(ast_value*);
198
199 bool ast_value_set_name(ast_value*, const char *name);
200
201 bool ast_value_codegen(ast_value*, ast_function*, bool lvalue, ir_value**);
202 bool ast_local_codegen(ast_value *self, ir_function *func, bool isparam);
203 bool ast_global_codegen(ast_value *self, ir_builder *ir, bool isfield);
204
205 void ast_value_params_add(ast_value*, ast_value*);
206
207 bool ast_compare_type(ast_expression *a, ast_expression *b);
208 ast_expression* ast_type_copy(lex_ctx ctx, const ast_expression *ex);
209 #define ast_type_adopt(a, b) ast_type_adopt_impl((ast_expression*)(a), (ast_expression*)(b))
210 bool ast_type_adopt_impl(ast_expression *self, const ast_expression *other);
211 void ast_type_to_string(ast_expression *e, char *buf, size_t bufsize);
212
213 /* Binary
214  *
215  * A value-returning binary expression.
216  */
217 struct ast_binary_s
218 {
219     ast_expression_common expression;
220
221     int             op;
222     ast_expression *left;
223     ast_expression *right;
224 };
225 ast_binary* ast_binary_new(lex_ctx    ctx,
226                            int        op,
227                            ast_expression *left,
228                            ast_expression *right);
229 void ast_binary_delete(ast_binary*);
230
231 bool ast_binary_codegen(ast_binary*, ast_function*, bool lvalue, ir_value**);
232
233 /* Binstore
234  *
235  * An assignment including a binary expression with the source as left operand.
236  * Eg. a += b; is a binstore { INSTR_STORE, INSTR_ADD, a, b }
237  */
238 struct ast_binstore_s
239 {
240     ast_expression_common expression;
241
242     int             opstore;
243     int             opbin;
244     ast_expression *dest;
245     ast_expression *source;
246     /* for &~= which uses the destination in a binary in source we can use this */
247     bool            keep_dest;
248 };
249 ast_binstore* ast_binstore_new(lex_ctx    ctx,
250                                int        storeop,
251                                int        op,
252                                ast_expression *left,
253                                ast_expression *right);
254 void ast_binstore_delete(ast_binstore*);
255
256 bool ast_binstore_codegen(ast_binstore*, ast_function*, bool lvalue, ir_value**);
257
258 /* Unary
259  *
260  * Regular unary expressions: not,neg
261  */
262 struct ast_unary_s
263 {
264     ast_expression_common expression;
265
266     int             op;
267     ast_expression *operand;
268 };
269 ast_unary* ast_unary_new(lex_ctx    ctx,
270                          int        op,
271                          ast_expression *expr);
272 void ast_unary_delete(ast_unary*);
273
274 bool ast_unary_codegen(ast_unary*, ast_function*, bool lvalue, ir_value**);
275
276 /* Return
277  *
278  * Make sure 'return' only happens at the end of a block, otherwise the IR
279  * will refuse to create further instructions.
280  * This should be honored by the parser.
281  */
282 struct ast_return_s
283 {
284     ast_expression_common expression;
285     ast_expression *operand;
286 };
287 ast_return* ast_return_new(lex_ctx    ctx,
288                            ast_expression *expr);
289 void ast_return_delete(ast_return*);
290
291 bool ast_return_codegen(ast_return*, ast_function*, bool lvalue, ir_value**);
292
293 /* Entity-field
294  *
295  * This must do 2 things:
296  * -) Provide a way to fetch an entity field value. (Rvalue)
297  * -) Provide a pointer to an entity field. (Lvalue)
298  * The problem:
299  * In original QC, there's only a STORE via pointer, but
300  * no LOAD via pointer.
301  * So we must know beforehand if we are going to read or assign
302  * the field.
303  * For this we will have to extend the codegen() functions with
304  * a flag saying whether or not we need an L or an R-value.
305  */
306 struct ast_entfield_s
307 {
308     ast_expression_common expression;
309     /* The entity can come from an expression of course. */
310     ast_expression *entity;
311     /* As can the field, it just must result in a value of TYPE_FIELD */
312     ast_expression *field;
313 };
314 ast_entfield* ast_entfield_new(lex_ctx ctx, ast_expression *entity, ast_expression *field);
315 ast_entfield* ast_entfield_new_force(lex_ctx ctx, ast_expression *entity, ast_expression *field, const ast_expression *outtype);
316 void ast_entfield_delete(ast_entfield*);
317
318 bool ast_entfield_codegen(ast_entfield*, ast_function*, bool lvalue, ir_value**);
319
320 /* Member access:
321  *
322  * For now used for vectors. If we get structs or unions
323  * we can have them handled here as well.
324  */
325 struct ast_member_s
326 {
327     ast_expression_common expression;
328     ast_expression *owner;
329     unsigned int    field;
330     const char     *name;
331     bool            rvalue;
332 };
333 ast_member* ast_member_new(lex_ctx ctx, ast_expression *owner, unsigned int field, const char *name);
334 void ast_member_delete(ast_member*);
335 bool ast_member_set_name(ast_member*, const char *name);
336
337 bool ast_member_codegen(ast_member*, ast_function*, bool lvalue, ir_value**);
338
339 /* Array index access:
340  *
341  * QC forces us to take special action on arrays:
342  * an ast_store on an ast_array_index must not codegen the index,
343  * but call its setter - unless we have an instruction set which supports
344  * what we need.
345  * Any other array index access will be codegened to a call to the getter.
346  * In any case, accessing an element via a compiletime-constant index will
347  * result in quick access to that variable.
348  */
349 struct ast_array_index_s
350 {
351     ast_expression_common expression;
352     ast_expression *array;
353     ast_expression *index;
354 };
355 ast_array_index* ast_array_index_new(lex_ctx ctx, ast_expression *array, ast_expression *index);
356 void ast_array_index_delete(ast_array_index*);
357
358 bool ast_array_index_codegen(ast_array_index*, ast_function*, bool lvalue, ir_value**);
359
360 /* Store
361  *
362  * Stores left<-right and returns left.
363  * Specialized binary expression node
364  */
365 struct ast_store_s
366 {
367     ast_expression_common expression;
368     int             op;
369     ast_expression *dest;
370     ast_expression *source;
371 };
372 ast_store* ast_store_new(lex_ctx ctx, int op,
373                          ast_expression *d, ast_expression *s);
374 void ast_store_delete(ast_store*);
375
376 bool ast_store_codegen(ast_store*, ast_function*, bool lvalue, ir_value**);
377
378 /* If
379  *
380  * A general 'if then else' statement, either side can be NULL and will
381  * thus be omitted. It is an error for *both* cases to be NULL at once.
382  *
383  * During its 'codegen' it'll be changing the ast_function's block.
384  *
385  * An if is also an "expression". Its codegen will put NULL into the
386  * output field though. For ternary expressions an ast_ternary will be
387  * added.
388  */
389 struct ast_ifthen_s
390 {
391     ast_expression_common expression;
392     ast_expression *cond;
393     /* It's all just 'expressions', since an ast_block is one too. */
394     ast_expression *on_true;
395     ast_expression *on_false;
396 };
397 ast_ifthen* ast_ifthen_new(lex_ctx ctx, ast_expression *cond, ast_expression *ontrue, ast_expression *onfalse);
398 void ast_ifthen_delete(ast_ifthen*);
399
400 bool ast_ifthen_codegen(ast_ifthen*, ast_function*, bool lvalue, ir_value**);
401
402 /* Ternary expressions...
403  *
404  * Contrary to 'if-then-else' nodes, ternary expressions actually
405  * return a value, otherwise they behave the very same way.
406  * The difference in 'codegen' is that it'll return the value of
407  * a PHI node.
408  *
409  * The other difference is that in an ast_ternary, NEITHER side
410  * must be NULL, there's ALWAYS an else branch.
411  *
412  * This is the only ast_node beside ast_value which contains
413  * an ir_value. Theoretically we don't need to remember it though.
414  */
415 struct ast_ternary_s
416 {
417     ast_expression_common expression;
418     ast_expression *cond;
419     /* It's all just 'expressions', since an ast_block is one too. */
420     ast_expression *on_true;
421     ast_expression *on_false;
422 };
423 ast_ternary* ast_ternary_new(lex_ctx ctx, ast_expression *cond, ast_expression *ontrue, ast_expression *onfalse);
424 void ast_ternary_delete(ast_ternary*);
425
426 bool ast_ternary_codegen(ast_ternary*, ast_function*, bool lvalue, ir_value**);
427
428 /* A general loop node
429  *
430  * For convenience it contains 4 parts:
431  * -) (ini) = initializing expression
432  * -) (pre) = pre-loop condition
433  * -) (pst) = post-loop condition
434  * -) (inc) = "increment" expression
435  * The following is a psudo-representation of this loop
436  * note that '=>' bears the logical meaning of "implies".
437  * (a => b) equals (!a || b)
438
439 {ini};
440 while (has_pre => {pre})
441 {
442     {body};
443
444 continue:      // a 'continue' will jump here
445     if (has_pst => {pst})
446         break;
447
448     {inc};
449 }
450  */
451 struct ast_loop_s
452 {
453     ast_expression_common expression;
454     ast_expression *initexpr;
455     ast_expression *precond;
456     ast_expression *postcond;
457     ast_expression *increment;
458     ast_expression *body;
459     /* For now we allow a seperate flag on whether or not the condition
460      * is supposed to be true or false.
461      * That way, the parser can generate a 'while not(!x)' for `while(x)`
462      * if desired, which is useful for the new -f{true,false}-empty-strings
463      * flag.
464      */
465     bool pre_not;
466     bool post_not;
467 };
468 ast_loop* ast_loop_new(lex_ctx ctx,
469                        ast_expression *initexpr,
470                        ast_expression *precond, bool pre_not,
471                        ast_expression *postcond, bool post_not,
472                        ast_expression *increment,
473                        ast_expression *body);
474 void ast_loop_delete(ast_loop*);
475
476 bool ast_loop_codegen(ast_loop*, ast_function*, bool lvalue, ir_value**);
477
478 /* Break/Continue
479  */
480 struct ast_breakcont_s
481 {
482     ast_expression_common expression;
483     bool         is_continue;
484     unsigned int levels;
485 };
486 ast_breakcont* ast_breakcont_new(lex_ctx ctx, bool iscont, unsigned int levels);
487 void ast_breakcont_delete(ast_breakcont*);
488
489 bool ast_breakcont_codegen(ast_breakcont*, ast_function*, bool lvalue, ir_value**);
490
491 /* Switch Statements
492  *
493  * A few notes about this: with the original QCVM, no real optimization
494  * is possible. The SWITCH instruction set isn't really helping a lot, since
495  * it only collapes the EQ and IF instructions into one.
496  * Note: Declaring local variables inside caseblocks is normal.
497  * Since we don't have to deal with a stack there's no unnatural behaviour to
498  * be expected from it.
499  * TODO: Ticket #20
500  */
501 typedef struct {
502     ast_expression *value; /* #20 will replace this */
503     ast_expression *code;
504 } ast_switch_case;
505 struct ast_switch_s
506 {
507     ast_expression_common expression;
508
509     ast_expression  *operand;
510     ast_switch_case *cases;
511 };
512
513 ast_switch* ast_switch_new(lex_ctx ctx, ast_expression *op);
514 void ast_switch_delete(ast_switch*);
515
516 bool ast_switch_codegen(ast_switch*, ast_function*, bool lvalue, ir_value**);
517
518 /* Label nodes
519  *
520  * Introduce a label which can be used together with 'goto'
521  */
522 struct ast_label_s
523 {
524     ast_expression_common expression;
525     const char *name;
526     ir_block   *irblock;
527     ast_goto  **gotos;
528     /* means it has not yet been defined */
529     bool        undefined;
530 };
531
532 ast_label* ast_label_new(lex_ctx ctx, const char *name, bool undefined);
533 void ast_label_delete(ast_label*);
534 void ast_label_register_goto(ast_label*, ast_goto*);
535
536 bool ast_label_codegen(ast_label*, ast_function*, bool lvalue, ir_value**);
537
538 /* GOTO nodes
539  *
540  * Go to a label, the label node is filled in at a later point!
541  */
542 struct ast_goto_s
543 {
544     ast_expression_common expression;
545     const char *name;
546     ast_label  *target;
547     ir_block   *irblock_from;
548 };
549
550 ast_goto* ast_goto_new(lex_ctx ctx, const char *name);
551 void ast_goto_delete(ast_goto*);
552 void ast_goto_set_label(ast_goto*, ast_label*);
553
554 bool ast_goto_codegen(ast_goto*, ast_function*, bool lvalue, ir_value**);
555
556 /* CALL node
557  *
558  * Contains an ast_expression as target, rather than an ast_function/value.
559  * Since it's how QC works, every ast_function has an ast_value
560  * associated anyway - in other words, the VM contains function
561  * pointers for every function anyway. Thus, this node will call
562  * expression.
563  * Additionally it contains a list of ast_expressions as parameters.
564  * Since calls can return values, an ast_call is also an ast_expression.
565  */
566 struct ast_call_s
567 {
568     ast_expression_common expression;
569     ast_expression *func;
570     ast_expression* *params;
571 };
572 ast_call* ast_call_new(lex_ctx ctx,
573                        ast_expression *funcexpr);
574 void ast_call_delete(ast_call*);
575 bool ast_call_codegen(ast_call*, ast_function*, bool lvalue, ir_value**);
576 bool ast_call_check_types(ast_call*);
577
578 /* Blocks
579  *
580  */
581 struct ast_block_s
582 {
583     ast_expression_common expression;
584
585     ast_value*      *locals;
586     ast_expression* *exprs;
587     ast_expression* *collect;
588 };
589 ast_block* ast_block_new(lex_ctx ctx);
590 void ast_block_delete(ast_block*);
591 bool ast_block_set_type(ast_block*, ast_expression *from);
592
593 bool ast_block_codegen(ast_block*, ast_function*, bool lvalue, ir_value**);
594 void ast_block_collect(ast_block*, ast_expression*);
595
596 bool GMQCC_WARN ast_block_add_expr(ast_block*, ast_expression*);
597
598 /* Function
599  *
600  * Contains a list of blocks... at least in theory.
601  * Usually there's just the main block, other blocks are inside that.
602  *
603  * Technically, functions don't need to be an AST node, since we have
604  * neither functions inside functions, nor lambdas, and function
605  * pointers could just work with a name. However, this way could be
606  * more flexible, and adds no real complexity.
607  */
608 struct ast_function_s
609 {
610     ast_node_common node;
611
612     ast_value  *vtype;
613     const char *name;
614
615     int builtin;
616
617     ir_function *ir_func;
618     ir_block    *curblock;
619     ir_block    **breakblocks;
620     ir_block    **continueblocks;
621
622 #if 0
623     /* In order for early-out logic not to go over
624      * excessive jumps, we remember their target
625      * blocks...
626      */
627     ir_block    *iftrue;
628     ir_block    *iffalse;
629 #endif
630
631     size_t       labelcount;
632     /* in order for thread safety - for the optional
633      * channel abesed multithreading... keeping a buffer
634      * here to use in ast_function_label.
635      */
636     char         labelbuf[64];
637
638     ast_block* *blocks;
639 };
640 ast_function* ast_function_new(lex_ctx ctx, const char *name, ast_value *vtype);
641 /* This will NOT delete the underlying ast_value */
642 void ast_function_delete(ast_function*);
643 /* For "optimized" builds this can just keep returning "foo"...
644  * or whatever...
645  */
646 const char* ast_function_label(ast_function*, const char *prefix);
647
648 bool ast_function_codegen(ast_function *self, ir_builder *builder);
649 bool ast_generate_accessors(ast_value *asvalue, ir_builder *ir);
650
651 /* Expression union
652  */
653 union ast_expression_u
654 {
655     ast_expression_common expression;
656
657     ast_value    value;
658     ast_binary   binary;
659     ast_block    block;
660     ast_ternary  ternary;
661     ast_ifthen   ifthen;
662     ast_store    store;
663     ast_entfield entfield;
664 };
665
666 /* Node union
667  */
668 union ast_node_u
669 {
670     ast_node_common node;
671     ast_expression  expression;
672 };
673
674 #endif