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:
12 * The above copyright notice and this permission notice shall be included in all
13 * copies or substantial portions of the Software.
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
30 #define ast_instantiate(T, ctx, destroyfn) \
31 T* self = (T*)mem_a(sizeof(T)); \
35 ast_node_init((ast_node*)self, ctx); \
36 ( (ast_node*)self )->node.destroy = (ast_node_delete*)destroyfn
38 /* It must not be possible to get here. */
39 static void _ast_node_destroy(ast_node *self)
41 fprintf(stderr, "ast node missing destroy()\n");
45 /* Initialize main ast node aprts */
46 static void ast_node_init(ast_node *self, lex_ctx ctx)
48 self->node.context = ctx;
49 self->node.destroy = &_ast_node_destroy;
50 self->node.keep = false;
53 /* General expression initialization */
54 static void ast_expression_init(ast_expression *self,
55 ast_expression_codegen *codegen)
57 self->expression.codegen = codegen;
58 self->expression.vtype = TYPE_VOID;
59 self->expression.next = NULL;
62 static void ast_expression_delete(ast_expression *self)
64 if (self->expression.next)
65 ast_delete(self->expression.next);
68 static void ast_expression_delete_full(ast_expression *self)
70 ast_expression_delete(self);
74 static ast_expression* ast_type_copy(lex_ctx ctx, const ast_expression *ex)
76 const ast_expression_common *cpex;
77 ast_expression_common *selfex;
83 ast_instantiate(ast_expression, ctx, ast_expression_delete_full);
85 cpex = &ex->expression;
86 selfex = &self->expression;
88 selfex->vtype = cpex->vtype;
91 selfex->next = ast_type_copy(ctx, cpex->next);
100 /* This may never be codegen()d */
101 selfex->codegen = NULL;
106 ast_value* ast_value_new(lex_ctx ctx, const char *name, int t)
108 ast_instantiate(ast_value, ctx, ast_value_delete);
109 ast_expression_init((ast_expression*)self,
110 (ast_expression_codegen*)&ast_value_codegen);
111 self->expression.node.keep = true; /* keep */
113 self->name = name ? util_strdup(name) : NULL;
114 self->expression.vtype = t;
115 self->expression.next = NULL;
116 MEM_VECTOR_INIT(self, params);
117 self->isconst = false;
118 memset(&self->constval, 0, sizeof(self->constval));
124 MEM_VEC_FUNCTIONS(ast_value, ast_value*, params)
126 void ast_value_delete(ast_value* self)
130 mem_d((void*)self->name);
131 for (i = 0; i < self->params_count; ++i)
132 ast_value_delete(self->params[i]); /* delete, the ast_function is expected to die first */
133 MEM_VECTOR_CLEAR(self, params);
135 switch (self->expression.vtype)
138 mem_d((void*)self->constval.vstring);
141 /* unlink us from the function node */
142 self->constval.vfunc->vtype = NULL;
144 /* NOTE: delete function? currently collected in
145 * the parser structure
151 ast_expression_delete((ast_expression*)self);
155 bool ast_value_set_name(ast_value *self, const char *name)
158 mem_d((void*)self->name);
159 self->name = util_strdup(name);
163 ast_binary* ast_binary_new(lex_ctx ctx, int op,
164 ast_expression* left, ast_expression* right)
166 ast_instantiate(ast_binary, ctx, ast_binary_delete);
167 ast_expression_init((ast_expression*)self, (ast_expression_codegen*)&ast_binary_codegen);
176 void ast_binary_delete(ast_binary *self)
178 ast_unref(self->left);
179 ast_unref(self->right);
180 ast_expression_delete((ast_expression*)self);
184 ast_entfield* ast_entfield_new(lex_ctx ctx, ast_expression *entity, ast_expression *field)
186 const ast_expression *outtype;
188 ast_instantiate(ast_entfield, ctx, ast_entfield_delete);
190 if (field->expression.vtype != TYPE_FIELD) {
195 outtype = field->expression.next;
198 /* Error: field has no type... */
202 ast_expression_init((ast_expression*)self, (ast_expression_codegen*)&ast_entfield_codegen);
204 self->expression.vtype = outtype->expression.vtype;
205 self->expression.next = ast_type_copy(ctx, outtype->expression.next);
207 self->entity = entity;
213 void ast_entfield_delete(ast_entfield *self)
215 ast_unref(self->entity);
216 ast_unref(self->field);
217 ast_expression_delete((ast_expression*)self);
221 ast_ifthen* ast_ifthen_new(lex_ctx ctx, ast_expression *cond, ast_expression *ontrue, ast_expression *onfalse)
223 ast_instantiate(ast_ifthen, ctx, ast_ifthen_delete);
224 if (!ontrue && !onfalse) {
225 /* because it is invalid */
229 ast_expression_init((ast_expression*)self, (ast_expression_codegen*)&ast_ifthen_codegen);
232 self->on_true = ontrue;
233 self->on_false = onfalse;
238 void ast_ifthen_delete(ast_ifthen *self)
240 ast_unref(self->cond);
242 ast_unref(self->on_true);
244 ast_unref(self->on_false);
245 ast_expression_delete((ast_expression*)self);
249 ast_ternary* ast_ternary_new(lex_ctx ctx, ast_expression *cond, ast_expression *ontrue, ast_expression *onfalse)
251 ast_instantiate(ast_ternary, ctx, ast_ternary_delete);
252 /* This time NEITHER must be NULL */
253 if (!ontrue || !onfalse) {
257 ast_expression_init((ast_expression*)self, (ast_expression_codegen*)&ast_ternary_codegen);
260 self->on_true = ontrue;
261 self->on_false = onfalse;
262 self->phi_out = NULL;
267 void ast_ternary_delete(ast_ternary *self)
269 ast_unref(self->cond);
270 ast_unref(self->on_true);
271 ast_unref(self->on_false);
272 ast_expression_delete((ast_expression*)self);
276 ast_store* ast_store_new(lex_ctx ctx, int op,
277 ast_value *dest, ast_expression *source)
279 ast_instantiate(ast_store, ctx, ast_store_delete);
280 ast_expression_init((ast_expression*)self, (ast_expression_codegen*)&ast_store_codegen);
284 self->source = source;
289 void ast_store_delete(ast_store *self)
291 ast_unref(self->dest);
292 ast_unref(self->source);
293 ast_expression_delete((ast_expression*)self);
297 ast_block* ast_block_new(lex_ctx ctx)
299 ast_instantiate(ast_block, ctx, ast_block_delete);
300 ast_expression_init((ast_expression*)self,
301 (ast_expression_codegen*)&ast_block_codegen);
303 MEM_VECTOR_INIT(self, locals);
304 MEM_VECTOR_INIT(self, exprs);
308 MEM_VEC_FUNCTIONS(ast_block, ast_value*, locals)
309 MEM_VEC_FUNCTIONS(ast_block, ast_expression*, exprs)
311 void ast_block_delete(ast_block *self)
314 for (i = 0; i < self->exprs_count; ++i)
315 ast_unref(self->exprs[i]);
316 MEM_VECTOR_CLEAR(self, exprs);
317 for (i = 0; i < self->locals_count; ++i)
318 ast_delete(self->locals[i]);
319 MEM_VECTOR_CLEAR(self, locals);
320 ast_expression_delete((ast_expression*)self);
324 ast_function* ast_function_new(lex_ctx ctx, const char *name, ast_value *vtype)
326 ast_instantiate(ast_function, ctx, ast_function_delete);
330 vtype->expression.vtype != TYPE_FUNCTION)
337 self->name = name ? util_strdup(name) : NULL;
338 MEM_VECTOR_INIT(self, blocks);
340 self->labelcount = 0;
342 self->ir_func = NULL;
343 self->curblock = NULL;
345 vtype->isconst = true;
346 vtype->constval.vfunc = self;
351 MEM_VEC_FUNCTIONS(ast_function, ast_block*, blocks)
353 void ast_function_delete(ast_function *self)
357 mem_d((void*)self->name);
359 /* ast_value_delete(self->vtype); */
360 self->vtype->isconst = false;
361 self->vtype->constval.vfunc = NULL;
362 /* We use unref - if it was stored in a global table it is supposed
363 * to be deleted from *there*
365 ast_unref(self->vtype);
367 for (i = 0; i < self->blocks_count; ++i)
368 ast_delete(self->blocks[i]);
369 MEM_VECTOR_CLEAR(self, blocks);
373 static void ast_util_hexitoa(char *buf, size_t size, unsigned int num)
375 unsigned int base = 10;
376 #define checknul() do { if (size == 1) { *buf = 0; return; } } while (0)
377 #define addch(x) do { *buf++ = (x); --size; checknul(); } while (0)
386 int digit = num % base;
397 const char* ast_function_label(ast_function *self, const char *prefix)
399 size_t id = (self->labelcount++);
400 size_t len = strlen(prefix);
401 strncpy(self->labelbuf, prefix, sizeof(self->labelbuf));
402 ast_util_hexitoa(self->labelbuf + len, sizeof(self->labelbuf)-len, id);
403 return self->labelbuf;
406 /*********************************************************************/
408 * by convention you must never pass NULL to the 'ir_value **out'
409 * parameter. If you really don't care about the output, pass a dummy.
410 * But I can't imagine a pituation where the output is truly unnecessary.
413 bool ast_value_codegen(ast_value *self, ast_function *func, bool lvalue, ir_value **out)
415 /* NOTE: This is the codegen for a variable used in an expression.
416 * It is not the codegen to generate the value. For this purpose,
417 * ast_local_codegen and ast_global_codegen are to be used before this
418 * is executed. ast_function_codegen should take care of its locals,
419 * and the ast-user should take care of ast_global_codegen to be used
420 * on all the globals.
428 bool ast_global_codegen(ast_value *self, ir_builder *ir)
431 if (self->isconst && self->expression.vtype == TYPE_FUNCTION)
433 ir_function *func = ir_builder_create_function(ir, self->name);
437 self->constval.vfunc->ir_func = func;
438 /* The function is filled later on ast_function_codegen... */
442 v = ir_builder_create_global(ir, self->name, self->expression.vtype);
447 switch (self->expression.vtype)
450 if (!ir_value_set_float(v, self->constval.vfloat))
454 if (!ir_value_set_vector(v, self->constval.vvec))
458 if (!ir_value_set_string(v, self->constval.vstring))
462 /* Cannot generate an IR value for a function,
463 * need a pointer pointing to a function rather.
467 printf("TODO: global constant type %i\n", self->expression.vtype);
472 /* link us to the ir_value */
476 error: /* clean up */
481 bool ast_local_codegen(ast_value *self, ir_function *func)
484 if (self->isconst && self->expression.vtype == TYPE_FUNCTION)
486 /* Do we allow local functions? I think not...
487 * this is NOT a function pointer atm.
492 v = ir_function_create_local(func, self->name, self->expression.vtype);
496 /* A constant local... hmmm...
497 * I suppose the IR will have to deal with this
500 switch (self->expression.vtype)
503 if (!ir_value_set_float(v, self->constval.vfloat))
507 if (!ir_value_set_vector(v, self->constval.vvec))
511 if (!ir_value_set_string(v, self->constval.vstring))
515 printf("TODO: global constant type %i\n", self->expression.vtype);
520 /* link us to the ir_value */
524 error: /* clean up */
529 bool ast_function_codegen(ast_function *self, ir_builder *ir)
537 printf("ast_function's related ast_value was not generated yet\n");
541 self->curblock = ir_function_create_block(irf, "entry");
545 for (i = 0; i < self->blocks_count; ++i) {
546 ast_expression_codegen *gen = self->blocks[i]->expression.codegen;
547 if (!(*gen)((ast_expression*)self->blocks[i], self, false, &dummy))
551 /* TODO: check return types */
552 if (!self->curblock->is_return)
554 if (!self->vtype->expression.next ||
555 self->vtype->expression.next->expression.vtype == TYPE_VOID)
556 return ir_block_create_return(self->curblock, NULL);
559 /* error("missing return"); */
566 /* Note, you will not see ast_block_codegen generate ir_blocks.
567 * To the AST and the IR, blocks are 2 different things.
568 * In the AST it represents a block of code, usually enclosed in
569 * curly braces {...}.
570 * While in the IR it represents a block in terms of control-flow.
572 bool ast_block_codegen(ast_block *self, ast_function *func, bool lvalue, ir_value **out)
577 * Note: an ast-representation using the comma-operator
578 * of the form: (a, b, c) = x should not assign to c...
582 /* output is NULL at first, we'll have each expression
583 * assign to out output, thus, a comma-operator represention
584 * using an ast_block will return the last generated value,
585 * so: (b, c) + a executed both b and c, and returns c,
586 * which is then added to a.
590 /* generate locals */
591 for (i = 0; i < self->locals_count; ++i)
593 if (!ast_local_codegen(self->locals[i], func->ir_func))
597 for (i = 0; i < self->exprs_count; ++i)
599 ast_expression_codegen *gen = self->exprs[i]->expression.codegen;
600 if (!(*gen)(self->exprs[i], func, false, out))
607 bool ast_store_codegen(ast_store *self, ast_function *func, bool lvalue, ir_value **out)
609 ast_expression_codegen *cgen;
610 ir_value *left, *right;
612 cgen = self->dest->expression.codegen;
614 if (!(*cgen)((ast_expression*)(self->dest), func, true, &left))
617 cgen = self->source->expression.codegen;
619 if (!(*cgen)((ast_expression*)(self->source), func, false, &right))
622 if (!ir_block_create_store_op(func->curblock, self->op, left, right))
625 /* Theoretically, an assinment returns its left side as an
626 * lvalue, if we don't need an lvalue though, we return
627 * the right side as an rvalue, otherwise we have to
628 * somehow know whether or not we need to dereference the pointer
629 * on the left side - that is: OP_LOAD if it was an address.
630 * Also: in original QC we cannot OP_LOADP *anyway*.
632 *out = (lvalue ? left : right);
637 bool ast_binary_codegen(ast_binary *self, ast_function *func, bool lvalue, ir_value **out)
639 ast_expression_codegen *cgen;
640 ir_value *left, *right;
642 /* In the context of a binary operation, we can disregard
647 cgen = self->left->expression.codegen;
649 if (!(*cgen)((ast_expression*)(self->left), func, false, &left))
652 cgen = self->right->expression.codegen;
654 if (!(*cgen)((ast_expression*)(self->right), func, false, &right))
657 *out = ir_block_create_binop(func->curblock, ast_function_label(func, "bin"),
658 self->op, left, right);
665 bool ast_entfield_codegen(ast_entfield *self, ast_function *func, bool lvalue, ir_value **out)
667 ast_expression_codegen *cgen;
668 ir_value *ent, *field;
670 /* This function needs to take the 'lvalue' flag into account!
671 * As lvalue we provide a field-pointer, as rvalue we provide the
675 cgen = self->entity->expression.codegen;
676 if (!(*cgen)((ast_expression*)(self->entity), func, false, &ent))
679 cgen = self->field->expression.codegen;
680 if (!(*cgen)((ast_expression*)(self->field), func, false, &field))
685 *out = ir_block_create_fieldaddress(func->curblock, ast_function_label(func, "efa"),
688 *out = ir_block_create_load_from_ent(func->curblock, ast_function_label(func, "efv"),
689 ent, field, self->expression.vtype);
694 /* Hm that should be it... */
698 bool ast_ifthen_codegen(ast_ifthen *self, ast_function *func, bool lvalue, ir_value **out)
700 ast_expression_codegen *cgen;
705 ir_block *cond = func->curblock;
710 /* We don't output any value, thus also don't care about r/lvalue */
714 /* create blocks first, it's nicer if they're ordered */
717 /* create on-true block */
718 ontrue = ir_function_create_block(func->ir_func, ast_function_label(func, "ontrue"));
724 if (self->on_false) {
725 /* create on-false block */
726 onfalse = ir_function_create_block(func->ir_func, ast_function_label(func, "onfalse"));
732 merge = ir_function_create_block(func->ir_func, ast_function_label(func, "endif"));
736 /* generate the condition */
737 func->curblock = cond;
738 cgen = self->cond->expression.codegen;
739 if (!(*cgen)((ast_expression*)(self->cond), func, false, &condval))
742 if (!ir_block_create_if(cond, condval,
743 (ontrue ? ontrue : merge),
744 (onfalse ? onfalse : merge)))
751 /* enter the block */
752 func->curblock = ontrue;
755 cgen = self->on_true->expression.codegen;
756 if (!(*cgen)((ast_expression*)(self->on_true), func, false, &dummy))
759 /* jump to merge block */
760 if (!ir_block_create_jump(ontrue, merge))
766 /* enter the block */
767 func->curblock = onfalse;
770 cgen = self->on_false->expression.codegen;
771 if (!(*cgen)((ast_expression*)(self->on_false), func, false, &dummy))
774 /* jump to merge block */
775 if (!ir_block_create_jump(ontrue, merge))
779 /* Now enter the merge block */
780 func->curblock = merge;
785 bool ast_ternary_codegen(ast_ternary *self, ast_function *func, bool lvalue, ir_value **out)
787 ast_expression_codegen *cgen;
790 ir_value *trueval, *falseval;
793 ir_block *cond = func->curblock;
798 /* In theory it shouldn't be possible to pass through a node twice, but
799 * in case we add any kind of optimization pass for the AST itself, it
800 * may still happen, thus we remember a created ir_value and simply return one
801 * if it already exists.
804 *out = self->phi_out;
808 /* Ternary can never create an lvalue... */
812 /* In the following, contraty to ast_ifthen, we assume both paths exist. */
814 /* create on-true block */
815 ontrue = ir_function_create_block(func->ir_func, ast_function_label(func, "tern_T"));
819 /* create on-false block */
820 onfalse = ir_function_create_block(func->ir_func, ast_function_label(func, "tern_F"));
824 merge = ir_function_create_block(func->ir_func, ast_function_label(func, "tern_out"));
828 /* generate the condition */
829 func->curblock = cond;
830 cgen = self->cond->expression.codegen;
831 if (!(*cgen)((ast_expression*)(self->cond), func, false, &condval))
834 if (!ir_block_create_if(cond, condval, ontrue, onfalse))
838 /* enter the block */
839 func->curblock = ontrue;
842 cgen = self->on_true->expression.codegen;
843 if (!(*cgen)((ast_expression*)(self->on_true), func, false, &trueval))
846 /* jump to merge block */
847 if (!ir_block_create_jump(ontrue, merge))
851 /* enter the block */
852 func->curblock = onfalse;
855 cgen = self->on_false->expression.codegen;
856 if (!(*cgen)((ast_expression*)(self->on_false), func, false, &falseval))
859 /* jump to merge block */
860 if (!ir_block_create_jump(ontrue, merge))
863 /* Now enter the merge block */
864 func->curblock = merge;
866 /* Here, now, we need a PHI node
867 * but first some sanity checking...
869 if (trueval->vtype != falseval->vtype) {
870 /* error("ternary with different types on the two sides"); */
875 phi = ir_block_create_phi(merge, ast_function_label(func, "phi"), trueval->vtype);
877 !ir_phi_add(phi, ontrue, trueval) ||
878 !ir_phi_add(phi, onfalse, falseval))
883 self->phi_out = ir_phi_value(phi);
884 *out = self->phi_out;