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 if (target->store == store_value) {
910 fprintf(stderr, "cannot store to an SSA value\n");
911 fprintf(stderr, "trying to store: %s <- %s\n", target->name, what->name);
914 ir_instr *in = ir_instr_new(self, op);
917 if (!ir_instr_op(in, 0, target, true) ||
918 !ir_instr_op(in, 1, what, false) ||
919 !ir_block_instr_add(self, in) )
927 bool ir_block_create_store(ir_block *self, ir_value *target, ir_value *what)
931 if (target->vtype == TYPE_VARIANT)
934 vtype = target->vtype;
937 if (vtype == TYPE_FLOAT && what->vtype == TYPE_INTEGER)
938 op = INSTR_CONV_ITOF;
939 else if (vtype == TYPE_INTEGER && what->vtype == TYPE_FLOAT)
940 op = INSTR_CONV_FTOI;
942 op = type_store_instr[vtype];
944 return ir_block_create_store_op(self, op, target, what);
947 bool ir_block_create_storep(ir_block *self, ir_value *target, ir_value *what)
952 if (target->vtype != TYPE_POINTER)
955 /* storing using pointer - target is a pointer, type must be
956 * inferred from source
960 op = type_storep_instr[vtype];
962 return ir_block_create_store_op(self, op, target, what);
965 bool ir_block_create_return(ir_block *self, ir_value *v)
969 fprintf(stderr, "block already ended (%s)\n", self->label);
973 self->is_return = true;
974 in = ir_instr_new(self, INSTR_RETURN);
978 if (!ir_instr_op(in, 0, v, false) ||
979 !ir_block_instr_add(self, in) )
986 bool ir_block_create_if(ir_block *self, ir_value *v,
987 ir_block *ontrue, ir_block *onfalse)
991 fprintf(stderr, "block already ended (%s)\n", self->label);
995 /*in = ir_instr_new(self, (v->vtype == TYPE_STRING ? INSTR_IF_S : INSTR_IF_F));*/
996 in = ir_instr_new(self, VINSTR_COND);
1000 if (!ir_instr_op(in, 0, v, false)) {
1001 ir_instr_delete(in);
1005 in->bops[0] = ontrue;
1006 in->bops[1] = onfalse;
1008 if (!ir_block_instr_add(self, in))
1011 if (!ir_block_exits_add(self, ontrue) ||
1012 !ir_block_exits_add(self, onfalse) ||
1013 !ir_block_entries_add(ontrue, self) ||
1014 !ir_block_entries_add(onfalse, self) )
1021 bool ir_block_create_jump(ir_block *self, ir_block *to)
1025 fprintf(stderr, "block already ended (%s)\n", self->label);
1029 in = ir_instr_new(self, VINSTR_JUMP);
1034 if (!ir_block_instr_add(self, in))
1037 if (!ir_block_exits_add(self, to) ||
1038 !ir_block_entries_add(to, self) )
1045 bool ir_block_create_goto(ir_block *self, ir_block *to)
1049 fprintf(stderr, "block already ended (%s)\n", self->label);
1053 in = ir_instr_new(self, INSTR_GOTO);
1058 if (!ir_block_instr_add(self, in))
1061 if (!ir_block_exits_add(self, to) ||
1062 !ir_block_entries_add(to, self) )
1069 ir_instr* ir_block_create_phi(ir_block *self, const char *label, int ot)
1073 in = ir_instr_new(self, VINSTR_PHI);
1076 out = ir_value_out(self->owner, label, store_value, ot);
1078 ir_instr_delete(in);
1081 if (!ir_instr_op(in, 0, out, true)) {
1082 ir_instr_delete(in);
1083 ir_value_delete(out);
1086 if (!ir_block_instr_add(self, in)) {
1087 ir_instr_delete(in);
1088 ir_value_delete(out);
1094 ir_value* ir_phi_value(ir_instr *self)
1096 return self->_ops[0];
1099 bool ir_phi_add(ir_instr* self, ir_block *b, ir_value *v)
1103 if (!ir_block_entries_find(self->owner, b, NULL)) {
1104 /* Must not be possible to cause this, otherwise the AST
1105 * is doing something wrong.
1107 fprintf(stderr, "Invalid entry block for PHI\n");
1113 if (!ir_value_reads_add(v, self))
1115 return ir_instr_phi_add(self, pe);
1118 /* call related code */
1119 ir_instr* ir_block_create_call(ir_block *self, const char *label, ir_value *func)
1123 in = ir_instr_new(self, INSTR_CALL0);
1126 out = ir_value_out(self->owner, label, store_return, func->outtype);
1128 ir_instr_delete(in);
1131 if (!ir_instr_op(in, 0, out, true) ||
1132 !ir_instr_op(in, 1, func, false) ||
1133 !ir_block_instr_add(self, in))
1135 ir_instr_delete(in);
1136 ir_value_delete(out);
1142 ir_value* ir_call_value(ir_instr *self)
1144 return self->_ops[0];
1147 bool ir_call_param(ir_instr* self, ir_value *v)
1149 if (!ir_instr_params_add(self, v))
1151 if (!ir_value_reads_add(v, self)) {
1152 if (!ir_instr_params_remove(self, self->params_count-1))
1153 GMQCC_SUPPRESS_EMPTY_BODY;
1159 /* binary op related code */
1161 ir_value* ir_block_create_binop(ir_block *self,
1162 const char *label, int opcode,
1163 ir_value *left, ir_value *right)
1185 case INSTR_SUB_S: /* -- offset of string as float */
1190 case INSTR_BITOR_IF:
1191 case INSTR_BITOR_FI:
1192 case INSTR_BITAND_FI:
1193 case INSTR_BITAND_IF:
1208 case INSTR_BITAND_I:
1211 case INSTR_RSHIFT_I:
1212 case INSTR_LSHIFT_I:
1234 /* boolean operations result in floats */
1235 if (opcode >= INSTR_EQ_F && opcode <= INSTR_GT)
1237 else if (opcode >= INSTR_LE && opcode <= INSTR_GT)
1240 else if (opcode >= INSTR_LE_I && opcode <= INSTR_EQ_FI)
1245 if (ot == TYPE_VOID) {
1246 /* The AST or parser were supposed to check this! */
1250 return ir_block_create_general_instr(self, label, opcode, left, right, ot);
1253 ir_value* ir_block_create_unary(ir_block *self,
1254 const char *label, int opcode,
1257 int ot = TYPE_FLOAT;
1269 /* QC doesn't have other unary operations. We expect extensions to fill
1270 * the above list, otherwise we assume out-type = in-type, eg for an
1274 ot = operand->vtype;
1277 if (ot == TYPE_VOID) {
1278 /* The AST or parser were supposed to check this! */
1282 /* let's use the general instruction creator and pass NULL for OPB */
1283 return ir_block_create_general_instr(self, label, opcode, operand, NULL, ot);
1286 ir_value* ir_block_create_general_instr(ir_block *self, const char *label,
1287 int op, ir_value *a, ir_value *b, int outype)
1292 out = ir_value_out(self->owner, label, store_value, outype);
1296 instr = ir_instr_new(self, op);
1298 ir_value_delete(out);
1302 if (!ir_instr_op(instr, 0, out, true) ||
1303 !ir_instr_op(instr, 1, a, false) ||
1304 !ir_instr_op(instr, 2, b, false) )
1309 if (!ir_block_instr_add(self, instr))
1314 ir_instr_delete(instr);
1315 ir_value_delete(out);
1319 ir_value* ir_block_create_fieldaddress(ir_block *self, const char *label, ir_value *ent, ir_value *field)
1323 /* Support for various pointer types todo if so desired */
1324 if (ent->vtype != TYPE_ENTITY)
1327 if (field->vtype != TYPE_FIELD)
1330 v = ir_block_create_general_instr(self, label, INSTR_ADDRESS, ent, field, TYPE_POINTER);
1331 v->fieldtype = field->fieldtype;
1335 ir_value* ir_block_create_load_from_ent(ir_block *self, const char *label, ir_value *ent, ir_value *field, int outype)
1338 if (ent->vtype != TYPE_ENTITY)
1341 /* at some point we could redirect for TYPE_POINTER... but that could lead to carelessness */
1342 if (field->vtype != TYPE_FIELD)
1347 case TYPE_FLOAT: op = INSTR_LOAD_F; break;
1348 case TYPE_VECTOR: op = INSTR_LOAD_V; break;
1349 case TYPE_STRING: op = INSTR_LOAD_S; break;
1350 case TYPE_FIELD: op = INSTR_LOAD_FLD; break;
1351 case TYPE_ENTITY: op = INSTR_LOAD_ENT; break;
1353 case TYPE_POINTER: op = INSTR_LOAD_I; break;
1354 case TYPE_INTEGER: op = INSTR_LOAD_I; break;
1360 return ir_block_create_general_instr(self, label, op, ent, field, outype);
1363 ir_value* ir_block_create_add(ir_block *self,
1365 ir_value *left, ir_value *right)
1368 int l = left->vtype;
1369 int r = right->vtype;
1388 if ( (l == TYPE_FLOAT && r == TYPE_INTEGER) )
1390 else if ( (l == TYPE_INTEGER && r == TYPE_FLOAT) )
1396 return ir_block_create_binop(self, label, op, left, right);
1399 ir_value* ir_block_create_sub(ir_block *self,
1401 ir_value *left, ir_value *right)
1404 int l = left->vtype;
1405 int r = right->vtype;
1425 if ( (l == TYPE_FLOAT && r == TYPE_INTEGER) )
1427 else if ( (l == TYPE_INTEGER && r == TYPE_FLOAT) )
1433 return ir_block_create_binop(self, label, op, left, right);
1436 ir_value* ir_block_create_mul(ir_block *self,
1438 ir_value *left, ir_value *right)
1441 int l = left->vtype;
1442 int r = right->vtype;
1461 if ( (l == TYPE_VECTOR && r == TYPE_FLOAT) )
1463 else if ( (l == TYPE_FLOAT && r == TYPE_VECTOR) )
1466 else if ( (l == TYPE_VECTOR && r == TYPE_INTEGER) )
1468 else if ( (l == TYPE_INTEGER && r == TYPE_VECTOR) )
1470 else if ( (l == TYPE_FLOAT && r == TYPE_INTEGER) )
1472 else if ( (l == TYPE_INTEGER && r == TYPE_FLOAT) )
1478 return ir_block_create_binop(self, label, op, left, right);
1481 ir_value* ir_block_create_div(ir_block *self,
1483 ir_value *left, ir_value *right)
1486 int l = left->vtype;
1487 int r = right->vtype;
1504 if ( (l == TYPE_VECTOR && r == TYPE_FLOAT) )
1506 else if ( (l == TYPE_FLOAT && r == TYPE_INTEGER) )
1508 else if ( (l == TYPE_INTEGER && r == TYPE_FLOAT) )
1514 return ir_block_create_binop(self, label, op, left, right);
1517 /* PHI resolving breaks the SSA, and must thus be the last
1518 * step before life-range calculation.
1521 static bool ir_block_naive_phi(ir_block *self);
1522 bool ir_function_naive_phi(ir_function *self)
1526 for (i = 0; i < self->blocks_count; ++i)
1528 if (!ir_block_naive_phi(self->blocks[i]))
1534 static bool ir_naive_phi_emit_store(ir_block *block, size_t iid, ir_value *old, ir_value *what)
1539 /* create a store */
1540 if (!ir_block_create_store(block, old, what))
1543 /* we now move it up */
1544 instr = block->instr[block->instr_count-1];
1545 for (i = block->instr_count; i > iid; --i)
1546 block->instr[i] = block->instr[i-1];
1547 block->instr[i] = instr;
1552 static bool ir_block_naive_phi(ir_block *self)
1555 /* FIXME: optionally, create_phi can add the phis
1556 * to a list so we don't need to loop through blocks
1557 * - anyway: "don't optimize YET"
1559 for (i = 0; i < self->instr_count; ++i)
1561 ir_instr *instr = self->instr[i];
1562 if (instr->opcode != VINSTR_PHI)
1565 if (!ir_block_instr_remove(self, i))
1567 --i; /* NOTE: i+1 below */
1569 for (p = 0; p < instr->phi_count; ++p)
1571 ir_value *v = instr->phi[p].value;
1572 for (w = 0; w < v->writes_count; ++w) {
1575 if (!v->writes[w]->_ops[0])
1578 /* When the write was to a global, we have to emit a mov */
1579 old = v->writes[w]->_ops[0];
1581 /* The original instruction now writes to the PHI target local */
1582 if (v->writes[w]->_ops[0] == v)
1583 v->writes[w]->_ops[0] = instr->_ops[0];
1585 if (old->store != store_value && old->store != store_local && old->store != store_param)
1587 /* If it originally wrote to a global we need to store the value
1590 if (!ir_naive_phi_emit_store(self, i+1, old, v))
1592 if (i+1 < self->instr_count)
1593 instr = self->instr[i+1];
1596 /* In case I forget and access instr later, it'll be NULL
1597 * when it's a problem, to make sure we crash, rather than accessing
1603 /* If it didn't, we can replace all reads by the phi target now. */
1605 for (r = 0; r < old->reads_count; ++r)
1608 ir_instr *ri = old->reads[r];
1609 for (op = 0; op < ri->phi_count; ++op) {
1610 if (ri->phi[op].value == old)
1611 ri->phi[op].value = v;
1613 for (op = 0; op < 3; ++op) {
1614 if (ri->_ops[op] == old)
1621 ir_instr_delete(instr);
1626 /***********************************************************************
1627 *IR Temp allocation code
1628 * Propagating value life ranges by walking through the function backwards
1629 * until no more changes are made.
1630 * In theory this should happen once more than once for every nested loop
1632 * Though this implementation might run an additional time for if nests.
1641 MEM_VEC_FUNCTIONS_ALL(new_reads_t, ir_value*, v)
1643 /* Enumerate instructions used by value's life-ranges
1645 static void ir_block_enumerate(ir_block *self, size_t *_eid)
1649 for (i = 0; i < self->instr_count; ++i)
1651 self->instr[i]->eid = eid++;
1656 /* Enumerate blocks and instructions.
1657 * The block-enumeration is unordered!
1658 * We do not really use the block enumreation, however
1659 * the instruction enumeration is important for life-ranges.
1661 void ir_function_enumerate(ir_function *self)
1664 size_t instruction_id = 0;
1665 for (i = 0; i < self->blocks_count; ++i)
1667 self->blocks[i]->eid = i;
1668 self->blocks[i]->run_id = 0;
1669 ir_block_enumerate(self->blocks[i], &instruction_id);
1673 static bool ir_block_life_propagate(ir_block *b, ir_block *prev, bool *changed);
1674 bool ir_function_calculate_liferanges(ir_function *self)
1682 for (i = 0; i != self->blocks_count; ++i)
1684 if (self->blocks[i]->is_return)
1686 if (!ir_block_life_propagate(self->blocks[i], NULL, &changed))
1694 /* Local-value allocator
1695 * After finishing creating the liferange of all values used in a function
1696 * we can allocate their global-positions.
1697 * This is the counterpart to register-allocation in register machines.
1700 MEM_VECTOR_MAKE(ir_value*, locals);
1701 MEM_VECTOR_MAKE(size_t, sizes);
1702 MEM_VECTOR_MAKE(size_t, positions);
1703 } function_allocator;
1704 MEM_VEC_FUNCTIONS(function_allocator, ir_value*, locals)
1705 MEM_VEC_FUNCTIONS(function_allocator, size_t, sizes)
1706 MEM_VEC_FUNCTIONS(function_allocator, size_t, positions)
1708 static bool function_allocator_alloc(function_allocator *alloc, const ir_value *var)
1711 size_t vsize = type_sizeof[var->vtype];
1713 slot = ir_value_var("reg", store_global, var->vtype);
1717 if (!ir_value_life_merge_into(slot, var))
1720 if (!function_allocator_locals_add(alloc, slot))
1723 if (!function_allocator_sizes_add(alloc, vsize))
1729 ir_value_delete(slot);
1733 bool ir_function_allocate_locals(ir_function *self)
1742 function_allocator alloc;
1744 if (!self->locals_count)
1747 MEM_VECTOR_INIT(&alloc, locals);
1748 MEM_VECTOR_INIT(&alloc, sizes);
1749 MEM_VECTOR_INIT(&alloc, positions);
1751 for (i = 0; i < self->locals_count; ++i)
1753 if (!function_allocator_alloc(&alloc, self->locals[i]))
1757 /* Allocate a slot for any value that still exists */
1758 for (i = 0; i < self->values_count; ++i)
1760 v = self->values[i];
1765 for (a = 0; a < alloc.locals_count; ++a)
1767 slot = alloc.locals[a];
1769 if (ir_values_overlap(v, slot))
1772 if (!ir_value_life_merge_into(slot, v))
1775 /* adjust size for this slot */
1776 if (alloc.sizes[a] < type_sizeof[v->vtype])
1777 alloc.sizes[a] = type_sizeof[v->vtype];
1779 self->values[i]->code.local = a;
1782 if (a >= alloc.locals_count) {
1783 self->values[i]->code.local = alloc.locals_count;
1784 if (!function_allocator_alloc(&alloc, v))
1789 /* Adjust slot positions based on sizes */
1790 if (!function_allocator_positions_add(&alloc, 0))
1793 if (alloc.sizes_count)
1794 pos = alloc.positions[0] + alloc.sizes[0];
1797 for (i = 1; i < alloc.sizes_count; ++i)
1799 pos = alloc.positions[i-1] + alloc.sizes[i-1];
1800 if (!function_allocator_positions_add(&alloc, pos))
1804 self->allocated_locals = pos + alloc.sizes[alloc.sizes_count-1];
1806 /* Take over the actual slot positions */
1807 for (i = 0; i < self->values_count; ++i)
1808 self->values[i]->code.local = alloc.positions[self->values[i]->code.local];
1815 for (i = 0; i < alloc.locals_count; ++i)
1816 ir_value_delete(alloc.locals[i]);
1817 MEM_VECTOR_CLEAR(&alloc, locals);
1818 MEM_VECTOR_CLEAR(&alloc, sizes);
1819 MEM_VECTOR_CLEAR(&alloc, positions);
1823 /* Get information about which operand
1824 * is read from, or written to.
1826 static void ir_op_read_write(int op, size_t *read, size_t *write)
1853 static bool ir_block_living_add_instr(ir_block *self, size_t eid)
1856 bool changed = false;
1858 for (i = 0; i != self->living_count; ++i)
1860 tempbool = ir_value_life_merge(self->living[i], eid);
1863 fprintf(stderr, "block_living_add_instr() value instruction added %s: %i\n", self->living[i]->_name, (int)eid);
1865 changed = changed || tempbool;
1870 static bool ir_block_life_prop_previous(ir_block* self, ir_block *prev, bool *changed)
1873 /* values which have been read in a previous iteration are now
1874 * in the "living" array even if the previous block doesn't use them.
1875 * So we have to remove whatever does not exist in the previous block.
1876 * They will be re-added on-read, but the liferange merge won't cause
1879 for (i = 0; i < self->living_count; ++i)
1881 if (!ir_block_living_find(prev, self->living[i], NULL)) {
1882 if (!ir_block_living_remove(self, i))
1888 /* Whatever the previous block still has in its living set
1889 * must now be added to ours as well.
1891 for (i = 0; i < prev->living_count; ++i)
1893 if (ir_block_living_find(self, prev->living[i], NULL))
1895 if (!ir_block_living_add(self, prev->living[i]))
1898 printf("%s got from prev: %s\n", self->label, prev->living[i]->_name);
1904 static bool ir_block_life_propagate(ir_block *self, ir_block *prev, bool *changed)
1910 /* bitmasks which operands are read from or written to */
1912 #if defined(LIFE_RANGE_WITHOUT_LAST_READ)
1914 new_reads_t new_reads;
1916 char dbg_ind[16] = { '#', '0' };
1919 #if defined(LIFE_RANGE_WITHOUT_LAST_READ)
1920 MEM_VECTOR_INIT(&new_reads, v);
1925 if (!ir_block_life_prop_previous(self, prev, changed))
1929 i = self->instr_count;
1932 instr = self->instr[i];
1934 /* PHI operands are always read operands */
1935 for (p = 0; p < instr->phi_count; ++p)
1937 value = instr->phi[p].value;
1938 #if ! defined(LIFE_RANGE_WITHOUT_LAST_READ)
1939 if (!ir_block_living_find(self, value, NULL) &&
1940 !ir_block_living_add(self, value))
1945 if (!new_reads_t_v_find(&new_reads, value, NULL))
1947 if (!new_reads_t_v_add(&new_reads, value))
1953 /* See which operands are read and write operands */
1954 ir_op_read_write(instr->opcode, &read, &write);
1956 /* Go through the 3 main operands */
1957 for (o = 0; o < 3; ++o)
1959 if (!instr->_ops[o]) /* no such operand */
1962 value = instr->_ops[o];
1964 /* We only care about locals */
1965 /* we also calculate parameter liferanges so that locals
1966 * can take up parameter slots */
1967 if (value->store != store_value &&
1968 value->store != store_local &&
1969 value->store != store_param)
1975 #if ! defined(LIFE_RANGE_WITHOUT_LAST_READ)
1976 if (!ir_block_living_find(self, value, NULL) &&
1977 !ir_block_living_add(self, value))
1982 /* fprintf(stderr, "read: %s\n", value->_name); */
1983 if (!new_reads_t_v_find(&new_reads, value, NULL))
1985 if (!new_reads_t_v_add(&new_reads, value))
1991 /* write operands */
1992 /* When we write to a local, we consider it "dead" for the
1993 * remaining upper part of the function, since in SSA a value
1994 * can only be written once (== created)
1999 bool in_living = ir_block_living_find(self, value, &idx);
2000 #if defined(LIFE_RANGE_WITHOUT_LAST_READ)
2002 bool in_reads = new_reads_t_v_find(&new_reads, value, &readidx);
2003 if (!in_living && !in_reads)
2008 /* If the value isn't alive it hasn't been read before... */
2009 /* TODO: See if the warning can be emitted during parsing or AST processing
2010 * otherwise have warning printed here.
2011 * IF printing a warning here: include filecontext_t,
2012 * and make sure it's only printed once
2013 * since this function is run multiple times.
2015 /* For now: debug info: */
2016 fprintf(stderr, "Value only written %s\n", value->name);
2017 tempbool = ir_value_life_merge(value, instr->eid);
2018 *changed = *changed || tempbool;
2020 ir_instr_dump(instr, dbg_ind, printf);
2024 /* since 'living' won't contain it
2025 * anymore, merge the value, since
2028 tempbool = ir_value_life_merge(value, instr->eid);
2031 fprintf(stderr, "value added id %s %i\n", value->name, (int)instr->eid);
2033 *changed = *changed || tempbool;
2035 #if ! defined(LIFE_RANGE_WITHOUT_LAST_READ)
2036 if (!ir_block_living_remove(self, idx))
2041 if (!new_reads_t_v_remove(&new_reads, readidx))
2049 tempbool = ir_block_living_add_instr(self, instr->eid);
2050 /*fprintf(stderr, "living added values\n");*/
2051 *changed = *changed || tempbool;
2053 #if defined(LIFE_RANGE_WITHOUT_LAST_READ)
2055 for (rd = 0; rd < new_reads.v_count; ++rd)
2057 if (!ir_block_living_find(self, new_reads.v[rd], NULL)) {
2058 if (!ir_block_living_add(self, new_reads.v[rd]))
2061 if (!i && !self->entries_count) {
2063 *changed = *changed || ir_value_life_merge(new_reads.v[rd], instr->eid);
2066 MEM_VECTOR_CLEAR(&new_reads, v);
2070 if (self->run_id == self->owner->run_id)
2073 self->run_id = self->owner->run_id;
2075 for (i = 0; i < self->entries_count; ++i)
2077 ir_block *entry = self->entries[i];
2078 ir_block_life_propagate(entry, self, changed);
2083 #if defined(LIFE_RANGE_WITHOUT_LAST_READ)
2084 MEM_VECTOR_CLEAR(&new_reads, v);
2089 /***********************************************************************
2092 * Since the IR has the convention of putting 'write' operands
2093 * at the beginning, we have to rotate the operands of instructions
2094 * properly in order to generate valid QCVM code.
2096 * Having destinations at a fixed position is more convenient. In QC
2097 * this is *mostly* OPC, but FTE adds at least 2 instructions which
2098 * read from from OPA, and store to OPB rather than OPC. Which is
2099 * partially the reason why the implementation of these instructions
2100 * in darkplaces has been delayed for so long.
2102 * Breaking conventions is annoying...
2104 static bool ir_builder_gen_global(ir_builder *self, ir_value *global);
2106 static bool gen_global_field(ir_value *global)
2108 if (global->isconst)
2110 ir_value *fld = global->constval.vpointer;
2112 printf("Invalid field constant with no field: %s\n", global->name);
2116 /* Now, in this case, a relocation would be impossible to code
2117 * since it looks like this:
2118 * .vector v = origin; <- parse error, wtf is 'origin'?
2121 * But we will need a general relocation support later anyway
2122 * for functions... might as well support that here.
2124 if (!fld->code.globaladdr) {
2125 printf("FIXME: Relocation support\n");
2129 /* copy the field's value */
2130 ir_value_code_setaddr(global, code_globals_add(code_globals_data[fld->code.globaladdr]));
2134 ir_value_code_setaddr(global, code_globals_add(0));
2136 if (global->code.globaladdr < 0)
2141 static bool gen_global_pointer(ir_value *global)
2143 if (global->isconst)
2145 ir_value *target = global->constval.vpointer;
2147 printf("Invalid pointer constant: %s\n", global->name);
2148 /* NULL pointers are pointing to the NULL constant, which also
2149 * sits at address 0, but still has an ir_value for itself.
2154 /* Here, relocations ARE possible - in fteqcc-enhanced-qc:
2155 * void() foo; <- proto
2156 * void() *fooptr = &foo;
2157 * void() foo = { code }
2159 if (!target->code.globaladdr) {
2160 /* FIXME: Check for the constant nullptr ir_value!
2161 * because then code.globaladdr being 0 is valid.
2163 printf("FIXME: Relocation support\n");
2167 ir_value_code_setaddr(global, code_globals_add(target->code.globaladdr));
2171 ir_value_code_setaddr(global, code_globals_add(0));
2173 if (global->code.globaladdr < 0)
2178 static bool gen_blocks_recursive(ir_function *func, ir_block *block)
2180 prog_section_statement stmt;
2189 block->generated = true;
2190 block->code_start = code_statements_elements;
2191 for (i = 0; i < block->instr_count; ++i)
2193 instr = block->instr[i];
2195 if (instr->opcode == VINSTR_PHI) {
2196 printf("cannot generate virtual instruction (phi)\n");
2200 if (instr->opcode == VINSTR_JUMP) {
2201 target = instr->bops[0];
2202 /* for uncoditional jumps, if the target hasn't been generated
2203 * yet, we generate them right here.
2205 if (!target->generated) {
2210 /* otherwise we generate a jump instruction */
2211 stmt.opcode = INSTR_GOTO;
2212 stmt.o1.s1 = (target->code_start) - code_statements_elements;
2215 if (code_statements_add(stmt) < 0)
2218 /* no further instructions can be in this block */
2222 if (instr->opcode == VINSTR_COND) {
2223 ontrue = instr->bops[0];
2224 onfalse = instr->bops[1];
2225 /* TODO: have the AST signal which block should
2226 * come first: eg. optimize IFs without ELSE...
2229 stmt.o1.u1 = ir_value_code_addr(instr->_ops[0]);
2233 if (ontrue->generated) {
2234 stmt.opcode = INSTR_IF;
2235 stmt.o2.s1 = (ontrue->code_start-1) - code_statements_elements;
2236 if (code_statements_add(stmt) < 0)
2239 if (onfalse->generated) {
2240 stmt.opcode = INSTR_IFNOT;
2241 stmt.o2.s1 = (onfalse->code_start-1) - code_statements_elements;
2242 if (code_statements_add(stmt) < 0)
2245 if (!ontrue->generated) {
2246 if (onfalse->generated) {
2251 if (!onfalse->generated) {
2252 if (ontrue->generated) {
2257 /* neither ontrue nor onfalse exist */
2258 stmt.opcode = INSTR_IFNOT;
2259 stidx = code_statements_elements;
2260 if (code_statements_add(stmt) < 0)
2262 /* on false we jump, so add ontrue-path */
2263 if (!gen_blocks_recursive(func, ontrue))
2265 /* fixup the jump address */
2266 code_statements_data[stidx].o2.s1 = code_statements_elements - stidx;
2267 /* generate onfalse path */
2268 if (onfalse->generated) {
2269 /* fixup the jump address */
2270 code_statements_data[stidx].o2.s1 = (onfalse->code_start) - (stidx);
2271 /* may have been generated in the previous recursive call */
2272 stmt.opcode = INSTR_GOTO;
2273 stmt.o1.s1 = (onfalse->code_start) - code_statements_elements;
2276 return (code_statements_add(stmt) >= 0);
2278 /* if not, generate now */
2283 if (instr->opcode >= INSTR_CALL0 && instr->opcode <= INSTR_CALL8) {
2284 /* Trivial call translation:
2285 * copy all params to OFS_PARM*
2286 * if the output's storetype is not store_return,
2287 * add append a STORE instruction!
2289 * NOTES on how to do it better without much trouble:
2290 * -) The liferanges!
2291 * Simply check the liferange of all parameters for
2292 * other CALLs. For each param with no CALL in its
2293 * liferange, we can store it in an OFS_PARM at
2294 * generation already. This would even include later
2295 * reuse.... probably... :)
2300 for (p = 0; p < instr->params_count; ++p)
2302 ir_value *param = instr->params[p];
2304 stmt.opcode = INSTR_STORE_F;
2307 stmt.opcode = type_store_instr[param->vtype];
2308 stmt.o1.u1 = ir_value_code_addr(param);
2309 stmt.o2.u1 = OFS_PARM0 + 3 * p;
2310 if (code_statements_add(stmt) < 0)
2313 stmt.opcode = INSTR_CALL0 + instr->params_count;
2314 if (stmt.opcode > INSTR_CALL8)
2315 stmt.opcode = INSTR_CALL8;
2316 stmt.o1.u1 = ir_value_code_addr(instr->_ops[1]);
2319 if (code_statements_add(stmt) < 0)
2322 retvalue = instr->_ops[0];
2323 if (retvalue && retvalue->store != store_return && retvalue->life_count)
2325 /* not to be kept in OFS_RETURN */
2326 stmt.opcode = type_store_instr[retvalue->vtype];
2327 stmt.o1.u1 = OFS_RETURN;
2328 stmt.o2.u1 = ir_value_code_addr(retvalue);
2330 if (code_statements_add(stmt) < 0)
2336 if (instr->opcode == INSTR_STATE) {
2337 printf("TODO: state instruction\n");
2341 stmt.opcode = instr->opcode;
2346 /* This is the general order of operands */
2348 stmt.o3.u1 = ir_value_code_addr(instr->_ops[0]);
2351 stmt.o1.u1 = ir_value_code_addr(instr->_ops[1]);
2354 stmt.o2.u1 = ir_value_code_addr(instr->_ops[2]);
2356 if (stmt.opcode == INSTR_RETURN || stmt.opcode == INSTR_DONE)
2358 stmt.o1.u1 = stmt.o3.u1;
2361 else if (stmt.opcode >= INSTR_STORE_F &&
2362 stmt.opcode <= INSTR_STORE_FNC)
2364 /* 2-operand instructions with A -> B */
2365 stmt.o2.u1 = stmt.o3.u1;
2369 if (code_statements_add(stmt) < 0)
2375 static bool gen_function_code(ir_function *self)
2378 prog_section_statement stmt;
2380 /* Starting from entry point, we generate blocks "as they come"
2381 * for now. Dead blocks will not be translated obviously.
2383 if (!self->blocks_count) {
2384 printf("Function '%s' declared without body.\n", self->name);
2388 block = self->blocks[0];
2389 if (block->generated)
2392 if (!gen_blocks_recursive(self, block)) {
2393 printf("failed to generate blocks for '%s'\n", self->name);
2397 /* otherwise code_write crashes since it debug-prints functions until AINSTR_END */
2398 stmt.opcode = AINSTR_END;
2402 if (code_statements_add(stmt) < 0)
2407 static bool gen_global_function(ir_builder *ir, ir_value *global)
2409 prog_section_function fun;
2413 size_t local_var_end;
2415 if (!global->isconst || (!global->constval.vfunc))
2417 printf("Invalid state of function-global: not constant: %s\n", global->name);
2421 irfun = global->constval.vfunc;
2423 fun.name = global->code.name;
2424 fun.file = code_cachedstring(global->context.file);
2425 fun.profile = 0; /* always 0 */
2426 fun.nargs = irfun->params_count;
2428 for (i = 0;i < 8; ++i) {
2432 fun.argsize[i] = type_sizeof[irfun->params[i]];
2435 fun.firstlocal = code_globals_elements;
2436 fun.locals = irfun->allocated_locals + irfun->locals_count;
2439 for (i = 0; i < irfun->locals_count; ++i) {
2440 if (!ir_builder_gen_global(ir, irfun->locals[i])) {
2441 printf("Failed to generate global %s\n", irfun->locals[i]->name);
2445 if (irfun->locals_count) {
2446 ir_value *last = irfun->locals[irfun->locals_count-1];
2447 local_var_end = last->code.globaladdr;
2448 local_var_end += type_sizeof[last->vtype];
2450 for (i = 0; i < irfun->values_count; ++i)
2452 /* generate code.globaladdr for ssa values */
2453 ir_value *v = irfun->values[i];
2454 ir_value_code_setaddr(v, local_var_end + v->code.local);
2456 for (i = 0; i < irfun->locals_count; ++i) {
2457 /* fill the locals with zeros */
2458 code_globals_add(0);
2462 fun.entry = irfun->builtin;
2464 fun.entry = code_statements_elements;
2465 if (!gen_function_code(irfun)) {
2466 printf("Failed to generate code for function %s\n", irfun->name);
2471 return (code_functions_add(fun) >= 0);
2474 static bool ir_builder_gen_global(ir_builder *self, ir_value *global)
2478 prog_section_def def;
2480 def.type = global->vtype;
2481 def.offset = code_globals_elements;
2482 def.name = global->code.name = code_genstring(global->name);
2484 switch (global->vtype)
2487 if (code_defs_add(def) < 0)
2489 return gen_global_pointer(global);
2491 if (code_defs_add(def) < 0)
2493 return gen_global_field(global);
2498 if (code_defs_add(def) < 0)
2501 if (global->isconst) {
2502 iptr = (int32_t*)&global->constval.vfloat;
2503 ir_value_code_setaddr(global, code_globals_add(*iptr));
2505 ir_value_code_setaddr(global, code_globals_add(0));
2507 return global->code.globaladdr >= 0;
2511 if (code_defs_add(def) < 0)
2513 if (global->isconst)
2514 ir_value_code_setaddr(global, code_globals_add(code_cachedstring(global->constval.vstring)));
2516 ir_value_code_setaddr(global, code_globals_add(0));
2517 return global->code.globaladdr >= 0;
2522 if (code_defs_add(def) < 0)
2525 if (global->isconst) {
2526 iptr = (int32_t*)&global->constval.vvec;
2527 ir_value_code_setaddr(global, code_globals_add(iptr[0]));
2528 if (global->code.globaladdr < 0)
2530 for (d = 1; d < type_sizeof[global->vtype]; ++d)
2532 if (code_globals_add(iptr[d]) < 0)
2536 ir_value_code_setaddr(global, code_globals_add(0));
2537 if (global->code.globaladdr < 0)
2539 for (d = 1; d < type_sizeof[global->vtype]; ++d)
2541 if (code_globals_add(0) < 0)
2545 return global->code.globaladdr >= 0;
2548 if (code_defs_add(def) < 0)
2550 ir_value_code_setaddr(global, code_globals_elements);
2551 code_globals_add(code_functions_elements);
2552 return gen_global_function(self, global);
2554 /* assume biggest type */
2555 ir_value_code_setaddr(global, code_globals_add(0));
2556 for (i = 1; i < type_sizeof[TYPE_VARIANT]; ++i)
2557 code_globals_add(0);
2560 /* refuse to create 'void' type or any other fancy business. */
2561 printf("Invalid type for global variable %s\n", global->name);
2566 static bool ir_builder_gen_field(ir_builder *self, ir_value *field)
2568 prog_section_def def;
2569 prog_section_field fld;
2571 def.type = field->vtype;
2572 def.offset = code_globals_elements;
2574 /* create a global named the same as the field */
2575 if (opts_standard == COMPILER_GMQCC) {
2576 /* in our standard, the global gets a dot prefix */
2577 size_t len = strlen(field->name);
2580 /* we really don't want to have to allocate this, and 1024
2581 * bytes is more than enough for a variable/field name
2583 if (len+2 >= sizeof(name)) {
2584 printf("invalid field name size: %u\n", (unsigned int)len);
2589 strcpy(name+1, field->name); /* no strncpy - we used strlen above */
2592 def.name = code_genstring(name);
2593 fld.name = def.name + 1; /* we reuse that string table entry */
2595 /* in plain QC, there cannot be a global with the same name,
2596 * and so we also name the global the same.
2597 * FIXME: fteqcc should create a global as well
2598 * check if it actually uses the same name. Probably does
2600 def.name = code_genstring(field->name);
2601 fld.name = def.name;
2604 field->code.name = def.name;
2606 if (code_defs_add(def) < 0)
2609 fld.type = field->fieldtype;
2611 if (fld.type == TYPE_VOID) {
2612 printf("field is missing a type: %s - don't know its size\n", field->name);
2616 fld.offset = code_alloc_field(type_sizeof[field->fieldtype]);
2618 if (code_fields_add(fld) < 0)
2621 if (!code_globals_add(fld.offset))
2624 ir_value_code_setaddr(field, code_globals_add(fld.offset));
2625 return field->code.globaladdr >= 0;
2628 bool ir_builder_generate(ir_builder *self, const char *filename)
2634 for (i = 0; i < self->fields_count; ++i)
2636 if (!ir_builder_gen_field(self, self->fields[i])) {
2641 for (i = 0; i < self->globals_count; ++i)
2643 if (!ir_builder_gen_global(self, self->globals[i])) {
2648 printf("writing '%s'...\n", filename);
2649 return code_write(filename);
2652 /***********************************************************************
2653 *IR DEBUG Dump functions...
2656 #define IND_BUFSZ 1024
2658 const char *qc_opname(int op)
2660 if (op < 0) return "<INVALID>";
2661 if (op < ( sizeof(asm_instr) / sizeof(asm_instr[0]) ))
2662 return asm_instr[op].m;
2664 case VINSTR_PHI: return "PHI";
2665 case VINSTR_JUMP: return "JUMP";
2666 case VINSTR_COND: return "COND";
2667 default: return "<UNK>";
2671 void ir_builder_dump(ir_builder *b, int (*oprintf)(const char*, ...))
2674 char indent[IND_BUFSZ];
2678 oprintf("module %s\n", b->name);
2679 for (i = 0; i < b->globals_count; ++i)
2682 if (b->globals[i]->isconst)
2683 oprintf("%s = ", b->globals[i]->name);
2684 ir_value_dump(b->globals[i], oprintf);
2687 for (i = 0; i < b->functions_count; ++i)
2688 ir_function_dump(b->functions[i], indent, oprintf);
2689 oprintf("endmodule %s\n", b->name);
2692 void ir_function_dump(ir_function *f, char *ind,
2693 int (*oprintf)(const char*, ...))
2696 if (f->builtin != 0) {
2697 oprintf("%sfunction %s = builtin %i\n", ind, f->name, -f->builtin);
2700 oprintf("%sfunction %s\n", ind, f->name);
2701 strncat(ind, "\t", IND_BUFSZ);
2702 if (f->locals_count)
2704 oprintf("%s%i locals:\n", ind, (int)f->locals_count);
2705 for (i = 0; i < f->locals_count; ++i) {
2706 oprintf("%s\t", ind);
2707 ir_value_dump(f->locals[i], oprintf);
2711 if (f->blocks_count)
2713 oprintf("%slife passes (check): %i\n", ind, (int)f->run_id);
2714 for (i = 0; i < f->blocks_count; ++i) {
2715 if (f->blocks[i]->run_id != f->run_id) {
2716 oprintf("%slife pass check fail! %i != %i\n", ind, (int)f->blocks[i]->run_id, (int)f->run_id);
2718 ir_block_dump(f->blocks[i], ind, oprintf);
2722 ind[strlen(ind)-1] = 0;
2723 oprintf("%sendfunction %s\n", ind, f->name);
2726 void ir_block_dump(ir_block* b, char *ind,
2727 int (*oprintf)(const char*, ...))
2730 oprintf("%s:%s\n", ind, b->label);
2731 strncat(ind, "\t", IND_BUFSZ);
2733 for (i = 0; i < b->instr_count; ++i)
2734 ir_instr_dump(b->instr[i], ind, oprintf);
2735 ind[strlen(ind)-1] = 0;
2738 void dump_phi(ir_instr *in, char *ind,
2739 int (*oprintf)(const char*, ...))
2742 oprintf("%s <- phi ", in->_ops[0]->name);
2743 for (i = 0; i < in->phi_count; ++i)
2745 oprintf("([%s] : %s) ", in->phi[i].from->label,
2746 in->phi[i].value->name);
2751 void ir_instr_dump(ir_instr *in, char *ind,
2752 int (*oprintf)(const char*, ...))
2755 const char *comma = NULL;
2757 oprintf("%s (%i) ", ind, (int)in->eid);
2759 if (in->opcode == VINSTR_PHI) {
2760 dump_phi(in, ind, oprintf);
2764 strncat(ind, "\t", IND_BUFSZ);
2766 if (in->_ops[0] && (in->_ops[1] || in->_ops[2])) {
2767 ir_value_dump(in->_ops[0], oprintf);
2768 if (in->_ops[1] || in->_ops[2])
2771 oprintf("%s\t", qc_opname(in->opcode));
2772 if (in->_ops[0] && !(in->_ops[1] || in->_ops[2])) {
2773 ir_value_dump(in->_ops[0], oprintf);
2778 for (i = 1; i != 3; ++i) {
2782 ir_value_dump(in->_ops[i], oprintf);
2790 oprintf("[%s]", in->bops[0]->label);
2794 oprintf("%s[%s]", comma, in->bops[1]->label);
2796 ind[strlen(ind)-1] = 0;
2799 void ir_value_dump(ir_value* v, int (*oprintf)(const char*, ...))
2807 oprintf("%g", v->constval.vfloat);
2810 oprintf("'%g %g %g'",
2813 v->constval.vvec.z);
2816 oprintf("(entity)");
2819 oprintf("\"%s\"", v->constval.vstring);
2823 oprintf("%i", v->constval.vint);
2828 v->constval.vpointer->name);
2832 oprintf("%s", v->name);
2836 void ir_value_dump_life(ir_value *self, int (*oprintf)(const char*,...))
2839 oprintf("Life of %s:\n", self->name);
2840 for (i = 0; i < self->life_count; ++i)
2842 oprintf(" + [%i, %i]\n", self->life[i].start, self->life[i].end);