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 const char *type_name[TYPE_COUNT] = {
49 size_t type_sizeof[TYPE_COUNT] = {
56 1, /* TYPE_FUNCTION */
61 4, /* TYPE_QUATERNION */
63 16, /* TYPE_VARIANT */
66 uint16_t type_store_instr[TYPE_COUNT] = {
67 INSTR_STORE_F, /* should use I when having integer support */
74 INSTR_STORE_ENT, /* should use I */
76 INSTR_STORE_I, /* integer type */
81 INSTR_STORE_M, /* variant, should never be accessed */
84 uint16_t type_storep_instr[TYPE_COUNT] = {
85 INSTR_STOREP_F, /* should use I when having integer support */
92 INSTR_STOREP_ENT, /* should use I */
94 INSTR_STOREP_ENT, /* integer type */
99 INSTR_STOREP_M, /* variant, should never be accessed */
102 MEM_VEC_FUNCTIONS(ir_value_vector, ir_value*, v)
104 /***********************************************************************
108 ir_builder* ir_builder_new(const char *modulename)
112 self = (ir_builder*)mem_a(sizeof(*self));
116 MEM_VECTOR_INIT(self, functions);
117 MEM_VECTOR_INIT(self, globals);
118 MEM_VECTOR_INIT(self, fields);
120 if (!ir_builder_set_name(self, modulename)) {
125 /* globals which always exist */
127 /* for now we give it a vector size */
128 ir_builder_create_global(self, "OFS_RETURN", TYPE_VARIANT);
133 MEM_VEC_FUNCTIONS(ir_builder, ir_value*, globals)
134 MEM_VEC_FUNCTIONS(ir_builder, ir_value*, fields)
135 MEM_VEC_FUNCTIONS(ir_builder, ir_function*, functions)
137 void ir_builder_delete(ir_builder* self)
140 mem_d((void*)self->name);
141 for (i = 0; i != self->functions_count; ++i) {
142 ir_function_delete(self->functions[i]);
144 MEM_VECTOR_CLEAR(self, functions);
145 for (i = 0; i != self->globals_count; ++i) {
146 ir_value_delete(self->globals[i]);
148 MEM_VECTOR_CLEAR(self, fields);
149 for (i = 0; i != self->fields_count; ++i) {
150 ir_value_delete(self->fields[i]);
152 MEM_VECTOR_CLEAR(self, fields);
156 bool ir_builder_set_name(ir_builder *self, const char *name)
159 mem_d((void*)self->name);
160 self->name = util_strdup(name);
164 ir_function* ir_builder_get_function(ir_builder *self, const char *name)
167 for (i = 0; i < self->functions_count; ++i) {
168 if (!strcmp(name, self->functions[i]->name))
169 return self->functions[i];
174 ir_function* ir_builder_create_function(ir_builder *self, const char *name, int outtype)
176 ir_function *fn = ir_builder_get_function(self, name);
181 fn = ir_function_new(self, outtype);
182 if (!ir_function_set_name(fn, name) ||
183 !ir_builder_functions_add(self, fn) )
185 ir_function_delete(fn);
189 fn->value = ir_builder_create_global(self, fn->name, TYPE_FUNCTION);
191 ir_function_delete(fn);
195 fn->value->isconst = true;
196 fn->value->outtype = outtype;
197 fn->value->constval.vfunc = fn;
198 fn->value->context = fn->context;
203 ir_value* ir_builder_get_global(ir_builder *self, const char *name)
206 for (i = 0; i < self->globals_count; ++i) {
207 if (!strcmp(self->globals[i]->name, name))
208 return self->globals[i];
213 ir_value* ir_builder_create_global(ir_builder *self, const char *name, int vtype)
217 if (name && name[0] != '#')
219 ve = ir_builder_get_global(self, name);
225 ve = ir_value_var(name, store_global, vtype);
226 if (!ir_builder_globals_add(self, ve)) {
233 ir_value* ir_builder_get_field(ir_builder *self, const char *name)
236 for (i = 0; i < self->fields_count; ++i) {
237 if (!strcmp(self->fields[i]->name, name))
238 return self->fields[i];
244 ir_value* ir_builder_create_field(ir_builder *self, const char *name, int vtype)
246 ir_value *ve = ir_builder_get_field(self, name);
251 ve = ir_value_var(name, store_global, TYPE_FIELD);
252 ve->fieldtype = vtype;
253 if (!ir_builder_fields_add(self, ve)) {
260 /***********************************************************************
264 bool ir_function_naive_phi(ir_function*);
265 void ir_function_enumerate(ir_function*);
266 bool ir_function_calculate_liferanges(ir_function*);
267 bool ir_function_allocate_locals(ir_function*);
269 ir_function* ir_function_new(ir_builder* owner, int outtype)
272 self = (ir_function*)mem_a(sizeof(*self));
278 if (!ir_function_set_name(self, "<@unnamed>")) {
283 self->context.file = "<@no context>";
284 self->context.line = 0;
285 self->outtype = outtype;
288 MEM_VECTOR_INIT(self, params);
289 MEM_VECTOR_INIT(self, blocks);
290 MEM_VECTOR_INIT(self, values);
291 MEM_VECTOR_INIT(self, locals);
296 MEM_VEC_FUNCTIONS(ir_function, ir_value*, values)
297 MEM_VEC_FUNCTIONS(ir_function, ir_block*, blocks)
298 MEM_VEC_FUNCTIONS(ir_function, ir_value*, locals)
299 MEM_VEC_FUNCTIONS(ir_function, int, params)
301 bool ir_function_set_name(ir_function *self, const char *name)
304 mem_d((void*)self->name);
305 self->name = util_strdup(name);
309 void ir_function_delete(ir_function *self)
312 mem_d((void*)self->name);
314 for (i = 0; i != self->blocks_count; ++i)
315 ir_block_delete(self->blocks[i]);
316 MEM_VECTOR_CLEAR(self, blocks);
318 MEM_VECTOR_CLEAR(self, params);
320 for (i = 0; i != self->values_count; ++i)
321 ir_value_delete(self->values[i]);
322 MEM_VECTOR_CLEAR(self, values);
324 for (i = 0; i != self->locals_count; ++i)
325 ir_value_delete(self->locals[i]);
326 MEM_VECTOR_CLEAR(self, locals);
328 /* self->value is deleted by the builder */
333 bool GMQCC_WARN ir_function_collect_value(ir_function *self, ir_value *v)
335 return ir_function_values_add(self, v);
338 ir_block* ir_function_create_block(ir_function *self, const char *label)
340 ir_block* bn = ir_block_new(self, label);
341 memcpy(&bn->context, &self->context, sizeof(self->context));
342 if (!ir_function_blocks_add(self, bn)) {
349 bool ir_function_finalize(ir_function *self)
354 if (!ir_function_naive_phi(self))
357 ir_function_enumerate(self);
359 if (!ir_function_calculate_liferanges(self))
362 if (!ir_function_allocate_locals(self))
367 ir_value* ir_function_get_local(ir_function *self, const char *name)
370 for (i = 0; i < self->locals_count; ++i) {
371 if (!strcmp(self->locals[i]->name, name))
372 return self->locals[i];
377 ir_value* ir_function_create_local(ir_function *self, const char *name, int vtype, bool param)
379 ir_value *ve = ir_function_get_local(self, name);
385 self->locals_count &&
386 self->locals[self->locals_count-1]->store != store_param) {
387 printf("cannot add parameters after adding locals\n");
391 ve = ir_value_var(name, (param ? store_param : store_local), vtype);
392 if (!ir_function_locals_add(self, ve)) {
399 /***********************************************************************
403 ir_block* ir_block_new(ir_function* owner, const char *name)
406 self = (ir_block*)mem_a(sizeof(*self));
410 memset(self, 0, sizeof(*self));
413 if (!ir_block_set_label(self, name)) {
418 self->context.file = "<@no context>";
419 self->context.line = 0;
421 MEM_VECTOR_INIT(self, instr);
422 MEM_VECTOR_INIT(self, entries);
423 MEM_VECTOR_INIT(self, exits);
426 self->is_return = false;
428 MEM_VECTOR_INIT(self, living);
430 self->generated = false;
434 MEM_VEC_FUNCTIONS(ir_block, ir_instr*, instr)
435 MEM_VEC_FUNCTIONS_ALL(ir_block, ir_block*, entries)
436 MEM_VEC_FUNCTIONS_ALL(ir_block, ir_block*, exits)
437 MEM_VEC_FUNCTIONS_ALL(ir_block, ir_value*, living)
439 void ir_block_delete(ir_block* self)
443 for (i = 0; i != self->instr_count; ++i)
444 ir_instr_delete(self->instr[i]);
445 MEM_VECTOR_CLEAR(self, instr);
446 MEM_VECTOR_CLEAR(self, entries);
447 MEM_VECTOR_CLEAR(self, exits);
448 MEM_VECTOR_CLEAR(self, living);
452 bool ir_block_set_label(ir_block *self, const char *name)
455 mem_d((void*)self->label);
456 self->label = util_strdup(name);
457 return !!self->label;
460 /***********************************************************************
464 ir_instr* ir_instr_new(ir_block* owner, int op)
467 self = (ir_instr*)mem_a(sizeof(*self));
472 self->context.file = "<@no context>";
473 self->context.line = 0;
475 self->_ops[0] = NULL;
476 self->_ops[1] = NULL;
477 self->_ops[2] = NULL;
478 self->bops[0] = NULL;
479 self->bops[1] = NULL;
480 MEM_VECTOR_INIT(self, phi);
481 MEM_VECTOR_INIT(self, params);
486 MEM_VEC_FUNCTIONS(ir_instr, ir_phi_entry_t, phi)
487 MEM_VEC_FUNCTIONS(ir_instr, ir_value*, params)
489 void ir_instr_delete(ir_instr *self)
492 /* The following calls can only delete from
493 * vectors, we still want to delete this instruction
494 * so ignore the return value. Since with the warn_unused_result attribute
495 * gcc doesn't care about an explicit: (void)foo(); to ignore the result,
496 * I have to improvise here and use if(foo());
498 for (i = 0; i < self->phi_count; ++i) {
500 if (ir_value_writes_find(self->phi[i].value, self, &idx))
501 if (ir_value_writes_remove(self->phi[i].value, idx)) GMQCC_SUPPRESS_EMPTY_BODY;
502 if (ir_value_reads_find(self->phi[i].value, self, &idx))
503 if (ir_value_reads_remove (self->phi[i].value, idx)) GMQCC_SUPPRESS_EMPTY_BODY;
505 MEM_VECTOR_CLEAR(self, phi);
506 for (i = 0; i < self->params_count; ++i) {
508 if (ir_value_writes_find(self->params[i], self, &idx))
509 if (ir_value_writes_remove(self->params[i], idx)) GMQCC_SUPPRESS_EMPTY_BODY;
510 if (ir_value_reads_find(self->params[i], self, &idx))
511 if (ir_value_reads_remove (self->params[i], idx)) GMQCC_SUPPRESS_EMPTY_BODY;
513 MEM_VECTOR_CLEAR(self, params);
514 if (ir_instr_op(self, 0, NULL, false)) GMQCC_SUPPRESS_EMPTY_BODY;
515 if (ir_instr_op(self, 1, NULL, false)) GMQCC_SUPPRESS_EMPTY_BODY;
516 if (ir_instr_op(self, 2, NULL, false)) GMQCC_SUPPRESS_EMPTY_BODY;
520 bool ir_instr_op(ir_instr *self, int op, ir_value *v, bool writing)
522 if (self->_ops[op]) {
524 if (writing && ir_value_writes_find(self->_ops[op], self, &idx))
526 if (!ir_value_writes_remove(self->_ops[op], idx))
529 else if (ir_value_reads_find(self->_ops[op], self, &idx))
531 if (!ir_value_reads_remove(self->_ops[op], idx))
537 if (!ir_value_writes_add(v, self))
540 if (!ir_value_reads_add(v, self))
548 /***********************************************************************
552 int32_t ir_value_code_addr(const ir_value *self)
554 return self->code.globaladdr + self->code.addroffset;
557 ir_value* ir_value_var(const char *name, int storetype, int vtype)
560 self = (ir_value*)mem_a(sizeof(*self));
562 self->fieldtype = TYPE_VOID;
563 self->outtype = TYPE_VOID;
564 self->store = storetype;
565 MEM_VECTOR_INIT(self, reads);
566 MEM_VECTOR_INIT(self, writes);
567 self->isconst = false;
568 self->context.file = "<@no context>";
569 self->context.line = 0;
571 ir_value_set_name(self, name);
573 memset(&self->constval, 0, sizeof(self->constval));
574 memset(&self->code, 0, sizeof(self->code));
576 MEM_VECTOR_INIT(self, life);
580 ir_value* ir_value_vector_member(ir_value *self, unsigned int member)
586 if (self->members[member])
587 return self->members[member];
589 m = ir_value_var(self->name, self->store, TYPE_FLOAT);
592 m->context = self->context;
594 self->members[member] = m;
595 m->code.addroffset = member;
600 MEM_VEC_FUNCTIONS(ir_value, ir_life_entry_t, life)
601 MEM_VEC_FUNCTIONS_ALL(ir_value, ir_instr*, reads)
602 MEM_VEC_FUNCTIONS_ALL(ir_value, ir_instr*, writes)
604 ir_value* ir_value_out(ir_function *owner, const char *name, int storetype, int vtype)
606 ir_value *v = ir_value_var(name, storetype, vtype);
609 if (!ir_function_collect_value(owner, v))
617 void ir_value_delete(ir_value* self)
621 mem_d((void*)self->name);
624 if (self->vtype == TYPE_STRING)
625 mem_d((void*)self->constval.vstring);
627 for (i = 0; i < 3; ++i) {
628 if (self->members[i])
629 ir_value_delete(self->members[i]);
631 MEM_VECTOR_CLEAR(self, reads);
632 MEM_VECTOR_CLEAR(self, writes);
633 MEM_VECTOR_CLEAR(self, life);
637 void ir_value_set_name(ir_value *self, const char *name)
640 mem_d((void*)self->name);
641 self->name = util_strdup(name);
644 bool ir_value_set_float(ir_value *self, float f)
646 if (self->vtype != TYPE_FLOAT)
648 self->constval.vfloat = f;
649 self->isconst = true;
653 bool ir_value_set_func(ir_value *self, int f)
655 if (self->vtype != TYPE_FUNCTION)
657 self->constval.vint = f;
658 self->isconst = true;
662 bool ir_value_set_vector(ir_value *self, vector v)
664 if (self->vtype != TYPE_VECTOR)
666 self->constval.vvec = v;
667 self->isconst = true;
671 bool ir_value_set_quaternion(ir_value *self, quaternion v)
673 if (self->vtype != TYPE_QUATERNION)
675 memcpy(&self->constval.vquat, v, sizeof(self->constval.vquat));
676 self->isconst = true;
680 bool ir_value_set_matrix(ir_value *self, matrix v)
682 if (self->vtype != TYPE_MATRIX)
684 memcpy(&self->constval.vmat, v, sizeof(self->constval.vmat));
685 self->isconst = true;
689 bool ir_value_set_string(ir_value *self, const char *str)
691 if (self->vtype != TYPE_STRING)
693 self->constval.vstring = util_strdup(str);
694 self->isconst = true;
699 bool ir_value_set_int(ir_value *self, int i)
701 if (self->vtype != TYPE_INTEGER)
703 self->constval.vint = i;
704 self->isconst = true;
709 bool ir_value_lives(ir_value *self, size_t at)
712 for (i = 0; i < self->life_count; ++i)
714 ir_life_entry_t *life = &self->life[i];
715 if (life->start <= at && at <= life->end)
717 if (life->start > at) /* since it's ordered */
723 bool ir_value_life_insert(ir_value *self, size_t idx, ir_life_entry_t e)
726 if (!ir_value_life_add(self, e)) /* naive... */
728 for (k = self->life_count-1; k > idx; --k)
729 self->life[k] = self->life[k-1];
734 bool ir_value_life_merge(ir_value *self, size_t s)
737 ir_life_entry_t *life = NULL;
738 ir_life_entry_t *before = NULL;
739 ir_life_entry_t new_entry;
741 /* Find the first range >= s */
742 for (i = 0; i < self->life_count; ++i)
745 life = &self->life[i];
749 /* nothing found? append */
750 if (i == self->life_count) {
752 if (life && life->end+1 == s)
754 /* previous life range can be merged in */
758 if (life && life->end >= s)
761 if (!ir_value_life_add(self, e))
762 return false; /* failing */
768 if (before->end + 1 == s &&
769 life->start - 1 == s)
772 before->end = life->end;
773 if (!ir_value_life_remove(self, i))
774 return false; /* failing */
777 if (before->end + 1 == s)
783 /* already contained */
784 if (before->end >= s)
788 if (life->start - 1 == s)
793 /* insert a new entry */
794 new_entry.start = new_entry.end = s;
795 return ir_value_life_insert(self, i, new_entry);
798 bool ir_value_life_merge_into(ir_value *self, const ir_value *other)
802 if (!other->life_count)
805 if (!self->life_count) {
806 for (i = 0; i < other->life_count; ++i) {
807 if (!ir_value_life_add(self, other->life[i]))
814 for (i = 0; i < other->life_count; ++i)
816 const ir_life_entry_t *life = &other->life[i];
819 ir_life_entry_t *entry = &self->life[myi];
821 if (life->end+1 < entry->start)
823 /* adding an interval before entry */
824 if (!ir_value_life_insert(self, myi, *life))
830 if (life->start < entry->start &&
831 life->end >= entry->start)
833 /* starts earlier and overlaps */
834 entry->start = life->start;
837 if (life->end > entry->end &&
838 life->start-1 <= entry->end)
840 /* ends later and overlaps */
841 entry->end = life->end;
844 /* see if our change combines it with the next ranges */
845 while (myi+1 < self->life_count &&
846 entry->end+1 >= self->life[1+myi].start)
848 /* overlaps with (myi+1) */
849 if (entry->end < self->life[1+myi].end)
850 entry->end = self->life[1+myi].end;
851 if (!ir_value_life_remove(self, myi+1))
853 entry = &self->life[myi];
856 /* see if we're after the entry */
857 if (life->start > entry->end)
860 /* append if we're at the end */
861 if (myi >= self->life_count) {
862 if (!ir_value_life_add(self, *life))
866 /* otherweise check the next range */
875 bool ir_values_overlap(const ir_value *a, const ir_value *b)
877 /* For any life entry in A see if it overlaps with
878 * any life entry in B.
879 * Note that the life entries are orderes, so we can make a
880 * more efficient algorithm there than naively translating the
884 ir_life_entry_t *la, *lb, *enda, *endb;
886 /* first of all, if either has no life range, they cannot clash */
887 if (!a->life_count || !b->life_count)
892 enda = la + a->life_count;
893 endb = lb + b->life_count;
896 /* check if the entries overlap, for that,
897 * both must start before the other one ends.
899 #if defined(LIFE_RANGE_WITHOUT_LAST_READ)
900 if (la->start <= lb->end &&
901 lb->start <= la->end)
903 if (la->start < lb->end &&
910 /* entries are ordered
911 * one entry is earlier than the other
912 * that earlier entry will be moved forward
914 if (la->start < lb->start)
916 /* order: A B, move A forward
917 * check if we hit the end with A
922 else if (lb->start < la->start)
924 /* order: B A, move B forward
925 * check if we hit the end with B
934 /***********************************************************************
938 bool ir_block_create_store_op(ir_block *self, int op, ir_value *target, ir_value *what)
940 if (target->store == store_value) {
941 fprintf(stderr, "cannot store to an SSA value\n");
942 fprintf(stderr, "trying to store: %s <- %s\n", target->name, what->name);
945 ir_instr *in = ir_instr_new(self, op);
948 if (!ir_instr_op(in, 0, target, true) ||
949 !ir_instr_op(in, 1, what, false) ||
950 !ir_block_instr_add(self, in) )
958 bool ir_block_create_store(ir_block *self, ir_value *target, ir_value *what)
962 if (target->vtype == TYPE_VARIANT)
965 vtype = target->vtype;
968 if (vtype == TYPE_FLOAT && what->vtype == TYPE_INTEGER)
969 op = INSTR_CONV_ITOF;
970 else if (vtype == TYPE_INTEGER && what->vtype == TYPE_FLOAT)
971 op = INSTR_CONV_FTOI;
973 op = type_store_instr[vtype];
975 return ir_block_create_store_op(self, op, target, what);
978 bool ir_block_create_storep(ir_block *self, ir_value *target, ir_value *what)
983 if (target->vtype != TYPE_POINTER)
986 /* storing using pointer - target is a pointer, type must be
987 * inferred from source
991 op = type_storep_instr[vtype];
992 return ir_block_create_store_op(self, op, target, what);
995 bool ir_block_create_return(ir_block *self, ir_value *v)
999 fprintf(stderr, "block already ended (%s)\n", self->label);
1003 self->is_return = true;
1004 in = ir_instr_new(self, INSTR_RETURN);
1008 if (!ir_instr_op(in, 0, v, false) ||
1009 !ir_block_instr_add(self, in) )
1016 bool ir_block_create_if(ir_block *self, ir_value *v,
1017 ir_block *ontrue, ir_block *onfalse)
1021 fprintf(stderr, "block already ended (%s)\n", self->label);
1025 /*in = ir_instr_new(self, (v->vtype == TYPE_STRING ? INSTR_IF_S : INSTR_IF_F));*/
1026 in = ir_instr_new(self, VINSTR_COND);
1030 if (!ir_instr_op(in, 0, v, false)) {
1031 ir_instr_delete(in);
1035 in->bops[0] = ontrue;
1036 in->bops[1] = onfalse;
1038 if (!ir_block_instr_add(self, in))
1041 if (!ir_block_exits_add(self, ontrue) ||
1042 !ir_block_exits_add(self, onfalse) ||
1043 !ir_block_entries_add(ontrue, self) ||
1044 !ir_block_entries_add(onfalse, self) )
1051 bool ir_block_create_jump(ir_block *self, ir_block *to)
1055 fprintf(stderr, "block already ended (%s)\n", self->label);
1059 in = ir_instr_new(self, VINSTR_JUMP);
1064 if (!ir_block_instr_add(self, in))
1067 if (!ir_block_exits_add(self, to) ||
1068 !ir_block_entries_add(to, self) )
1075 bool ir_block_create_goto(ir_block *self, ir_block *to)
1079 fprintf(stderr, "block already ended (%s)\n", self->label);
1083 in = ir_instr_new(self, INSTR_GOTO);
1088 if (!ir_block_instr_add(self, in))
1091 if (!ir_block_exits_add(self, to) ||
1092 !ir_block_entries_add(to, self) )
1099 ir_instr* ir_block_create_phi(ir_block *self, const char *label, int ot)
1103 in = ir_instr_new(self, VINSTR_PHI);
1106 out = ir_value_out(self->owner, label, store_value, ot);
1108 ir_instr_delete(in);
1111 if (!ir_instr_op(in, 0, out, true)) {
1112 ir_instr_delete(in);
1113 ir_value_delete(out);
1116 if (!ir_block_instr_add(self, in)) {
1117 ir_instr_delete(in);
1118 ir_value_delete(out);
1124 ir_value* ir_phi_value(ir_instr *self)
1126 return self->_ops[0];
1129 bool ir_phi_add(ir_instr* self, ir_block *b, ir_value *v)
1133 if (!ir_block_entries_find(self->owner, b, NULL)) {
1134 /* Must not be possible to cause this, otherwise the AST
1135 * is doing something wrong.
1137 fprintf(stderr, "Invalid entry block for PHI\n");
1143 if (!ir_value_reads_add(v, self))
1145 return ir_instr_phi_add(self, pe);
1148 /* call related code */
1149 ir_instr* ir_block_create_call(ir_block *self, const char *label, ir_value *func)
1153 in = ir_instr_new(self, INSTR_CALL0);
1156 out = ir_value_out(self->owner, label, store_return, func->outtype);
1158 ir_instr_delete(in);
1161 if (!ir_instr_op(in, 0, out, true) ||
1162 !ir_instr_op(in, 1, func, false) ||
1163 !ir_block_instr_add(self, in))
1165 ir_instr_delete(in);
1166 ir_value_delete(out);
1172 ir_value* ir_call_value(ir_instr *self)
1174 return self->_ops[0];
1177 bool ir_call_param(ir_instr* self, ir_value *v)
1179 if (!ir_instr_params_add(self, v))
1181 if (!ir_value_reads_add(v, self)) {
1182 if (!ir_instr_params_remove(self, self->params_count-1))
1183 GMQCC_SUPPRESS_EMPTY_BODY;
1189 /* binary op related code */
1191 ir_value* ir_block_create_binop(ir_block *self,
1192 const char *label, int opcode,
1193 ir_value *left, ir_value *right)
1215 case INSTR_SUB_S: /* -- offset of string as float */
1220 case INSTR_BITOR_IF:
1221 case INSTR_BITOR_FI:
1222 case INSTR_BITAND_FI:
1223 case INSTR_BITAND_IF:
1238 case INSTR_BITAND_I:
1241 case INSTR_RSHIFT_I:
1242 case INSTR_LSHIFT_I:
1264 /* boolean operations result in floats */
1265 if (opcode >= INSTR_EQ_F && opcode <= INSTR_GT)
1267 else if (opcode >= INSTR_LE && opcode <= INSTR_GT)
1270 else if (opcode >= INSTR_LE_I && opcode <= INSTR_EQ_FI)
1275 if (ot == TYPE_VOID) {
1276 /* The AST or parser were supposed to check this! */
1280 return ir_block_create_general_instr(self, label, opcode, left, right, ot);
1283 ir_value* ir_block_create_unary(ir_block *self,
1284 const char *label, int opcode,
1287 int ot = TYPE_FLOAT;
1299 /* QC doesn't have other unary operations. We expect extensions to fill
1300 * the above list, otherwise we assume out-type = in-type, eg for an
1304 ot = operand->vtype;
1307 if (ot == TYPE_VOID) {
1308 /* The AST or parser were supposed to check this! */
1312 /* let's use the general instruction creator and pass NULL for OPB */
1313 return ir_block_create_general_instr(self, label, opcode, operand, NULL, ot);
1316 ir_value* ir_block_create_general_instr(ir_block *self, const char *label,
1317 int op, ir_value *a, ir_value *b, int outype)
1322 out = ir_value_out(self->owner, label, store_value, outype);
1326 instr = ir_instr_new(self, op);
1328 ir_value_delete(out);
1332 if (!ir_instr_op(instr, 0, out, true) ||
1333 !ir_instr_op(instr, 1, a, false) ||
1334 !ir_instr_op(instr, 2, b, false) )
1339 if (!ir_block_instr_add(self, instr))
1344 ir_instr_delete(instr);
1345 ir_value_delete(out);
1349 ir_value* ir_block_create_fieldaddress(ir_block *self, const char *label, ir_value *ent, ir_value *field)
1353 /* Support for various pointer types todo if so desired */
1354 if (ent->vtype != TYPE_ENTITY)
1357 if (field->vtype != TYPE_FIELD)
1360 v = ir_block_create_general_instr(self, label, INSTR_ADDRESS, ent, field, TYPE_POINTER);
1361 v->fieldtype = field->fieldtype;
1365 ir_value* ir_block_create_load_from_ent(ir_block *self, const char *label, ir_value *ent, ir_value *field, int outype)
1368 if (ent->vtype != TYPE_ENTITY)
1371 /* at some point we could redirect for TYPE_POINTER... but that could lead to carelessness */
1372 if (field->vtype != TYPE_FIELD)
1377 case TYPE_FLOAT: op = INSTR_LOAD_F; break;
1378 case TYPE_VECTOR: op = INSTR_LOAD_V; break;
1379 case TYPE_STRING: op = INSTR_LOAD_S; break;
1380 case TYPE_FIELD: op = INSTR_LOAD_FLD; break;
1381 case TYPE_ENTITY: op = INSTR_LOAD_ENT; break;
1383 case TYPE_POINTER: op = INSTR_LOAD_I; break;
1384 case TYPE_INTEGER: op = INSTR_LOAD_I; break;
1386 case TYPE_QUATERNION: op = INSTR_LOAD_Q; break;
1387 case TYPE_MATRIX: op = INSTR_LOAD_M; break;
1392 return ir_block_create_general_instr(self, label, op, ent, field, outype);
1395 ir_value* ir_block_create_add(ir_block *self,
1397 ir_value *left, ir_value *right)
1400 int l = left->vtype;
1401 int r = right->vtype;
1420 if ( (l == TYPE_FLOAT && r == TYPE_INTEGER) )
1422 else if ( (l == TYPE_INTEGER && r == TYPE_FLOAT) )
1428 return ir_block_create_binop(self, label, op, left, right);
1431 ir_value* ir_block_create_sub(ir_block *self,
1433 ir_value *left, ir_value *right)
1436 int l = left->vtype;
1437 int r = right->vtype;
1457 if ( (l == TYPE_FLOAT && r == TYPE_INTEGER) )
1459 else if ( (l == TYPE_INTEGER && r == TYPE_FLOAT) )
1465 return ir_block_create_binop(self, label, op, left, right);
1468 ir_value* ir_block_create_mul(ir_block *self,
1470 ir_value *left, ir_value *right)
1473 int l = left->vtype;
1474 int r = right->vtype;
1491 case TYPE_QUATERNION:
1499 if ( (l == TYPE_VECTOR && r == TYPE_FLOAT) )
1501 else if ( (l == TYPE_FLOAT && r == TYPE_VECTOR) )
1503 else if ( (l == TYPE_QUATERNION && r == TYPE_FLOAT) )
1505 else if ( (l == TYPE_MATRIX && r == TYPE_FLOAT) )
1508 else if ( (l == TYPE_VECTOR && r == TYPE_INTEGER) )
1510 else if ( (l == TYPE_INTEGER && r == TYPE_VECTOR) )
1512 else if ( (l == TYPE_FLOAT && r == TYPE_INTEGER) )
1514 else if ( (l == TYPE_INTEGER && r == TYPE_FLOAT) )
1520 return ir_block_create_binop(self, label, op, left, right);
1523 ir_value* ir_block_create_div(ir_block *self,
1525 ir_value *left, ir_value *right)
1528 int l = left->vtype;
1529 int r = right->vtype;
1546 if ( (l == TYPE_VECTOR && r == TYPE_FLOAT) )
1548 else if ( (l == TYPE_FLOAT && r == TYPE_INTEGER) )
1550 else if ( (l == TYPE_INTEGER && r == TYPE_FLOAT) )
1556 return ir_block_create_binop(self, label, op, left, right);
1559 /* PHI resolving breaks the SSA, and must thus be the last
1560 * step before life-range calculation.
1563 static bool ir_block_naive_phi(ir_block *self);
1564 bool ir_function_naive_phi(ir_function *self)
1568 for (i = 0; i < self->blocks_count; ++i)
1570 if (!ir_block_naive_phi(self->blocks[i]))
1576 static bool ir_naive_phi_emit_store(ir_block *block, size_t iid, ir_value *old, ir_value *what)
1581 /* create a store */
1582 if (!ir_block_create_store(block, old, what))
1585 /* we now move it up */
1586 instr = block->instr[block->instr_count-1];
1587 for (i = block->instr_count; i > iid; --i)
1588 block->instr[i] = block->instr[i-1];
1589 block->instr[i] = instr;
1594 static bool ir_block_naive_phi(ir_block *self)
1597 /* FIXME: optionally, create_phi can add the phis
1598 * to a list so we don't need to loop through blocks
1599 * - anyway: "don't optimize YET"
1601 for (i = 0; i < self->instr_count; ++i)
1603 ir_instr *instr = self->instr[i];
1604 if (instr->opcode != VINSTR_PHI)
1607 if (!ir_block_instr_remove(self, i))
1609 --i; /* NOTE: i+1 below */
1611 for (p = 0; p < instr->phi_count; ++p)
1613 ir_value *v = instr->phi[p].value;
1614 for (w = 0; w < v->writes_count; ++w) {
1617 if (!v->writes[w]->_ops[0])
1620 /* When the write was to a global, we have to emit a mov */
1621 old = v->writes[w]->_ops[0];
1623 /* The original instruction now writes to the PHI target local */
1624 if (v->writes[w]->_ops[0] == v)
1625 v->writes[w]->_ops[0] = instr->_ops[0];
1627 if (old->store != store_value && old->store != store_local && old->store != store_param)
1629 /* If it originally wrote to a global we need to store the value
1632 if (!ir_naive_phi_emit_store(self, i+1, old, v))
1634 if (i+1 < self->instr_count)
1635 instr = self->instr[i+1];
1638 /* In case I forget and access instr later, it'll be NULL
1639 * when it's a problem, to make sure we crash, rather than accessing
1645 /* If it didn't, we can replace all reads by the phi target now. */
1647 for (r = 0; r < old->reads_count; ++r)
1650 ir_instr *ri = old->reads[r];
1651 for (op = 0; op < ri->phi_count; ++op) {
1652 if (ri->phi[op].value == old)
1653 ri->phi[op].value = v;
1655 for (op = 0; op < 3; ++op) {
1656 if (ri->_ops[op] == old)
1663 ir_instr_delete(instr);
1668 /***********************************************************************
1669 *IR Temp allocation code
1670 * Propagating value life ranges by walking through the function backwards
1671 * until no more changes are made.
1672 * In theory this should happen once more than once for every nested loop
1674 * Though this implementation might run an additional time for if nests.
1683 MEM_VEC_FUNCTIONS_ALL(new_reads_t, ir_value*, v)
1685 /* Enumerate instructions used by value's life-ranges
1687 static void ir_block_enumerate(ir_block *self, size_t *_eid)
1691 for (i = 0; i < self->instr_count; ++i)
1693 self->instr[i]->eid = eid++;
1698 /* Enumerate blocks and instructions.
1699 * The block-enumeration is unordered!
1700 * We do not really use the block enumreation, however
1701 * the instruction enumeration is important for life-ranges.
1703 void ir_function_enumerate(ir_function *self)
1706 size_t instruction_id = 0;
1707 for (i = 0; i < self->blocks_count; ++i)
1709 self->blocks[i]->eid = i;
1710 self->blocks[i]->run_id = 0;
1711 ir_block_enumerate(self->blocks[i], &instruction_id);
1715 static bool ir_block_life_propagate(ir_block *b, ir_block *prev, bool *changed);
1716 bool ir_function_calculate_liferanges(ir_function *self)
1724 for (i = 0; i != self->blocks_count; ++i)
1726 if (self->blocks[i]->is_return)
1728 if (!ir_block_life_propagate(self->blocks[i], NULL, &changed))
1736 /* Local-value allocator
1737 * After finishing creating the liferange of all values used in a function
1738 * we can allocate their global-positions.
1739 * This is the counterpart to register-allocation in register machines.
1742 MEM_VECTOR_MAKE(ir_value*, locals);
1743 MEM_VECTOR_MAKE(size_t, sizes);
1744 MEM_VECTOR_MAKE(size_t, positions);
1745 } function_allocator;
1746 MEM_VEC_FUNCTIONS(function_allocator, ir_value*, locals)
1747 MEM_VEC_FUNCTIONS(function_allocator, size_t, sizes)
1748 MEM_VEC_FUNCTIONS(function_allocator, size_t, positions)
1750 static bool function_allocator_alloc(function_allocator *alloc, const ir_value *var)
1753 size_t vsize = type_sizeof[var->vtype];
1755 slot = ir_value_var("reg", store_global, var->vtype);
1759 if (!ir_value_life_merge_into(slot, var))
1762 if (!function_allocator_locals_add(alloc, slot))
1765 if (!function_allocator_sizes_add(alloc, vsize))
1771 ir_value_delete(slot);
1775 bool ir_function_allocate_locals(ir_function *self)
1784 function_allocator alloc;
1786 if (!self->locals_count)
1789 MEM_VECTOR_INIT(&alloc, locals);
1790 MEM_VECTOR_INIT(&alloc, sizes);
1791 MEM_VECTOR_INIT(&alloc, positions);
1793 for (i = 0; i < self->locals_count; ++i)
1795 if (!function_allocator_alloc(&alloc, self->locals[i]))
1799 /* Allocate a slot for any value that still exists */
1800 for (i = 0; i < self->values_count; ++i)
1802 v = self->values[i];
1807 for (a = 0; a < alloc.locals_count; ++a)
1809 slot = alloc.locals[a];
1811 if (ir_values_overlap(v, slot))
1814 if (!ir_value_life_merge_into(slot, v))
1817 /* adjust size for this slot */
1818 if (alloc.sizes[a] < type_sizeof[v->vtype])
1819 alloc.sizes[a] = type_sizeof[v->vtype];
1821 self->values[i]->code.local = a;
1824 if (a >= alloc.locals_count) {
1825 self->values[i]->code.local = alloc.locals_count;
1826 if (!function_allocator_alloc(&alloc, v))
1831 /* Adjust slot positions based on sizes */
1832 if (!function_allocator_positions_add(&alloc, 0))
1835 if (alloc.sizes_count)
1836 pos = alloc.positions[0] + alloc.sizes[0];
1839 for (i = 1; i < alloc.sizes_count; ++i)
1841 pos = alloc.positions[i-1] + alloc.sizes[i-1];
1842 if (!function_allocator_positions_add(&alloc, pos))
1846 self->allocated_locals = pos + alloc.sizes[alloc.sizes_count-1];
1848 /* Take over the actual slot positions */
1849 for (i = 0; i < self->values_count; ++i)
1850 self->values[i]->code.local = alloc.positions[self->values[i]->code.local];
1857 for (i = 0; i < alloc.locals_count; ++i)
1858 ir_value_delete(alloc.locals[i]);
1859 MEM_VECTOR_CLEAR(&alloc, locals);
1860 MEM_VECTOR_CLEAR(&alloc, sizes);
1861 MEM_VECTOR_CLEAR(&alloc, positions);
1865 /* Get information about which operand
1866 * is read from, or written to.
1868 static void ir_op_read_write(int op, size_t *read, size_t *write)
1895 static bool ir_block_living_add_instr(ir_block *self, size_t eid)
1898 bool changed = false;
1900 for (i = 0; i != self->living_count; ++i)
1902 tempbool = ir_value_life_merge(self->living[i], eid);
1905 fprintf(stderr, "block_living_add_instr() value instruction added %s: %i\n", self->living[i]->_name, (int)eid);
1907 changed = changed || tempbool;
1912 static bool ir_block_life_prop_previous(ir_block* self, ir_block *prev, bool *changed)
1915 /* values which have been read in a previous iteration are now
1916 * in the "living" array even if the previous block doesn't use them.
1917 * So we have to remove whatever does not exist in the previous block.
1918 * They will be re-added on-read, but the liferange merge won't cause
1921 for (i = 0; i < self->living_count; ++i)
1923 if (!ir_block_living_find(prev, self->living[i], NULL)) {
1924 if (!ir_block_living_remove(self, i))
1930 /* Whatever the previous block still has in its living set
1931 * must now be added to ours as well.
1933 for (i = 0; i < prev->living_count; ++i)
1935 if (ir_block_living_find(self, prev->living[i], NULL))
1937 if (!ir_block_living_add(self, prev->living[i]))
1940 printf("%s got from prev: %s\n", self->label, prev->living[i]->_name);
1946 static bool ir_block_life_propagate(ir_block *self, ir_block *prev, bool *changed)
1952 /* bitmasks which operands are read from or written to */
1954 #if defined(LIFE_RANGE_WITHOUT_LAST_READ)
1956 new_reads_t new_reads;
1958 char dbg_ind[16] = { '#', '0' };
1961 #if defined(LIFE_RANGE_WITHOUT_LAST_READ)
1962 MEM_VECTOR_INIT(&new_reads, v);
1967 if (!ir_block_life_prop_previous(self, prev, changed))
1971 i = self->instr_count;
1974 instr = self->instr[i];
1976 /* PHI operands are always read operands */
1977 for (p = 0; p < instr->phi_count; ++p)
1979 value = instr->phi[p].value;
1980 #if ! defined(LIFE_RANGE_WITHOUT_LAST_READ)
1981 if (!ir_block_living_find(self, value, NULL) &&
1982 !ir_block_living_add(self, value))
1987 if (!new_reads_t_v_find(&new_reads, value, NULL))
1989 if (!new_reads_t_v_add(&new_reads, value))
1995 /* See which operands are read and write operands */
1996 ir_op_read_write(instr->opcode, &read, &write);
1998 /* Go through the 3 main operands */
1999 for (o = 0; o < 3; ++o)
2001 if (!instr->_ops[o]) /* no such operand */
2004 value = instr->_ops[o];
2006 /* We only care about locals */
2007 /* we also calculate parameter liferanges so that locals
2008 * can take up parameter slots */
2009 if (value->store != store_value &&
2010 value->store != store_local &&
2011 value->store != store_param)
2017 #if ! defined(LIFE_RANGE_WITHOUT_LAST_READ)
2018 if (!ir_block_living_find(self, value, NULL) &&
2019 !ir_block_living_add(self, value))
2024 /* fprintf(stderr, "read: %s\n", value->_name); */
2025 if (!new_reads_t_v_find(&new_reads, value, NULL))
2027 if (!new_reads_t_v_add(&new_reads, value))
2033 /* write operands */
2034 /* When we write to a local, we consider it "dead" for the
2035 * remaining upper part of the function, since in SSA a value
2036 * can only be written once (== created)
2041 bool in_living = ir_block_living_find(self, value, &idx);
2042 #if defined(LIFE_RANGE_WITHOUT_LAST_READ)
2044 bool in_reads = new_reads_t_v_find(&new_reads, value, &readidx);
2045 if (!in_living && !in_reads)
2050 /* If the value isn't alive it hasn't been read before... */
2051 /* TODO: See if the warning can be emitted during parsing or AST processing
2052 * otherwise have warning printed here.
2053 * IF printing a warning here: include filecontext_t,
2054 * and make sure it's only printed once
2055 * since this function is run multiple times.
2057 /* For now: debug info: */
2058 fprintf(stderr, "Value only written %s\n", value->name);
2059 tempbool = ir_value_life_merge(value, instr->eid);
2060 *changed = *changed || tempbool;
2062 ir_instr_dump(instr, dbg_ind, printf);
2066 /* since 'living' won't contain it
2067 * anymore, merge the value, since
2070 tempbool = ir_value_life_merge(value, instr->eid);
2073 fprintf(stderr, "value added id %s %i\n", value->name, (int)instr->eid);
2075 *changed = *changed || tempbool;
2077 #if ! defined(LIFE_RANGE_WITHOUT_LAST_READ)
2078 if (!ir_block_living_remove(self, idx))
2083 if (!new_reads_t_v_remove(&new_reads, readidx))
2091 tempbool = ir_block_living_add_instr(self, instr->eid);
2092 /*fprintf(stderr, "living added values\n");*/
2093 *changed = *changed || tempbool;
2095 #if defined(LIFE_RANGE_WITHOUT_LAST_READ)
2097 for (rd = 0; rd < new_reads.v_count; ++rd)
2099 if (!ir_block_living_find(self, new_reads.v[rd], NULL)) {
2100 if (!ir_block_living_add(self, new_reads.v[rd]))
2103 if (!i && !self->entries_count) {
2105 *changed = *changed || ir_value_life_merge(new_reads.v[rd], instr->eid);
2108 MEM_VECTOR_CLEAR(&new_reads, v);
2112 if (self->run_id == self->owner->run_id)
2115 self->run_id = self->owner->run_id;
2117 for (i = 0; i < self->entries_count; ++i)
2119 ir_block *entry = self->entries[i];
2120 ir_block_life_propagate(entry, self, changed);
2125 #if defined(LIFE_RANGE_WITHOUT_LAST_READ)
2126 MEM_VECTOR_CLEAR(&new_reads, v);
2131 /***********************************************************************
2134 * Since the IR has the convention of putting 'write' operands
2135 * at the beginning, we have to rotate the operands of instructions
2136 * properly in order to generate valid QCVM code.
2138 * Having destinations at a fixed position is more convenient. In QC
2139 * this is *mostly* OPC, but FTE adds at least 2 instructions which
2140 * read from from OPA, and store to OPB rather than OPC. Which is
2141 * partially the reason why the implementation of these instructions
2142 * in darkplaces has been delayed for so long.
2144 * Breaking conventions is annoying...
2146 static bool ir_builder_gen_global(ir_builder *self, ir_value *global);
2148 static bool gen_global_field(ir_value *global)
2150 if (global->isconst)
2152 ir_value *fld = global->constval.vpointer;
2154 printf("Invalid field constant with no field: %s\n", global->name);
2158 /* Now, in this case, a relocation would be impossible to code
2159 * since it looks like this:
2160 * .vector v = origin; <- parse error, wtf is 'origin'?
2163 * But we will need a general relocation support later anyway
2164 * for functions... might as well support that here.
2166 if (!fld->code.globaladdr) {
2167 printf("FIXME: Relocation support\n");
2171 /* copy the field's value */
2172 global->code.globaladdr = code_globals_add(code_globals_data[fld->code.globaladdr]);
2176 global->code.globaladdr = code_globals_add(0);
2178 if (global->code.globaladdr < 0)
2183 static bool gen_global_pointer(ir_value *global)
2185 if (global->isconst)
2187 ir_value *target = global->constval.vpointer;
2189 printf("Invalid pointer constant: %s\n", global->name);
2190 /* NULL pointers are pointing to the NULL constant, which also
2191 * sits at address 0, but still has an ir_value for itself.
2196 /* Here, relocations ARE possible - in fteqcc-enhanced-qc:
2197 * void() foo; <- proto
2198 * void() *fooptr = &foo;
2199 * void() foo = { code }
2201 if (!target->code.globaladdr) {
2202 /* FIXME: Check for the constant nullptr ir_value!
2203 * because then code.globaladdr being 0 is valid.
2205 printf("FIXME: Relocation support\n");
2209 global->code.globaladdr = code_globals_add(target->code.globaladdr);
2213 global->code.globaladdr = code_globals_add(0);
2215 if (global->code.globaladdr < 0)
2220 static bool gen_blocks_recursive(ir_function *func, ir_block *block)
2222 prog_section_statement stmt;
2231 block->generated = true;
2232 block->code_start = code_statements_elements;
2233 for (i = 0; i < block->instr_count; ++i)
2235 instr = block->instr[i];
2237 if (instr->opcode == VINSTR_PHI) {
2238 printf("cannot generate virtual instruction (phi)\n");
2242 if (instr->opcode == VINSTR_JUMP) {
2243 target = instr->bops[0];
2244 /* for uncoditional jumps, if the target hasn't been generated
2245 * yet, we generate them right here.
2247 if (!target->generated) {
2252 /* otherwise we generate a jump instruction */
2253 stmt.opcode = INSTR_GOTO;
2254 stmt.o1.s1 = (target->code_start) - code_statements_elements;
2257 if (code_statements_add(stmt) < 0)
2260 /* no further instructions can be in this block */
2264 if (instr->opcode == VINSTR_COND) {
2265 ontrue = instr->bops[0];
2266 onfalse = instr->bops[1];
2267 /* TODO: have the AST signal which block should
2268 * come first: eg. optimize IFs without ELSE...
2271 stmt.o1.u1 = ir_value_code_addr(instr->_ops[0]);
2275 if (ontrue->generated) {
2276 stmt.opcode = INSTR_IF;
2277 stmt.o2.s1 = (ontrue->code_start-1) - code_statements_elements;
2278 if (code_statements_add(stmt) < 0)
2281 if (onfalse->generated) {
2282 stmt.opcode = INSTR_IFNOT;
2283 stmt.o2.s1 = (onfalse->code_start-1) - code_statements_elements;
2284 if (code_statements_add(stmt) < 0)
2287 if (!ontrue->generated) {
2288 if (onfalse->generated) {
2293 if (!onfalse->generated) {
2294 if (ontrue->generated) {
2299 /* neither ontrue nor onfalse exist */
2300 stmt.opcode = INSTR_IFNOT;
2301 stidx = code_statements_elements;
2302 if (code_statements_add(stmt) < 0)
2304 /* on false we jump, so add ontrue-path */
2305 if (!gen_blocks_recursive(func, ontrue))
2307 /* fixup the jump address */
2308 code_statements_data[stidx].o2.s1 = code_statements_elements - stidx;
2309 /* generate onfalse path */
2310 if (onfalse->generated) {
2311 /* fixup the jump address */
2312 code_statements_data[stidx].o2.s1 = (onfalse->code_start) - (stidx);
2313 /* may have been generated in the previous recursive call */
2314 stmt.opcode = INSTR_GOTO;
2315 stmt.o1.s1 = (onfalse->code_start) - code_statements_elements;
2318 return (code_statements_add(stmt) >= 0);
2320 /* if not, generate now */
2325 if (instr->opcode >= INSTR_CALL0 && instr->opcode <= INSTR_CALL8) {
2326 /* Trivial call translation:
2327 * copy all params to OFS_PARM*
2328 * if the output's storetype is not store_return,
2329 * add append a STORE instruction!
2331 * NOTES on how to do it better without much trouble:
2332 * -) The liferanges!
2333 * Simply check the liferange of all parameters for
2334 * other CALLs. For each param with no CALL in its
2335 * liferange, we can store it in an OFS_PARM at
2336 * generation already. This would even include later
2337 * reuse.... probably... :)
2342 for (p = 0; p < instr->params_count; ++p)
2344 ir_value *param = instr->params[p];
2346 stmt.opcode = INSTR_STORE_F;
2349 stmt.opcode = type_store_instr[param->vtype];
2350 stmt.o1.u1 = ir_value_code_addr(param);
2351 stmt.o2.u1 = OFS_PARM0 + 3 * p;
2352 if (code_statements_add(stmt) < 0)
2355 stmt.opcode = INSTR_CALL0 + instr->params_count;
2356 if (stmt.opcode > INSTR_CALL8)
2357 stmt.opcode = INSTR_CALL8;
2358 stmt.o1.u1 = ir_value_code_addr(instr->_ops[1]);
2361 if (code_statements_add(stmt) < 0)
2364 retvalue = instr->_ops[0];
2365 if (retvalue && retvalue->store != store_return && retvalue->life_count)
2367 /* not to be kept in OFS_RETURN */
2368 stmt.opcode = type_store_instr[retvalue->vtype];
2369 stmt.o1.u1 = OFS_RETURN;
2370 stmt.o2.u1 = ir_value_code_addr(retvalue);
2372 if (code_statements_add(stmt) < 0)
2378 if (instr->opcode == INSTR_STATE) {
2379 printf("TODO: state instruction\n");
2383 stmt.opcode = instr->opcode;
2388 /* This is the general order of operands */
2390 stmt.o3.u1 = ir_value_code_addr(instr->_ops[0]);
2393 stmt.o1.u1 = ir_value_code_addr(instr->_ops[1]);
2396 stmt.o2.u1 = ir_value_code_addr(instr->_ops[2]);
2398 if (stmt.opcode == INSTR_RETURN || stmt.opcode == INSTR_DONE)
2400 stmt.o1.u1 = stmt.o3.u1;
2403 else if (stmt.opcode >= INSTR_STORE_F &&
2404 stmt.opcode <= INSTR_STORE_FNC)
2406 /* 2-operand instructions with A -> B */
2407 stmt.o2.u1 = stmt.o3.u1;
2411 if (code_statements_add(stmt) < 0)
2417 static bool gen_function_code(ir_function *self)
2420 prog_section_statement stmt;
2422 /* Starting from entry point, we generate blocks "as they come"
2423 * for now. Dead blocks will not be translated obviously.
2425 if (!self->blocks_count) {
2426 printf("Function '%s' declared without body.\n", self->name);
2430 block = self->blocks[0];
2431 if (block->generated)
2434 if (!gen_blocks_recursive(self, block)) {
2435 printf("failed to generate blocks for '%s'\n", self->name);
2439 /* otherwise code_write crashes since it debug-prints functions until AINSTR_END */
2440 stmt.opcode = AINSTR_END;
2444 if (code_statements_add(stmt) < 0)
2449 static bool gen_global_function(ir_builder *ir, ir_value *global)
2451 prog_section_function fun;
2455 size_t local_var_end;
2457 if (!global->isconst || (!global->constval.vfunc))
2459 printf("Invalid state of function-global: not constant: %s\n", global->name);
2463 irfun = global->constval.vfunc;
2465 fun.name = global->code.name;
2466 fun.file = code_cachedstring(global->context.file);
2467 fun.profile = 0; /* always 0 */
2468 fun.nargs = irfun->params_count;
2470 for (i = 0;i < 8; ++i) {
2474 fun.argsize[i] = type_sizeof[irfun->params[i]];
2477 fun.firstlocal = code_globals_elements;
2478 fun.locals = irfun->allocated_locals + irfun->locals_count;
2481 for (i = 0; i < irfun->locals_count; ++i) {
2482 if (!ir_builder_gen_global(ir, irfun->locals[i])) {
2483 printf("Failed to generate global %s\n", irfun->locals[i]->name);
2487 if (irfun->locals_count) {
2488 ir_value *last = irfun->locals[irfun->locals_count-1];
2489 local_var_end = last->code.globaladdr;
2490 local_var_end += type_sizeof[last->vtype];
2492 for (i = 0; i < irfun->values_count; ++i)
2494 /* generate code.globaladdr for ssa values */
2495 ir_value *v = irfun->values[i];
2496 v->code.globaladdr = local_var_end + v->code.local;
2498 for (i = 0; i < irfun->locals_count; ++i) {
2499 /* fill the locals with zeros */
2500 code_globals_add(0);
2504 fun.entry = irfun->builtin;
2506 fun.entry = code_statements_elements;
2507 if (!gen_function_code(irfun)) {
2508 printf("Failed to generate code for function %s\n", irfun->name);
2513 return (code_functions_add(fun) >= 0);
2516 static bool ir_builder_gen_global(ir_builder *self, ir_value *global)
2520 prog_section_def def;
2522 def.type = global->vtype;
2523 def.offset = code_globals_elements;
2524 def.name = global->code.name = code_genstring(global->name);
2526 switch (global->vtype)
2529 if (code_defs_add(def) < 0)
2531 return gen_global_pointer(global);
2533 if (code_defs_add(def) < 0)
2535 return gen_global_field(global);
2540 if (code_defs_add(def) < 0)
2543 if (global->isconst) {
2544 iptr = (int32_t*)&global->constval.vfloat;
2545 global->code.globaladdr = code_globals_add(*iptr);
2547 global->code.globaladdr = code_globals_add(0);
2549 return global->code.globaladdr >= 0;
2553 if (code_defs_add(def) < 0)
2555 if (global->isconst)
2556 global->code.globaladdr = code_globals_add(code_cachedstring(global->constval.vstring));
2558 global->code.globaladdr = code_globals_add(0);
2559 return global->code.globaladdr >= 0;
2562 case TYPE_QUATERNION:
2566 if (code_defs_add(def) < 0)
2569 if (global->isconst) {
2570 iptr = (int32_t*)&global->constval.vvec;
2571 global->code.globaladdr = code_globals_add(iptr[0]);
2572 if (global->code.globaladdr < 0)
2574 for (d = 1; d < type_sizeof[global->vtype]; ++d)
2576 if (code_globals_add(iptr[d]) < 0)
2580 global->code.globaladdr = code_globals_add(0);
2581 if (global->code.globaladdr < 0)
2583 for (d = 1; d < type_sizeof[global->vtype]; ++d)
2585 if (code_globals_add(0) < 0)
2589 return global->code.globaladdr >= 0;
2592 if (code_defs_add(def) < 0)
2594 global->code.globaladdr = code_globals_elements;
2595 code_globals_add(code_functions_elements);
2596 return gen_global_function(self, global);
2598 /* assume biggest type */
2599 global->code.globaladdr = code_globals_add(0);
2600 for (i = 1; i < type_sizeof[TYPE_VARIANT]; ++i)
2601 code_globals_add(0);
2604 /* refuse to create 'void' type or any other fancy business. */
2605 printf("Invalid type for global variable %s\n", global->name);
2610 static bool ir_builder_gen_field(ir_builder *self, ir_value *field)
2612 prog_section_def def;
2613 prog_section_field fld;
2615 def.type = field->vtype;
2616 def.offset = code_globals_elements;
2617 def.name = field->code.name = code_genstring(field->name);
2619 if (code_defs_add(def) < 0)
2622 fld.name = def.name;
2623 fld.offset = code_fields_elements;
2624 fld.type = field->fieldtype;
2626 if (fld.type == TYPE_VOID) {
2627 printf("field is missing a type: %s - don't know its size\n", field->name);
2631 if (code_fields_add(fld) < 0)
2634 if (!code_globals_add(code_alloc_field(type_sizeof[field->fieldtype])))
2637 field->code.globaladdr = code_globals_add(fld.offset);
2638 return field->code.globaladdr >= 0;
2641 bool ir_builder_generate(ir_builder *self, const char *filename)
2647 for (i = 0; i < self->fields_count; ++i)
2649 if (!ir_builder_gen_field(self, self->fields[i])) {
2654 for (i = 0; i < self->globals_count; ++i)
2656 if (!ir_builder_gen_global(self, self->globals[i])) {
2661 printf("writing '%s'...\n", filename);
2662 return code_write(filename);
2665 /***********************************************************************
2666 *IR DEBUG Dump functions...
2669 #define IND_BUFSZ 1024
2671 const char *qc_opname(int op)
2673 if (op < 0) return "<INVALID>";
2674 if (op < ( sizeof(asm_instr) / sizeof(asm_instr[0]) ))
2675 return asm_instr[op].m;
2677 case VINSTR_PHI: return "PHI";
2678 case VINSTR_JUMP: return "JUMP";
2679 case VINSTR_COND: return "COND";
2680 default: return "<UNK>";
2684 void ir_builder_dump(ir_builder *b, int (*oprintf)(const char*, ...))
2687 char indent[IND_BUFSZ];
2691 oprintf("module %s\n", b->name);
2692 for (i = 0; i < b->globals_count; ++i)
2695 if (b->globals[i]->isconst)
2696 oprintf("%s = ", b->globals[i]->name);
2697 ir_value_dump(b->globals[i], oprintf);
2700 for (i = 0; i < b->functions_count; ++i)
2701 ir_function_dump(b->functions[i], indent, oprintf);
2702 oprintf("endmodule %s\n", b->name);
2705 void ir_function_dump(ir_function *f, char *ind,
2706 int (*oprintf)(const char*, ...))
2709 if (f->builtin != 0) {
2710 oprintf("%sfunction %s = builtin %i\n", ind, f->name, -f->builtin);
2713 oprintf("%sfunction %s\n", ind, f->name);
2714 strncat(ind, "\t", IND_BUFSZ);
2715 if (f->locals_count)
2717 oprintf("%s%i locals:\n", ind, (int)f->locals_count);
2718 for (i = 0; i < f->locals_count; ++i) {
2719 oprintf("%s\t", ind);
2720 ir_value_dump(f->locals[i], oprintf);
2724 if (f->blocks_count)
2726 oprintf("%slife passes (check): %i\n", ind, (int)f->run_id);
2727 for (i = 0; i < f->blocks_count; ++i) {
2728 if (f->blocks[i]->run_id != f->run_id) {
2729 oprintf("%slife pass check fail! %i != %i\n", ind, (int)f->blocks[i]->run_id, (int)f->run_id);
2731 ir_block_dump(f->blocks[i], ind, oprintf);
2735 ind[strlen(ind)-1] = 0;
2736 oprintf("%sendfunction %s\n", ind, f->name);
2739 void ir_block_dump(ir_block* b, char *ind,
2740 int (*oprintf)(const char*, ...))
2743 oprintf("%s:%s\n", ind, b->label);
2744 strncat(ind, "\t", IND_BUFSZ);
2746 for (i = 0; i < b->instr_count; ++i)
2747 ir_instr_dump(b->instr[i], ind, oprintf);
2748 ind[strlen(ind)-1] = 0;
2751 void dump_phi(ir_instr *in, char *ind,
2752 int (*oprintf)(const char*, ...))
2755 oprintf("%s <- phi ", in->_ops[0]->name);
2756 for (i = 0; i < in->phi_count; ++i)
2758 oprintf("([%s] : %s) ", in->phi[i].from->label,
2759 in->phi[i].value->name);
2764 void ir_instr_dump(ir_instr *in, char *ind,
2765 int (*oprintf)(const char*, ...))
2768 const char *comma = NULL;
2770 oprintf("%s (%i) ", ind, (int)in->eid);
2772 if (in->opcode == VINSTR_PHI) {
2773 dump_phi(in, ind, oprintf);
2777 strncat(ind, "\t", IND_BUFSZ);
2779 if (in->_ops[0] && (in->_ops[1] || in->_ops[2])) {
2780 ir_value_dump(in->_ops[0], oprintf);
2781 if (in->_ops[1] || in->_ops[2])
2784 oprintf("%s\t", qc_opname(in->opcode));
2785 if (in->_ops[0] && !(in->_ops[1] || in->_ops[2])) {
2786 ir_value_dump(in->_ops[0], oprintf);
2791 for (i = 1; i != 3; ++i) {
2795 ir_value_dump(in->_ops[i], oprintf);
2803 oprintf("[%s]", in->bops[0]->label);
2807 oprintf("%s[%s]", comma, in->bops[1]->label);
2809 ind[strlen(ind)-1] = 0;
2812 void ir_value_dump(ir_value* v, int (*oprintf)(const char*, ...))
2821 oprintf("%g", v->constval.vfloat);
2824 oprintf("'%g %g %g'",
2827 v->constval.vvec.z);
2830 oprintf("(entity)");
2833 oprintf("\"%s\"", v->constval.vstring);
2837 oprintf("%i", v->constval.vint);
2842 v->constval.vpointer->name);
2846 oprintf("%s", v->name);
2850 void ir_value_dump_life(ir_value *self, int (*oprintf)(const char*,...))
2853 oprintf("Life of %s:\n", self->name);
2854 for (i = 0; i < self->life_count; ++i)
2856 oprintf(" + [%i, %i]\n", self->life[i].start, self->life[i].end);