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