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