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 return self->code.globaladdr + self->code.addroffset;
535 ir_value* ir_value_var(const char *name, int storetype, int vtype)
538 self = (ir_value*)mem_a(sizeof(*self));
540 self->fieldtype = TYPE_VOID;
541 self->outtype = TYPE_VOID;
542 self->store = storetype;
543 MEM_VECTOR_INIT(self, reads);
544 MEM_VECTOR_INIT(self, writes);
545 self->isconst = false;
546 self->context.file = "<@no context>";
547 self->context.line = 0;
549 ir_value_set_name(self, name);
551 memset(&self->constval, 0, sizeof(self->constval));
552 memset(&self->code, 0, sizeof(self->code));
554 MEM_VECTOR_INIT(self, life);
558 ir_value* ir_value_vector_member(ir_value *self, unsigned int member)
564 if (self->members[member])
565 return self->members[member];
567 m = ir_value_var(self->name, self->store, TYPE_FLOAT);
570 m->context = self->context;
572 self->members[member] = m;
573 m->code.addroffset = member;
578 MEM_VEC_FUNCTIONS(ir_value, ir_life_entry_t, life)
579 MEM_VEC_FUNCTIONS_ALL(ir_value, ir_instr*, reads)
580 MEM_VEC_FUNCTIONS_ALL(ir_value, ir_instr*, writes)
582 ir_value* ir_value_out(ir_function *owner, const char *name, int storetype, int vtype)
584 ir_value *v = ir_value_var(name, storetype, vtype);
587 if (!ir_function_collect_value(owner, v))
595 void ir_value_delete(ir_value* self)
599 mem_d((void*)self->name);
602 if (self->vtype == TYPE_STRING)
603 mem_d((void*)self->constval.vstring);
605 for (i = 0; i < 3; ++i) {
606 if (self->members[i])
607 ir_value_delete(self->members[i]);
609 MEM_VECTOR_CLEAR(self, reads);
610 MEM_VECTOR_CLEAR(self, writes);
611 MEM_VECTOR_CLEAR(self, life);
615 void ir_value_set_name(ir_value *self, const char *name)
618 mem_d((void*)self->name);
619 self->name = util_strdup(name);
622 bool ir_value_set_float(ir_value *self, float f)
624 if (self->vtype != TYPE_FLOAT)
626 self->constval.vfloat = f;
627 self->isconst = true;
631 bool ir_value_set_func(ir_value *self, int f)
633 if (self->vtype != TYPE_FUNCTION)
635 self->constval.vint = f;
636 self->isconst = true;
640 bool ir_value_set_vector(ir_value *self, vector v)
642 if (self->vtype != TYPE_VECTOR)
644 self->constval.vvec = v;
645 self->isconst = true;
649 bool ir_value_set_field(ir_value *self, ir_value *fld)
651 if (self->vtype != TYPE_FIELD)
653 self->constval.vpointer = fld;
654 self->isconst = true;
658 bool ir_value_set_string(ir_value *self, const char *str)
660 if (self->vtype != TYPE_STRING)
662 self->constval.vstring = util_strdup(str);
663 self->isconst = true;
668 bool ir_value_set_int(ir_value *self, int i)
670 if (self->vtype != TYPE_INTEGER)
672 self->constval.vint = i;
673 self->isconst = true;
678 bool ir_value_lives(ir_value *self, size_t at)
681 for (i = 0; i < self->life_count; ++i)
683 ir_life_entry_t *life = &self->life[i];
684 if (life->start <= at && at <= life->end)
686 if (life->start > at) /* since it's ordered */
692 bool ir_value_life_insert(ir_value *self, size_t idx, ir_life_entry_t e)
695 if (!ir_value_life_add(self, e)) /* naive... */
697 for (k = self->life_count-1; k > idx; --k)
698 self->life[k] = self->life[k-1];
703 bool ir_value_life_merge(ir_value *self, size_t s)
706 ir_life_entry_t *life = NULL;
707 ir_life_entry_t *before = NULL;
708 ir_life_entry_t new_entry;
710 /* Find the first range >= s */
711 for (i = 0; i < self->life_count; ++i)
714 life = &self->life[i];
718 /* nothing found? append */
719 if (i == self->life_count) {
721 if (life && life->end+1 == s)
723 /* previous life range can be merged in */
727 if (life && life->end >= s)
730 if (!ir_value_life_add(self, e))
731 return false; /* failing */
737 if (before->end + 1 == s &&
738 life->start - 1 == s)
741 before->end = life->end;
742 if (!ir_value_life_remove(self, i))
743 return false; /* failing */
746 if (before->end + 1 == s)
752 /* already contained */
753 if (before->end >= s)
757 if (life->start - 1 == s)
762 /* insert a new entry */
763 new_entry.start = new_entry.end = s;
764 return ir_value_life_insert(self, i, new_entry);
767 bool ir_value_life_merge_into(ir_value *self, const ir_value *other)
771 if (!other->life_count)
774 if (!self->life_count) {
775 for (i = 0; i < other->life_count; ++i) {
776 if (!ir_value_life_add(self, other->life[i]))
783 for (i = 0; i < other->life_count; ++i)
785 const ir_life_entry_t *life = &other->life[i];
788 ir_life_entry_t *entry = &self->life[myi];
790 if (life->end+1 < entry->start)
792 /* adding an interval before entry */
793 if (!ir_value_life_insert(self, myi, *life))
799 if (life->start < entry->start &&
800 life->end >= entry->start)
802 /* starts earlier and overlaps */
803 entry->start = life->start;
806 if (life->end > entry->end &&
807 life->start-1 <= entry->end)
809 /* ends later and overlaps */
810 entry->end = life->end;
813 /* see if our change combines it with the next ranges */
814 while (myi+1 < self->life_count &&
815 entry->end+1 >= self->life[1+myi].start)
817 /* overlaps with (myi+1) */
818 if (entry->end < self->life[1+myi].end)
819 entry->end = self->life[1+myi].end;
820 if (!ir_value_life_remove(self, myi+1))
822 entry = &self->life[myi];
825 /* see if we're after the entry */
826 if (life->start > entry->end)
829 /* append if we're at the end */
830 if (myi >= self->life_count) {
831 if (!ir_value_life_add(self, *life))
835 /* otherweise check the next range */
844 bool ir_values_overlap(const ir_value *a, const ir_value *b)
846 /* For any life entry in A see if it overlaps with
847 * any life entry in B.
848 * Note that the life entries are orderes, so we can make a
849 * more efficient algorithm there than naively translating the
853 ir_life_entry_t *la, *lb, *enda, *endb;
855 /* first of all, if either has no life range, they cannot clash */
856 if (!a->life_count || !b->life_count)
861 enda = la + a->life_count;
862 endb = lb + b->life_count;
865 /* check if the entries overlap, for that,
866 * both must start before the other one ends.
868 #if defined(LIFE_RANGE_WITHOUT_LAST_READ)
869 if (la->start <= lb->end &&
870 lb->start <= la->end)
872 if (la->start < lb->end &&
879 /* entries are ordered
880 * one entry is earlier than the other
881 * that earlier entry will be moved forward
883 if (la->start < lb->start)
885 /* order: A B, move A forward
886 * check if we hit the end with A
891 else if (lb->start < la->start)
893 /* order: B A, move B forward
894 * check if we hit the end with B
903 /***********************************************************************
907 bool ir_block_create_store_op(ir_block *self, int op, ir_value *target, ir_value *what)
909 ir_instr *in = ir_instr_new(self, op);
913 if (target->store == store_value &&
914 (op < INSTR_STOREP_F || op > INSTR_STOREP_FNC))
916 fprintf(stderr, "cannot store to an SSA value\n");
917 fprintf(stderr, "trying to store: %s <- %s\n", target->name, what->name);
918 fprintf(stderr, "instruction: %s\n", asm_instr[op].m);
922 if (!ir_instr_op(in, 0, target, true) ||
923 !ir_instr_op(in, 1, what, false) ||
924 !ir_block_instr_add(self, in) )
931 bool ir_block_create_store(ir_block *self, ir_value *target, ir_value *what)
935 if (target->vtype == TYPE_VARIANT)
938 vtype = target->vtype;
941 if (vtype == TYPE_FLOAT && what->vtype == TYPE_INTEGER)
942 op = INSTR_CONV_ITOF;
943 else if (vtype == TYPE_INTEGER && what->vtype == TYPE_FLOAT)
944 op = INSTR_CONV_FTOI;
946 op = type_store_instr[vtype];
948 return ir_block_create_store_op(self, op, target, what);
951 bool ir_block_create_storep(ir_block *self, ir_value *target, ir_value *what)
956 if (target->vtype != TYPE_POINTER)
959 /* storing using pointer - target is a pointer, type must be
960 * inferred from source
964 op = type_storep_instr[vtype];
966 return ir_block_create_store_op(self, op, target, what);
969 bool ir_block_create_return(ir_block *self, ir_value *v)
973 fprintf(stderr, "block already ended (%s)\n", self->label);
977 self->is_return = true;
978 in = ir_instr_new(self, INSTR_RETURN);
982 if (!ir_instr_op(in, 0, v, false) ||
983 !ir_block_instr_add(self, in) )
990 bool ir_block_create_if(ir_block *self, ir_value *v,
991 ir_block *ontrue, ir_block *onfalse)
995 fprintf(stderr, "block already ended (%s)\n", self->label);
999 /*in = ir_instr_new(self, (v->vtype == TYPE_STRING ? INSTR_IF_S : INSTR_IF_F));*/
1000 in = ir_instr_new(self, VINSTR_COND);
1004 if (!ir_instr_op(in, 0, v, false)) {
1005 ir_instr_delete(in);
1009 in->bops[0] = ontrue;
1010 in->bops[1] = onfalse;
1012 if (!ir_block_instr_add(self, in))
1015 if (!ir_block_exits_add(self, ontrue) ||
1016 !ir_block_exits_add(self, onfalse) ||
1017 !ir_block_entries_add(ontrue, self) ||
1018 !ir_block_entries_add(onfalse, self) )
1025 bool ir_block_create_jump(ir_block *self, ir_block *to)
1029 fprintf(stderr, "block already ended (%s)\n", self->label);
1033 in = ir_instr_new(self, VINSTR_JUMP);
1038 if (!ir_block_instr_add(self, in))
1041 if (!ir_block_exits_add(self, to) ||
1042 !ir_block_entries_add(to, self) )
1049 bool ir_block_create_goto(ir_block *self, ir_block *to)
1053 fprintf(stderr, "block already ended (%s)\n", self->label);
1057 in = ir_instr_new(self, INSTR_GOTO);
1062 if (!ir_block_instr_add(self, in))
1065 if (!ir_block_exits_add(self, to) ||
1066 !ir_block_entries_add(to, self) )
1073 ir_instr* ir_block_create_phi(ir_block *self, const char *label, int ot)
1077 in = ir_instr_new(self, VINSTR_PHI);
1080 out = ir_value_out(self->owner, label, store_value, ot);
1082 ir_instr_delete(in);
1085 if (!ir_instr_op(in, 0, out, true)) {
1086 ir_instr_delete(in);
1087 ir_value_delete(out);
1090 if (!ir_block_instr_add(self, in)) {
1091 ir_instr_delete(in);
1092 ir_value_delete(out);
1098 ir_value* ir_phi_value(ir_instr *self)
1100 return self->_ops[0];
1103 bool ir_phi_add(ir_instr* self, ir_block *b, ir_value *v)
1107 if (!ir_block_entries_find(self->owner, b, NULL)) {
1108 /* Must not be possible to cause this, otherwise the AST
1109 * is doing something wrong.
1111 fprintf(stderr, "Invalid entry block for PHI\n");
1117 if (!ir_value_reads_add(v, self))
1119 return ir_instr_phi_add(self, pe);
1122 /* call related code */
1123 ir_instr* ir_block_create_call(ir_block *self, const char *label, ir_value *func)
1127 in = ir_instr_new(self, INSTR_CALL0);
1130 out = ir_value_out(self->owner, label, store_return, func->outtype);
1132 ir_instr_delete(in);
1135 if (!ir_instr_op(in, 0, out, true) ||
1136 !ir_instr_op(in, 1, func, false) ||
1137 !ir_block_instr_add(self, in))
1139 ir_instr_delete(in);
1140 ir_value_delete(out);
1146 ir_value* ir_call_value(ir_instr *self)
1148 return self->_ops[0];
1151 bool ir_call_param(ir_instr* self, ir_value *v)
1153 if (!ir_instr_params_add(self, v))
1155 if (!ir_value_reads_add(v, self)) {
1156 if (!ir_instr_params_remove(self, self->params_count-1))
1157 GMQCC_SUPPRESS_EMPTY_BODY;
1163 /* binary op related code */
1165 ir_value* ir_block_create_binop(ir_block *self,
1166 const char *label, int opcode,
1167 ir_value *left, ir_value *right)
1189 case INSTR_SUB_S: /* -- offset of string as float */
1194 case INSTR_BITOR_IF:
1195 case INSTR_BITOR_FI:
1196 case INSTR_BITAND_FI:
1197 case INSTR_BITAND_IF:
1212 case INSTR_BITAND_I:
1215 case INSTR_RSHIFT_I:
1216 case INSTR_LSHIFT_I:
1238 /* boolean operations result in floats */
1239 if (opcode >= INSTR_EQ_F && opcode <= INSTR_GT)
1241 else if (opcode >= INSTR_LE && opcode <= INSTR_GT)
1244 else if (opcode >= INSTR_LE_I && opcode <= INSTR_EQ_FI)
1249 if (ot == TYPE_VOID) {
1250 /* The AST or parser were supposed to check this! */
1254 return ir_block_create_general_instr(self, label, opcode, left, right, ot);
1257 ir_value* ir_block_create_unary(ir_block *self,
1258 const char *label, int opcode,
1261 int ot = TYPE_FLOAT;
1273 /* QC doesn't have other unary operations. We expect extensions to fill
1274 * the above list, otherwise we assume out-type = in-type, eg for an
1278 ot = operand->vtype;
1281 if (ot == TYPE_VOID) {
1282 /* The AST or parser were supposed to check this! */
1286 /* let's use the general instruction creator and pass NULL for OPB */
1287 return ir_block_create_general_instr(self, label, opcode, operand, NULL, ot);
1290 ir_value* ir_block_create_general_instr(ir_block *self, const char *label,
1291 int op, ir_value *a, ir_value *b, int outype)
1296 out = ir_value_out(self->owner, label, store_value, outype);
1300 instr = ir_instr_new(self, op);
1302 ir_value_delete(out);
1306 if (!ir_instr_op(instr, 0, out, true) ||
1307 !ir_instr_op(instr, 1, a, false) ||
1308 !ir_instr_op(instr, 2, b, false) )
1313 if (!ir_block_instr_add(self, instr))
1318 ir_instr_delete(instr);
1319 ir_value_delete(out);
1323 ir_value* ir_block_create_fieldaddress(ir_block *self, const char *label, ir_value *ent, ir_value *field)
1327 /* Support for various pointer types todo if so desired */
1328 if (ent->vtype != TYPE_ENTITY)
1331 if (field->vtype != TYPE_FIELD)
1334 v = ir_block_create_general_instr(self, label, INSTR_ADDRESS, ent, field, TYPE_POINTER);
1335 v->fieldtype = field->fieldtype;
1339 ir_value* ir_block_create_load_from_ent(ir_block *self, const char *label, ir_value *ent, ir_value *field, int outype)
1342 if (ent->vtype != TYPE_ENTITY)
1345 /* at some point we could redirect for TYPE_POINTER... but that could lead to carelessness */
1346 if (field->vtype != TYPE_FIELD)
1351 case TYPE_FLOAT: op = INSTR_LOAD_F; break;
1352 case TYPE_VECTOR: op = INSTR_LOAD_V; break;
1353 case TYPE_STRING: op = INSTR_LOAD_S; break;
1354 case TYPE_FIELD: op = INSTR_LOAD_FLD; break;
1355 case TYPE_ENTITY: op = INSTR_LOAD_ENT; break;
1357 case TYPE_POINTER: op = INSTR_LOAD_I; break;
1358 case TYPE_INTEGER: op = INSTR_LOAD_I; break;
1364 return ir_block_create_general_instr(self, label, op, ent, field, outype);
1367 ir_value* ir_block_create_add(ir_block *self,
1369 ir_value *left, ir_value *right)
1372 int l = left->vtype;
1373 int r = right->vtype;
1392 if ( (l == TYPE_FLOAT && r == TYPE_INTEGER) )
1394 else if ( (l == TYPE_INTEGER && r == TYPE_FLOAT) )
1400 return ir_block_create_binop(self, label, op, left, right);
1403 ir_value* ir_block_create_sub(ir_block *self,
1405 ir_value *left, ir_value *right)
1408 int l = left->vtype;
1409 int r = right->vtype;
1429 if ( (l == TYPE_FLOAT && r == TYPE_INTEGER) )
1431 else if ( (l == TYPE_INTEGER && r == TYPE_FLOAT) )
1437 return ir_block_create_binop(self, label, op, left, right);
1440 ir_value* ir_block_create_mul(ir_block *self,
1442 ir_value *left, ir_value *right)
1445 int l = left->vtype;
1446 int r = right->vtype;
1465 if ( (l == TYPE_VECTOR && r == TYPE_FLOAT) )
1467 else if ( (l == TYPE_FLOAT && r == TYPE_VECTOR) )
1470 else if ( (l == TYPE_VECTOR && r == TYPE_INTEGER) )
1472 else if ( (l == TYPE_INTEGER && r == TYPE_VECTOR) )
1474 else if ( (l == TYPE_FLOAT && r == TYPE_INTEGER) )
1476 else if ( (l == TYPE_INTEGER && r == TYPE_FLOAT) )
1482 return ir_block_create_binop(self, label, op, left, right);
1485 ir_value* ir_block_create_div(ir_block *self,
1487 ir_value *left, ir_value *right)
1490 int l = left->vtype;
1491 int r = right->vtype;
1508 if ( (l == TYPE_VECTOR && r == TYPE_FLOAT) )
1510 else if ( (l == TYPE_FLOAT && r == TYPE_INTEGER) )
1512 else if ( (l == TYPE_INTEGER && r == TYPE_FLOAT) )
1518 return ir_block_create_binop(self, label, op, left, right);
1521 /* PHI resolving breaks the SSA, and must thus be the last
1522 * step before life-range calculation.
1525 static bool ir_block_naive_phi(ir_block *self);
1526 bool ir_function_naive_phi(ir_function *self)
1530 for (i = 0; i < self->blocks_count; ++i)
1532 if (!ir_block_naive_phi(self->blocks[i]))
1538 static bool ir_naive_phi_emit_store(ir_block *block, size_t iid, ir_value *old, ir_value *what)
1543 /* create a store */
1544 if (!ir_block_create_store(block, old, what))
1547 /* we now move it up */
1548 instr = block->instr[block->instr_count-1];
1549 for (i = block->instr_count; i > iid; --i)
1550 block->instr[i] = block->instr[i-1];
1551 block->instr[i] = instr;
1556 static bool ir_block_naive_phi(ir_block *self)
1559 /* FIXME: optionally, create_phi can add the phis
1560 * to a list so we don't need to loop through blocks
1561 * - anyway: "don't optimize YET"
1563 for (i = 0; i < self->instr_count; ++i)
1565 ir_instr *instr = self->instr[i];
1566 if (instr->opcode != VINSTR_PHI)
1569 if (!ir_block_instr_remove(self, i))
1571 --i; /* NOTE: i+1 below */
1573 for (p = 0; p < instr->phi_count; ++p)
1575 ir_value *v = instr->phi[p].value;
1576 for (w = 0; w < v->writes_count; ++w) {
1579 if (!v->writes[w]->_ops[0])
1582 /* When the write was to a global, we have to emit a mov */
1583 old = v->writes[w]->_ops[0];
1585 /* The original instruction now writes to the PHI target local */
1586 if (v->writes[w]->_ops[0] == v)
1587 v->writes[w]->_ops[0] = instr->_ops[0];
1589 if (old->store != store_value && old->store != store_local && old->store != store_param)
1591 /* If it originally wrote to a global we need to store the value
1594 if (!ir_naive_phi_emit_store(self, i+1, old, v))
1596 if (i+1 < self->instr_count)
1597 instr = self->instr[i+1];
1600 /* In case I forget and access instr later, it'll be NULL
1601 * when it's a problem, to make sure we crash, rather than accessing
1607 /* If it didn't, we can replace all reads by the phi target now. */
1609 for (r = 0; r < old->reads_count; ++r)
1612 ir_instr *ri = old->reads[r];
1613 for (op = 0; op < ri->phi_count; ++op) {
1614 if (ri->phi[op].value == old)
1615 ri->phi[op].value = v;
1617 for (op = 0; op < 3; ++op) {
1618 if (ri->_ops[op] == old)
1625 ir_instr_delete(instr);
1630 /***********************************************************************
1631 *IR Temp allocation code
1632 * Propagating value life ranges by walking through the function backwards
1633 * until no more changes are made.
1634 * In theory this should happen once more than once for every nested loop
1636 * Though this implementation might run an additional time for if nests.
1645 MEM_VEC_FUNCTIONS_ALL(new_reads_t, ir_value*, v)
1647 /* Enumerate instructions used by value's life-ranges
1649 static void ir_block_enumerate(ir_block *self, size_t *_eid)
1653 for (i = 0; i < self->instr_count; ++i)
1655 self->instr[i]->eid = eid++;
1660 /* Enumerate blocks and instructions.
1661 * The block-enumeration is unordered!
1662 * We do not really use the block enumreation, however
1663 * the instruction enumeration is important for life-ranges.
1665 void ir_function_enumerate(ir_function *self)
1668 size_t instruction_id = 0;
1669 for (i = 0; i < self->blocks_count; ++i)
1671 self->blocks[i]->eid = i;
1672 self->blocks[i]->run_id = 0;
1673 ir_block_enumerate(self->blocks[i], &instruction_id);
1677 static bool ir_block_life_propagate(ir_block *b, ir_block *prev, bool *changed);
1678 bool ir_function_calculate_liferanges(ir_function *self)
1686 for (i = 0; i != self->blocks_count; ++i)
1688 if (self->blocks[i]->is_return)
1690 if (!ir_block_life_propagate(self->blocks[i], NULL, &changed))
1698 /* Local-value allocator
1699 * After finishing creating the liferange of all values used in a function
1700 * we can allocate their global-positions.
1701 * This is the counterpart to register-allocation in register machines.
1704 MEM_VECTOR_MAKE(ir_value*, locals);
1705 MEM_VECTOR_MAKE(size_t, sizes);
1706 MEM_VECTOR_MAKE(size_t, positions);
1707 } function_allocator;
1708 MEM_VEC_FUNCTIONS(function_allocator, ir_value*, locals)
1709 MEM_VEC_FUNCTIONS(function_allocator, size_t, sizes)
1710 MEM_VEC_FUNCTIONS(function_allocator, size_t, positions)
1712 static bool function_allocator_alloc(function_allocator *alloc, const ir_value *var)
1715 size_t vsize = type_sizeof[var->vtype];
1717 slot = ir_value_var("reg", store_global, var->vtype);
1721 if (!ir_value_life_merge_into(slot, var))
1724 if (!function_allocator_locals_add(alloc, slot))
1727 if (!function_allocator_sizes_add(alloc, vsize))
1733 ir_value_delete(slot);
1737 bool ir_function_allocate_locals(ir_function *self)
1746 function_allocator alloc;
1748 if (!self->locals_count)
1751 MEM_VECTOR_INIT(&alloc, locals);
1752 MEM_VECTOR_INIT(&alloc, sizes);
1753 MEM_VECTOR_INIT(&alloc, positions);
1755 for (i = 0; i < self->locals_count; ++i)
1757 if (!function_allocator_alloc(&alloc, self->locals[i]))
1761 /* Allocate a slot for any value that still exists */
1762 for (i = 0; i < self->values_count; ++i)
1764 v = self->values[i];
1769 for (a = 0; a < alloc.locals_count; ++a)
1771 slot = alloc.locals[a];
1773 if (ir_values_overlap(v, slot))
1776 if (!ir_value_life_merge_into(slot, v))
1779 /* adjust size for this slot */
1780 if (alloc.sizes[a] < type_sizeof[v->vtype])
1781 alloc.sizes[a] = type_sizeof[v->vtype];
1783 self->values[i]->code.local = a;
1786 if (a >= alloc.locals_count) {
1787 self->values[i]->code.local = alloc.locals_count;
1788 if (!function_allocator_alloc(&alloc, v))
1793 /* Adjust slot positions based on sizes */
1794 if (!function_allocator_positions_add(&alloc, 0))
1797 if (alloc.sizes_count)
1798 pos = alloc.positions[0] + alloc.sizes[0];
1801 for (i = 1; i < alloc.sizes_count; ++i)
1803 pos = alloc.positions[i-1] + alloc.sizes[i-1];
1804 if (!function_allocator_positions_add(&alloc, pos))
1808 self->allocated_locals = pos + alloc.sizes[alloc.sizes_count-1];
1810 /* Take over the actual slot positions */
1811 for (i = 0; i < self->values_count; ++i)
1812 self->values[i]->code.local = alloc.positions[self->values[i]->code.local];
1819 for (i = 0; i < alloc.locals_count; ++i)
1820 ir_value_delete(alloc.locals[i]);
1821 MEM_VECTOR_CLEAR(&alloc, locals);
1822 MEM_VECTOR_CLEAR(&alloc, sizes);
1823 MEM_VECTOR_CLEAR(&alloc, positions);
1827 /* Get information about which operand
1828 * is read from, or written to.
1830 static void ir_op_read_write(int op, size_t *read, size_t *write)
1857 static bool ir_block_living_add_instr(ir_block *self, size_t eid)
1860 bool changed = false;
1862 for (i = 0; i != self->living_count; ++i)
1864 tempbool = ir_value_life_merge(self->living[i], eid);
1867 fprintf(stderr, "block_living_add_instr() value instruction added %s: %i\n", self->living[i]->_name, (int)eid);
1869 changed = changed || tempbool;
1874 static bool ir_block_life_prop_previous(ir_block* self, ir_block *prev, bool *changed)
1877 /* values which have been read in a previous iteration are now
1878 * in the "living" array even if the previous block doesn't use them.
1879 * So we have to remove whatever does not exist in the previous block.
1880 * They will be re-added on-read, but the liferange merge won't cause
1883 for (i = 0; i < self->living_count; ++i)
1885 if (!ir_block_living_find(prev, self->living[i], NULL)) {
1886 if (!ir_block_living_remove(self, i))
1892 /* Whatever the previous block still has in its living set
1893 * must now be added to ours as well.
1895 for (i = 0; i < prev->living_count; ++i)
1897 if (ir_block_living_find(self, prev->living[i], NULL))
1899 if (!ir_block_living_add(self, prev->living[i]))
1902 printf("%s got from prev: %s\n", self->label, prev->living[i]->_name);
1908 static bool ir_block_life_propagate(ir_block *self, ir_block *prev, bool *changed)
1914 /* bitmasks which operands are read from or written to */
1916 #if defined(LIFE_RANGE_WITHOUT_LAST_READ)
1918 new_reads_t new_reads;
1920 char dbg_ind[16] = { '#', '0' };
1923 #if defined(LIFE_RANGE_WITHOUT_LAST_READ)
1924 MEM_VECTOR_INIT(&new_reads, v);
1929 if (!ir_block_life_prop_previous(self, prev, changed))
1933 i = self->instr_count;
1936 instr = self->instr[i];
1938 /* PHI operands are always read operands */
1939 for (p = 0; p < instr->phi_count; ++p)
1941 value = instr->phi[p].value;
1942 #if ! defined(LIFE_RANGE_WITHOUT_LAST_READ)
1943 if (!ir_block_living_find(self, value, NULL) &&
1944 !ir_block_living_add(self, value))
1949 if (!new_reads_t_v_find(&new_reads, value, NULL))
1951 if (!new_reads_t_v_add(&new_reads, value))
1957 /* See which operands are read and write operands */
1958 ir_op_read_write(instr->opcode, &read, &write);
1960 /* Go through the 3 main operands */
1961 for (o = 0; o < 3; ++o)
1963 if (!instr->_ops[o]) /* no such operand */
1966 value = instr->_ops[o];
1968 /* We only care about locals */
1969 /* we also calculate parameter liferanges so that locals
1970 * can take up parameter slots */
1971 if (value->store != store_value &&
1972 value->store != store_local &&
1973 value->store != store_param)
1979 #if ! defined(LIFE_RANGE_WITHOUT_LAST_READ)
1980 if (!ir_block_living_find(self, value, NULL) &&
1981 !ir_block_living_add(self, value))
1986 /* fprintf(stderr, "read: %s\n", value->_name); */
1987 if (!new_reads_t_v_find(&new_reads, value, NULL))
1989 if (!new_reads_t_v_add(&new_reads, value))
1995 /* write operands */
1996 /* When we write to a local, we consider it "dead" for the
1997 * remaining upper part of the function, since in SSA a value
1998 * can only be written once (== created)
2003 bool in_living = ir_block_living_find(self, value, &idx);
2004 #if defined(LIFE_RANGE_WITHOUT_LAST_READ)
2006 bool in_reads = new_reads_t_v_find(&new_reads, value, &readidx);
2007 if (!in_living && !in_reads)
2012 /* If the value isn't alive it hasn't been read before... */
2013 /* TODO: See if the warning can be emitted during parsing or AST processing
2014 * otherwise have warning printed here.
2015 * IF printing a warning here: include filecontext_t,
2016 * and make sure it's only printed once
2017 * since this function is run multiple times.
2019 /* For now: debug info: */
2020 fprintf(stderr, "Value only written %s\n", value->name);
2021 tempbool = ir_value_life_merge(value, instr->eid);
2022 *changed = *changed || tempbool;
2024 ir_instr_dump(instr, dbg_ind, printf);
2028 /* since 'living' won't contain it
2029 * anymore, merge the value, since
2032 tempbool = ir_value_life_merge(value, instr->eid);
2035 fprintf(stderr, "value added id %s %i\n", value->name, (int)instr->eid);
2037 *changed = *changed || tempbool;
2039 #if ! defined(LIFE_RANGE_WITHOUT_LAST_READ)
2040 if (!ir_block_living_remove(self, idx))
2045 if (!new_reads_t_v_remove(&new_reads, readidx))
2053 tempbool = ir_block_living_add_instr(self, instr->eid);
2054 /*fprintf(stderr, "living added values\n");*/
2055 *changed = *changed || tempbool;
2057 #if defined(LIFE_RANGE_WITHOUT_LAST_READ)
2059 for (rd = 0; rd < new_reads.v_count; ++rd)
2061 if (!ir_block_living_find(self, new_reads.v[rd], NULL)) {
2062 if (!ir_block_living_add(self, new_reads.v[rd]))
2065 if (!i && !self->entries_count) {
2067 *changed = *changed || ir_value_life_merge(new_reads.v[rd], instr->eid);
2070 MEM_VECTOR_CLEAR(&new_reads, v);
2074 if (self->run_id == self->owner->run_id)
2077 self->run_id = self->owner->run_id;
2079 for (i = 0; i < self->entries_count; ++i)
2081 ir_block *entry = self->entries[i];
2082 ir_block_life_propagate(entry, self, changed);
2087 #if defined(LIFE_RANGE_WITHOUT_LAST_READ)
2088 MEM_VECTOR_CLEAR(&new_reads, v);
2093 /***********************************************************************
2096 * Since the IR has the convention of putting 'write' operands
2097 * at the beginning, we have to rotate the operands of instructions
2098 * properly in order to generate valid QCVM code.
2100 * Having destinations at a fixed position is more convenient. In QC
2101 * this is *mostly* OPC, but FTE adds at least 2 instructions which
2102 * read from from OPA, and store to OPB rather than OPC. Which is
2103 * partially the reason why the implementation of these instructions
2104 * in darkplaces has been delayed for so long.
2106 * Breaking conventions is annoying...
2108 static bool ir_builder_gen_global(ir_builder *self, ir_value *global);
2110 static bool gen_global_field(ir_value *global)
2112 if (global->isconst)
2114 ir_value *fld = global->constval.vpointer;
2116 printf("Invalid field constant with no field: %s\n", global->name);
2120 /* Now, in this case, a relocation would be impossible to code
2121 * since it looks like this:
2122 * .vector v = origin; <- parse error, wtf is 'origin'?
2125 * But we will need a general relocation support later anyway
2126 * for functions... might as well support that here.
2128 if (!fld->code.globaladdr) {
2129 printf("FIXME: Relocation support\n");
2133 /* copy the field's value */
2134 ir_value_code_setaddr(global, code_globals_add(code_globals_data[fld->code.globaladdr]));
2138 ir_value_code_setaddr(global, code_globals_add(0));
2140 if (global->code.globaladdr < 0)
2145 static bool gen_global_pointer(ir_value *global)
2147 if (global->isconst)
2149 ir_value *target = global->constval.vpointer;
2151 printf("Invalid pointer constant: %s\n", global->name);
2152 /* NULL pointers are pointing to the NULL constant, which also
2153 * sits at address 0, but still has an ir_value for itself.
2158 /* Here, relocations ARE possible - in fteqcc-enhanced-qc:
2159 * void() foo; <- proto
2160 * void() *fooptr = &foo;
2161 * void() foo = { code }
2163 if (!target->code.globaladdr) {
2164 /* FIXME: Check for the constant nullptr ir_value!
2165 * because then code.globaladdr being 0 is valid.
2167 printf("FIXME: Relocation support\n");
2171 ir_value_code_setaddr(global, code_globals_add(target->code.globaladdr));
2175 ir_value_code_setaddr(global, code_globals_add(0));
2177 if (global->code.globaladdr < 0)
2182 static bool gen_blocks_recursive(ir_function *func, ir_block *block)
2184 prog_section_statement stmt;
2193 block->generated = true;
2194 block->code_start = code_statements_elements;
2195 for (i = 0; i < block->instr_count; ++i)
2197 instr = block->instr[i];
2199 if (instr->opcode == VINSTR_PHI) {
2200 printf("cannot generate virtual instruction (phi)\n");
2204 if (instr->opcode == VINSTR_JUMP) {
2205 target = instr->bops[0];
2206 /* for uncoditional jumps, if the target hasn't been generated
2207 * yet, we generate them right here.
2209 if (!target->generated) {
2214 /* otherwise we generate a jump instruction */
2215 stmt.opcode = INSTR_GOTO;
2216 stmt.o1.s1 = (target->code_start) - code_statements_elements;
2219 if (code_statements_add(stmt) < 0)
2222 /* no further instructions can be in this block */
2226 if (instr->opcode == VINSTR_COND) {
2227 ontrue = instr->bops[0];
2228 onfalse = instr->bops[1];
2229 /* TODO: have the AST signal which block should
2230 * come first: eg. optimize IFs without ELSE...
2233 stmt.o1.u1 = ir_value_code_addr(instr->_ops[0]);
2237 if (ontrue->generated) {
2238 stmt.opcode = INSTR_IF;
2239 stmt.o2.s1 = (ontrue->code_start-1) - code_statements_elements;
2240 if (code_statements_add(stmt) < 0)
2243 if (onfalse->generated) {
2244 stmt.opcode = INSTR_IFNOT;
2245 stmt.o2.s1 = (onfalse->code_start-1) - code_statements_elements;
2246 if (code_statements_add(stmt) < 0)
2249 if (!ontrue->generated) {
2250 if (onfalse->generated) {
2255 if (!onfalse->generated) {
2256 if (ontrue->generated) {
2261 /* neither ontrue nor onfalse exist */
2262 stmt.opcode = INSTR_IFNOT;
2263 stidx = code_statements_elements;
2264 if (code_statements_add(stmt) < 0)
2266 /* on false we jump, so add ontrue-path */
2267 if (!gen_blocks_recursive(func, ontrue))
2269 /* fixup the jump address */
2270 code_statements_data[stidx].o2.s1 = code_statements_elements - stidx;
2271 /* generate onfalse path */
2272 if (onfalse->generated) {
2273 /* fixup the jump address */
2274 code_statements_data[stidx].o2.s1 = (onfalse->code_start) - (stidx);
2275 /* may have been generated in the previous recursive call */
2276 stmt.opcode = INSTR_GOTO;
2277 stmt.o1.s1 = (onfalse->code_start) - code_statements_elements;
2280 return (code_statements_add(stmt) >= 0);
2282 /* if not, generate now */
2287 if (instr->opcode >= INSTR_CALL0 && instr->opcode <= INSTR_CALL8) {
2288 /* Trivial call translation:
2289 * copy all params to OFS_PARM*
2290 * if the output's storetype is not store_return,
2291 * add append a STORE instruction!
2293 * NOTES on how to do it better without much trouble:
2294 * -) The liferanges!
2295 * Simply check the liferange of all parameters for
2296 * other CALLs. For each param with no CALL in its
2297 * liferange, we can store it in an OFS_PARM at
2298 * generation already. This would even include later
2299 * reuse.... probably... :)
2304 for (p = 0; p < instr->params_count; ++p)
2306 ir_value *param = instr->params[p];
2308 stmt.opcode = INSTR_STORE_F;
2311 stmt.opcode = type_store_instr[param->vtype];
2312 stmt.o1.u1 = ir_value_code_addr(param);
2313 stmt.o2.u1 = OFS_PARM0 + 3 * p;
2314 if (code_statements_add(stmt) < 0)
2317 stmt.opcode = INSTR_CALL0 + instr->params_count;
2318 if (stmt.opcode > INSTR_CALL8)
2319 stmt.opcode = INSTR_CALL8;
2320 stmt.o1.u1 = ir_value_code_addr(instr->_ops[1]);
2323 if (code_statements_add(stmt) < 0)
2326 retvalue = instr->_ops[0];
2327 if (retvalue && retvalue->store != store_return && retvalue->life_count)
2329 /* not to be kept in OFS_RETURN */
2330 stmt.opcode = type_store_instr[retvalue->vtype];
2331 stmt.o1.u1 = OFS_RETURN;
2332 stmt.o2.u1 = ir_value_code_addr(retvalue);
2334 if (code_statements_add(stmt) < 0)
2340 if (instr->opcode == INSTR_STATE) {
2341 printf("TODO: state instruction\n");
2345 stmt.opcode = instr->opcode;
2350 /* This is the general order of operands */
2352 stmt.o3.u1 = ir_value_code_addr(instr->_ops[0]);
2355 stmt.o1.u1 = ir_value_code_addr(instr->_ops[1]);
2358 stmt.o2.u1 = ir_value_code_addr(instr->_ops[2]);
2360 if (stmt.opcode == INSTR_RETURN || stmt.opcode == INSTR_DONE)
2362 stmt.o1.u1 = stmt.o3.u1;
2365 else if (stmt.opcode >= INSTR_STORE_F &&
2366 stmt.opcode <= INSTR_STORE_FNC)
2368 /* 2-operand instructions with A -> B */
2369 stmt.o2.u1 = stmt.o3.u1;
2373 if (code_statements_add(stmt) < 0)
2379 static bool gen_function_code(ir_function *self)
2382 prog_section_statement stmt;
2384 /* Starting from entry point, we generate blocks "as they come"
2385 * for now. Dead blocks will not be translated obviously.
2387 if (!self->blocks_count) {
2388 printf("Function '%s' declared without body.\n", self->name);
2392 block = self->blocks[0];
2393 if (block->generated)
2396 if (!gen_blocks_recursive(self, block)) {
2397 printf("failed to generate blocks for '%s'\n", self->name);
2401 /* otherwise code_write crashes since it debug-prints functions until AINSTR_END */
2402 stmt.opcode = AINSTR_END;
2406 if (code_statements_add(stmt) < 0)
2411 static bool gen_global_function(ir_builder *ir, ir_value *global)
2413 prog_section_function fun;
2417 size_t local_var_end;
2419 if (!global->isconst || (!global->constval.vfunc))
2421 printf("Invalid state of function-global: not constant: %s\n", global->name);
2425 irfun = global->constval.vfunc;
2427 fun.name = global->code.name;
2428 fun.file = code_cachedstring(global->context.file);
2429 fun.profile = 0; /* always 0 */
2430 fun.nargs = irfun->params_count;
2432 for (i = 0;i < 8; ++i) {
2436 fun.argsize[i] = type_sizeof[irfun->params[i]];
2439 fun.firstlocal = code_globals_elements;
2440 fun.locals = irfun->allocated_locals + irfun->locals_count;
2443 for (i = 0; i < irfun->locals_count; ++i) {
2444 if (!ir_builder_gen_global(ir, irfun->locals[i])) {
2445 printf("Failed to generate global %s\n", irfun->locals[i]->name);
2449 if (irfun->locals_count) {
2450 ir_value *last = irfun->locals[irfun->locals_count-1];
2451 local_var_end = last->code.globaladdr;
2452 local_var_end += type_sizeof[last->vtype];
2454 for (i = 0; i < irfun->values_count; ++i)
2456 /* generate code.globaladdr for ssa values */
2457 ir_value *v = irfun->values[i];
2458 ir_value_code_setaddr(v, local_var_end + v->code.local);
2460 for (i = 0; i < irfun->locals_count; ++i) {
2461 /* fill the locals with zeros */
2462 code_globals_add(0);
2466 fun.entry = irfun->builtin;
2468 fun.entry = code_statements_elements;
2469 if (!gen_function_code(irfun)) {
2470 printf("Failed to generate code for function %s\n", irfun->name);
2475 return (code_functions_add(fun) >= 0);
2478 static bool ir_builder_gen_global(ir_builder *self, ir_value *global)
2482 prog_section_def def;
2484 def.type = global->vtype;
2485 def.offset = code_globals_elements;
2486 def.name = global->code.name = code_genstring(global->name);
2488 switch (global->vtype)
2491 if (code_defs_add(def) < 0)
2493 return gen_global_pointer(global);
2495 if (code_defs_add(def) < 0)
2497 return gen_global_field(global);
2502 if (code_defs_add(def) < 0)
2505 if (global->isconst) {
2506 iptr = (int32_t*)&global->constval.vfloat;
2507 ir_value_code_setaddr(global, code_globals_add(*iptr));
2509 ir_value_code_setaddr(global, code_globals_add(0));
2511 return global->code.globaladdr >= 0;
2515 if (code_defs_add(def) < 0)
2517 if (global->isconst)
2518 ir_value_code_setaddr(global, code_globals_add(code_cachedstring(global->constval.vstring)));
2520 ir_value_code_setaddr(global, code_globals_add(0));
2521 return global->code.globaladdr >= 0;
2526 if (code_defs_add(def) < 0)
2529 if (global->isconst) {
2530 iptr = (int32_t*)&global->constval.vvec;
2531 ir_value_code_setaddr(global, code_globals_add(iptr[0]));
2532 if (global->code.globaladdr < 0)
2534 for (d = 1; d < type_sizeof[global->vtype]; ++d)
2536 if (code_globals_add(iptr[d]) < 0)
2540 ir_value_code_setaddr(global, code_globals_add(0));
2541 if (global->code.globaladdr < 0)
2543 for (d = 1; d < type_sizeof[global->vtype]; ++d)
2545 if (code_globals_add(0) < 0)
2549 return global->code.globaladdr >= 0;
2552 if (code_defs_add(def) < 0)
2554 ir_value_code_setaddr(global, code_globals_elements);
2555 code_globals_add(code_functions_elements);
2556 return gen_global_function(self, global);
2558 /* assume biggest type */
2559 ir_value_code_setaddr(global, code_globals_add(0));
2560 for (i = 1; i < type_sizeof[TYPE_VARIANT]; ++i)
2561 code_globals_add(0);
2564 /* refuse to create 'void' type or any other fancy business. */
2565 printf("Invalid type for global variable %s\n", global->name);
2570 static bool ir_builder_gen_field(ir_builder *self, ir_value *field)
2572 prog_section_def def;
2573 prog_section_field fld;
2575 def.type = field->vtype;
2576 def.offset = code_globals_elements;
2578 /* create a global named the same as the field */
2579 if (opts_standard == COMPILER_GMQCC) {
2580 /* in our standard, the global gets a dot prefix */
2581 size_t len = strlen(field->name);
2584 /* we really don't want to have to allocate this, and 1024
2585 * bytes is more than enough for a variable/field name
2587 if (len+2 >= sizeof(name)) {
2588 printf("invalid field name size: %u\n", (unsigned int)len);
2593 strcpy(name+1, field->name); /* no strncpy - we used strlen above */
2596 def.name = code_genstring(name);
2597 fld.name = def.name + 1; /* we reuse that string table entry */
2599 /* in plain QC, there cannot be a global with the same name,
2600 * and so we also name the global the same.
2601 * FIXME: fteqcc should create a global as well
2602 * check if it actually uses the same name. Probably does
2604 def.name = code_genstring(field->name);
2605 fld.name = def.name;
2608 field->code.name = def.name;
2610 if (code_defs_add(def) < 0)
2613 fld.type = field->fieldtype;
2615 if (fld.type == TYPE_VOID) {
2616 printf("field is missing a type: %s - don't know its size\n", field->name);
2620 fld.offset = code_alloc_field(type_sizeof[field->fieldtype]);
2622 if (code_fields_add(fld) < 0)
2625 if (!code_globals_add(fld.offset))
2628 ir_value_code_setaddr(field, code_globals_add(fld.offset));
2629 return field->code.globaladdr >= 0;
2632 bool ir_builder_generate(ir_builder *self, const char *filename)
2638 for (i = 0; i < self->fields_count; ++i)
2640 if (!ir_builder_gen_field(self, self->fields[i])) {
2645 for (i = 0; i < self->globals_count; ++i)
2647 if (!ir_builder_gen_global(self, self->globals[i])) {
2652 printf("writing '%s'...\n", filename);
2653 return code_write(filename);
2656 /***********************************************************************
2657 *IR DEBUG Dump functions...
2660 #define IND_BUFSZ 1024
2662 const char *qc_opname(int op)
2664 if (op < 0) return "<INVALID>";
2665 if (op < ( sizeof(asm_instr) / sizeof(asm_instr[0]) ))
2666 return asm_instr[op].m;
2668 case VINSTR_PHI: return "PHI";
2669 case VINSTR_JUMP: return "JUMP";
2670 case VINSTR_COND: return "COND";
2671 default: return "<UNK>";
2675 void ir_builder_dump(ir_builder *b, int (*oprintf)(const char*, ...))
2678 char indent[IND_BUFSZ];
2682 oprintf("module %s\n", b->name);
2683 for (i = 0; i < b->globals_count; ++i)
2686 if (b->globals[i]->isconst)
2687 oprintf("%s = ", b->globals[i]->name);
2688 ir_value_dump(b->globals[i], oprintf);
2691 for (i = 0; i < b->functions_count; ++i)
2692 ir_function_dump(b->functions[i], indent, oprintf);
2693 oprintf("endmodule %s\n", b->name);
2696 void ir_function_dump(ir_function *f, char *ind,
2697 int (*oprintf)(const char*, ...))
2700 if (f->builtin != 0) {
2701 oprintf("%sfunction %s = builtin %i\n", ind, f->name, -f->builtin);
2704 oprintf("%sfunction %s\n", ind, f->name);
2705 strncat(ind, "\t", IND_BUFSZ);
2706 if (f->locals_count)
2708 oprintf("%s%i locals:\n", ind, (int)f->locals_count);
2709 for (i = 0; i < f->locals_count; ++i) {
2710 oprintf("%s\t", ind);
2711 ir_value_dump(f->locals[i], oprintf);
2715 if (f->blocks_count)
2717 oprintf("%slife passes (check): %i\n", ind, (int)f->run_id);
2718 for (i = 0; i < f->blocks_count; ++i) {
2719 if (f->blocks[i]->run_id != f->run_id) {
2720 oprintf("%slife pass check fail! %i != %i\n", ind, (int)f->blocks[i]->run_id, (int)f->run_id);
2722 ir_block_dump(f->blocks[i], ind, oprintf);
2726 ind[strlen(ind)-1] = 0;
2727 oprintf("%sendfunction %s\n", ind, f->name);
2730 void ir_block_dump(ir_block* b, char *ind,
2731 int (*oprintf)(const char*, ...))
2734 oprintf("%s:%s\n", ind, b->label);
2735 strncat(ind, "\t", IND_BUFSZ);
2737 for (i = 0; i < b->instr_count; ++i)
2738 ir_instr_dump(b->instr[i], ind, oprintf);
2739 ind[strlen(ind)-1] = 0;
2742 void dump_phi(ir_instr *in, char *ind,
2743 int (*oprintf)(const char*, ...))
2746 oprintf("%s <- phi ", in->_ops[0]->name);
2747 for (i = 0; i < in->phi_count; ++i)
2749 oprintf("([%s] : %s) ", in->phi[i].from->label,
2750 in->phi[i].value->name);
2755 void ir_instr_dump(ir_instr *in, char *ind,
2756 int (*oprintf)(const char*, ...))
2759 const char *comma = NULL;
2761 oprintf("%s (%i) ", ind, (int)in->eid);
2763 if (in->opcode == VINSTR_PHI) {
2764 dump_phi(in, ind, oprintf);
2768 strncat(ind, "\t", IND_BUFSZ);
2770 if (in->_ops[0] && (in->_ops[1] || in->_ops[2])) {
2771 ir_value_dump(in->_ops[0], oprintf);
2772 if (in->_ops[1] || in->_ops[2])
2775 oprintf("%s\t", qc_opname(in->opcode));
2776 if (in->_ops[0] && !(in->_ops[1] || in->_ops[2])) {
2777 ir_value_dump(in->_ops[0], oprintf);
2782 for (i = 1; i != 3; ++i) {
2786 ir_value_dump(in->_ops[i], oprintf);
2794 oprintf("[%s]", in->bops[0]->label);
2798 oprintf("%s[%s]", comma, in->bops[1]->label);
2800 ind[strlen(ind)-1] = 0;
2803 void ir_value_dump(ir_value* v, int (*oprintf)(const char*, ...))
2811 oprintf("%g", v->constval.vfloat);
2814 oprintf("'%g %g %g'",
2817 v->constval.vvec.z);
2820 oprintf("(entity)");
2823 oprintf("\"%s\"", v->constval.vstring);
2827 oprintf("%i", v->constval.vint);
2832 v->constval.vpointer->name);
2836 oprintf("%s", v->name);
2840 void ir_value_dump_life(ir_value *self, int (*oprintf)(const char*,...))
2843 oprintf("Life of %s:\n", self->name);
2844 for (i = 0; i < self->life_count; ++i)
2846 oprintf(" + [%i, %i]\n", self->life[i].start, self->life[i].end);