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