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;
596 MEM_VEC_FUNCTIONS(ir_value, ir_life_entry_t, life)
597 MEM_VEC_FUNCTIONS_ALL(ir_value, ir_instr*, reads)
598 MEM_VEC_FUNCTIONS_ALL(ir_value, ir_instr*, writes)
600 ir_value* ir_value_out(ir_function *owner, const char *name, int storetype, int vtype)
602 ir_value *v = ir_value_var(name, storetype, vtype);
605 if (!ir_function_collect_value(owner, v))
613 void ir_value_delete(ir_value* self)
617 mem_d((void*)self->name);
620 if (self->vtype == TYPE_STRING)
621 mem_d((void*)self->constval.vstring);
623 for (i = 0; i < 3; ++i) {
624 if (self->members[i])
625 ir_value_delete(self->members[i]);
627 MEM_VECTOR_CLEAR(self, reads);
628 MEM_VECTOR_CLEAR(self, writes);
629 MEM_VECTOR_CLEAR(self, life);
633 void ir_value_set_name(ir_value *self, const char *name)
636 mem_d((void*)self->name);
637 self->name = util_strdup(name);
640 bool ir_value_set_float(ir_value *self, float f)
642 if (self->vtype != TYPE_FLOAT)
644 self->constval.vfloat = f;
645 self->isconst = true;
649 bool ir_value_set_func(ir_value *self, int f)
651 if (self->vtype != TYPE_FUNCTION)
653 self->constval.vint = f;
654 self->isconst = true;
658 bool ir_value_set_vector(ir_value *self, vector v)
660 if (self->vtype != TYPE_VECTOR)
662 self->constval.vvec = v;
663 self->isconst = true;
667 bool ir_value_set_field(ir_value *self, ir_value *fld)
669 if (self->vtype != TYPE_FIELD)
671 self->constval.vpointer = fld;
672 self->isconst = true;
676 bool ir_value_set_string(ir_value *self, const char *str)
678 if (self->vtype != TYPE_STRING)
680 self->constval.vstring = util_strdup(str);
681 self->isconst = true;
686 bool ir_value_set_int(ir_value *self, int i)
688 if (self->vtype != TYPE_INTEGER)
690 self->constval.vint = i;
691 self->isconst = true;
696 bool ir_value_lives(ir_value *self, size_t at)
699 for (i = 0; i < self->life_count; ++i)
701 ir_life_entry_t *life = &self->life[i];
702 if (life->start <= at && at <= life->end)
704 if (life->start > at) /* since it's ordered */
710 bool ir_value_life_insert(ir_value *self, size_t idx, ir_life_entry_t e)
713 if (!ir_value_life_add(self, e)) /* naive... */
715 for (k = self->life_count-1; k > idx; --k)
716 self->life[k] = self->life[k-1];
721 bool ir_value_life_merge(ir_value *self, size_t s)
724 ir_life_entry_t *life = NULL;
725 ir_life_entry_t *before = NULL;
726 ir_life_entry_t new_entry;
728 /* Find the first range >= s */
729 for (i = 0; i < self->life_count; ++i)
732 life = &self->life[i];
736 /* nothing found? append */
737 if (i == self->life_count) {
739 if (life && life->end+1 == s)
741 /* previous life range can be merged in */
745 if (life && life->end >= s)
748 if (!ir_value_life_add(self, e))
749 return false; /* failing */
755 if (before->end + 1 == s &&
756 life->start - 1 == s)
759 before->end = life->end;
760 if (!ir_value_life_remove(self, i))
761 return false; /* failing */
764 if (before->end + 1 == s)
770 /* already contained */
771 if (before->end >= s)
775 if (life->start - 1 == s)
780 /* insert a new entry */
781 new_entry.start = new_entry.end = s;
782 return ir_value_life_insert(self, i, new_entry);
785 bool ir_value_life_merge_into(ir_value *self, const ir_value *other)
789 if (!other->life_count)
792 if (!self->life_count) {
793 for (i = 0; i < other->life_count; ++i) {
794 if (!ir_value_life_add(self, other->life[i]))
801 for (i = 0; i < other->life_count; ++i)
803 const ir_life_entry_t *life = &other->life[i];
806 ir_life_entry_t *entry = &self->life[myi];
808 if (life->end+1 < entry->start)
810 /* adding an interval before entry */
811 if (!ir_value_life_insert(self, myi, *life))
817 if (life->start < entry->start &&
818 life->end >= entry->start)
820 /* starts earlier and overlaps */
821 entry->start = life->start;
824 if (life->end > entry->end &&
825 life->start-1 <= entry->end)
827 /* ends later and overlaps */
828 entry->end = life->end;
831 /* see if our change combines it with the next ranges */
832 while (myi+1 < self->life_count &&
833 entry->end+1 >= self->life[1+myi].start)
835 /* overlaps with (myi+1) */
836 if (entry->end < self->life[1+myi].end)
837 entry->end = self->life[1+myi].end;
838 if (!ir_value_life_remove(self, myi+1))
840 entry = &self->life[myi];
843 /* see if we're after the entry */
844 if (life->start > entry->end)
847 /* append if we're at the end */
848 if (myi >= self->life_count) {
849 if (!ir_value_life_add(self, *life))
853 /* otherweise check the next range */
862 bool ir_values_overlap(const ir_value *a, const ir_value *b)
864 /* For any life entry in A see if it overlaps with
865 * any life entry in B.
866 * Note that the life entries are orderes, so we can make a
867 * more efficient algorithm there than naively translating the
871 ir_life_entry_t *la, *lb, *enda, *endb;
873 /* first of all, if either has no life range, they cannot clash */
874 if (!a->life_count || !b->life_count)
879 enda = la + a->life_count;
880 endb = lb + b->life_count;
883 /* check if the entries overlap, for that,
884 * both must start before the other one ends.
886 #if defined(LIFE_RANGE_WITHOUT_LAST_READ)
887 if (la->start <= lb->end &&
888 lb->start <= la->end)
890 if (la->start < lb->end &&
897 /* entries are ordered
898 * one entry is earlier than the other
899 * that earlier entry will be moved forward
901 if (la->start < lb->start)
903 /* order: A B, move A forward
904 * check if we hit the end with A
909 else if (lb->start < la->start)
911 /* order: B A, move B forward
912 * check if we hit the end with B
921 /***********************************************************************
925 bool ir_block_create_store_op(ir_block *self, int op, ir_value *target, ir_value *what)
927 ir_instr *in = ir_instr_new(self, op);
931 if (target->store == store_value &&
932 (op < INSTR_STOREP_F || op > INSTR_STOREP_FNC))
934 fprintf(stderr, "cannot store to an SSA value\n");
935 fprintf(stderr, "trying to store: %s <- %s\n", target->name, what->name);
936 fprintf(stderr, "instruction: %s\n", asm_instr[op].m);
940 if (!ir_instr_op(in, 0, target, true) ||
941 !ir_instr_op(in, 1, what, false) ||
942 !ir_block_instr_add(self, in) )
949 bool ir_block_create_store(ir_block *self, ir_value *target, ir_value *what)
953 if (target->vtype == TYPE_VARIANT)
956 vtype = target->vtype;
959 if (vtype == TYPE_FLOAT && what->vtype == TYPE_INTEGER)
960 op = INSTR_CONV_ITOF;
961 else if (vtype == TYPE_INTEGER && what->vtype == TYPE_FLOAT)
962 op = INSTR_CONV_FTOI;
964 op = type_store_instr[vtype];
966 return ir_block_create_store_op(self, op, target, what);
969 bool ir_block_create_storep(ir_block *self, ir_value *target, ir_value *what)
974 if (target->vtype != TYPE_POINTER)
977 /* storing using pointer - target is a pointer, type must be
978 * inferred from source
982 op = type_storep_instr[vtype];
984 return ir_block_create_store_op(self, op, target, what);
987 bool ir_block_create_return(ir_block *self, ir_value *v)
991 fprintf(stderr, "block already ended (%s)\n", self->label);
995 self->is_return = true;
996 in = ir_instr_new(self, INSTR_RETURN);
1000 if (!ir_instr_op(in, 0, v, false) ||
1001 !ir_block_instr_add(self, in) )
1008 bool ir_block_create_if(ir_block *self, ir_value *v,
1009 ir_block *ontrue, ir_block *onfalse)
1013 fprintf(stderr, "block already ended (%s)\n", self->label);
1017 /*in = ir_instr_new(self, (v->vtype == TYPE_STRING ? INSTR_IF_S : INSTR_IF_F));*/
1018 in = ir_instr_new(self, VINSTR_COND);
1022 if (!ir_instr_op(in, 0, v, false)) {
1023 ir_instr_delete(in);
1027 in->bops[0] = ontrue;
1028 in->bops[1] = onfalse;
1030 if (!ir_block_instr_add(self, in))
1033 if (!ir_block_exits_add(self, ontrue) ||
1034 !ir_block_exits_add(self, onfalse) ||
1035 !ir_block_entries_add(ontrue, self) ||
1036 !ir_block_entries_add(onfalse, self) )
1043 bool ir_block_create_jump(ir_block *self, ir_block *to)
1047 fprintf(stderr, "block already ended (%s)\n", self->label);
1051 in = ir_instr_new(self, VINSTR_JUMP);
1056 if (!ir_block_instr_add(self, in))
1059 if (!ir_block_exits_add(self, to) ||
1060 !ir_block_entries_add(to, self) )
1067 bool ir_block_create_goto(ir_block *self, ir_block *to)
1071 fprintf(stderr, "block already ended (%s)\n", self->label);
1075 in = ir_instr_new(self, INSTR_GOTO);
1080 if (!ir_block_instr_add(self, in))
1083 if (!ir_block_exits_add(self, to) ||
1084 !ir_block_entries_add(to, self) )
1091 ir_instr* ir_block_create_phi(ir_block *self, const char *label, int ot)
1095 in = ir_instr_new(self, VINSTR_PHI);
1098 out = ir_value_out(self->owner, label, store_value, ot);
1100 ir_instr_delete(in);
1103 if (!ir_instr_op(in, 0, out, true)) {
1104 ir_instr_delete(in);
1105 ir_value_delete(out);
1108 if (!ir_block_instr_add(self, in)) {
1109 ir_instr_delete(in);
1110 ir_value_delete(out);
1116 ir_value* ir_phi_value(ir_instr *self)
1118 return self->_ops[0];
1121 bool ir_phi_add(ir_instr* self, ir_block *b, ir_value *v)
1125 if (!ir_block_entries_find(self->owner, b, NULL)) {
1126 /* Must not be possible to cause this, otherwise the AST
1127 * is doing something wrong.
1129 fprintf(stderr, "Invalid entry block for PHI\n");
1135 if (!ir_value_reads_add(v, self))
1137 return ir_instr_phi_add(self, pe);
1140 /* call related code */
1141 ir_instr* ir_block_create_call(ir_block *self, const char *label, ir_value *func)
1145 in = ir_instr_new(self, INSTR_CALL0);
1148 out = ir_value_out(self->owner, label, store_return, func->outtype);
1150 ir_instr_delete(in);
1153 if (!ir_instr_op(in, 0, out, true) ||
1154 !ir_instr_op(in, 1, func, false) ||
1155 !ir_block_instr_add(self, in))
1157 ir_instr_delete(in);
1158 ir_value_delete(out);
1164 ir_value* ir_call_value(ir_instr *self)
1166 return self->_ops[0];
1169 bool ir_call_param(ir_instr* self, ir_value *v)
1171 if (!ir_instr_params_add(self, v))
1173 if (!ir_value_reads_add(v, self)) {
1174 if (!ir_instr_params_remove(self, self->params_count-1))
1175 GMQCC_SUPPRESS_EMPTY_BODY;
1181 /* binary op related code */
1183 ir_value* ir_block_create_binop(ir_block *self,
1184 const char *label, int opcode,
1185 ir_value *left, ir_value *right)
1207 case INSTR_SUB_S: /* -- offset of string as float */
1212 case INSTR_BITOR_IF:
1213 case INSTR_BITOR_FI:
1214 case INSTR_BITAND_FI:
1215 case INSTR_BITAND_IF:
1230 case INSTR_BITAND_I:
1233 case INSTR_RSHIFT_I:
1234 case INSTR_LSHIFT_I:
1256 /* boolean operations result in floats */
1257 if (opcode >= INSTR_EQ_F && opcode <= INSTR_GT)
1259 else if (opcode >= INSTR_LE && opcode <= INSTR_GT)
1262 else if (opcode >= INSTR_LE_I && opcode <= INSTR_EQ_FI)
1267 if (ot == TYPE_VOID) {
1268 /* The AST or parser were supposed to check this! */
1272 return ir_block_create_general_instr(self, label, opcode, left, right, ot);
1275 ir_value* ir_block_create_unary(ir_block *self,
1276 const char *label, int opcode,
1279 int ot = TYPE_FLOAT;
1291 /* QC doesn't have other unary operations. We expect extensions to fill
1292 * the above list, otherwise we assume out-type = in-type, eg for an
1296 ot = operand->vtype;
1299 if (ot == TYPE_VOID) {
1300 /* The AST or parser were supposed to check this! */
1304 /* let's use the general instruction creator and pass NULL for OPB */
1305 return ir_block_create_general_instr(self, label, opcode, operand, NULL, ot);
1308 ir_value* ir_block_create_general_instr(ir_block *self, const char *label,
1309 int op, ir_value *a, ir_value *b, int outype)
1314 out = ir_value_out(self->owner, label, store_value, outype);
1318 instr = ir_instr_new(self, op);
1320 ir_value_delete(out);
1324 if (!ir_instr_op(instr, 0, out, true) ||
1325 !ir_instr_op(instr, 1, a, false) ||
1326 !ir_instr_op(instr, 2, b, false) )
1331 if (!ir_block_instr_add(self, instr))
1336 ir_instr_delete(instr);
1337 ir_value_delete(out);
1341 ir_value* ir_block_create_fieldaddress(ir_block *self, const char *label, ir_value *ent, ir_value *field)
1345 /* Support for various pointer types todo if so desired */
1346 if (ent->vtype != TYPE_ENTITY)
1349 if (field->vtype != TYPE_FIELD)
1352 v = ir_block_create_general_instr(self, label, INSTR_ADDRESS, ent, field, TYPE_POINTER);
1353 v->fieldtype = field->fieldtype;
1357 ir_value* ir_block_create_load_from_ent(ir_block *self, const char *label, ir_value *ent, ir_value *field, int outype)
1360 if (ent->vtype != TYPE_ENTITY)
1363 /* at some point we could redirect for TYPE_POINTER... but that could lead to carelessness */
1364 if (field->vtype != TYPE_FIELD)
1369 case TYPE_FLOAT: op = INSTR_LOAD_F; break;
1370 case TYPE_VECTOR: op = INSTR_LOAD_V; break;
1371 case TYPE_STRING: op = INSTR_LOAD_S; break;
1372 case TYPE_FIELD: op = INSTR_LOAD_FLD; break;
1373 case TYPE_ENTITY: op = INSTR_LOAD_ENT; break;
1375 case TYPE_POINTER: op = INSTR_LOAD_I; break;
1376 case TYPE_INTEGER: op = INSTR_LOAD_I; break;
1382 return ir_block_create_general_instr(self, label, op, ent, field, outype);
1385 ir_value* ir_block_create_add(ir_block *self,
1387 ir_value *left, ir_value *right)
1390 int l = left->vtype;
1391 int r = right->vtype;
1410 if ( (l == TYPE_FLOAT && r == TYPE_INTEGER) )
1412 else if ( (l == TYPE_INTEGER && r == TYPE_FLOAT) )
1418 return ir_block_create_binop(self, label, op, left, right);
1421 ir_value* ir_block_create_sub(ir_block *self,
1423 ir_value *left, ir_value *right)
1426 int l = left->vtype;
1427 int r = right->vtype;
1447 if ( (l == TYPE_FLOAT && r == TYPE_INTEGER) )
1449 else if ( (l == TYPE_INTEGER && r == TYPE_FLOAT) )
1455 return ir_block_create_binop(self, label, op, left, right);
1458 ir_value* ir_block_create_mul(ir_block *self,
1460 ir_value *left, ir_value *right)
1463 int l = left->vtype;
1464 int r = right->vtype;
1483 if ( (l == TYPE_VECTOR && r == TYPE_FLOAT) )
1485 else if ( (l == TYPE_FLOAT && r == TYPE_VECTOR) )
1488 else if ( (l == TYPE_VECTOR && r == TYPE_INTEGER) )
1490 else if ( (l == TYPE_INTEGER && r == TYPE_VECTOR) )
1492 else if ( (l == TYPE_FLOAT && r == TYPE_INTEGER) )
1494 else if ( (l == TYPE_INTEGER && r == TYPE_FLOAT) )
1500 return ir_block_create_binop(self, label, op, left, right);
1503 ir_value* ir_block_create_div(ir_block *self,
1505 ir_value *left, ir_value *right)
1508 int l = left->vtype;
1509 int r = right->vtype;
1526 if ( (l == TYPE_VECTOR && r == TYPE_FLOAT) )
1528 else if ( (l == TYPE_FLOAT && r == TYPE_INTEGER) )
1530 else if ( (l == TYPE_INTEGER && r == TYPE_FLOAT) )
1536 return ir_block_create_binop(self, label, op, left, right);
1539 /* PHI resolving breaks the SSA, and must thus be the last
1540 * step before life-range calculation.
1543 static bool ir_block_naive_phi(ir_block *self);
1544 bool ir_function_naive_phi(ir_function *self)
1548 for (i = 0; i < self->blocks_count; ++i)
1550 if (!ir_block_naive_phi(self->blocks[i]))
1556 static bool ir_naive_phi_emit_store(ir_block *block, size_t iid, ir_value *old, ir_value *what)
1561 /* create a store */
1562 if (!ir_block_create_store(block, old, what))
1565 /* we now move it up */
1566 instr = block->instr[block->instr_count-1];
1567 for (i = block->instr_count; i > iid; --i)
1568 block->instr[i] = block->instr[i-1];
1569 block->instr[i] = instr;
1574 static bool ir_block_naive_phi(ir_block *self)
1577 /* FIXME: optionally, create_phi can add the phis
1578 * to a list so we don't need to loop through blocks
1579 * - anyway: "don't optimize YET"
1581 for (i = 0; i < self->instr_count; ++i)
1583 ir_instr *instr = self->instr[i];
1584 if (instr->opcode != VINSTR_PHI)
1587 if (!ir_block_instr_remove(self, i))
1589 --i; /* NOTE: i+1 below */
1591 for (p = 0; p < instr->phi_count; ++p)
1593 ir_value *v = instr->phi[p].value;
1594 for (w = 0; w < v->writes_count; ++w) {
1597 if (!v->writes[w]->_ops[0])
1600 /* When the write was to a global, we have to emit a mov */
1601 old = v->writes[w]->_ops[0];
1603 /* The original instruction now writes to the PHI target local */
1604 if (v->writes[w]->_ops[0] == v)
1605 v->writes[w]->_ops[0] = instr->_ops[0];
1607 if (old->store != store_value && old->store != store_local && old->store != store_param)
1609 /* If it originally wrote to a global we need to store the value
1612 if (!ir_naive_phi_emit_store(self, i+1, old, v))
1614 if (i+1 < self->instr_count)
1615 instr = self->instr[i+1];
1618 /* In case I forget and access instr later, it'll be NULL
1619 * when it's a problem, to make sure we crash, rather than accessing
1625 /* If it didn't, we can replace all reads by the phi target now. */
1627 for (r = 0; r < old->reads_count; ++r)
1630 ir_instr *ri = old->reads[r];
1631 for (op = 0; op < ri->phi_count; ++op) {
1632 if (ri->phi[op].value == old)
1633 ri->phi[op].value = v;
1635 for (op = 0; op < 3; ++op) {
1636 if (ri->_ops[op] == old)
1643 ir_instr_delete(instr);
1648 /***********************************************************************
1649 *IR Temp allocation code
1650 * Propagating value life ranges by walking through the function backwards
1651 * until no more changes are made.
1652 * In theory this should happen once more than once for every nested loop
1654 * Though this implementation might run an additional time for if nests.
1663 MEM_VEC_FUNCTIONS_ALL(new_reads_t, ir_value*, v)
1665 /* Enumerate instructions used by value's life-ranges
1667 static void ir_block_enumerate(ir_block *self, size_t *_eid)
1671 for (i = 0; i < self->instr_count; ++i)
1673 self->instr[i]->eid = eid++;
1678 /* Enumerate blocks and instructions.
1679 * The block-enumeration is unordered!
1680 * We do not really use the block enumreation, however
1681 * the instruction enumeration is important for life-ranges.
1683 void ir_function_enumerate(ir_function *self)
1686 size_t instruction_id = 0;
1687 for (i = 0; i < self->blocks_count; ++i)
1689 self->blocks[i]->eid = i;
1690 self->blocks[i]->run_id = 0;
1691 ir_block_enumerate(self->blocks[i], &instruction_id);
1695 static bool ir_block_life_propagate(ir_block *b, ir_block *prev, bool *changed);
1696 bool ir_function_calculate_liferanges(ir_function *self)
1704 for (i = 0; i != self->blocks_count; ++i)
1706 if (self->blocks[i]->is_return)
1708 if (!ir_block_life_propagate(self->blocks[i], NULL, &changed))
1716 /* Local-value allocator
1717 * After finishing creating the liferange of all values used in a function
1718 * we can allocate their global-positions.
1719 * This is the counterpart to register-allocation in register machines.
1722 MEM_VECTOR_MAKE(ir_value*, locals);
1723 MEM_VECTOR_MAKE(size_t, sizes);
1724 MEM_VECTOR_MAKE(size_t, positions);
1725 } function_allocator;
1726 MEM_VEC_FUNCTIONS(function_allocator, ir_value*, locals)
1727 MEM_VEC_FUNCTIONS(function_allocator, size_t, sizes)
1728 MEM_VEC_FUNCTIONS(function_allocator, size_t, positions)
1730 static bool function_allocator_alloc(function_allocator *alloc, const ir_value *var)
1733 size_t vsize = type_sizeof[var->vtype];
1735 slot = ir_value_var("reg", store_global, var->vtype);
1739 if (!ir_value_life_merge_into(slot, var))
1742 if (!function_allocator_locals_add(alloc, slot))
1745 if (!function_allocator_sizes_add(alloc, vsize))
1751 ir_value_delete(slot);
1755 bool ir_function_allocate_locals(ir_function *self)
1764 function_allocator alloc;
1766 if (!self->locals_count)
1769 MEM_VECTOR_INIT(&alloc, locals);
1770 MEM_VECTOR_INIT(&alloc, sizes);
1771 MEM_VECTOR_INIT(&alloc, positions);
1773 for (i = 0; i < self->locals_count; ++i)
1775 if (!function_allocator_alloc(&alloc, self->locals[i]))
1779 /* Allocate a slot for any value that still exists */
1780 for (i = 0; i < self->values_count; ++i)
1782 v = self->values[i];
1787 for (a = 0; a < alloc.locals_count; ++a)
1789 slot = alloc.locals[a];
1791 if (ir_values_overlap(v, slot))
1794 if (!ir_value_life_merge_into(slot, v))
1797 /* adjust size for this slot */
1798 if (alloc.sizes[a] < type_sizeof[v->vtype])
1799 alloc.sizes[a] = type_sizeof[v->vtype];
1801 self->values[i]->code.local = a;
1804 if (a >= alloc.locals_count) {
1805 self->values[i]->code.local = alloc.locals_count;
1806 if (!function_allocator_alloc(&alloc, v))
1811 /* Adjust slot positions based on sizes */
1812 if (!function_allocator_positions_add(&alloc, 0))
1815 if (alloc.sizes_count)
1816 pos = alloc.positions[0] + alloc.sizes[0];
1819 for (i = 1; i < alloc.sizes_count; ++i)
1821 pos = alloc.positions[i-1] + alloc.sizes[i-1];
1822 if (!function_allocator_positions_add(&alloc, pos))
1826 self->allocated_locals = pos + alloc.sizes[alloc.sizes_count-1];
1828 /* Take over the actual slot positions */
1829 for (i = 0; i < self->values_count; ++i)
1830 self->values[i]->code.local = alloc.positions[self->values[i]->code.local];
1837 for (i = 0; i < alloc.locals_count; ++i)
1838 ir_value_delete(alloc.locals[i]);
1839 MEM_VECTOR_CLEAR(&alloc, locals);
1840 MEM_VECTOR_CLEAR(&alloc, sizes);
1841 MEM_VECTOR_CLEAR(&alloc, positions);
1845 /* Get information about which operand
1846 * is read from, or written to.
1848 static void ir_op_read_write(int op, size_t *read, size_t *write)
1875 static bool ir_block_living_add_instr(ir_block *self, size_t eid)
1878 bool changed = false;
1880 for (i = 0; i != self->living_count; ++i)
1882 tempbool = ir_value_life_merge(self->living[i], eid);
1885 fprintf(stderr, "block_living_add_instr() value instruction added %s: %i\n", self->living[i]->_name, (int)eid);
1887 changed = changed || tempbool;
1892 static bool ir_block_life_prop_previous(ir_block* self, ir_block *prev, bool *changed)
1895 /* values which have been read in a previous iteration are now
1896 * in the "living" array even if the previous block doesn't use them.
1897 * So we have to remove whatever does not exist in the previous block.
1898 * They will be re-added on-read, but the liferange merge won't cause
1901 for (i = 0; i < self->living_count; ++i)
1903 if (!ir_block_living_find(prev, self->living[i], NULL)) {
1904 if (!ir_block_living_remove(self, i))
1910 /* Whatever the previous block still has in its living set
1911 * must now be added to ours as well.
1913 for (i = 0; i < prev->living_count; ++i)
1915 if (ir_block_living_find(self, prev->living[i], NULL))
1917 if (!ir_block_living_add(self, prev->living[i]))
1920 printf("%s got from prev: %s\n", self->label, prev->living[i]->_name);
1926 static bool ir_block_life_propagate(ir_block *self, ir_block *prev, bool *changed)
1932 /* bitmasks which operands are read from or written to */
1934 #if defined(LIFE_RANGE_WITHOUT_LAST_READ)
1936 new_reads_t new_reads;
1938 char dbg_ind[16] = { '#', '0' };
1941 #if defined(LIFE_RANGE_WITHOUT_LAST_READ)
1942 MEM_VECTOR_INIT(&new_reads, v);
1947 if (!ir_block_life_prop_previous(self, prev, changed))
1951 i = self->instr_count;
1954 instr = self->instr[i];
1956 /* PHI operands are always read operands */
1957 for (p = 0; p < instr->phi_count; ++p)
1959 value = instr->phi[p].value;
1960 #if ! defined(LIFE_RANGE_WITHOUT_LAST_READ)
1961 if (!ir_block_living_find(self, value, NULL) &&
1962 !ir_block_living_add(self, value))
1967 if (!new_reads_t_v_find(&new_reads, value, NULL))
1969 if (!new_reads_t_v_add(&new_reads, value))
1975 /* See which operands are read and write operands */
1976 ir_op_read_write(instr->opcode, &read, &write);
1978 /* Go through the 3 main operands */
1979 for (o = 0; o < 3; ++o)
1981 if (!instr->_ops[o]) /* no such operand */
1984 value = instr->_ops[o];
1986 /* We only care about locals */
1987 /* we also calculate parameter liferanges so that locals
1988 * can take up parameter slots */
1989 if (value->store != store_value &&
1990 value->store != store_local &&
1991 value->store != store_param)
1997 #if ! defined(LIFE_RANGE_WITHOUT_LAST_READ)
1998 if (!ir_block_living_find(self, value, NULL) &&
1999 !ir_block_living_add(self, value))
2004 /* fprintf(stderr, "read: %s\n", value->_name); */
2005 if (!new_reads_t_v_find(&new_reads, value, NULL))
2007 if (!new_reads_t_v_add(&new_reads, value))
2013 /* write operands */
2014 /* When we write to a local, we consider it "dead" for the
2015 * remaining upper part of the function, since in SSA a value
2016 * can only be written once (== created)
2021 bool in_living = ir_block_living_find(self, value, &idx);
2022 #if defined(LIFE_RANGE_WITHOUT_LAST_READ)
2024 bool in_reads = new_reads_t_v_find(&new_reads, value, &readidx);
2025 if (!in_living && !in_reads)
2030 /* If the value isn't alive it hasn't been read before... */
2031 /* TODO: See if the warning can be emitted during parsing or AST processing
2032 * otherwise have warning printed here.
2033 * IF printing a warning here: include filecontext_t,
2034 * and make sure it's only printed once
2035 * since this function is run multiple times.
2037 /* For now: debug info: */
2038 fprintf(stderr, "Value only written %s\n", value->name);
2039 tempbool = ir_value_life_merge(value, instr->eid);
2040 *changed = *changed || tempbool;
2042 ir_instr_dump(instr, dbg_ind, printf);
2046 /* since 'living' won't contain it
2047 * anymore, merge the value, since
2050 tempbool = ir_value_life_merge(value, instr->eid);
2053 fprintf(stderr, "value added id %s %i\n", value->name, (int)instr->eid);
2055 *changed = *changed || tempbool;
2057 #if ! defined(LIFE_RANGE_WITHOUT_LAST_READ)
2058 if (!ir_block_living_remove(self, idx))
2063 if (!new_reads_t_v_remove(&new_reads, readidx))
2071 tempbool = ir_block_living_add_instr(self, instr->eid);
2072 /*fprintf(stderr, "living added values\n");*/
2073 *changed = *changed || tempbool;
2075 #if defined(LIFE_RANGE_WITHOUT_LAST_READ)
2077 for (rd = 0; rd < new_reads.v_count; ++rd)
2079 if (!ir_block_living_find(self, new_reads.v[rd], NULL)) {
2080 if (!ir_block_living_add(self, new_reads.v[rd]))
2083 if (!i && !self->entries_count) {
2085 *changed = *changed || ir_value_life_merge(new_reads.v[rd], instr->eid);
2088 MEM_VECTOR_CLEAR(&new_reads, v);
2092 if (self->run_id == self->owner->run_id)
2095 self->run_id = self->owner->run_id;
2097 for (i = 0; i < self->entries_count; ++i)
2099 ir_block *entry = self->entries[i];
2100 ir_block_life_propagate(entry, self, changed);
2105 #if defined(LIFE_RANGE_WITHOUT_LAST_READ)
2106 MEM_VECTOR_CLEAR(&new_reads, v);
2111 /***********************************************************************
2114 * Since the IR has the convention of putting 'write' operands
2115 * at the beginning, we have to rotate the operands of instructions
2116 * properly in order to generate valid QCVM code.
2118 * Having destinations at a fixed position is more convenient. In QC
2119 * this is *mostly* OPC, but FTE adds at least 2 instructions which
2120 * read from from OPA, and store to OPB rather than OPC. Which is
2121 * partially the reason why the implementation of these instructions
2122 * in darkplaces has been delayed for so long.
2124 * Breaking conventions is annoying...
2126 static bool ir_builder_gen_global(ir_builder *self, ir_value *global);
2128 static bool gen_global_field(ir_value *global)
2130 if (global->isconst)
2132 ir_value *fld = global->constval.vpointer;
2134 printf("Invalid field constant with no field: %s\n", global->name);
2138 /* Now, in this case, a relocation would be impossible to code
2139 * since it looks like this:
2140 * .vector v = origin; <- parse error, wtf is 'origin'?
2143 * But we will need a general relocation support later anyway
2144 * for functions... might as well support that here.
2146 if (!fld->code.globaladdr) {
2147 printf("FIXME: Relocation support\n");
2151 /* copy the field's value */
2152 ir_value_code_setaddr(global, code_globals_add(code_globals_data[fld->code.globaladdr]));
2153 if (global->fieldtype == TYPE_VECTOR) {
2154 code_globals_add(code_globals_data[fld->code.globaladdr]+1);
2155 code_globals_add(code_globals_data[fld->code.globaladdr]+2);
2160 ir_value_code_setaddr(global, code_globals_add(0));
2161 if (global->fieldtype == TYPE_VECTOR) {
2162 code_globals_add(0);
2163 code_globals_add(0);
2166 if (global->code.globaladdr < 0)
2171 static bool gen_global_pointer(ir_value *global)
2173 if (global->isconst)
2175 ir_value *target = global->constval.vpointer;
2177 printf("Invalid pointer constant: %s\n", global->name);
2178 /* NULL pointers are pointing to the NULL constant, which also
2179 * sits at address 0, but still has an ir_value for itself.
2184 /* Here, relocations ARE possible - in fteqcc-enhanced-qc:
2185 * void() foo; <- proto
2186 * void() *fooptr = &foo;
2187 * void() foo = { code }
2189 if (!target->code.globaladdr) {
2190 /* FIXME: Check for the constant nullptr ir_value!
2191 * because then code.globaladdr being 0 is valid.
2193 printf("FIXME: Relocation support\n");
2197 ir_value_code_setaddr(global, code_globals_add(target->code.globaladdr));
2201 ir_value_code_setaddr(global, code_globals_add(0));
2203 if (global->code.globaladdr < 0)
2208 static bool gen_blocks_recursive(ir_function *func, ir_block *block)
2210 prog_section_statement stmt;
2219 block->generated = true;
2220 block->code_start = code_statements_elements;
2221 for (i = 0; i < block->instr_count; ++i)
2223 instr = block->instr[i];
2225 if (instr->opcode == VINSTR_PHI) {
2226 printf("cannot generate virtual instruction (phi)\n");
2230 if (instr->opcode == VINSTR_JUMP) {
2231 target = instr->bops[0];
2232 /* for uncoditional jumps, if the target hasn't been generated
2233 * yet, we generate them right here.
2235 if (!target->generated) {
2240 /* otherwise we generate a jump instruction */
2241 stmt.opcode = INSTR_GOTO;
2242 stmt.o1.s1 = (target->code_start) - code_statements_elements;
2245 if (code_statements_add(stmt) < 0)
2248 /* no further instructions can be in this block */
2252 if (instr->opcode == VINSTR_COND) {
2253 ontrue = instr->bops[0];
2254 onfalse = instr->bops[1];
2255 /* TODO: have the AST signal which block should
2256 * come first: eg. optimize IFs without ELSE...
2259 stmt.o1.u1 = ir_value_code_addr(instr->_ops[0]);
2263 if (ontrue->generated) {
2264 stmt.opcode = INSTR_IF;
2265 stmt.o2.s1 = (ontrue->code_start-1) - code_statements_elements;
2266 if (code_statements_add(stmt) < 0)
2269 if (onfalse->generated) {
2270 stmt.opcode = INSTR_IFNOT;
2271 stmt.o2.s1 = (onfalse->code_start-1) - code_statements_elements;
2272 if (code_statements_add(stmt) < 0)
2275 if (!ontrue->generated) {
2276 if (onfalse->generated) {
2281 if (!onfalse->generated) {
2282 if (ontrue->generated) {
2287 /* neither ontrue nor onfalse exist */
2288 stmt.opcode = INSTR_IFNOT;
2289 stidx = code_statements_elements;
2290 if (code_statements_add(stmt) < 0)
2292 /* on false we jump, so add ontrue-path */
2293 if (!gen_blocks_recursive(func, ontrue))
2295 /* fixup the jump address */
2296 code_statements_data[stidx].o2.s1 = code_statements_elements - stidx;
2297 /* generate onfalse path */
2298 if (onfalse->generated) {
2299 /* fixup the jump address */
2300 code_statements_data[stidx].o2.s1 = (onfalse->code_start) - (stidx);
2301 /* may have been generated in the previous recursive call */
2302 stmt.opcode = INSTR_GOTO;
2303 stmt.o1.s1 = (onfalse->code_start) - code_statements_elements;
2306 return (code_statements_add(stmt) >= 0);
2308 /* if not, generate now */
2313 if (instr->opcode >= INSTR_CALL0 && instr->opcode <= INSTR_CALL8) {
2314 /* Trivial call translation:
2315 * copy all params to OFS_PARM*
2316 * if the output's storetype is not store_return,
2317 * add append a STORE instruction!
2319 * NOTES on how to do it better without much trouble:
2320 * -) The liferanges!
2321 * Simply check the liferange of all parameters for
2322 * other CALLs. For each param with no CALL in its
2323 * liferange, we can store it in an OFS_PARM at
2324 * generation already. This would even include later
2325 * reuse.... probably... :)
2330 for (p = 0; p < instr->params_count; ++p)
2332 ir_value *param = instr->params[p];
2334 stmt.opcode = INSTR_STORE_F;
2337 stmt.opcode = type_store_instr[param->vtype];
2338 stmt.o1.u1 = ir_value_code_addr(param);
2339 stmt.o2.u1 = OFS_PARM0 + 3 * p;
2340 if (code_statements_add(stmt) < 0)
2343 stmt.opcode = INSTR_CALL0 + instr->params_count;
2344 if (stmt.opcode > INSTR_CALL8)
2345 stmt.opcode = INSTR_CALL8;
2346 stmt.o1.u1 = ir_value_code_addr(instr->_ops[1]);
2349 if (code_statements_add(stmt) < 0)
2352 retvalue = instr->_ops[0];
2353 if (retvalue && retvalue->store != store_return && retvalue->life_count)
2355 /* not to be kept in OFS_RETURN */
2356 stmt.opcode = type_store_instr[retvalue->vtype];
2357 stmt.o1.u1 = OFS_RETURN;
2358 stmt.o2.u1 = ir_value_code_addr(retvalue);
2360 if (code_statements_add(stmt) < 0)
2366 if (instr->opcode == INSTR_STATE) {
2367 printf("TODO: state instruction\n");
2371 stmt.opcode = instr->opcode;
2376 /* This is the general order of operands */
2378 stmt.o3.u1 = ir_value_code_addr(instr->_ops[0]);
2381 stmt.o1.u1 = ir_value_code_addr(instr->_ops[1]);
2384 stmt.o2.u1 = ir_value_code_addr(instr->_ops[2]);
2386 if (stmt.opcode == INSTR_RETURN || stmt.opcode == INSTR_DONE)
2388 stmt.o1.u1 = stmt.o3.u1;
2391 else if ((stmt.opcode >= INSTR_STORE_F &&
2392 stmt.opcode <= INSTR_STORE_FNC) ||
2393 (stmt.opcode >= INSTR_STOREP_F &&
2394 stmt.opcode <= INSTR_STOREP_FNC))
2396 /* 2-operand instructions with A -> B */
2397 stmt.o2.u1 = stmt.o3.u1;
2401 if (code_statements_add(stmt) < 0)
2407 static bool gen_function_code(ir_function *self)
2410 prog_section_statement stmt;
2412 /* Starting from entry point, we generate blocks "as they come"
2413 * for now. Dead blocks will not be translated obviously.
2415 if (!self->blocks_count) {
2416 printf("Function '%s' declared without body.\n", self->name);
2420 block = self->blocks[0];
2421 if (block->generated)
2424 if (!gen_blocks_recursive(self, block)) {
2425 printf("failed to generate blocks for '%s'\n", self->name);
2429 /* otherwise code_write crashes since it debug-prints functions until AINSTR_END */
2430 stmt.opcode = AINSTR_END;
2434 if (code_statements_add(stmt) < 0)
2439 static bool gen_global_function(ir_builder *ir, ir_value *global)
2441 prog_section_function fun;
2445 size_t local_var_end;
2447 if (!global->isconst || (!global->constval.vfunc))
2449 printf("Invalid state of function-global: not constant: %s\n", global->name);
2453 irfun = global->constval.vfunc;
2455 fun.name = global->code.name;
2456 fun.file = code_cachedstring(global->context.file);
2457 fun.profile = 0; /* always 0 */
2458 fun.nargs = irfun->params_count;
2460 for (i = 0;i < 8; ++i) {
2464 fun.argsize[i] = type_sizeof[irfun->params[i]];
2467 fun.firstlocal = code_globals_elements;
2468 fun.locals = irfun->allocated_locals + irfun->locals_count;
2471 for (i = 0; i < irfun->locals_count; ++i) {
2472 if (!ir_builder_gen_global(ir, irfun->locals[i])) {
2473 printf("Failed to generate global %s\n", irfun->locals[i]->name);
2477 if (irfun->locals_count) {
2478 ir_value *last = irfun->locals[irfun->locals_count-1];
2479 local_var_end = last->code.globaladdr;
2480 local_var_end += type_sizeof[last->vtype];
2482 for (i = 0; i < irfun->values_count; ++i)
2484 /* generate code.globaladdr for ssa values */
2485 ir_value *v = irfun->values[i];
2486 ir_value_code_setaddr(v, local_var_end + v->code.local);
2488 for (i = 0; i < irfun->locals_count; ++i) {
2489 /* fill the locals with zeros */
2490 code_globals_add(0);
2494 fun.entry = irfun->builtin;
2496 fun.entry = code_statements_elements;
2497 if (!gen_function_code(irfun)) {
2498 printf("Failed to generate code for function %s\n", irfun->name);
2503 return (code_functions_add(fun) >= 0);
2506 static bool ir_builder_gen_global(ir_builder *self, ir_value *global)
2510 prog_section_def def;
2512 def.type = global->vtype;
2513 def.offset = code_globals_elements;
2514 def.name = global->code.name = code_genstring(global->name);
2516 switch (global->vtype)
2519 if (code_defs_add(def) < 0)
2521 return gen_global_pointer(global);
2523 if (code_defs_add(def) < 0)
2525 return gen_global_field(global);
2530 if (code_defs_add(def) < 0)
2533 if (global->isconst) {
2534 iptr = (int32_t*)&global->constval.vfloat;
2535 ir_value_code_setaddr(global, code_globals_add(*iptr));
2537 ir_value_code_setaddr(global, code_globals_add(0));
2539 return global->code.globaladdr >= 0;
2543 if (code_defs_add(def) < 0)
2545 if (global->isconst)
2546 ir_value_code_setaddr(global, code_globals_add(code_cachedstring(global->constval.vstring)));
2548 ir_value_code_setaddr(global, code_globals_add(0));
2549 return global->code.globaladdr >= 0;
2554 if (code_defs_add(def) < 0)
2557 if (global->isconst) {
2558 iptr = (int32_t*)&global->constval.vvec;
2559 ir_value_code_setaddr(global, code_globals_add(iptr[0]));
2560 if (global->code.globaladdr < 0)
2562 for (d = 1; d < type_sizeof[global->vtype]; ++d)
2564 if (code_globals_add(iptr[d]) < 0)
2568 ir_value_code_setaddr(global, code_globals_add(0));
2569 if (global->code.globaladdr < 0)
2571 for (d = 1; d < type_sizeof[global->vtype]; ++d)
2573 if (code_globals_add(0) < 0)
2577 return global->code.globaladdr >= 0;
2580 if (code_defs_add(def) < 0)
2582 ir_value_code_setaddr(global, code_globals_elements);
2583 code_globals_add(code_functions_elements);
2584 return gen_global_function(self, global);
2586 /* assume biggest type */
2587 ir_value_code_setaddr(global, code_globals_add(0));
2588 for (i = 1; i < type_sizeof[TYPE_VARIANT]; ++i)
2589 code_globals_add(0);
2592 /* refuse to create 'void' type or any other fancy business. */
2593 printf("Invalid type for global variable %s\n", global->name);
2598 static bool ir_builder_gen_field(ir_builder *self, ir_value *field)
2600 prog_section_def def;
2601 prog_section_field fld;
2603 def.type = field->vtype;
2604 def.offset = code_globals_elements;
2606 /* create a global named the same as the field */
2607 if (opts_standard == COMPILER_GMQCC) {
2608 /* in our standard, the global gets a dot prefix */
2609 size_t len = strlen(field->name);
2612 /* we really don't want to have to allocate this, and 1024
2613 * bytes is more than enough for a variable/field name
2615 if (len+2 >= sizeof(name)) {
2616 printf("invalid field name size: %u\n", (unsigned int)len);
2621 strcpy(name+1, field->name); /* no strncpy - we used strlen above */
2624 def.name = code_genstring(name);
2625 fld.name = def.name + 1; /* we reuse that string table entry */
2627 /* in plain QC, there cannot be a global with the same name,
2628 * and so we also name the global the same.
2629 * FIXME: fteqcc should create a global as well
2630 * check if it actually uses the same name. Probably does
2632 def.name = code_genstring(field->name);
2633 fld.name = def.name;
2636 field->code.name = def.name;
2638 if (code_defs_add(def) < 0)
2641 fld.type = field->fieldtype;
2643 if (fld.type == TYPE_VOID) {
2644 printf("field is missing a type: %s - don't know its size\n", field->name);
2648 fld.offset = code_alloc_field(type_sizeof[field->fieldtype]);
2650 if (code_fields_add(fld) < 0)
2653 if (!code_globals_add(fld.offset))
2655 if (fld.type == TYPE_VECTOR) {
2656 if (!code_globals_add(fld.offset+1))
2658 if (!code_globals_add(fld.offset+2))
2662 ir_value_code_setaddr(field, code_globals_add(fld.offset));
2663 return field->code.globaladdr >= 0;
2666 bool ir_builder_generate(ir_builder *self, const char *filename)
2672 for (i = 0; i < self->fields_count; ++i)
2674 if (!ir_builder_gen_field(self, self->fields[i])) {
2679 for (i = 0; i < self->globals_count; ++i)
2681 if (!ir_builder_gen_global(self, self->globals[i])) {
2686 printf("writing '%s'...\n", filename);
2687 return code_write(filename);
2690 /***********************************************************************
2691 *IR DEBUG Dump functions...
2694 #define IND_BUFSZ 1024
2696 const char *qc_opname(int op)
2698 if (op < 0) return "<INVALID>";
2699 if (op < ( sizeof(asm_instr) / sizeof(asm_instr[0]) ))
2700 return asm_instr[op].m;
2702 case VINSTR_PHI: return "PHI";
2703 case VINSTR_JUMP: return "JUMP";
2704 case VINSTR_COND: return "COND";
2705 default: return "<UNK>";
2709 void ir_builder_dump(ir_builder *b, int (*oprintf)(const char*, ...))
2712 char indent[IND_BUFSZ];
2716 oprintf("module %s\n", b->name);
2717 for (i = 0; i < b->globals_count; ++i)
2720 if (b->globals[i]->isconst)
2721 oprintf("%s = ", b->globals[i]->name);
2722 ir_value_dump(b->globals[i], oprintf);
2725 for (i = 0; i < b->functions_count; ++i)
2726 ir_function_dump(b->functions[i], indent, oprintf);
2727 oprintf("endmodule %s\n", b->name);
2730 void ir_function_dump(ir_function *f, char *ind,
2731 int (*oprintf)(const char*, ...))
2734 if (f->builtin != 0) {
2735 oprintf("%sfunction %s = builtin %i\n", ind, f->name, -f->builtin);
2738 oprintf("%sfunction %s\n", ind, f->name);
2739 strncat(ind, "\t", IND_BUFSZ);
2740 if (f->locals_count)
2742 oprintf("%s%i locals:\n", ind, (int)f->locals_count);
2743 for (i = 0; i < f->locals_count; ++i) {
2744 oprintf("%s\t", ind);
2745 ir_value_dump(f->locals[i], oprintf);
2749 if (f->blocks_count)
2751 oprintf("%slife passes (check): %i\n", ind, (int)f->run_id);
2752 for (i = 0; i < f->blocks_count; ++i) {
2753 if (f->blocks[i]->run_id != f->run_id) {
2754 oprintf("%slife pass check fail! %i != %i\n", ind, (int)f->blocks[i]->run_id, (int)f->run_id);
2756 ir_block_dump(f->blocks[i], ind, oprintf);
2760 ind[strlen(ind)-1] = 0;
2761 oprintf("%sendfunction %s\n", ind, f->name);
2764 void ir_block_dump(ir_block* b, char *ind,
2765 int (*oprintf)(const char*, ...))
2768 oprintf("%s:%s\n", ind, b->label);
2769 strncat(ind, "\t", IND_BUFSZ);
2771 for (i = 0; i < b->instr_count; ++i)
2772 ir_instr_dump(b->instr[i], ind, oprintf);
2773 ind[strlen(ind)-1] = 0;
2776 void dump_phi(ir_instr *in, char *ind,
2777 int (*oprintf)(const char*, ...))
2780 oprintf("%s <- phi ", in->_ops[0]->name);
2781 for (i = 0; i < in->phi_count; ++i)
2783 oprintf("([%s] : %s) ", in->phi[i].from->label,
2784 in->phi[i].value->name);
2789 void ir_instr_dump(ir_instr *in, char *ind,
2790 int (*oprintf)(const char*, ...))
2793 const char *comma = NULL;
2795 oprintf("%s (%i) ", ind, (int)in->eid);
2797 if (in->opcode == VINSTR_PHI) {
2798 dump_phi(in, ind, oprintf);
2802 strncat(ind, "\t", IND_BUFSZ);
2804 if (in->_ops[0] && (in->_ops[1] || in->_ops[2])) {
2805 ir_value_dump(in->_ops[0], oprintf);
2806 if (in->_ops[1] || in->_ops[2])
2809 oprintf("%s\t", qc_opname(in->opcode));
2810 if (in->_ops[0] && !(in->_ops[1] || in->_ops[2])) {
2811 ir_value_dump(in->_ops[0], oprintf);
2816 for (i = 1; i != 3; ++i) {
2820 ir_value_dump(in->_ops[i], oprintf);
2828 oprintf("[%s]", in->bops[0]->label);
2832 oprintf("%s[%s]", comma, in->bops[1]->label);
2834 ind[strlen(ind)-1] = 0;
2837 void ir_value_dump(ir_value* v, int (*oprintf)(const char*, ...))
2845 oprintf("%g", v->constval.vfloat);
2848 oprintf("'%g %g %g'",
2851 v->constval.vvec.z);
2854 oprintf("(entity)");
2857 oprintf("\"%s\"", v->constval.vstring);
2861 oprintf("%i", v->constval.vint);
2866 v->constval.vpointer->name);
2870 oprintf("%s", v->name);
2874 void ir_value_dump_life(ir_value *self, int (*oprintf)(const char*,...))
2877 oprintf("Life of %s:\n", self->name);
2878 for (i = 0; i < self->life_count; ++i)
2880 oprintf(" + [%i, %i]\n", self->life[i].start, self->life[i].end);