ast.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_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
  49 enum {
  50     TYPE_ast_node,
  51     TYPE_ast_expression,
  52     TYPE_ast_value,
  53     TYPE_ast_function,
  54     TYPE_ast_block,
  55     TYPE_ast_binary,
  56     TYPE_ast_store,
  57     TYPE_ast_binstore,
  58     TYPE_ast_entfield,
  59     TYPE_ast_ifthen,
  60     TYPE_ast_ternary,
  61     TYPE_ast_loop,
  62     TYPE_ast_call,
  63     TYPE_ast_unary,
  64     TYPE_ast_return,
  65     TYPE_ast_member
  66 };
  67
  68 #define ast_istype(x, t) ( ((ast_node_common*)x)->nodetype == (TYPE_##t) )
  69 #define ast_ctx(node) (((ast_node_common*)(node))->context)
  70
  71 /* Node interface with common components
  72  */
  73 typedef void ast_node_delete(ast_node*);
  74 typedef struct
  75 {
  76     lex_ctx          context;
  77     /* I don't feel comfortable using keywords like 'delete' as names... */
  78     ast_node_delete *destroy;
  79     int              nodetype;
  80     /* keep: if a node contains this node, 'keep'
  81      * prevents its dtor from destroying this node as well.
  82      */
  83     bool             keep;
  84 } ast_node_common;
  85
  86 #define ast_delete(x) ( ( (ast_node*)(x) ) -> node.destroy )((ast_node*)(x))
  87 #define ast_unref(x) do                     \
  88 {                                           \
  89     if (! (((ast_node*)(x))->node.keep) ) { \
  90         ast_delete(x);                      \
  91     }                                       \
  92 } while(0)
  93
  94 /* Expression interface
  95  *
  96  * Any expression or block returns an ir_value, and needs
  97  * to know the current function.
  98  */
  99 typedef bool ast_expression_codegen(ast_expression*,
 100                                     ast_function*,
 101                                     bool lvalue,
 102                                     ir_value**);
 103 typedef struct
 104 {
 105     ast_node_common         node;
 106     ast_expression_codegen *codegen;
 107     int                     vtype;
 108     ast_expression         *next;
 109     MEM_VECTOR_MAKE(ast_value*, params);
 110     bool                    variadic;
 111     /* The codegen functions should store their output values
 112      * so we can call it multiple times without re-evaluating.
 113      * Store lvalue and rvalue seperately though. So that
 114      * ast_entfield for example can generate both if required.
 115      */
 116     ir_value               *outl;
 117     ir_value               *outr;
 118 } ast_expression_common;
 119 MEM_VECTOR_PROTO(ast_expression_common, ast_value*, params);
 120
 121 /* Value
 122  *
 123  * Types are also values, both have a type and a name.
 124  * especially considering possible constructs like typedefs.
 125  * typedef float foo;
 126  * is like creating a 'float foo', foo serving as the type's name.
 127  */
 128 struct ast_value_s
 129 {
 130     ast_expression_common expression;
 131
 132     const char *name;
 133
 134     /*
 135     int         vtype;
 136     ast_value  *next;
 137     */
 138
 139     bool isconst;
 140     union {
 141         double        vfloat;
 142         int           vint;
 143         vector        vvec;
 144         const char   *vstring;
 145         int           ventity;
 146         ast_function *vfunc;
 147     } constval;
 148
 149     /* usecount for the parser */
 150     size_t uses;
 151
 152     ir_value *ir_v;
 153 };
 154
 155 ast_value* ast_value_new(lex_ctx ctx, const char *name, int qctype);
 156 ast_value* ast_value_copy(const ast_value *self);
 157 /* This will NOT delete an underlying ast_function */
 158 void ast_value_delete(ast_value*);
 159
 160 bool ast_value_set_name(ast_value*, const char *name);
 161
 162 bool ast_value_codegen(ast_value*, ast_function*, bool lvalue, ir_value**);
 163 bool ast_local_codegen(ast_value *self, ir_function *func, bool isparam);
 164 bool ast_global_codegen(ast_value *self, ir_builder *ir);
 165
 166 bool GMQCC_WARN ast_value_params_add(ast_value*, ast_value*);
 167
 168 bool ast_compare_type(ast_expression *a, ast_expression *b);
 169 ast_expression* ast_type_copy(lex_ctx ctx, const ast_expression *ex);
 170 #define ast_type_adopt(a, b) ast_type_adopt_impl((ast_expression*)(a), (ast_expression*)(b))
 171 bool ast_type_adopt_impl(ast_expression *self, const ast_expression *other);
 172 void ast_type_to_string(ast_expression *e, char *buf, size_t bufsize);
 173
 174 /* Binary
 175  *
 176  * A value-returning binary expression.
 177  */
 178 struct ast_binary_s
 179 {
 180     ast_expression_common expression;
 181
 182     int             op;
 183     ast_expression *left;
 184     ast_expression *right;
 185 };
 186 ast_binary* ast_binary_new(lex_ctx    ctx,
 187                            int        op,
 188                            ast_expression *left,
 189                            ast_expression *right);
 190 void ast_binary_delete(ast_binary*);
 191
 192 bool ast_binary_codegen(ast_binary*, ast_function*, bool lvalue, ir_value**);
 193
 194 /* Binstore
 195  *
 196  * An assignment including a binary expression with the source as left operand.
 197  * Eg. a += b; is a binstore { INSTR_STORE, INSTR_ADD, a, b }
 198  */
 199 struct ast_binstore_s
 200 {
 201     ast_expression_common expression;
 202
 203     int             opstore;
 204     int             opbin;
 205     ast_expression *dest;
 206     ast_expression *source;
 207 };
 208 ast_binstore* ast_binstore_new(lex_ctx    ctx,
 209                                int        storeop,
 210                                int        op,
 211                                ast_expression *left,
 212                                ast_expression *right);
 213 void ast_binstore_delete(ast_binstore*);
 214
 215 bool ast_binstore_codegen(ast_binstore*, ast_function*, bool lvalue, ir_value**);
 216
 217 /* Unary
 218  *
 219  * Regular unary expressions: not,neg
 220  */
 221 struct ast_unary_s
 222 {
 223     ast_expression_common expression;
 224
 225     int             op;
 226     ast_expression *operand;
 227 };
 228 ast_unary* ast_unary_new(lex_ctx    ctx,
 229                          int        op,
 230                          ast_expression *expr);
 231 void ast_unary_delete(ast_unary*);
 232
 233 bool ast_unary_codegen(ast_unary*, ast_function*, bool lvalue, ir_value**);
 234
 235 /* Return
 236  *
 237  * Make sure 'return' only happens at the end of a block, otherwise the IR
 238  * will refuse to create further instructions.
 239  * This should be honored by the parser.
 240  */
 241 struct ast_return_s
 242 {
 243     ast_expression_common expression;
 244     ast_expression *operand;
 245 };
 246 ast_return* ast_return_new(lex_ctx    ctx,
 247                            ast_expression *expr);
 248 void ast_return_delete(ast_return*);
 249
 250 bool ast_return_codegen(ast_return*, ast_function*, bool lvalue, ir_value**);
 251
 252 /* Entity-field
 253  *
 254  * This must do 2 things:
 255  * -) Provide a way to fetch an entity field value. (Rvalue)
 256  * -) Provide a pointer to an entity field. (Lvalue)
 257  * The problem:
 258  * In original QC, there's only a STORE via pointer, but
 259  * no LOAD via pointer.
 260  * So we must know beforehand if we are going to read or assign
 261  * the field.
 262  * For this we will have to extend the codegen() functions with
 263  * a flag saying whether or not we need an L or an R-value.
 264  */
 265 struct ast_entfield_s
 266 {
 267     ast_expression_common expression;
 268     /* The entity can come from an expression of course. */
 269     ast_expression *entity;
 270     /* As can the field, it just must result in a value of TYPE_FIELD */
 271     ast_expression *field;
 272 };
 273 ast_entfield* ast_entfield_new(lex_ctx ctx, ast_expression *entity, ast_expression *field);
 274 void ast_entfield_delete(ast_entfield*);
 275
 276 bool ast_entfield_codegen(ast_entfield*, ast_function*, bool lvalue, ir_value**);
 277
 278 /* Member access:
 279  *
 280  * For now used for vectors. If we get structs or unions
 281  * we can have them handled here as well.
 282  */
 283 struct ast_member_s
 284 {
 285     ast_expression_common expression;
 286     ast_expression *owner;
 287     unsigned int    field;
 288 };
 289 ast_member* ast_member_new(lex_ctx ctx, ast_expression *owner, unsigned int field);
 290 void ast_member_delete(ast_member*);
 291
 292 bool ast_member_codegen(ast_member*, ast_function*, bool lvalue, ir_value**);
 293
 294 /* Store
 295  *
 296  * Stores left<-right and returns left.
 297  * Specialized binary expression node
 298  */
 299 struct ast_store_s
 300 {
 301     ast_expression_common expression;
 302     int             op;
 303     ast_expression *dest;
 304     ast_expression *source;
 305 };
 306 ast_store* ast_store_new(lex_ctx ctx, int op,
 307                          ast_expression *d, ast_expression *s);
 308 void ast_store_delete(ast_store*);
 309
 310 bool ast_store_codegen(ast_store*, ast_function*, bool lvalue, ir_value**);
 311
 312 /* If
 313  *
 314  * A general 'if then else' statement, either side can be NULL and will
 315  * thus be omitted. It is an error for *both* cases to be NULL at once.
 316  *
 317  * During its 'codegen' it'll be changing the ast_function's block.
 318  *
 319  * An if is also an "expression". Its codegen will put NULL into the
 320  * output field though. For ternary expressions an ast_ternary will be
 321  * added.
 322  */
 323 struct ast_ifthen_s
 324 {
 325     ast_expression_common expression;
 326     ast_expression *cond;
 327     /* It's all just 'expressions', since an ast_block is one too. */
 328     ast_expression *on_true;
 329     ast_expression *on_false;
 330 };
 331 ast_ifthen* ast_ifthen_new(lex_ctx ctx, ast_expression *cond, ast_expression *ontrue, ast_expression *onfalse);
 332 void ast_ifthen_delete(ast_ifthen*);
 333
 334 bool ast_ifthen_codegen(ast_ifthen*, ast_function*, bool lvalue, ir_value**);
 335
 336 /* Ternary expressions...
 337  *
 338  * Contrary to 'if-then-else' nodes, ternary expressions actually
 339  * return a value, otherwise they behave the very same way.
 340  * The difference in 'codegen' is that it'll return the value of
 341  * a PHI node.
 342  *
 343  * The other difference is that in an ast_ternary, NEITHER side
 344  * must be NULL, there's ALWAYS an else branch.
 345  *
 346  * This is the only ast_node beside ast_value which contains
 347  * an ir_value. Theoretically we don't need to remember it though.
 348  */
 349 struct ast_ternary_s
 350 {
 351     ast_expression_common expression;
 352     ast_expression *cond;
 353     /* It's all just 'expressions', since an ast_block is one too. */
 354     ast_expression *on_true;
 355     ast_expression *on_false;
 356     /* After a ternary expression we find ourselves in a new IR block
 357      * and start with a PHI node */
 358     ir_value       *phi_out;
 359 };
 360 ast_ternary* ast_ternary_new(lex_ctx ctx, ast_expression *cond, ast_expression *ontrue, ast_expression *onfalse);
 361 void ast_ternary_delete(ast_ternary*);
 362
 363 bool ast_ternary_codegen(ast_ternary*, ast_function*, bool lvalue, ir_value**);
 364
 365 /* A general loop node
 366  *
 367  * For convenience it contains 4 parts:
 368  * -) (ini) = initializing expression
 369  * -) (pre) = pre-loop condition
 370  * -) (pst) = post-loop condition
 371  * -) (inc) = "increment" expression
 372  * The following is a psudo-representation of this loop
 373  * note that '=>' bears the logical meaning of "implies".
 374  * (a => b) equals (!a || b)
 375
 376 {ini};
 377 while (has_pre => {pre})
 378 {
 379     {body};
 380
 381 continue:      // a 'continue' will jump here
 382     if (has_pst => {pst})
 383         break;
 384
 385     {inc};
 386 }
 387  */
 388 struct ast_loop_s
 389 {
 390     ast_expression_common expression;
 391     ast_expression *initexpr;
 392     ast_expression *precond;
 393     ast_expression *postcond;
 394     ast_expression *increment;
 395     ast_expression *body;
 396 };
 397 ast_loop* ast_loop_new(lex_ctx ctx,
 398                        ast_expression *initexpr,
 399                        ast_expression *precond,
 400                        ast_expression *postcond,
 401                        ast_expression *increment,
 402                        ast_expression *body);
 403 void ast_loop_delete(ast_loop*);
 404
 405 bool ast_loop_codegen(ast_loop*, ast_function*, bool lvalue, ir_value**);
 406
 407 /* CALL node
 408  *
 409  * Contains an ast_expression as target, rather than an ast_function/value.
 410  * Since it's how QC works, every ast_function has an ast_value
 411  * associated anyway - in other words, the VM contains function
 412  * pointers for every function anyway. Thus, this node will call
 413  * expression.
 414  * Additionally it contains a list of ast_expressions as parameters.
 415  * Since calls can return values, an ast_call is also an ast_expression.
 416  */
 417 struct ast_call_s
 418 {
 419     ast_expression_common expression;
 420     ast_expression *func;
 421     MEM_VECTOR_MAKE(ast_expression*, params);
 422 };
 423 ast_call* ast_call_new(lex_ctx ctx,
 424                        ast_expression *funcexpr);
 425 void ast_call_delete(ast_call*);
 426 bool ast_call_codegen(ast_call*, ast_function*, bool lvalue, ir_value**);
 427 bool ast_call_check_types(ast_call*);
 428
 429 MEM_VECTOR_PROTO(ast_call, ast_expression*, params);
 430
 431 /* Blocks
 432  *
 433  */
 434 struct ast_block_s
 435 {
 436     ast_expression_common expression;
 437
 438     MEM_VECTOR_MAKE(ast_value*,      locals);
 439     MEM_VECTOR_MAKE(ast_expression*, exprs);
 440     MEM_VECTOR_MAKE(ast_expression*, collect);
 441 };
 442 ast_block* ast_block_new(lex_ctx ctx);
 443 void ast_block_delete(ast_block*);
 444 bool ast_block_set_type(ast_block*, ast_expression *from);
 445
 446 MEM_VECTOR_PROTO(ast_block, ast_value*, locals);
 447 MEM_VECTOR_PROTO(ast_block, ast_expression*, exprs);
 448 MEM_VECTOR_PROTO(ast_block, ast_expression*, collect);
 449
 450 bool ast_block_codegen(ast_block*, ast_function*, bool lvalue, ir_value**);
 451 bool ast_block_collect(ast_block*, ast_expression*);
 452
 453 /* Function
 454  *
 455  * Contains a list of blocks... at least in theory.
 456  * Usually there's just the main block, other blocks are inside that.
 457  *
 458  * Technically, functions don't need to be an AST node, since we have
 459  * neither functions inside functions, nor lambdas, and function
 460  * pointers could just work with a name. However, this way could be
 461  * more flexible, and adds no real complexity.
 462  */
 463 struct ast_function_s
 464 {
 465     ast_node_common node;
 466
 467     ast_value  *vtype;
 468     const char *name;
 469
 470     int builtin;
 471
 472     ir_function *ir_func;
 473     ir_block    *curblock;
 474     ir_block    *breakblock;
 475     ir_block    *continueblock;
 476
 477     size_t       labelcount;
 478     /* in order for thread safety - for the optional
 479      * channel abesed multithreading... keeping a buffer
 480      * here to use in ast_function_label.
 481      */
 482     char         labelbuf[64];
 483
 484     MEM_VECTOR_MAKE(ast_block*, blocks);
 485 };
 486 ast_function* ast_function_new(lex_ctx ctx, const char *name, ast_value *vtype);
 487 /* This will NOT delete the underlying ast_value */
 488 void ast_function_delete(ast_function*);
 489 /* For "optimized" builds this can just keep returning "foo"...
 490  * or whatever...
 491  */
 492 const char* ast_function_label(ast_function*, const char *prefix);
 493
 494 MEM_VECTOR_PROTO(ast_function, ast_block*, blocks);
 495
 496 bool ast_function_codegen(ast_function *self, ir_builder *builder);
 497
 498 /* Expression union
 499  */
 500 union ast_expression_u
 501 {
 502     ast_expression_common expression;
 503
 504     ast_value    value;
 505     ast_binary   binary;
 506     ast_block    block;
 507     ast_ternary  ternary;
 508     ast_ifthen   ifthen;
 509     ast_store    store;
 510     ast_entfield entfield;
 511 };
 512
 513 /* Node union
 514  */
 515 union ast_node_u
 516 {
 517     ast_node_common node;
 518     ast_expression  expression;
 519 };
 520
 521 #endif