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
28 /***********************************************************************
29 * Type sizes used at multiple points in the IR codegen
32 size_t type_sizeof[TYPE_COUNT] = {
39 1, /* TYPE_FUNCTION */
47 uint16_t type_store_instr[TYPE_COUNT] = {
48 INSTR_STORE_F, /* should use I when having integer support */
55 INSTR_STORE_ENT, /* should use I */
57 INSTR_STORE_ENT, /* integer type */
59 INSTR_STORE_V, /* variant, should never be accessed */
62 uint16_t type_storep_instr[TYPE_COUNT] = {
63 INSTR_STOREP_F, /* should use I when having integer support */
70 INSTR_STOREP_ENT, /* should use I */
72 INSTR_STOREP_ENT, /* integer type */
74 INSTR_STOREP_V, /* variant, should never be accessed */
77 MEM_VEC_FUNCTIONS(ir_value_vector, ir_value*, v)
79 /***********************************************************************
83 ir_builder* ir_builder_new(const char *modulename)
87 self = (ir_builder*)mem_a(sizeof(*self));
91 MEM_VECTOR_INIT(self, functions);
92 MEM_VECTOR_INIT(self, globals);
93 MEM_VECTOR_INIT(self, fields);
95 if (!ir_builder_set_name(self, modulename)) {
100 /* globals which always exist */
102 /* for now we give it a vector size */
103 ir_builder_create_global(self, "OFS_RETURN", TYPE_VARIANT);
108 MEM_VEC_FUNCTIONS(ir_builder, ir_value*, globals)
109 MEM_VEC_FUNCTIONS(ir_builder, ir_value*, fields)
110 MEM_VEC_FUNCTIONS(ir_builder, ir_function*, functions)
112 void ir_builder_delete(ir_builder* self)
115 mem_d((void*)self->name);
116 for (i = 0; i != self->functions_count; ++i) {
117 ir_function_delete(self->functions[i]);
119 MEM_VECTOR_CLEAR(self, functions);
120 for (i = 0; i != self->globals_count; ++i) {
121 ir_value_delete(self->globals[i]);
123 MEM_VECTOR_CLEAR(self, fields);
124 for (i = 0; i != self->fields_count; ++i) {
125 ir_value_delete(self->fields[i]);
127 MEM_VECTOR_CLEAR(self, fields);
131 bool ir_builder_set_name(ir_builder *self, const char *name)
134 mem_d((void*)self->name);
135 self->name = util_strdup(name);
139 ir_function* ir_builder_get_function(ir_builder *self, const char *name)
142 for (i = 0; i < self->functions_count; ++i) {
143 if (!strcmp(name, self->functions[i]->name))
144 return self->functions[i];
149 ir_function* ir_builder_create_function(ir_builder *self, const char *name, int outtype)
151 ir_function *fn = ir_builder_get_function(self, name);
156 fn = ir_function_new(self, outtype);
157 if (!ir_function_set_name(fn, name) ||
158 !ir_builder_functions_add(self, fn) )
160 ir_function_delete(fn);
164 fn->value = ir_builder_create_global(self, fn->name, TYPE_FUNCTION);
166 ir_function_delete(fn);
170 fn->value->isconst = true;
171 fn->value->outtype = outtype;
172 fn->value->constval.vfunc = fn;
173 fn->value->context = fn->context;
178 ir_value* ir_builder_get_global(ir_builder *self, const char *name)
181 for (i = 0; i < self->globals_count; ++i) {
182 if (!strcmp(self->globals[i]->name, name))
183 return self->globals[i];
188 ir_value* ir_builder_create_global(ir_builder *self, const char *name, int vtype)
190 ir_value *ve = ir_builder_get_global(self, name);
195 ve = ir_value_var(name, store_global, vtype);
196 if (!ir_builder_globals_add(self, ve)) {
203 ir_value* ir_builder_get_field(ir_builder *self, const char *name)
206 for (i = 0; i < self->fields_count; ++i) {
207 if (!strcmp(self->fields[i]->name, name))
208 return self->fields[i];
214 ir_value* ir_builder_create_field(ir_builder *self, const char *name, int vtype)
216 ir_value *ve = ir_builder_get_field(self, name);
221 ve = ir_value_var(name, store_global, TYPE_FIELD);
222 ve->fieldtype = vtype;
223 if (!ir_builder_fields_add(self, ve)) {
230 /***********************************************************************
234 bool ir_function_naive_phi(ir_function*);
235 void ir_function_enumerate(ir_function*);
236 bool ir_function_calculate_liferanges(ir_function*);
237 bool ir_function_allocate_locals(ir_function*);
239 ir_function* ir_function_new(ir_builder* owner, int outtype)
242 self = (ir_function*)mem_a(sizeof(*self));
248 if (!ir_function_set_name(self, "<@unnamed>")) {
253 self->context.file = "<@no context>";
254 self->context.line = 0;
255 self->outtype = outtype;
258 MEM_VECTOR_INIT(self, params);
259 MEM_VECTOR_INIT(self, blocks);
260 MEM_VECTOR_INIT(self, values);
261 MEM_VECTOR_INIT(self, locals);
266 MEM_VEC_FUNCTIONS(ir_function, ir_value*, values)
267 MEM_VEC_FUNCTIONS(ir_function, ir_block*, blocks)
268 MEM_VEC_FUNCTIONS(ir_function, ir_value*, locals)
269 MEM_VEC_FUNCTIONS(ir_function, int, params)
271 bool ir_function_set_name(ir_function *self, const char *name)
274 mem_d((void*)self->name);
275 self->name = util_strdup(name);
279 void ir_function_delete(ir_function *self)
282 mem_d((void*)self->name);
284 for (i = 0; i != self->blocks_count; ++i)
285 ir_block_delete(self->blocks[i]);
286 MEM_VECTOR_CLEAR(self, blocks);
288 MEM_VECTOR_CLEAR(self, params);
290 for (i = 0; i != self->values_count; ++i)
291 ir_value_delete(self->values[i]);
292 MEM_VECTOR_CLEAR(self, values);
294 for (i = 0; i != self->locals_count; ++i)
295 ir_value_delete(self->locals[i]);
296 MEM_VECTOR_CLEAR(self, locals);
298 /* self->value is deleted by the builder */
303 bool GMQCC_WARN ir_function_collect_value(ir_function *self, ir_value *v)
305 return ir_function_values_add(self, v);
308 ir_block* ir_function_create_block(ir_function *self, const char *label)
310 ir_block* bn = ir_block_new(self, label);
311 memcpy(&bn->context, &self->context, sizeof(self->context));
312 if (!ir_function_blocks_add(self, bn)) {
319 bool ir_function_finalize(ir_function *self)
324 if (!ir_function_naive_phi(self))
327 ir_function_enumerate(self);
329 if (!ir_function_calculate_liferanges(self))
332 if (!ir_function_allocate_locals(self))
337 ir_value* ir_function_get_local(ir_function *self, const char *name)
340 for (i = 0; i < self->locals_count; ++i) {
341 if (!strcmp(self->locals[i]->name, name))
342 return self->locals[i];
347 ir_value* ir_function_create_local(ir_function *self, const char *name, int vtype, bool param)
349 ir_value *ve = ir_function_get_local(self, name);
355 self->locals_count &&
356 self->locals[self->locals_count-1]->store != store_param) {
357 printf("cannot add parameters after adding locals\n");
361 ve = ir_value_var(name, (param ? store_param : store_local), vtype);
362 if (!ir_function_locals_add(self, ve)) {
369 /***********************************************************************
373 ir_block* ir_block_new(ir_function* owner, const char *name)
376 self = (ir_block*)mem_a(sizeof(*self));
380 memset(self, 0, sizeof(*self));
383 if (!ir_block_set_label(self, name)) {
388 self->context.file = "<@no context>";
389 self->context.line = 0;
391 MEM_VECTOR_INIT(self, instr);
392 MEM_VECTOR_INIT(self, entries);
393 MEM_VECTOR_INIT(self, exits);
396 self->is_return = false;
398 MEM_VECTOR_INIT(self, living);
400 self->generated = false;
404 MEM_VEC_FUNCTIONS(ir_block, ir_instr*, instr)
405 MEM_VEC_FUNCTIONS_ALL(ir_block, ir_block*, entries)
406 MEM_VEC_FUNCTIONS_ALL(ir_block, ir_block*, exits)
407 MEM_VEC_FUNCTIONS_ALL(ir_block, ir_value*, living)
409 void ir_block_delete(ir_block* self)
413 for (i = 0; i != self->instr_count; ++i)
414 ir_instr_delete(self->instr[i]);
415 MEM_VECTOR_CLEAR(self, instr);
416 MEM_VECTOR_CLEAR(self, entries);
417 MEM_VECTOR_CLEAR(self, exits);
418 MEM_VECTOR_CLEAR(self, living);
422 bool ir_block_set_label(ir_block *self, const char *name)
425 mem_d((void*)self->label);
426 self->label = util_strdup(name);
427 return !!self->label;
430 /***********************************************************************
434 ir_instr* ir_instr_new(ir_block* owner, int op)
437 self = (ir_instr*)mem_a(sizeof(*self));
442 self->context.file = "<@no context>";
443 self->context.line = 0;
445 self->_ops[0] = NULL;
446 self->_ops[1] = NULL;
447 self->_ops[2] = NULL;
448 self->bops[0] = NULL;
449 self->bops[1] = NULL;
450 MEM_VECTOR_INIT(self, phi);
451 MEM_VECTOR_INIT(self, params);
456 MEM_VEC_FUNCTIONS(ir_instr, ir_phi_entry_t, phi)
457 MEM_VEC_FUNCTIONS(ir_instr, ir_value*, params)
459 void ir_instr_delete(ir_instr *self)
462 /* The following calls can only delete from
463 * vectors, we still want to delete this instruction
464 * so ignore the return value. Since with the warn_unused_result attribute
465 * gcc doesn't care about an explicit: (void)foo(); to ignore the result,
466 * I have to improvise here and use if(foo());
468 for (i = 0; i < self->phi_count; ++i) {
470 if (ir_value_writes_find(self->phi[i].value, self, &idx))
471 if (ir_value_writes_remove(self->phi[i].value, idx)) GMQCC_SUPPRESS_EMPTY_BODY;
472 if (ir_value_reads_find(self->phi[i].value, self, &idx))
473 if (ir_value_reads_remove (self->phi[i].value, idx)) GMQCC_SUPPRESS_EMPTY_BODY;
475 MEM_VECTOR_CLEAR(self, phi);
476 for (i = 0; i < self->params_count; ++i) {
478 if (ir_value_writes_find(self->params[i], self, &idx))
479 if (ir_value_writes_remove(self->params[i], idx)) GMQCC_SUPPRESS_EMPTY_BODY;
480 if (ir_value_reads_find(self->params[i], self, &idx))
481 if (ir_value_reads_remove (self->params[i], idx)) GMQCC_SUPPRESS_EMPTY_BODY;
483 MEM_VECTOR_CLEAR(self, params);
484 if (ir_instr_op(self, 0, NULL, false)) GMQCC_SUPPRESS_EMPTY_BODY;
485 if (ir_instr_op(self, 1, NULL, false)) GMQCC_SUPPRESS_EMPTY_BODY;
486 if (ir_instr_op(self, 2, NULL, false)) GMQCC_SUPPRESS_EMPTY_BODY;
490 bool ir_instr_op(ir_instr *self, int op, ir_value *v, bool writing)
492 if (self->_ops[op]) {
494 if (writing && ir_value_writes_find(self->_ops[op], self, &idx))
496 if (!ir_value_writes_remove(self->_ops[op], idx))
499 else if (ir_value_reads_find(self->_ops[op], self, &idx))
501 if (!ir_value_reads_remove(self->_ops[op], idx))
507 if (!ir_value_writes_add(v, self))
510 if (!ir_value_reads_add(v, self))
518 /***********************************************************************
522 void ir_value_code_setaddr(ir_value *self, int32_t gaddr)
524 self->code.globaladdr = gaddr;
525 if (self->members[0]) self->members[0]->code.globaladdr = gaddr;
526 if (self->members[1]) self->members[1]->code.globaladdr = gaddr;
527 if (self->members[2]) self->members[2]->code.globaladdr = gaddr;
530 int32_t ir_value_code_addr(const ir_value *self)
532 if (self->store == store_return)
533 return OFS_RETURN + self->code.addroffset;
534 return self->code.globaladdr + self->code.addroffset;
537 ir_value* ir_value_var(const char *name, int storetype, int vtype)
540 self = (ir_value*)mem_a(sizeof(*self));
542 self->fieldtype = TYPE_VOID;
543 self->outtype = TYPE_VOID;
544 self->store = storetype;
545 MEM_VECTOR_INIT(self, reads);
546 MEM_VECTOR_INIT(self, writes);
547 self->isconst = false;
548 self->context.file = "<@no context>";
549 self->context.line = 0;
551 ir_value_set_name(self, name);
553 memset(&self->constval, 0, sizeof(self->constval));
554 memset(&self->code, 0, sizeof(self->code));
556 MEM_VECTOR_INIT(self, life);
560 ir_value* ir_value_vector_member(ir_value *self, unsigned int member)
566 if (self->members[member])
567 return self->members[member];
569 if (self->vtype == TYPE_VECTOR)
571 m = ir_value_var(self->name, self->store, TYPE_FLOAT);
574 m->context = self->context;
576 self->members[member] = m;
577 m->code.addroffset = member;
579 else if (self->vtype == TYPE_FIELD)
581 if (self->fieldtype != TYPE_VECTOR)
583 m = ir_value_var(self->name, self->store, TYPE_FIELD);
586 m->fieldtype = TYPE_FLOAT;
587 m->context = self->context;
589 self->members[member] = m;
590 m->code.addroffset = member;
594 printf("invalid member access on %s\n", self->name);
601 MEM_VEC_FUNCTIONS(ir_value, ir_life_entry_t, life)
602 MEM_VEC_FUNCTIONS_ALL(ir_value, ir_instr*, reads)
603 MEM_VEC_FUNCTIONS_ALL(ir_value, ir_instr*, writes)
605 ir_value* ir_value_out(ir_function *owner, const char *name, int storetype, int vtype)
607 ir_value *v = ir_value_var(name, storetype, vtype);
610 if (!ir_function_collect_value(owner, v))
618 void ir_value_delete(ir_value* self)
622 mem_d((void*)self->name);
625 if (self->vtype == TYPE_STRING)
626 mem_d((void*)self->constval.vstring);
628 for (i = 0; i < 3; ++i) {
629 if (self->members[i])
630 ir_value_delete(self->members[i]);
632 MEM_VECTOR_CLEAR(self, reads);
633 MEM_VECTOR_CLEAR(self, writes);
634 MEM_VECTOR_CLEAR(self, life);
638 void ir_value_set_name(ir_value *self, const char *name)
641 mem_d((void*)self->name);
642 self->name = util_strdup(name);
645 bool ir_value_set_float(ir_value *self, float f)
647 if (self->vtype != TYPE_FLOAT)
649 self->constval.vfloat = f;
650 self->isconst = true;
654 bool ir_value_set_func(ir_value *self, int f)
656 if (self->vtype != TYPE_FUNCTION)
658 self->constval.vint = f;
659 self->isconst = true;
663 bool ir_value_set_vector(ir_value *self, vector v)
665 if (self->vtype != TYPE_VECTOR)
667 self->constval.vvec = v;
668 self->isconst = true;
672 bool ir_value_set_field(ir_value *self, ir_value *fld)
674 if (self->vtype != TYPE_FIELD)
676 self->constval.vpointer = fld;
677 self->isconst = true;
681 bool ir_value_set_string(ir_value *self, const char *str)
683 if (self->vtype != TYPE_STRING)
685 self->constval.vstring = util_strdup(str);
686 self->isconst = true;
691 bool ir_value_set_int(ir_value *self, int i)
693 if (self->vtype != TYPE_INTEGER)
695 self->constval.vint = i;
696 self->isconst = true;
701 bool ir_value_lives(ir_value *self, size_t at)
704 for (i = 0; i < self->life_count; ++i)
706 ir_life_entry_t *life = &self->life[i];
707 if (life->start <= at && at <= life->end)
709 if (life->start > at) /* since it's ordered */
715 bool ir_value_life_insert(ir_value *self, size_t idx, ir_life_entry_t e)
718 if (!ir_value_life_add(self, e)) /* naive... */
720 for (k = self->life_count-1; k > idx; --k)
721 self->life[k] = self->life[k-1];
726 bool ir_value_life_merge(ir_value *self, size_t s)
729 ir_life_entry_t *life = NULL;
730 ir_life_entry_t *before = NULL;
731 ir_life_entry_t new_entry;
733 /* Find the first range >= s */
734 for (i = 0; i < self->life_count; ++i)
737 life = &self->life[i];
741 /* nothing found? append */
742 if (i == self->life_count) {
744 if (life && life->end+1 == s)
746 /* previous life range can be merged in */
750 if (life && life->end >= s)
753 if (!ir_value_life_add(self, e))
754 return false; /* failing */
760 if (before->end + 1 == s &&
761 life->start - 1 == s)
764 before->end = life->end;
765 if (!ir_value_life_remove(self, i))
766 return false; /* failing */
769 if (before->end + 1 == s)
775 /* already contained */
776 if (before->end >= s)
780 if (life->start - 1 == s)
785 /* insert a new entry */
786 new_entry.start = new_entry.end = s;
787 return ir_value_life_insert(self, i, new_entry);
790 bool ir_value_life_merge_into(ir_value *self, const ir_value *other)
794 if (!other->life_count)
797 if (!self->life_count) {
798 for (i = 0; i < other->life_count; ++i) {
799 if (!ir_value_life_add(self, other->life[i]))
806 for (i = 0; i < other->life_count; ++i)
808 const ir_life_entry_t *life = &other->life[i];
811 ir_life_entry_t *entry = &self->life[myi];
813 if (life->end+1 < entry->start)
815 /* adding an interval before entry */
816 if (!ir_value_life_insert(self, myi, *life))
822 if (life->start < entry->start &&
823 life->end >= entry->start)
825 /* starts earlier and overlaps */
826 entry->start = life->start;
829 if (life->end > entry->end &&
830 life->start-1 <= entry->end)
832 /* ends later and overlaps */
833 entry->end = life->end;
836 /* see if our change combines it with the next ranges */
837 while (myi+1 < self->life_count &&
838 entry->end+1 >= self->life[1+myi].start)
840 /* overlaps with (myi+1) */
841 if (entry->end < self->life[1+myi].end)
842 entry->end = self->life[1+myi].end;
843 if (!ir_value_life_remove(self, myi+1))
845 entry = &self->life[myi];
848 /* see if we're after the entry */
849 if (life->start > entry->end)
852 /* append if we're at the end */
853 if (myi >= self->life_count) {
854 if (!ir_value_life_add(self, *life))
858 /* otherweise check the next range */
867 bool ir_values_overlap(const ir_value *a, const ir_value *b)
869 /* For any life entry in A see if it overlaps with
870 * any life entry in B.
871 * Note that the life entries are orderes, so we can make a
872 * more efficient algorithm there than naively translating the
876 ir_life_entry_t *la, *lb, *enda, *endb;
878 /* first of all, if either has no life range, they cannot clash */
879 if (!a->life_count || !b->life_count)
884 enda = la + a->life_count;
885 endb = lb + b->life_count;
888 /* check if the entries overlap, for that,
889 * both must start before the other one ends.
891 #if defined(LIFE_RANGE_WITHOUT_LAST_READ)
892 if (la->start <= lb->end &&
893 lb->start <= la->end)
895 if (la->start < lb->end &&
902 /* entries are ordered
903 * one entry is earlier than the other
904 * that earlier entry will be moved forward
906 if (la->start < lb->start)
908 /* order: A B, move A forward
909 * check if we hit the end with A
914 else if (lb->start < la->start)
916 /* order: B A, move B forward
917 * check if we hit the end with B
926 /***********************************************************************
930 bool ir_block_create_store_op(ir_block *self, int op, ir_value *target, ir_value *what)
932 ir_instr *in = ir_instr_new(self, op);
936 if (target->store == store_value &&
937 (op < INSTR_STOREP_F || op > INSTR_STOREP_FNC))
939 fprintf(stderr, "cannot store to an SSA value\n");
940 fprintf(stderr, "trying to store: %s <- %s\n", target->name, what->name);
941 fprintf(stderr, "instruction: %s\n", asm_instr[op].m);
945 if (!ir_instr_op(in, 0, target, true) ||
946 !ir_instr_op(in, 1, what, false) ||
947 !ir_block_instr_add(self, in) )
954 bool ir_block_create_store(ir_block *self, ir_value *target, ir_value *what)
958 if (target->vtype == TYPE_VARIANT)
961 vtype = target->vtype;
964 if (vtype == TYPE_FLOAT && what->vtype == TYPE_INTEGER)
965 op = INSTR_CONV_ITOF;
966 else if (vtype == TYPE_INTEGER && what->vtype == TYPE_FLOAT)
967 op = INSTR_CONV_FTOI;
969 op = type_store_instr[vtype];
971 if (OPTS_FLAG(ADJUST_VECTOR_FIELDS)) {
972 if (op == INSTR_STORE_FLD && what->fieldtype == TYPE_VECTOR)
976 return ir_block_create_store_op(self, op, target, what);
979 bool ir_block_create_storep(ir_block *self, ir_value *target, ir_value *what)
984 if (target->vtype != TYPE_POINTER)
987 /* storing using pointer - target is a pointer, type must be
988 * inferred from source
992 op = type_storep_instr[vtype];
993 if (OPTS_FLAG(ADJUST_VECTOR_FIELDS)) {
994 if (op == INSTR_STOREP_FLD && what->fieldtype == TYPE_VECTOR)
998 return ir_block_create_store_op(self, op, target, what);
1001 bool ir_block_create_return(ir_block *self, ir_value *v)
1005 fprintf(stderr, "block already ended (%s)\n", self->label);
1009 self->is_return = true;
1010 in = ir_instr_new(self, INSTR_RETURN);
1014 if (!ir_instr_op(in, 0, v, false) ||
1015 !ir_block_instr_add(self, in) )
1022 bool ir_block_create_if(ir_block *self, ir_value *v,
1023 ir_block *ontrue, ir_block *onfalse)
1027 fprintf(stderr, "block already ended (%s)\n", self->label);
1031 /*in = ir_instr_new(self, (v->vtype == TYPE_STRING ? INSTR_IF_S : INSTR_IF_F));*/
1032 in = ir_instr_new(self, VINSTR_COND);
1036 if (!ir_instr_op(in, 0, v, false)) {
1037 ir_instr_delete(in);
1041 in->bops[0] = ontrue;
1042 in->bops[1] = onfalse;
1044 if (!ir_block_instr_add(self, in))
1047 if (!ir_block_exits_add(self, ontrue) ||
1048 !ir_block_exits_add(self, onfalse) ||
1049 !ir_block_entries_add(ontrue, self) ||
1050 !ir_block_entries_add(onfalse, self) )
1057 bool ir_block_create_jump(ir_block *self, ir_block *to)
1061 fprintf(stderr, "block already ended (%s)\n", self->label);
1065 in = ir_instr_new(self, VINSTR_JUMP);
1070 if (!ir_block_instr_add(self, in))
1073 if (!ir_block_exits_add(self, to) ||
1074 !ir_block_entries_add(to, self) )
1081 bool ir_block_create_goto(ir_block *self, ir_block *to)
1085 fprintf(stderr, "block already ended (%s)\n", self->label);
1089 in = ir_instr_new(self, INSTR_GOTO);
1094 if (!ir_block_instr_add(self, in))
1097 if (!ir_block_exits_add(self, to) ||
1098 !ir_block_entries_add(to, self) )
1105 ir_instr* ir_block_create_phi(ir_block *self, const char *label, int ot)
1109 in = ir_instr_new(self, VINSTR_PHI);
1112 out = ir_value_out(self->owner, label, store_value, ot);
1114 ir_instr_delete(in);
1117 if (!ir_instr_op(in, 0, out, true)) {
1118 ir_instr_delete(in);
1119 ir_value_delete(out);
1122 if (!ir_block_instr_add(self, in)) {
1123 ir_instr_delete(in);
1124 ir_value_delete(out);
1130 ir_value* ir_phi_value(ir_instr *self)
1132 return self->_ops[0];
1135 bool ir_phi_add(ir_instr* self, ir_block *b, ir_value *v)
1139 if (!ir_block_entries_find(self->owner, b, NULL)) {
1140 /* Must not be possible to cause this, otherwise the AST
1141 * is doing something wrong.
1143 fprintf(stderr, "Invalid entry block for PHI\n");
1149 if (!ir_value_reads_add(v, self))
1151 return ir_instr_phi_add(self, pe);
1154 /* call related code */
1155 ir_instr* ir_block_create_call(ir_block *self, const char *label, ir_value *func)
1159 in = ir_instr_new(self, INSTR_CALL0);
1162 out = ir_value_out(self->owner, label, store_return, func->outtype);
1164 ir_instr_delete(in);
1167 if (!ir_instr_op(in, 0, out, true) ||
1168 !ir_instr_op(in, 1, func, false) ||
1169 !ir_block_instr_add(self, in))
1171 ir_instr_delete(in);
1172 ir_value_delete(out);
1178 ir_value* ir_call_value(ir_instr *self)
1180 return self->_ops[0];
1183 bool ir_call_param(ir_instr* self, ir_value *v)
1185 if (!ir_instr_params_add(self, v))
1187 if (!ir_value_reads_add(v, self)) {
1188 if (!ir_instr_params_remove(self, self->params_count-1))
1189 GMQCC_SUPPRESS_EMPTY_BODY;
1195 /* binary op related code */
1197 ir_value* ir_block_create_binop(ir_block *self,
1198 const char *label, int opcode,
1199 ir_value *left, ir_value *right)
1221 case INSTR_SUB_S: /* -- offset of string as float */
1226 case INSTR_BITOR_IF:
1227 case INSTR_BITOR_FI:
1228 case INSTR_BITAND_FI:
1229 case INSTR_BITAND_IF:
1244 case INSTR_BITAND_I:
1247 case INSTR_RSHIFT_I:
1248 case INSTR_LSHIFT_I:
1270 /* boolean operations result in floats */
1271 if (opcode >= INSTR_EQ_F && opcode <= INSTR_GT)
1273 else if (opcode >= INSTR_LE && opcode <= INSTR_GT)
1276 else if (opcode >= INSTR_LE_I && opcode <= INSTR_EQ_FI)
1281 if (ot == TYPE_VOID) {
1282 /* The AST or parser were supposed to check this! */
1286 return ir_block_create_general_instr(self, label, opcode, left, right, ot);
1289 ir_value* ir_block_create_unary(ir_block *self,
1290 const char *label, int opcode,
1293 int ot = TYPE_FLOAT;
1305 /* QC doesn't have other unary operations. We expect extensions to fill
1306 * the above list, otherwise we assume out-type = in-type, eg for an
1310 ot = operand->vtype;
1313 if (ot == TYPE_VOID) {
1314 /* The AST or parser were supposed to check this! */
1318 /* let's use the general instruction creator and pass NULL for OPB */
1319 return ir_block_create_general_instr(self, label, opcode, operand, NULL, ot);
1322 ir_value* ir_block_create_general_instr(ir_block *self, const char *label,
1323 int op, ir_value *a, ir_value *b, int outype)
1328 out = ir_value_out(self->owner, label, store_value, outype);
1332 instr = ir_instr_new(self, op);
1334 ir_value_delete(out);
1338 if (!ir_instr_op(instr, 0, out, true) ||
1339 !ir_instr_op(instr, 1, a, false) ||
1340 !ir_instr_op(instr, 2, b, false) )
1345 if (!ir_block_instr_add(self, instr))
1350 ir_instr_delete(instr);
1351 ir_value_delete(out);
1355 ir_value* ir_block_create_fieldaddress(ir_block *self, const char *label, ir_value *ent, ir_value *field)
1359 /* Support for various pointer types todo if so desired */
1360 if (ent->vtype != TYPE_ENTITY)
1363 if (field->vtype != TYPE_FIELD)
1366 v = ir_block_create_general_instr(self, label, INSTR_ADDRESS, ent, field, TYPE_POINTER);
1367 v->fieldtype = field->fieldtype;
1371 ir_value* ir_block_create_load_from_ent(ir_block *self, const char *label, ir_value *ent, ir_value *field, int outype)
1374 if (ent->vtype != TYPE_ENTITY)
1377 /* at some point we could redirect for TYPE_POINTER... but that could lead to carelessness */
1378 if (field->vtype != TYPE_FIELD)
1383 case TYPE_FLOAT: op = INSTR_LOAD_F; break;
1384 case TYPE_VECTOR: op = INSTR_LOAD_V; break;
1385 case TYPE_STRING: op = INSTR_LOAD_S; break;
1386 case TYPE_FIELD: op = INSTR_LOAD_FLD; break;
1387 case TYPE_ENTITY: op = INSTR_LOAD_ENT; break;
1389 case TYPE_POINTER: op = INSTR_LOAD_I; break;
1390 case TYPE_INTEGER: op = INSTR_LOAD_I; break;
1396 return ir_block_create_general_instr(self, label, op, ent, field, outype);
1399 ir_value* ir_block_create_add(ir_block *self,
1401 ir_value *left, ir_value *right)
1404 int l = left->vtype;
1405 int r = right->vtype;
1424 if ( (l == TYPE_FLOAT && r == TYPE_INTEGER) )
1426 else if ( (l == TYPE_INTEGER && r == TYPE_FLOAT) )
1432 return ir_block_create_binop(self, label, op, left, right);
1435 ir_value* ir_block_create_sub(ir_block *self,
1437 ir_value *left, ir_value *right)
1440 int l = left->vtype;
1441 int r = right->vtype;
1461 if ( (l == TYPE_FLOAT && r == TYPE_INTEGER) )
1463 else if ( (l == TYPE_INTEGER && r == TYPE_FLOAT) )
1469 return ir_block_create_binop(self, label, op, left, right);
1472 ir_value* ir_block_create_mul(ir_block *self,
1474 ir_value *left, ir_value *right)
1477 int l = left->vtype;
1478 int r = right->vtype;
1497 if ( (l == TYPE_VECTOR && r == TYPE_FLOAT) )
1499 else if ( (l == TYPE_FLOAT && r == TYPE_VECTOR) )
1502 else if ( (l == TYPE_VECTOR && r == TYPE_INTEGER) )
1504 else if ( (l == TYPE_INTEGER && r == TYPE_VECTOR) )
1506 else if ( (l == TYPE_FLOAT && r == TYPE_INTEGER) )
1508 else if ( (l == TYPE_INTEGER && r == TYPE_FLOAT) )
1514 return ir_block_create_binop(self, label, op, left, right);
1517 ir_value* ir_block_create_div(ir_block *self,
1519 ir_value *left, ir_value *right)
1522 int l = left->vtype;
1523 int r = right->vtype;
1540 if ( (l == TYPE_VECTOR && r == TYPE_FLOAT) )
1542 else if ( (l == TYPE_FLOAT && r == TYPE_INTEGER) )
1544 else if ( (l == TYPE_INTEGER && r == TYPE_FLOAT) )
1550 return ir_block_create_binop(self, label, op, left, right);
1553 /* PHI resolving breaks the SSA, and must thus be the last
1554 * step before life-range calculation.
1557 static bool ir_block_naive_phi(ir_block *self);
1558 bool ir_function_naive_phi(ir_function *self)
1562 for (i = 0; i < self->blocks_count; ++i)
1564 if (!ir_block_naive_phi(self->blocks[i]))
1570 static bool ir_naive_phi_emit_store(ir_block *block, size_t iid, ir_value *old, ir_value *what)
1575 /* create a store */
1576 if (!ir_block_create_store(block, old, what))
1579 /* we now move it up */
1580 instr = block->instr[block->instr_count-1];
1581 for (i = block->instr_count; i > iid; --i)
1582 block->instr[i] = block->instr[i-1];
1583 block->instr[i] = instr;
1588 static bool ir_block_naive_phi(ir_block *self)
1591 /* FIXME: optionally, create_phi can add the phis
1592 * to a list so we don't need to loop through blocks
1593 * - anyway: "don't optimize YET"
1595 for (i = 0; i < self->instr_count; ++i)
1597 ir_instr *instr = self->instr[i];
1598 if (instr->opcode != VINSTR_PHI)
1601 if (!ir_block_instr_remove(self, i))
1603 --i; /* NOTE: i+1 below */
1605 for (p = 0; p < instr->phi_count; ++p)
1607 ir_value *v = instr->phi[p].value;
1608 for (w = 0; w < v->writes_count; ++w) {
1611 if (!v->writes[w]->_ops[0])
1614 /* When the write was to a global, we have to emit a mov */
1615 old = v->writes[w]->_ops[0];
1617 /* The original instruction now writes to the PHI target local */
1618 if (v->writes[w]->_ops[0] == v)
1619 v->writes[w]->_ops[0] = instr->_ops[0];
1621 if (old->store != store_value && old->store != store_local && old->store != store_param)
1623 /* If it originally wrote to a global we need to store the value
1626 if (!ir_naive_phi_emit_store(self, i+1, old, v))
1628 if (i+1 < self->instr_count)
1629 instr = self->instr[i+1];
1632 /* In case I forget and access instr later, it'll be NULL
1633 * when it's a problem, to make sure we crash, rather than accessing
1639 /* If it didn't, we can replace all reads by the phi target now. */
1641 for (r = 0; r < old->reads_count; ++r)
1644 ir_instr *ri = old->reads[r];
1645 for (op = 0; op < ri->phi_count; ++op) {
1646 if (ri->phi[op].value == old)
1647 ri->phi[op].value = v;
1649 for (op = 0; op < 3; ++op) {
1650 if (ri->_ops[op] == old)
1657 ir_instr_delete(instr);
1662 /***********************************************************************
1663 *IR Temp allocation code
1664 * Propagating value life ranges by walking through the function backwards
1665 * until no more changes are made.
1666 * In theory this should happen once more than once for every nested loop
1668 * Though this implementation might run an additional time for if nests.
1677 MEM_VEC_FUNCTIONS_ALL(new_reads_t, ir_value*, v)
1679 /* Enumerate instructions used by value's life-ranges
1681 static void ir_block_enumerate(ir_block *self, size_t *_eid)
1685 for (i = 0; i < self->instr_count; ++i)
1687 self->instr[i]->eid = eid++;
1692 /* Enumerate blocks and instructions.
1693 * The block-enumeration is unordered!
1694 * We do not really use the block enumreation, however
1695 * the instruction enumeration is important for life-ranges.
1697 void ir_function_enumerate(ir_function *self)
1700 size_t instruction_id = 0;
1701 for (i = 0; i < self->blocks_count; ++i)
1703 self->blocks[i]->eid = i;
1704 self->blocks[i]->run_id = 0;
1705 ir_block_enumerate(self->blocks[i], &instruction_id);
1709 static bool ir_block_life_propagate(ir_block *b, ir_block *prev, bool *changed);
1710 bool ir_function_calculate_liferanges(ir_function *self)
1718 for (i = 0; i != self->blocks_count; ++i)
1720 if (self->blocks[i]->is_return)
1722 if (!ir_block_life_propagate(self->blocks[i], NULL, &changed))
1730 /* Local-value allocator
1731 * After finishing creating the liferange of all values used in a function
1732 * we can allocate their global-positions.
1733 * This is the counterpart to register-allocation in register machines.
1736 MEM_VECTOR_MAKE(ir_value*, locals);
1737 MEM_VECTOR_MAKE(size_t, sizes);
1738 MEM_VECTOR_MAKE(size_t, positions);
1739 } function_allocator;
1740 MEM_VEC_FUNCTIONS(function_allocator, ir_value*, locals)
1741 MEM_VEC_FUNCTIONS(function_allocator, size_t, sizes)
1742 MEM_VEC_FUNCTIONS(function_allocator, size_t, positions)
1744 static bool function_allocator_alloc(function_allocator *alloc, const ir_value *var)
1747 size_t vsize = type_sizeof[var->vtype];
1749 slot = ir_value_var("reg", store_global, var->vtype);
1753 if (!ir_value_life_merge_into(slot, var))
1756 if (!function_allocator_locals_add(alloc, slot))
1759 if (!function_allocator_sizes_add(alloc, vsize))
1765 ir_value_delete(slot);
1769 bool ir_function_allocate_locals(ir_function *self)
1778 function_allocator alloc;
1780 if (!self->locals_count)
1783 MEM_VECTOR_INIT(&alloc, locals);
1784 MEM_VECTOR_INIT(&alloc, sizes);
1785 MEM_VECTOR_INIT(&alloc, positions);
1787 for (i = 0; i < self->locals_count; ++i)
1789 if (!function_allocator_alloc(&alloc, self->locals[i]))
1793 /* Allocate a slot for any value that still exists */
1794 for (i = 0; i < self->values_count; ++i)
1796 v = self->values[i];
1801 for (a = 0; a < alloc.locals_count; ++a)
1803 slot = alloc.locals[a];
1805 if (ir_values_overlap(v, slot))
1808 if (!ir_value_life_merge_into(slot, v))
1811 /* adjust size for this slot */
1812 if (alloc.sizes[a] < type_sizeof[v->vtype])
1813 alloc.sizes[a] = type_sizeof[v->vtype];
1815 self->values[i]->code.local = a;
1818 if (a >= alloc.locals_count) {
1819 self->values[i]->code.local = alloc.locals_count;
1820 if (!function_allocator_alloc(&alloc, v))
1825 /* Adjust slot positions based on sizes */
1826 if (!function_allocator_positions_add(&alloc, 0))
1829 if (alloc.sizes_count)
1830 pos = alloc.positions[0] + alloc.sizes[0];
1833 for (i = 1; i < alloc.sizes_count; ++i)
1835 pos = alloc.positions[i-1] + alloc.sizes[i-1];
1836 if (!function_allocator_positions_add(&alloc, pos))
1840 self->allocated_locals = pos + alloc.sizes[alloc.sizes_count-1];
1842 /* Take over the actual slot positions */
1843 for (i = 0; i < self->values_count; ++i)
1844 self->values[i]->code.local = alloc.positions[self->values[i]->code.local];
1851 for (i = 0; i < alloc.locals_count; ++i)
1852 ir_value_delete(alloc.locals[i]);
1853 MEM_VECTOR_CLEAR(&alloc, locals);
1854 MEM_VECTOR_CLEAR(&alloc, sizes);
1855 MEM_VECTOR_CLEAR(&alloc, positions);
1859 /* Get information about which operand
1860 * is read from, or written to.
1862 static void ir_op_read_write(int op, size_t *read, size_t *write)
1889 static bool ir_block_living_add_instr(ir_block *self, size_t eid)
1892 bool changed = false;
1894 for (i = 0; i != self->living_count; ++i)
1896 tempbool = ir_value_life_merge(self->living[i], eid);
1899 fprintf(stderr, "block_living_add_instr() value instruction added %s: %i\n", self->living[i]->_name, (int)eid);
1901 changed = changed || tempbool;
1906 static bool ir_block_life_prop_previous(ir_block* self, ir_block *prev, bool *changed)
1909 /* values which have been read in a previous iteration are now
1910 * in the "living" array even if the previous block doesn't use them.
1911 * So we have to remove whatever does not exist in the previous block.
1912 * They will be re-added on-read, but the liferange merge won't cause
1915 for (i = 0; i < self->living_count; ++i)
1917 if (!ir_block_living_find(prev, self->living[i], NULL)) {
1918 if (!ir_block_living_remove(self, i))
1924 /* Whatever the previous block still has in its living set
1925 * must now be added to ours as well.
1927 for (i = 0; i < prev->living_count; ++i)
1929 if (ir_block_living_find(self, prev->living[i], NULL))
1931 if (!ir_block_living_add(self, prev->living[i]))
1934 printf("%s got from prev: %s\n", self->label, prev->living[i]->_name);
1940 static bool ir_block_life_propagate(ir_block *self, ir_block *prev, bool *changed)
1946 /* bitmasks which operands are read from or written to */
1948 #if defined(LIFE_RANGE_WITHOUT_LAST_READ)
1950 new_reads_t new_reads;
1952 char dbg_ind[16] = { '#', '0' };
1955 #if defined(LIFE_RANGE_WITHOUT_LAST_READ)
1956 MEM_VECTOR_INIT(&new_reads, v);
1961 if (!ir_block_life_prop_previous(self, prev, changed))
1965 i = self->instr_count;
1968 instr = self->instr[i];
1970 /* PHI operands are always read operands */
1971 for (p = 0; p < instr->phi_count; ++p)
1973 value = instr->phi[p].value;
1974 #if ! defined(LIFE_RANGE_WITHOUT_LAST_READ)
1975 if (!ir_block_living_find(self, value, NULL) &&
1976 !ir_block_living_add(self, value))
1981 if (!new_reads_t_v_find(&new_reads, value, NULL))
1983 if (!new_reads_t_v_add(&new_reads, value))
1989 /* See which operands are read and write operands */
1990 ir_op_read_write(instr->opcode, &read, &write);
1992 /* Go through the 3 main operands */
1993 for (o = 0; o < 3; ++o)
1995 if (!instr->_ops[o]) /* no such operand */
1998 value = instr->_ops[o];
2000 /* We only care about locals */
2001 /* we also calculate parameter liferanges so that locals
2002 * can take up parameter slots */
2003 if (value->store != store_value &&
2004 value->store != store_local &&
2005 value->store != store_param)
2011 #if ! defined(LIFE_RANGE_WITHOUT_LAST_READ)
2012 if (!ir_block_living_find(self, value, NULL) &&
2013 !ir_block_living_add(self, value))
2018 /* fprintf(stderr, "read: %s\n", value->_name); */
2019 if (!new_reads_t_v_find(&new_reads, value, NULL))
2021 if (!new_reads_t_v_add(&new_reads, value))
2027 /* write operands */
2028 /* When we write to a local, we consider it "dead" for the
2029 * remaining upper part of the function, since in SSA a value
2030 * can only be written once (== created)
2035 bool in_living = ir_block_living_find(self, value, &idx);
2036 #if defined(LIFE_RANGE_WITHOUT_LAST_READ)
2038 bool in_reads = new_reads_t_v_find(&new_reads, value, &readidx);
2039 if (!in_living && !in_reads)
2044 /* If the value isn't alive it hasn't been read before... */
2045 /* TODO: See if the warning can be emitted during parsing or AST processing
2046 * otherwise have warning printed here.
2047 * IF printing a warning here: include filecontext_t,
2048 * and make sure it's only printed once
2049 * since this function is run multiple times.
2051 /* For now: debug info: */
2052 fprintf(stderr, "Value only written %s\n", value->name);
2053 tempbool = ir_value_life_merge(value, instr->eid);
2054 *changed = *changed || tempbool;
2056 ir_instr_dump(instr, dbg_ind, printf);
2060 /* since 'living' won't contain it
2061 * anymore, merge the value, since
2064 tempbool = ir_value_life_merge(value, instr->eid);
2067 fprintf(stderr, "value added id %s %i\n", value->name, (int)instr->eid);
2069 *changed = *changed || tempbool;
2071 #if ! defined(LIFE_RANGE_WITHOUT_LAST_READ)
2072 if (!ir_block_living_remove(self, idx))
2077 if (!new_reads_t_v_remove(&new_reads, readidx))
2085 tempbool = ir_block_living_add_instr(self, instr->eid);
2086 /*fprintf(stderr, "living added values\n");*/
2087 *changed = *changed || tempbool;
2089 #if defined(LIFE_RANGE_WITHOUT_LAST_READ)
2091 for (rd = 0; rd < new_reads.v_count; ++rd)
2093 if (!ir_block_living_find(self, new_reads.v[rd], NULL)) {
2094 if (!ir_block_living_add(self, new_reads.v[rd]))
2097 if (!i && !self->entries_count) {
2099 *changed = *changed || ir_value_life_merge(new_reads.v[rd], instr->eid);
2102 MEM_VECTOR_CLEAR(&new_reads, v);
2106 if (self->run_id == self->owner->run_id)
2109 self->run_id = self->owner->run_id;
2111 for (i = 0; i < self->entries_count; ++i)
2113 ir_block *entry = self->entries[i];
2114 ir_block_life_propagate(entry, self, changed);
2119 #if defined(LIFE_RANGE_WITHOUT_LAST_READ)
2120 MEM_VECTOR_CLEAR(&new_reads, v);
2125 /***********************************************************************
2128 * Since the IR has the convention of putting 'write' operands
2129 * at the beginning, we have to rotate the operands of instructions
2130 * properly in order to generate valid QCVM code.
2132 * Having destinations at a fixed position is more convenient. In QC
2133 * this is *mostly* OPC, but FTE adds at least 2 instructions which
2134 * read from from OPA, and store to OPB rather than OPC. Which is
2135 * partially the reason why the implementation of these instructions
2136 * in darkplaces has been delayed for so long.
2138 * Breaking conventions is annoying...
2140 static bool ir_builder_gen_global(ir_builder *self, ir_value *global);
2142 static bool gen_global_field(ir_value *global)
2144 if (global->isconst)
2146 ir_value *fld = global->constval.vpointer;
2148 printf("Invalid field constant with no field: %s\n", global->name);
2152 /* Now, in this case, a relocation would be impossible to code
2153 * since it looks like this:
2154 * .vector v = origin; <- parse error, wtf is 'origin'?
2157 * But we will need a general relocation support later anyway
2158 * for functions... might as well support that here.
2160 if (!fld->code.globaladdr) {
2161 printf("FIXME: Relocation support\n");
2165 /* copy the field's value */
2166 ir_value_code_setaddr(global, code_globals_add(code_globals_data[fld->code.globaladdr]));
2167 if (global->fieldtype == TYPE_VECTOR) {
2168 code_globals_add(code_globals_data[fld->code.globaladdr]+1);
2169 code_globals_add(code_globals_data[fld->code.globaladdr]+2);
2174 ir_value_code_setaddr(global, code_globals_add(0));
2175 if (global->fieldtype == TYPE_VECTOR) {
2176 code_globals_add(0);
2177 code_globals_add(0);
2180 if (global->code.globaladdr < 0)
2185 static bool gen_global_pointer(ir_value *global)
2187 if (global->isconst)
2189 ir_value *target = global->constval.vpointer;
2191 printf("Invalid pointer constant: %s\n", global->name);
2192 /* NULL pointers are pointing to the NULL constant, which also
2193 * sits at address 0, but still has an ir_value for itself.
2198 /* Here, relocations ARE possible - in fteqcc-enhanced-qc:
2199 * void() foo; <- proto
2200 * void() *fooptr = &foo;
2201 * void() foo = { code }
2203 if (!target->code.globaladdr) {
2204 /* FIXME: Check for the constant nullptr ir_value!
2205 * because then code.globaladdr being 0 is valid.
2207 printf("FIXME: Relocation support\n");
2211 ir_value_code_setaddr(global, code_globals_add(target->code.globaladdr));
2215 ir_value_code_setaddr(global, code_globals_add(0));
2217 if (global->code.globaladdr < 0)
2222 static bool gen_blocks_recursive(ir_function *func, ir_block *block)
2224 prog_section_statement stmt;
2233 block->generated = true;
2234 block->code_start = code_statements_elements;
2235 for (i = 0; i < block->instr_count; ++i)
2237 instr = block->instr[i];
2239 if (instr->opcode == VINSTR_PHI) {
2240 printf("cannot generate virtual instruction (phi)\n");
2244 if (instr->opcode == VINSTR_JUMP) {
2245 target = instr->bops[0];
2246 /* for uncoditional jumps, if the target hasn't been generated
2247 * yet, we generate them right here.
2249 if (!target->generated) {
2254 /* otherwise we generate a jump instruction */
2255 stmt.opcode = INSTR_GOTO;
2256 stmt.o1.s1 = (target->code_start) - code_statements_elements;
2259 if (code_statements_add(stmt) < 0)
2262 /* no further instructions can be in this block */
2266 if (instr->opcode == VINSTR_COND) {
2267 ontrue = instr->bops[0];
2268 onfalse = instr->bops[1];
2269 /* TODO: have the AST signal which block should
2270 * come first: eg. optimize IFs without ELSE...
2273 stmt.o1.u1 = ir_value_code_addr(instr->_ops[0]);
2277 if (ontrue->generated) {
2278 stmt.opcode = INSTR_IF;
2279 stmt.o2.s1 = (ontrue->code_start-1) - code_statements_elements;
2280 if (code_statements_add(stmt) < 0)
2283 if (onfalse->generated) {
2284 stmt.opcode = INSTR_IFNOT;
2285 stmt.o2.s1 = (onfalse->code_start-1) - code_statements_elements;
2286 if (code_statements_add(stmt) < 0)
2289 if (!ontrue->generated) {
2290 if (onfalse->generated) {
2295 if (!onfalse->generated) {
2296 if (ontrue->generated) {
2301 /* neither ontrue nor onfalse exist */
2302 stmt.opcode = INSTR_IFNOT;
2303 stidx = code_statements_elements;
2304 if (code_statements_add(stmt) < 0)
2306 /* on false we jump, so add ontrue-path */
2307 if (!gen_blocks_recursive(func, ontrue))
2309 /* fixup the jump address */
2310 code_statements_data[stidx].o2.s1 = code_statements_elements - stidx;
2311 /* generate onfalse path */
2312 if (onfalse->generated) {
2313 /* fixup the jump address */
2314 code_statements_data[stidx].o2.s1 = (onfalse->code_start) - (stidx);
2315 /* may have been generated in the previous recursive call */
2316 stmt.opcode = INSTR_GOTO;
2317 stmt.o1.s1 = (onfalse->code_start) - code_statements_elements;
2320 return (code_statements_add(stmt) >= 0);
2322 /* if not, generate now */
2327 if (instr->opcode >= INSTR_CALL0 && instr->opcode <= INSTR_CALL8) {
2328 /* Trivial call translation:
2329 * copy all params to OFS_PARM*
2330 * if the output's storetype is not store_return,
2331 * add append a STORE instruction!
2333 * NOTES on how to do it better without much trouble:
2334 * -) The liferanges!
2335 * Simply check the liferange of all parameters for
2336 * other CALLs. For each param with no CALL in its
2337 * liferange, we can store it in an OFS_PARM at
2338 * generation already. This would even include later
2339 * reuse.... probably... :)
2344 for (p = 0; p < instr->params_count; ++p)
2346 ir_value *param = instr->params[p];
2348 stmt.opcode = INSTR_STORE_F;
2351 stmt.opcode = type_store_instr[param->vtype];
2352 stmt.o1.u1 = ir_value_code_addr(param);
2353 stmt.o2.u1 = OFS_PARM0 + 3 * p;
2354 if (code_statements_add(stmt) < 0)
2357 stmt.opcode = INSTR_CALL0 + instr->params_count;
2358 if (stmt.opcode > INSTR_CALL8)
2359 stmt.opcode = INSTR_CALL8;
2360 stmt.o1.u1 = ir_value_code_addr(instr->_ops[1]);
2363 if (code_statements_add(stmt) < 0)
2366 retvalue = instr->_ops[0];
2367 if (retvalue && retvalue->store != store_return && retvalue->life_count)
2369 /* not to be kept in OFS_RETURN */
2370 stmt.opcode = type_store_instr[retvalue->vtype];
2371 stmt.o1.u1 = OFS_RETURN;
2372 stmt.o2.u1 = ir_value_code_addr(retvalue);
2374 if (code_statements_add(stmt) < 0)
2380 if (instr->opcode == INSTR_STATE) {
2381 printf("TODO: state instruction\n");
2385 stmt.opcode = instr->opcode;
2390 /* This is the general order of operands */
2392 stmt.o3.u1 = ir_value_code_addr(instr->_ops[0]);
2395 stmt.o1.u1 = ir_value_code_addr(instr->_ops[1]);
2398 stmt.o2.u1 = ir_value_code_addr(instr->_ops[2]);
2400 if (stmt.opcode == INSTR_RETURN || stmt.opcode == INSTR_DONE)
2402 stmt.o1.u1 = stmt.o3.u1;
2405 else if ((stmt.opcode >= INSTR_STORE_F &&
2406 stmt.opcode <= INSTR_STORE_FNC) ||
2407 (stmt.opcode >= INSTR_STOREP_F &&
2408 stmt.opcode <= INSTR_STOREP_FNC))
2410 /* 2-operand instructions with A -> B */
2411 stmt.o2.u1 = stmt.o3.u1;
2415 if (code_statements_add(stmt) < 0)
2421 static bool gen_function_code(ir_function *self)
2424 prog_section_statement stmt;
2426 /* Starting from entry point, we generate blocks "as they come"
2427 * for now. Dead blocks will not be translated obviously.
2429 if (!self->blocks_count) {
2430 printf("Function '%s' declared without body.\n", self->name);
2434 block = self->blocks[0];
2435 if (block->generated)
2438 if (!gen_blocks_recursive(self, block)) {
2439 printf("failed to generate blocks for '%s'\n", self->name);
2443 /* otherwise code_write crashes since it debug-prints functions until AINSTR_END */
2444 stmt.opcode = AINSTR_END;
2448 if (code_statements_add(stmt) < 0)
2453 static bool gen_global_function(ir_builder *ir, ir_value *global)
2455 prog_section_function fun;
2459 size_t local_var_end;
2461 if (!global->isconst || (!global->constval.vfunc))
2463 printf("Invalid state of function-global: not constant: %s\n", global->name);
2467 irfun = global->constval.vfunc;
2469 fun.name = global->code.name;
2470 fun.file = code_cachedstring(global->context.file);
2471 fun.profile = 0; /* always 0 */
2472 fun.nargs = irfun->params_count;
2474 for (i = 0;i < 8; ++i) {
2478 fun.argsize[i] = type_sizeof[irfun->params[i]];
2481 fun.firstlocal = code_globals_elements;
2482 fun.locals = irfun->allocated_locals + irfun->locals_count;
2485 for (i = 0; i < irfun->locals_count; ++i) {
2486 if (!ir_builder_gen_global(ir, irfun->locals[i])) {
2487 printf("Failed to generate global %s\n", irfun->locals[i]->name);
2491 if (irfun->locals_count) {
2492 ir_value *last = irfun->locals[irfun->locals_count-1];
2493 local_var_end = last->code.globaladdr;
2494 local_var_end += type_sizeof[last->vtype];
2496 for (i = 0; i < irfun->values_count; ++i)
2498 /* generate code.globaladdr for ssa values */
2499 ir_value *v = irfun->values[i];
2500 ir_value_code_setaddr(v, local_var_end + v->code.local);
2502 for (i = 0; i < irfun->locals_count; ++i) {
2503 /* fill the locals with zeros */
2504 code_globals_add(0);
2508 fun.entry = irfun->builtin;
2510 fun.entry = code_statements_elements;
2511 if (!gen_function_code(irfun)) {
2512 printf("Failed to generate code for function %s\n", irfun->name);
2517 return (code_functions_add(fun) >= 0);
2520 static bool ir_builder_gen_global(ir_builder *self, ir_value *global)
2524 prog_section_def def;
2526 def.type = global->vtype;
2527 def.offset = code_globals_elements;
2528 def.name = global->code.name = code_genstring(global->name);
2530 switch (global->vtype)
2533 if (code_defs_add(def) < 0)
2535 return gen_global_pointer(global);
2537 if (code_defs_add(def) < 0)
2539 return gen_global_field(global);
2544 if (code_defs_add(def) < 0)
2547 if (global->isconst) {
2548 iptr = (int32_t*)&global->constval.vfloat;
2549 ir_value_code_setaddr(global, code_globals_add(*iptr));
2551 ir_value_code_setaddr(global, code_globals_add(0));
2553 return global->code.globaladdr >= 0;
2557 if (code_defs_add(def) < 0)
2559 if (global->isconst)
2560 ir_value_code_setaddr(global, code_globals_add(code_cachedstring(global->constval.vstring)));
2562 ir_value_code_setaddr(global, code_globals_add(0));
2563 return global->code.globaladdr >= 0;
2568 if (code_defs_add(def) < 0)
2571 if (global->isconst) {
2572 iptr = (int32_t*)&global->constval.vvec;
2573 ir_value_code_setaddr(global, code_globals_add(iptr[0]));
2574 if (global->code.globaladdr < 0)
2576 for (d = 1; d < type_sizeof[global->vtype]; ++d)
2578 if (code_globals_add(iptr[d]) < 0)
2582 ir_value_code_setaddr(global, code_globals_add(0));
2583 if (global->code.globaladdr < 0)
2585 for (d = 1; d < type_sizeof[global->vtype]; ++d)
2587 if (code_globals_add(0) < 0)
2591 return global->code.globaladdr >= 0;
2594 if (code_defs_add(def) < 0)
2596 ir_value_code_setaddr(global, code_globals_elements);
2597 code_globals_add(code_functions_elements);
2598 return gen_global_function(self, global);
2600 /* assume biggest type */
2601 ir_value_code_setaddr(global, code_globals_add(0));
2602 for (i = 1; i < type_sizeof[TYPE_VARIANT]; ++i)
2603 code_globals_add(0);
2606 /* refuse to create 'void' type or any other fancy business. */
2607 printf("Invalid type for global variable %s\n", global->name);
2612 static bool ir_builder_gen_field(ir_builder *self, ir_value *field)
2614 prog_section_def def;
2615 prog_section_field fld;
2617 def.type = field->vtype;
2618 def.offset = code_globals_elements;
2620 /* create a global named the same as the field */
2621 if (opts_standard == COMPILER_GMQCC) {
2622 /* in our standard, the global gets a dot prefix */
2623 size_t len = strlen(field->name);
2626 /* we really don't want to have to allocate this, and 1024
2627 * bytes is more than enough for a variable/field name
2629 if (len+2 >= sizeof(name)) {
2630 printf("invalid field name size: %u\n", (unsigned int)len);
2635 strcpy(name+1, field->name); /* no strncpy - we used strlen above */
2638 def.name = code_genstring(name);
2639 fld.name = def.name + 1; /* we reuse that string table entry */
2641 /* in plain QC, there cannot be a global with the same name,
2642 * and so we also name the global the same.
2643 * FIXME: fteqcc should create a global as well
2644 * check if it actually uses the same name. Probably does
2646 def.name = code_genstring(field->name);
2647 fld.name = def.name;
2650 field->code.name = def.name;
2652 if (code_defs_add(def) < 0)
2655 fld.type = field->fieldtype;
2657 if (fld.type == TYPE_VOID) {
2658 printf("field is missing a type: %s - don't know its size\n", field->name);
2662 fld.offset = code_alloc_field(type_sizeof[field->fieldtype]);
2664 if (code_fields_add(fld) < 0)
2667 ir_value_code_setaddr(field, code_globals_elements);
2668 if (!code_globals_add(fld.offset))
2670 if (fld.type == TYPE_VECTOR) {
2671 if (!code_globals_add(fld.offset+1))
2673 if (!code_globals_add(fld.offset+2))
2677 return field->code.globaladdr >= 0;
2680 bool ir_builder_generate(ir_builder *self, const char *filename)
2686 for (i = 0; i < self->fields_count; ++i)
2688 if (!ir_builder_gen_field(self, self->fields[i])) {
2693 for (i = 0; i < self->globals_count; ++i)
2695 if (!ir_builder_gen_global(self, self->globals[i])) {
2700 printf("writing '%s'...\n", filename);
2701 return code_write(filename);
2704 /***********************************************************************
2705 *IR DEBUG Dump functions...
2708 #define IND_BUFSZ 1024
2710 const char *qc_opname(int op)
2712 if (op < 0) return "<INVALID>";
2713 if (op < ( sizeof(asm_instr) / sizeof(asm_instr[0]) ))
2714 return asm_instr[op].m;
2716 case VINSTR_PHI: return "PHI";
2717 case VINSTR_JUMP: return "JUMP";
2718 case VINSTR_COND: return "COND";
2719 default: return "<UNK>";
2723 void ir_builder_dump(ir_builder *b, int (*oprintf)(const char*, ...))
2726 char indent[IND_BUFSZ];
2730 oprintf("module %s\n", b->name);
2731 for (i = 0; i < b->globals_count; ++i)
2734 if (b->globals[i]->isconst)
2735 oprintf("%s = ", b->globals[i]->name);
2736 ir_value_dump(b->globals[i], oprintf);
2739 for (i = 0; i < b->functions_count; ++i)
2740 ir_function_dump(b->functions[i], indent, oprintf);
2741 oprintf("endmodule %s\n", b->name);
2744 void ir_function_dump(ir_function *f, char *ind,
2745 int (*oprintf)(const char*, ...))
2748 if (f->builtin != 0) {
2749 oprintf("%sfunction %s = builtin %i\n", ind, f->name, -f->builtin);
2752 oprintf("%sfunction %s\n", ind, f->name);
2753 strncat(ind, "\t", IND_BUFSZ);
2754 if (f->locals_count)
2756 oprintf("%s%i locals:\n", ind, (int)f->locals_count);
2757 for (i = 0; i < f->locals_count; ++i) {
2758 oprintf("%s\t", ind);
2759 ir_value_dump(f->locals[i], oprintf);
2763 if (f->blocks_count)
2765 oprintf("%slife passes (check): %i\n", ind, (int)f->run_id);
2766 for (i = 0; i < f->blocks_count; ++i) {
2767 if (f->blocks[i]->run_id != f->run_id) {
2768 oprintf("%slife pass check fail! %i != %i\n", ind, (int)f->blocks[i]->run_id, (int)f->run_id);
2770 ir_block_dump(f->blocks[i], ind, oprintf);
2774 ind[strlen(ind)-1] = 0;
2775 oprintf("%sendfunction %s\n", ind, f->name);
2778 void ir_block_dump(ir_block* b, char *ind,
2779 int (*oprintf)(const char*, ...))
2782 oprintf("%s:%s\n", ind, b->label);
2783 strncat(ind, "\t", IND_BUFSZ);
2785 for (i = 0; i < b->instr_count; ++i)
2786 ir_instr_dump(b->instr[i], ind, oprintf);
2787 ind[strlen(ind)-1] = 0;
2790 void dump_phi(ir_instr *in, char *ind,
2791 int (*oprintf)(const char*, ...))
2794 oprintf("%s <- phi ", in->_ops[0]->name);
2795 for (i = 0; i < in->phi_count; ++i)
2797 oprintf("([%s] : %s) ", in->phi[i].from->label,
2798 in->phi[i].value->name);
2803 void ir_instr_dump(ir_instr *in, char *ind,
2804 int (*oprintf)(const char*, ...))
2807 const char *comma = NULL;
2809 oprintf("%s (%i) ", ind, (int)in->eid);
2811 if (in->opcode == VINSTR_PHI) {
2812 dump_phi(in, ind, oprintf);
2816 strncat(ind, "\t", IND_BUFSZ);
2818 if (in->_ops[0] && (in->_ops[1] || in->_ops[2])) {
2819 ir_value_dump(in->_ops[0], oprintf);
2820 if (in->_ops[1] || in->_ops[2])
2823 if (in->opcode == INSTR_CALL0) {
2824 oprintf("CALL%i\t", in->params_count);
2826 oprintf("%s\t", qc_opname(in->opcode));
2828 if (in->_ops[0] && !(in->_ops[1] || in->_ops[2])) {
2829 ir_value_dump(in->_ops[0], oprintf);
2834 for (i = 1; i != 3; ++i) {
2838 ir_value_dump(in->_ops[i], oprintf);
2846 oprintf("[%s]", in->bops[0]->label);
2850 oprintf("%s[%s]", comma, in->bops[1]->label);
2852 ind[strlen(ind)-1] = 0;
2855 void ir_value_dump(ir_value* v, int (*oprintf)(const char*, ...))
2864 oprintf("(function)");
2867 oprintf("%g", v->constval.vfloat);
2870 oprintf("'%g %g %g'",
2873 v->constval.vvec.z);
2876 oprintf("(entity)");
2879 oprintf("\"%s\"", v->constval.vstring);
2883 oprintf("%i", v->constval.vint);
2888 v->constval.vpointer->name);
2892 oprintf("%s", v->name);
2896 void ir_value_dump_life(ir_value *self, int (*oprintf)(const char*,...))
2899 oprintf("Life of %s:\n", self->name);
2900 for (i = 0; i < self->life_count; ++i)
2902 oprintf(" + [%i, %i]\n", self->life[i].start, self->life[i].end);