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 void ir_value_code_setaddr(ir_value *self, int32_t gaddr)
554 self->code.globaladdr = gaddr;
555 if (self->members[0]) self->members[0]->code.globaladdr = gaddr;
556 if (self->members[1]) self->members[1]->code.globaladdr = gaddr;
557 if (self->members[2]) self->members[2]->code.globaladdr = gaddr;
560 int32_t ir_value_code_addr(const ir_value *self)
562 if (self->store == store_return)
563 return OFS_RETURN + self->code.addroffset;
564 return self->code.globaladdr + self->code.addroffset;
567 ir_value* ir_value_var(const char *name, int storetype, int vtype)
570 self = (ir_value*)mem_a(sizeof(*self));
572 self->fieldtype = TYPE_VOID;
573 self->outtype = TYPE_VOID;
574 self->store = storetype;
575 MEM_VECTOR_INIT(self, reads);
576 MEM_VECTOR_INIT(self, writes);
577 self->isconst = false;
578 self->context.file = "<@no context>";
579 self->context.line = 0;
581 ir_value_set_name(self, name);
583 memset(&self->constval, 0, sizeof(self->constval));
584 memset(&self->code, 0, sizeof(self->code));
586 MEM_VECTOR_INIT(self, life);
590 ir_value* ir_value_vector_member(ir_value *self, unsigned int member)
596 if (self->members[member])
597 return self->members[member];
599 if (self->vtype == TYPE_VECTOR)
601 m = ir_value_var(self->name, self->store, TYPE_FLOAT);
604 m->context = self->context;
606 self->members[member] = m;
607 m->code.addroffset = member;
609 else if (self->vtype == TYPE_FIELD)
611 if (self->fieldtype != TYPE_VECTOR)
613 m = ir_value_var(self->name, self->store, TYPE_FIELD);
616 m->fieldtype = TYPE_FLOAT;
617 m->context = self->context;
619 self->members[member] = m;
620 m->code.addroffset = member;
626 MEM_VEC_FUNCTIONS(ir_value, ir_life_entry_t, life)
627 MEM_VEC_FUNCTIONS_ALL(ir_value, ir_instr*, reads)
628 MEM_VEC_FUNCTIONS_ALL(ir_value, ir_instr*, writes)
630 ir_value* ir_value_out(ir_function *owner, const char *name, int storetype, int vtype)
632 ir_value *v = ir_value_var(name, storetype, vtype);
635 if (!ir_function_collect_value(owner, v))
643 void ir_value_delete(ir_value* self)
647 mem_d((void*)self->name);
650 if (self->vtype == TYPE_STRING)
651 mem_d((void*)self->constval.vstring);
653 for (i = 0; i < 3; ++i) {
654 if (self->members[i])
655 ir_value_delete(self->members[i]);
657 MEM_VECTOR_CLEAR(self, reads);
658 MEM_VECTOR_CLEAR(self, writes);
659 MEM_VECTOR_CLEAR(self, life);
663 void ir_value_set_name(ir_value *self, const char *name)
666 mem_d((void*)self->name);
667 self->name = util_strdup(name);
670 bool ir_value_set_float(ir_value *self, float f)
672 if (self->vtype != TYPE_FLOAT)
674 self->constval.vfloat = f;
675 self->isconst = true;
679 bool ir_value_set_func(ir_value *self, int f)
681 if (self->vtype != TYPE_FUNCTION)
683 self->constval.vint = f;
684 self->isconst = true;
688 bool ir_value_set_vector(ir_value *self, vector v)
690 if (self->vtype != TYPE_VECTOR)
692 self->constval.vvec = v;
693 self->isconst = true;
697 bool ir_value_set_quaternion(ir_value *self, quaternion v)
699 if (self->vtype != TYPE_QUATERNION)
701 memcpy(&self->constval.vquat, v, sizeof(self->constval.vquat));
702 self->isconst = true;
706 bool ir_value_set_matrix(ir_value *self, matrix v)
708 if (self->vtype != TYPE_MATRIX)
710 memcpy(&self->constval.vmat, v, sizeof(self->constval.vmat));
711 self->isconst = true;
715 bool ir_value_set_field(ir_value *self, ir_value *fld)
717 if (self->vtype != TYPE_FIELD)
719 self->constval.vpointer = fld;
720 self->isconst = true;
724 bool ir_value_set_string(ir_value *self, const char *str)
726 if (self->vtype != TYPE_STRING)
728 self->constval.vstring = util_strdup(str);
729 self->isconst = true;
734 bool ir_value_set_int(ir_value *self, int i)
736 if (self->vtype != TYPE_INTEGER)
738 self->constval.vint = i;
739 self->isconst = true;
744 bool ir_value_lives(ir_value *self, size_t at)
747 for (i = 0; i < self->life_count; ++i)
749 ir_life_entry_t *life = &self->life[i];
750 if (life->start <= at && at <= life->end)
752 if (life->start > at) /* since it's ordered */
758 bool ir_value_life_insert(ir_value *self, size_t idx, ir_life_entry_t e)
761 if (!ir_value_life_add(self, e)) /* naive... */
763 for (k = self->life_count-1; k > idx; --k)
764 self->life[k] = self->life[k-1];
769 bool ir_value_life_merge(ir_value *self, size_t s)
772 ir_life_entry_t *life = NULL;
773 ir_life_entry_t *before = NULL;
774 ir_life_entry_t new_entry;
776 /* Find the first range >= s */
777 for (i = 0; i < self->life_count; ++i)
780 life = &self->life[i];
784 /* nothing found? append */
785 if (i == self->life_count) {
787 if (life && life->end+1 == s)
789 /* previous life range can be merged in */
793 if (life && life->end >= s)
796 if (!ir_value_life_add(self, e))
797 return false; /* failing */
803 if (before->end + 1 == s &&
804 life->start - 1 == s)
807 before->end = life->end;
808 if (!ir_value_life_remove(self, i))
809 return false; /* failing */
812 if (before->end + 1 == s)
818 /* already contained */
819 if (before->end >= s)
823 if (life->start - 1 == s)
828 /* insert a new entry */
829 new_entry.start = new_entry.end = s;
830 return ir_value_life_insert(self, i, new_entry);
833 bool ir_value_life_merge_into(ir_value *self, const ir_value *other)
837 if (!other->life_count)
840 if (!self->life_count) {
841 for (i = 0; i < other->life_count; ++i) {
842 if (!ir_value_life_add(self, other->life[i]))
849 for (i = 0; i < other->life_count; ++i)
851 const ir_life_entry_t *life = &other->life[i];
854 ir_life_entry_t *entry = &self->life[myi];
856 if (life->end+1 < entry->start)
858 /* adding an interval before entry */
859 if (!ir_value_life_insert(self, myi, *life))
865 if (life->start < entry->start &&
866 life->end >= entry->start)
868 /* starts earlier and overlaps */
869 entry->start = life->start;
872 if (life->end > entry->end &&
873 life->start-1 <= entry->end)
875 /* ends later and overlaps */
876 entry->end = life->end;
879 /* see if our change combines it with the next ranges */
880 while (myi+1 < self->life_count &&
881 entry->end+1 >= self->life[1+myi].start)
883 /* overlaps with (myi+1) */
884 if (entry->end < self->life[1+myi].end)
885 entry->end = self->life[1+myi].end;
886 if (!ir_value_life_remove(self, myi+1))
888 entry = &self->life[myi];
891 /* see if we're after the entry */
892 if (life->start > entry->end)
895 /* append if we're at the end */
896 if (myi >= self->life_count) {
897 if (!ir_value_life_add(self, *life))
901 /* otherweise check the next range */
910 bool ir_values_overlap(const ir_value *a, const ir_value *b)
912 /* For any life entry in A see if it overlaps with
913 * any life entry in B.
914 * Note that the life entries are orderes, so we can make a
915 * more efficient algorithm there than naively translating the
919 ir_life_entry_t *la, *lb, *enda, *endb;
921 /* first of all, if either has no life range, they cannot clash */
922 if (!a->life_count || !b->life_count)
927 enda = la + a->life_count;
928 endb = lb + b->life_count;
931 /* check if the entries overlap, for that,
932 * both must start before the other one ends.
934 #if defined(LIFE_RANGE_WITHOUT_LAST_READ)
935 if (la->start <= lb->end &&
936 lb->start <= la->end)
938 if (la->start < lb->end &&
945 /* entries are ordered
946 * one entry is earlier than the other
947 * that earlier entry will be moved forward
949 if (la->start < lb->start)
951 /* order: A B, move A forward
952 * check if we hit the end with A
957 else if (lb->start < la->start)
959 /* order: B A, move B forward
960 * check if we hit the end with B
969 /***********************************************************************
973 bool ir_block_create_store_op(ir_block *self, int op, ir_value *target, ir_value *what)
975 ir_instr *in = ir_instr_new(self, op);
979 if (target->store == store_value &&
980 (op < INSTR_STOREP_F || op > INSTR_STOREP_FNC))
982 fprintf(stderr, "cannot store to an SSA value\n");
983 fprintf(stderr, "trying to store: %s <- %s\n", target->name, what->name);
984 fprintf(stderr, "instruction: %s\n", asm_instr[op].m);
988 if (!ir_instr_op(in, 0, target, true) ||
989 !ir_instr_op(in, 1, what, false) ||
990 !ir_block_instr_add(self, in) )
997 bool ir_block_create_store(ir_block *self, ir_value *target, ir_value *what)
1001 if (target->vtype == TYPE_VARIANT)
1002 vtype = what->vtype;
1004 vtype = target->vtype;
1007 if (vtype == TYPE_FLOAT && what->vtype == TYPE_INTEGER)
1008 op = INSTR_CONV_ITOF;
1009 else if (vtype == TYPE_INTEGER && what->vtype == TYPE_FLOAT)
1010 op = INSTR_CONV_FTOI;
1012 op = type_store_instr[vtype];
1014 if (OPTS_FLAG(ADJUST_VECTOR_FIELDS)) {
1015 if (op == INSTR_STORE_FLD && what->fieldtype == TYPE_VECTOR)
1019 return ir_block_create_store_op(self, op, target, what);
1022 bool ir_block_create_storep(ir_block *self, ir_value *target, ir_value *what)
1027 if (target->vtype != TYPE_POINTER)
1030 /* storing using pointer - target is a pointer, type must be
1031 * inferred from source
1033 vtype = what->vtype;
1035 op = type_storep_instr[vtype];
1036 if (OPTS_FLAG(ADJUST_VECTOR_FIELDS)) {
1037 if (op == INSTR_STOREP_FLD && what->fieldtype == TYPE_VECTOR)
1038 op = INSTR_STOREP_V;
1041 return ir_block_create_store_op(self, op, target, what);
1044 bool ir_block_create_return(ir_block *self, ir_value *v)
1048 fprintf(stderr, "block already ended (%s)\n", self->label);
1052 self->is_return = true;
1053 in = ir_instr_new(self, INSTR_RETURN);
1057 if (!ir_instr_op(in, 0, v, false) ||
1058 !ir_block_instr_add(self, in) )
1065 bool ir_block_create_if(ir_block *self, ir_value *v,
1066 ir_block *ontrue, ir_block *onfalse)
1070 fprintf(stderr, "block already ended (%s)\n", self->label);
1074 /*in = ir_instr_new(self, (v->vtype == TYPE_STRING ? INSTR_IF_S : INSTR_IF_F));*/
1075 in = ir_instr_new(self, VINSTR_COND);
1079 if (!ir_instr_op(in, 0, v, false)) {
1080 ir_instr_delete(in);
1084 in->bops[0] = ontrue;
1085 in->bops[1] = onfalse;
1087 if (!ir_block_instr_add(self, in))
1090 if (!ir_block_exits_add(self, ontrue) ||
1091 !ir_block_exits_add(self, onfalse) ||
1092 !ir_block_entries_add(ontrue, self) ||
1093 !ir_block_entries_add(onfalse, self) )
1100 bool ir_block_create_jump(ir_block *self, ir_block *to)
1104 fprintf(stderr, "block already ended (%s)\n", self->label);
1108 in = ir_instr_new(self, VINSTR_JUMP);
1113 if (!ir_block_instr_add(self, in))
1116 if (!ir_block_exits_add(self, to) ||
1117 !ir_block_entries_add(to, self) )
1124 bool ir_block_create_goto(ir_block *self, ir_block *to)
1128 fprintf(stderr, "block already ended (%s)\n", self->label);
1132 in = ir_instr_new(self, INSTR_GOTO);
1137 if (!ir_block_instr_add(self, in))
1140 if (!ir_block_exits_add(self, to) ||
1141 !ir_block_entries_add(to, self) )
1148 ir_instr* ir_block_create_phi(ir_block *self, const char *label, int ot)
1152 in = ir_instr_new(self, VINSTR_PHI);
1155 out = ir_value_out(self->owner, label, store_value, ot);
1157 ir_instr_delete(in);
1160 if (!ir_instr_op(in, 0, out, true)) {
1161 ir_instr_delete(in);
1162 ir_value_delete(out);
1165 if (!ir_block_instr_add(self, in)) {
1166 ir_instr_delete(in);
1167 ir_value_delete(out);
1173 ir_value* ir_phi_value(ir_instr *self)
1175 return self->_ops[0];
1178 bool ir_phi_add(ir_instr* self, ir_block *b, ir_value *v)
1182 if (!ir_block_entries_find(self->owner, b, NULL)) {
1183 /* Must not be possible to cause this, otherwise the AST
1184 * is doing something wrong.
1186 fprintf(stderr, "Invalid entry block for PHI\n");
1192 if (!ir_value_reads_add(v, self))
1194 return ir_instr_phi_add(self, pe);
1197 /* call related code */
1198 ir_instr* ir_block_create_call(ir_block *self, const char *label, ir_value *func)
1202 in = ir_instr_new(self, INSTR_CALL0);
1205 out = ir_value_out(self->owner, label, store_return, func->outtype);
1207 ir_instr_delete(in);
1210 if (!ir_instr_op(in, 0, out, true) ||
1211 !ir_instr_op(in, 1, func, false) ||
1212 !ir_block_instr_add(self, in))
1214 ir_instr_delete(in);
1215 ir_value_delete(out);
1221 ir_value* ir_call_value(ir_instr *self)
1223 return self->_ops[0];
1226 bool ir_call_param(ir_instr* self, ir_value *v)
1228 if (!ir_instr_params_add(self, v))
1230 if (!ir_value_reads_add(v, self)) {
1231 if (!ir_instr_params_remove(self, self->params_count-1))
1232 GMQCC_SUPPRESS_EMPTY_BODY;
1238 /* binary op related code */
1240 ir_value* ir_block_create_binop(ir_block *self,
1241 const char *label, int opcode,
1242 ir_value *left, ir_value *right)
1264 case INSTR_SUB_S: /* -- offset of string as float */
1269 case INSTR_BITOR_IF:
1270 case INSTR_BITOR_FI:
1271 case INSTR_BITAND_FI:
1272 case INSTR_BITAND_IF:
1287 case INSTR_BITAND_I:
1290 case INSTR_RSHIFT_I:
1291 case INSTR_LSHIFT_I:
1313 /* boolean operations result in floats */
1314 if (opcode >= INSTR_EQ_F && opcode <= INSTR_GT)
1316 else if (opcode >= INSTR_LE && opcode <= INSTR_GT)
1319 else if (opcode >= INSTR_LE_I && opcode <= INSTR_EQ_FI)
1324 if (ot == TYPE_VOID) {
1325 /* The AST or parser were supposed to check this! */
1329 return ir_block_create_general_instr(self, label, opcode, left, right, ot);
1332 ir_value* ir_block_create_unary(ir_block *self,
1333 const char *label, int opcode,
1336 int ot = TYPE_FLOAT;
1348 /* QC doesn't have other unary operations. We expect extensions to fill
1349 * the above list, otherwise we assume out-type = in-type, eg for an
1353 ot = operand->vtype;
1356 if (ot == TYPE_VOID) {
1357 /* The AST or parser were supposed to check this! */
1361 /* let's use the general instruction creator and pass NULL for OPB */
1362 return ir_block_create_general_instr(self, label, opcode, operand, NULL, ot);
1365 ir_value* ir_block_create_general_instr(ir_block *self, const char *label,
1366 int op, ir_value *a, ir_value *b, int outype)
1371 out = ir_value_out(self->owner, label, store_value, outype);
1375 instr = ir_instr_new(self, op);
1377 ir_value_delete(out);
1381 if (!ir_instr_op(instr, 0, out, true) ||
1382 !ir_instr_op(instr, 1, a, false) ||
1383 !ir_instr_op(instr, 2, b, false) )
1388 if (!ir_block_instr_add(self, instr))
1393 ir_instr_delete(instr);
1394 ir_value_delete(out);
1398 ir_value* ir_block_create_fieldaddress(ir_block *self, const char *label, ir_value *ent, ir_value *field)
1402 /* Support for various pointer types todo if so desired */
1403 if (ent->vtype != TYPE_ENTITY)
1406 if (field->vtype != TYPE_FIELD)
1409 v = ir_block_create_general_instr(self, label, INSTR_ADDRESS, ent, field, TYPE_POINTER);
1410 v->fieldtype = field->fieldtype;
1414 ir_value* ir_block_create_load_from_ent(ir_block *self, const char *label, ir_value *ent, ir_value *field, int outype)
1417 if (ent->vtype != TYPE_ENTITY)
1420 /* at some point we could redirect for TYPE_POINTER... but that could lead to carelessness */
1421 if (field->vtype != TYPE_FIELD)
1426 case TYPE_FLOAT: op = INSTR_LOAD_F; break;
1427 case TYPE_VECTOR: op = INSTR_LOAD_V; break;
1428 case TYPE_STRING: op = INSTR_LOAD_S; break;
1429 case TYPE_FIELD: op = INSTR_LOAD_FLD; break;
1430 case TYPE_ENTITY: op = INSTR_LOAD_ENT; break;
1432 case TYPE_POINTER: op = INSTR_LOAD_I; break;
1433 case TYPE_INTEGER: op = INSTR_LOAD_I; break;
1435 case TYPE_QUATERNION: op = INSTR_LOAD_Q; break;
1436 case TYPE_MATRIX: op = INSTR_LOAD_M; break;
1441 return ir_block_create_general_instr(self, label, op, ent, field, outype);
1444 ir_value* ir_block_create_add(ir_block *self,
1446 ir_value *left, ir_value *right)
1449 int l = left->vtype;
1450 int r = right->vtype;
1469 if ( (l == TYPE_FLOAT && r == TYPE_INTEGER) )
1471 else if ( (l == TYPE_INTEGER && r == TYPE_FLOAT) )
1477 return ir_block_create_binop(self, label, op, left, right);
1480 ir_value* ir_block_create_sub(ir_block *self,
1482 ir_value *left, ir_value *right)
1485 int l = left->vtype;
1486 int r = right->vtype;
1506 if ( (l == TYPE_FLOAT && r == TYPE_INTEGER) )
1508 else if ( (l == TYPE_INTEGER && r == TYPE_FLOAT) )
1514 return ir_block_create_binop(self, label, op, left, right);
1517 ir_value* ir_block_create_mul(ir_block *self,
1519 ir_value *left, ir_value *right)
1522 int l = left->vtype;
1523 int r = right->vtype;
1540 case TYPE_QUATERNION:
1548 if ( (l == TYPE_VECTOR && r == TYPE_FLOAT) )
1550 else if ( (l == TYPE_FLOAT && r == TYPE_VECTOR) )
1552 else if ( (l == TYPE_QUATERNION && r == TYPE_FLOAT) )
1554 else if ( (l == TYPE_MATRIX && r == TYPE_FLOAT) )
1557 else if ( (l == TYPE_VECTOR && r == TYPE_INTEGER) )
1559 else if ( (l == TYPE_INTEGER && r == TYPE_VECTOR) )
1561 else if ( (l == TYPE_FLOAT && r == TYPE_INTEGER) )
1563 else if ( (l == TYPE_INTEGER && r == TYPE_FLOAT) )
1569 return ir_block_create_binop(self, label, op, left, right);
1572 ir_value* ir_block_create_div(ir_block *self,
1574 ir_value *left, ir_value *right)
1577 int l = left->vtype;
1578 int r = right->vtype;
1595 if ( (l == TYPE_VECTOR && r == TYPE_FLOAT) )
1597 else if ( (l == TYPE_FLOAT && r == TYPE_INTEGER) )
1599 else if ( (l == TYPE_INTEGER && r == TYPE_FLOAT) )
1605 return ir_block_create_binop(self, label, op, left, right);
1608 /* PHI resolving breaks the SSA, and must thus be the last
1609 * step before life-range calculation.
1612 static bool ir_block_naive_phi(ir_block *self);
1613 bool ir_function_naive_phi(ir_function *self)
1617 for (i = 0; i < self->blocks_count; ++i)
1619 if (!ir_block_naive_phi(self->blocks[i]))
1625 static bool ir_naive_phi_emit_store(ir_block *block, size_t iid, ir_value *old, ir_value *what)
1630 /* create a store */
1631 if (!ir_block_create_store(block, old, what))
1634 /* we now move it up */
1635 instr = block->instr[block->instr_count-1];
1636 for (i = block->instr_count; i > iid; --i)
1637 block->instr[i] = block->instr[i-1];
1638 block->instr[i] = instr;
1643 static bool ir_block_naive_phi(ir_block *self)
1646 /* FIXME: optionally, create_phi can add the phis
1647 * to a list so we don't need to loop through blocks
1648 * - anyway: "don't optimize YET"
1650 for (i = 0; i < self->instr_count; ++i)
1652 ir_instr *instr = self->instr[i];
1653 if (instr->opcode != VINSTR_PHI)
1656 if (!ir_block_instr_remove(self, i))
1658 --i; /* NOTE: i+1 below */
1660 for (p = 0; p < instr->phi_count; ++p)
1662 ir_value *v = instr->phi[p].value;
1663 for (w = 0; w < v->writes_count; ++w) {
1666 if (!v->writes[w]->_ops[0])
1669 /* When the write was to a global, we have to emit a mov */
1670 old = v->writes[w]->_ops[0];
1672 /* The original instruction now writes to the PHI target local */
1673 if (v->writes[w]->_ops[0] == v)
1674 v->writes[w]->_ops[0] = instr->_ops[0];
1676 if (old->store != store_value && old->store != store_local && old->store != store_param)
1678 /* If it originally wrote to a global we need to store the value
1681 if (!ir_naive_phi_emit_store(self, i+1, old, v))
1683 if (i+1 < self->instr_count)
1684 instr = self->instr[i+1];
1687 /* In case I forget and access instr later, it'll be NULL
1688 * when it's a problem, to make sure we crash, rather than accessing
1694 /* If it didn't, we can replace all reads by the phi target now. */
1696 for (r = 0; r < old->reads_count; ++r)
1699 ir_instr *ri = old->reads[r];
1700 for (op = 0; op < ri->phi_count; ++op) {
1701 if (ri->phi[op].value == old)
1702 ri->phi[op].value = v;
1704 for (op = 0; op < 3; ++op) {
1705 if (ri->_ops[op] == old)
1712 ir_instr_delete(instr);
1717 /***********************************************************************
1718 *IR Temp allocation code
1719 * Propagating value life ranges by walking through the function backwards
1720 * until no more changes are made.
1721 * In theory this should happen once more than once for every nested loop
1723 * Though this implementation might run an additional time for if nests.
1732 MEM_VEC_FUNCTIONS_ALL(new_reads_t, ir_value*, v)
1734 /* Enumerate instructions used by value's life-ranges
1736 static void ir_block_enumerate(ir_block *self, size_t *_eid)
1740 for (i = 0; i < self->instr_count; ++i)
1742 self->instr[i]->eid = eid++;
1747 /* Enumerate blocks and instructions.
1748 * The block-enumeration is unordered!
1749 * We do not really use the block enumreation, however
1750 * the instruction enumeration is important for life-ranges.
1752 void ir_function_enumerate(ir_function *self)
1755 size_t instruction_id = 0;
1756 for (i = 0; i < self->blocks_count; ++i)
1758 self->blocks[i]->eid = i;
1759 self->blocks[i]->run_id = 0;
1760 ir_block_enumerate(self->blocks[i], &instruction_id);
1764 static bool ir_block_life_propagate(ir_block *b, ir_block *prev, bool *changed);
1765 bool ir_function_calculate_liferanges(ir_function *self)
1773 for (i = 0; i != self->blocks_count; ++i)
1775 if (self->blocks[i]->is_return)
1777 if (!ir_block_life_propagate(self->blocks[i], NULL, &changed))
1785 /* Local-value allocator
1786 * After finishing creating the liferange of all values used in a function
1787 * we can allocate their global-positions.
1788 * This is the counterpart to register-allocation in register machines.
1791 MEM_VECTOR_MAKE(ir_value*, locals);
1792 MEM_VECTOR_MAKE(size_t, sizes);
1793 MEM_VECTOR_MAKE(size_t, positions);
1794 } function_allocator;
1795 MEM_VEC_FUNCTIONS(function_allocator, ir_value*, locals)
1796 MEM_VEC_FUNCTIONS(function_allocator, size_t, sizes)
1797 MEM_VEC_FUNCTIONS(function_allocator, size_t, positions)
1799 static bool function_allocator_alloc(function_allocator *alloc, const ir_value *var)
1802 size_t vsize = type_sizeof[var->vtype];
1804 slot = ir_value_var("reg", store_global, var->vtype);
1808 if (!ir_value_life_merge_into(slot, var))
1811 if (!function_allocator_locals_add(alloc, slot))
1814 if (!function_allocator_sizes_add(alloc, vsize))
1820 ir_value_delete(slot);
1824 bool ir_function_allocate_locals(ir_function *self)
1833 function_allocator alloc;
1835 if (!self->locals_count)
1838 MEM_VECTOR_INIT(&alloc, locals);
1839 MEM_VECTOR_INIT(&alloc, sizes);
1840 MEM_VECTOR_INIT(&alloc, positions);
1842 for (i = 0; i < self->locals_count; ++i)
1844 if (!function_allocator_alloc(&alloc, self->locals[i]))
1848 /* Allocate a slot for any value that still exists */
1849 for (i = 0; i < self->values_count; ++i)
1851 v = self->values[i];
1856 for (a = 0; a < alloc.locals_count; ++a)
1858 slot = alloc.locals[a];
1860 if (ir_values_overlap(v, slot))
1863 if (!ir_value_life_merge_into(slot, v))
1866 /* adjust size for this slot */
1867 if (alloc.sizes[a] < type_sizeof[v->vtype])
1868 alloc.sizes[a] = type_sizeof[v->vtype];
1870 self->values[i]->code.local = a;
1873 if (a >= alloc.locals_count) {
1874 self->values[i]->code.local = alloc.locals_count;
1875 if (!function_allocator_alloc(&alloc, v))
1880 /* Adjust slot positions based on sizes */
1881 if (!function_allocator_positions_add(&alloc, 0))
1884 if (alloc.sizes_count)
1885 pos = alloc.positions[0] + alloc.sizes[0];
1888 for (i = 1; i < alloc.sizes_count; ++i)
1890 pos = alloc.positions[i-1] + alloc.sizes[i-1];
1891 if (!function_allocator_positions_add(&alloc, pos))
1895 self->allocated_locals = pos + alloc.sizes[alloc.sizes_count-1];
1897 /* Take over the actual slot positions */
1898 for (i = 0; i < self->values_count; ++i)
1899 self->values[i]->code.local = alloc.positions[self->values[i]->code.local];
1906 for (i = 0; i < alloc.locals_count; ++i)
1907 ir_value_delete(alloc.locals[i]);
1908 MEM_VECTOR_CLEAR(&alloc, locals);
1909 MEM_VECTOR_CLEAR(&alloc, sizes);
1910 MEM_VECTOR_CLEAR(&alloc, positions);
1914 /* Get information about which operand
1915 * is read from, or written to.
1917 static void ir_op_read_write(int op, size_t *read, size_t *write)
1944 static bool ir_block_living_add_instr(ir_block *self, size_t eid)
1947 bool changed = false;
1949 for (i = 0; i != self->living_count; ++i)
1951 tempbool = ir_value_life_merge(self->living[i], eid);
1954 fprintf(stderr, "block_living_add_instr() value instruction added %s: %i\n", self->living[i]->_name, (int)eid);
1956 changed = changed || tempbool;
1961 static bool ir_block_life_prop_previous(ir_block* self, ir_block *prev, bool *changed)
1964 /* values which have been read in a previous iteration are now
1965 * in the "living" array even if the previous block doesn't use them.
1966 * So we have to remove whatever does not exist in the previous block.
1967 * They will be re-added on-read, but the liferange merge won't cause
1970 for (i = 0; i < self->living_count; ++i)
1972 if (!ir_block_living_find(prev, self->living[i], NULL)) {
1973 if (!ir_block_living_remove(self, i))
1979 /* Whatever the previous block still has in its living set
1980 * must now be added to ours as well.
1982 for (i = 0; i < prev->living_count; ++i)
1984 if (ir_block_living_find(self, prev->living[i], NULL))
1986 if (!ir_block_living_add(self, prev->living[i]))
1989 printf("%s got from prev: %s\n", self->label, prev->living[i]->_name);
1995 static bool ir_block_life_propagate(ir_block *self, ir_block *prev, bool *changed)
2001 /* bitmasks which operands are read from or written to */
2003 #if defined(LIFE_RANGE_WITHOUT_LAST_READ)
2005 new_reads_t new_reads;
2007 char dbg_ind[16] = { '#', '0' };
2010 #if defined(LIFE_RANGE_WITHOUT_LAST_READ)
2011 MEM_VECTOR_INIT(&new_reads, v);
2016 if (!ir_block_life_prop_previous(self, prev, changed))
2020 i = self->instr_count;
2023 instr = self->instr[i];
2025 /* PHI operands are always read operands */
2026 for (p = 0; p < instr->phi_count; ++p)
2028 value = instr->phi[p].value;
2029 #if ! defined(LIFE_RANGE_WITHOUT_LAST_READ)
2030 if (!ir_block_living_find(self, value, NULL) &&
2031 !ir_block_living_add(self, value))
2036 if (!new_reads_t_v_find(&new_reads, value, NULL))
2038 if (!new_reads_t_v_add(&new_reads, value))
2044 /* See which operands are read and write operands */
2045 ir_op_read_write(instr->opcode, &read, &write);
2047 /* Go through the 3 main operands */
2048 for (o = 0; o < 3; ++o)
2050 if (!instr->_ops[o]) /* no such operand */
2053 value = instr->_ops[o];
2055 /* We only care about locals */
2056 /* we also calculate parameter liferanges so that locals
2057 * can take up parameter slots */
2058 if (value->store != store_value &&
2059 value->store != store_local &&
2060 value->store != store_param)
2066 #if ! defined(LIFE_RANGE_WITHOUT_LAST_READ)
2067 if (!ir_block_living_find(self, value, NULL) &&
2068 !ir_block_living_add(self, value))
2073 /* fprintf(stderr, "read: %s\n", value->_name); */
2074 if (!new_reads_t_v_find(&new_reads, value, NULL))
2076 if (!new_reads_t_v_add(&new_reads, value))
2082 /* write operands */
2083 /* When we write to a local, we consider it "dead" for the
2084 * remaining upper part of the function, since in SSA a value
2085 * can only be written once (== created)
2090 bool in_living = ir_block_living_find(self, value, &idx);
2091 #if defined(LIFE_RANGE_WITHOUT_LAST_READ)
2093 bool in_reads = new_reads_t_v_find(&new_reads, value, &readidx);
2094 if (!in_living && !in_reads)
2099 /* If the value isn't alive it hasn't been read before... */
2100 /* TODO: See if the warning can be emitted during parsing or AST processing
2101 * otherwise have warning printed here.
2102 * IF printing a warning here: include filecontext_t,
2103 * and make sure it's only printed once
2104 * since this function is run multiple times.
2106 /* For now: debug info: */
2107 fprintf(stderr, "Value only written %s\n", value->name);
2108 tempbool = ir_value_life_merge(value, instr->eid);
2109 *changed = *changed || tempbool;
2111 ir_instr_dump(instr, dbg_ind, printf);
2115 /* since 'living' won't contain it
2116 * anymore, merge the value, since
2119 tempbool = ir_value_life_merge(value, instr->eid);
2122 fprintf(stderr, "value added id %s %i\n", value->name, (int)instr->eid);
2124 *changed = *changed || tempbool;
2126 #if ! defined(LIFE_RANGE_WITHOUT_LAST_READ)
2127 if (!ir_block_living_remove(self, idx))
2132 if (!new_reads_t_v_remove(&new_reads, readidx))
2140 tempbool = ir_block_living_add_instr(self, instr->eid);
2141 /*fprintf(stderr, "living added values\n");*/
2142 *changed = *changed || tempbool;
2144 #if defined(LIFE_RANGE_WITHOUT_LAST_READ)
2146 for (rd = 0; rd < new_reads.v_count; ++rd)
2148 if (!ir_block_living_find(self, new_reads.v[rd], NULL)) {
2149 if (!ir_block_living_add(self, new_reads.v[rd]))
2152 if (!i && !self->entries_count) {
2154 *changed = *changed || ir_value_life_merge(new_reads.v[rd], instr->eid);
2157 MEM_VECTOR_CLEAR(&new_reads, v);
2161 if (self->run_id == self->owner->run_id)
2164 self->run_id = self->owner->run_id;
2166 for (i = 0; i < self->entries_count; ++i)
2168 ir_block *entry = self->entries[i];
2169 ir_block_life_propagate(entry, self, changed);
2174 #if defined(LIFE_RANGE_WITHOUT_LAST_READ)
2175 MEM_VECTOR_CLEAR(&new_reads, v);
2180 /***********************************************************************
2183 * Since the IR has the convention of putting 'write' operands
2184 * at the beginning, we have to rotate the operands of instructions
2185 * properly in order to generate valid QCVM code.
2187 * Having destinations at a fixed position is more convenient. In QC
2188 * this is *mostly* OPC, but FTE adds at least 2 instructions which
2189 * read from from OPA, and store to OPB rather than OPC. Which is
2190 * partially the reason why the implementation of these instructions
2191 * in darkplaces has been delayed for so long.
2193 * Breaking conventions is annoying...
2195 static bool ir_builder_gen_global(ir_builder *self, ir_value *global);
2197 static bool gen_global_field(ir_value *global)
2199 if (global->isconst)
2201 ir_value *fld = global->constval.vpointer;
2203 printf("Invalid field constant with no field: %s\n", global->name);
2207 /* Now, in this case, a relocation would be impossible to code
2208 * since it looks like this:
2209 * .vector v = origin; <- parse error, wtf is 'origin'?
2212 * But we will need a general relocation support later anyway
2213 * for functions... might as well support that here.
2215 if (!fld->code.globaladdr) {
2216 printf("FIXME: Relocation support\n");
2220 /* copy the field's value */
2221 ir_value_code_setaddr(global, code_globals_add(code_globals_data[fld->code.globaladdr]));
2222 if (global->fieldtype == TYPE_VECTOR) {
2223 code_globals_add(code_globals_data[fld->code.globaladdr]+1);
2224 code_globals_add(code_globals_data[fld->code.globaladdr]+2);
2229 ir_value_code_setaddr(global, code_globals_add(0));
2230 if (global->fieldtype == TYPE_VECTOR) {
2231 code_globals_add(0);
2232 code_globals_add(0);
2235 if (global->code.globaladdr < 0)
2240 static bool gen_global_pointer(ir_value *global)
2242 if (global->isconst)
2244 ir_value *target = global->constval.vpointer;
2246 printf("Invalid pointer constant: %s\n", global->name);
2247 /* NULL pointers are pointing to the NULL constant, which also
2248 * sits at address 0, but still has an ir_value for itself.
2253 /* Here, relocations ARE possible - in fteqcc-enhanced-qc:
2254 * void() foo; <- proto
2255 * void() *fooptr = &foo;
2256 * void() foo = { code }
2258 if (!target->code.globaladdr) {
2259 /* FIXME: Check for the constant nullptr ir_value!
2260 * because then code.globaladdr being 0 is valid.
2262 printf("FIXME: Relocation support\n");
2266 ir_value_code_setaddr(global, code_globals_add(target->code.globaladdr));
2270 ir_value_code_setaddr(global, code_globals_add(0));
2272 if (global->code.globaladdr < 0)
2277 static bool gen_blocks_recursive(ir_function *func, ir_block *block)
2279 prog_section_statement stmt;
2288 block->generated = true;
2289 block->code_start = code_statements_elements;
2290 for (i = 0; i < block->instr_count; ++i)
2292 instr = block->instr[i];
2294 if (instr->opcode == VINSTR_PHI) {
2295 printf("cannot generate virtual instruction (phi)\n");
2299 if (instr->opcode == VINSTR_JUMP) {
2300 target = instr->bops[0];
2301 /* for uncoditional jumps, if the target hasn't been generated
2302 * yet, we generate them right here.
2304 if (!target->generated) {
2309 /* otherwise we generate a jump instruction */
2310 stmt.opcode = INSTR_GOTO;
2311 stmt.o1.s1 = (target->code_start) - code_statements_elements;
2314 if (code_statements_add(stmt) < 0)
2317 /* no further instructions can be in this block */
2321 if (instr->opcode == VINSTR_COND) {
2322 ontrue = instr->bops[0];
2323 onfalse = instr->bops[1];
2324 /* TODO: have the AST signal which block should
2325 * come first: eg. optimize IFs without ELSE...
2328 stmt.o1.u1 = ir_value_code_addr(instr->_ops[0]);
2332 if (ontrue->generated) {
2333 stmt.opcode = INSTR_IF;
2334 stmt.o2.s1 = (ontrue->code_start-1) - code_statements_elements;
2335 if (code_statements_add(stmt) < 0)
2338 if (onfalse->generated) {
2339 stmt.opcode = INSTR_IFNOT;
2340 stmt.o2.s1 = (onfalse->code_start-1) - code_statements_elements;
2341 if (code_statements_add(stmt) < 0)
2344 if (!ontrue->generated) {
2345 if (onfalse->generated) {
2350 if (!onfalse->generated) {
2351 if (ontrue->generated) {
2356 /* neither ontrue nor onfalse exist */
2357 stmt.opcode = INSTR_IFNOT;
2358 stidx = code_statements_elements;
2359 if (code_statements_add(stmt) < 0)
2361 /* on false we jump, so add ontrue-path */
2362 if (!gen_blocks_recursive(func, ontrue))
2364 /* fixup the jump address */
2365 code_statements_data[stidx].o2.s1 = code_statements_elements - stidx;
2366 /* generate onfalse path */
2367 if (onfalse->generated) {
2368 /* fixup the jump address */
2369 code_statements_data[stidx].o2.s1 = (onfalse->code_start) - (stidx);
2370 /* may have been generated in the previous recursive call */
2371 stmt.opcode = INSTR_GOTO;
2372 stmt.o1.s1 = (onfalse->code_start) - code_statements_elements;
2375 return (code_statements_add(stmt) >= 0);
2377 /* if not, generate now */
2382 if (instr->opcode >= INSTR_CALL0 && instr->opcode <= INSTR_CALL8) {
2383 /* Trivial call translation:
2384 * copy all params to OFS_PARM*
2385 * if the output's storetype is not store_return,
2386 * add append a STORE instruction!
2388 * NOTES on how to do it better without much trouble:
2389 * -) The liferanges!
2390 * Simply check the liferange of all parameters for
2391 * other CALLs. For each param with no CALL in its
2392 * liferange, we can store it in an OFS_PARM at
2393 * generation already. This would even include later
2394 * reuse.... probably... :)
2399 for (p = 0; p < instr->params_count; ++p)
2401 ir_value *param = instr->params[p];
2403 stmt.opcode = INSTR_STORE_F;
2406 stmt.opcode = type_store_instr[param->vtype];
2407 stmt.o1.u1 = ir_value_code_addr(param);
2408 stmt.o2.u1 = OFS_PARM0 + 3 * p;
2409 if (code_statements_add(stmt) < 0)
2412 stmt.opcode = INSTR_CALL0 + instr->params_count;
2413 if (stmt.opcode > INSTR_CALL8)
2414 stmt.opcode = INSTR_CALL8;
2415 stmt.o1.u1 = ir_value_code_addr(instr->_ops[1]);
2418 if (code_statements_add(stmt) < 0)
2421 retvalue = instr->_ops[0];
2422 if (retvalue && retvalue->store != store_return && retvalue->life_count)
2424 /* not to be kept in OFS_RETURN */
2425 stmt.opcode = type_store_instr[retvalue->vtype];
2426 stmt.o1.u1 = OFS_RETURN;
2427 stmt.o2.u1 = ir_value_code_addr(retvalue);
2429 if (code_statements_add(stmt) < 0)
2435 if (instr->opcode == INSTR_STATE) {
2436 printf("TODO: state instruction\n");
2440 stmt.opcode = instr->opcode;
2445 /* This is the general order of operands */
2447 stmt.o3.u1 = ir_value_code_addr(instr->_ops[0]);
2450 stmt.o1.u1 = ir_value_code_addr(instr->_ops[1]);
2453 stmt.o2.u1 = ir_value_code_addr(instr->_ops[2]);
2455 if (stmt.opcode == INSTR_RETURN || stmt.opcode == INSTR_DONE)
2457 stmt.o1.u1 = stmt.o3.u1;
2460 else if ((stmt.opcode >= INSTR_STORE_F &&
2461 stmt.opcode <= INSTR_STORE_FNC) ||
2462 (stmt.opcode >= INSTR_STOREP_F &&
2463 stmt.opcode <= INSTR_STOREP_FNC))
2465 /* 2-operand instructions with A -> B */
2466 stmt.o2.u1 = stmt.o3.u1;
2470 if (code_statements_add(stmt) < 0)
2476 static bool gen_function_code(ir_function *self)
2479 prog_section_statement stmt;
2481 /* Starting from entry point, we generate blocks "as they come"
2482 * for now. Dead blocks will not be translated obviously.
2484 if (!self->blocks_count) {
2485 printf("Function '%s' declared without body.\n", self->name);
2489 block = self->blocks[0];
2490 if (block->generated)
2493 if (!gen_blocks_recursive(self, block)) {
2494 printf("failed to generate blocks for '%s'\n", self->name);
2498 /* otherwise code_write crashes since it debug-prints functions until AINSTR_END */
2499 stmt.opcode = AINSTR_END;
2503 if (code_statements_add(stmt) < 0)
2508 static bool gen_global_function(ir_builder *ir, ir_value *global)
2510 prog_section_function fun;
2514 size_t local_var_end;
2516 if (!global->isconst || (!global->constval.vfunc))
2518 printf("Invalid state of function-global: not constant: %s\n", global->name);
2522 irfun = global->constval.vfunc;
2524 fun.name = global->code.name;
2525 fun.file = code_cachedstring(global->context.file);
2526 fun.profile = 0; /* always 0 */
2527 fun.nargs = irfun->params_count;
2529 for (i = 0;i < 8; ++i) {
2533 fun.argsize[i] = type_sizeof[irfun->params[i]];
2536 fun.firstlocal = code_globals_elements;
2537 fun.locals = irfun->allocated_locals + irfun->locals_count;
2540 for (i = 0; i < irfun->locals_count; ++i) {
2541 if (!ir_builder_gen_global(ir, irfun->locals[i])) {
2542 printf("Failed to generate global %s\n", irfun->locals[i]->name);
2546 if (irfun->locals_count) {
2547 ir_value *last = irfun->locals[irfun->locals_count-1];
2548 local_var_end = last->code.globaladdr;
2549 local_var_end += type_sizeof[last->vtype];
2551 for (i = 0; i < irfun->values_count; ++i)
2553 /* generate code.globaladdr for ssa values */
2554 ir_value *v = irfun->values[i];
2555 ir_value_code_setaddr(v, local_var_end + v->code.local);
2557 for (i = 0; i < irfun->locals_count; ++i) {
2558 /* fill the locals with zeros */
2559 code_globals_add(0);
2563 fun.entry = irfun->builtin;
2565 fun.entry = code_statements_elements;
2566 if (!gen_function_code(irfun)) {
2567 printf("Failed to generate code for function %s\n", irfun->name);
2572 return (code_functions_add(fun) >= 0);
2575 static bool ir_builder_gen_global(ir_builder *self, ir_value *global)
2579 prog_section_def def;
2581 def.type = global->vtype;
2582 def.offset = code_globals_elements;
2583 def.name = global->code.name = code_genstring(global->name);
2585 switch (global->vtype)
2588 if (code_defs_add(def) < 0)
2590 return gen_global_pointer(global);
2592 if (code_defs_add(def) < 0)
2594 return gen_global_field(global);
2599 if (code_defs_add(def) < 0)
2602 if (global->isconst) {
2603 iptr = (int32_t*)&global->constval.vfloat;
2604 ir_value_code_setaddr(global, code_globals_add(*iptr));
2606 ir_value_code_setaddr(global, code_globals_add(0));
2608 return global->code.globaladdr >= 0;
2612 if (code_defs_add(def) < 0)
2614 if (global->isconst)
2615 ir_value_code_setaddr(global, code_globals_add(code_cachedstring(global->constval.vstring)));
2617 ir_value_code_setaddr(global, code_globals_add(0));
2618 return global->code.globaladdr >= 0;
2621 case TYPE_QUATERNION:
2625 if (code_defs_add(def) < 0)
2628 if (global->isconst) {
2629 iptr = (int32_t*)&global->constval.vvec;
2630 ir_value_code_setaddr(global, code_globals_add(iptr[0]));
2631 if (global->code.globaladdr < 0)
2633 for (d = 1; d < type_sizeof[global->vtype]; ++d)
2635 if (code_globals_add(iptr[d]) < 0)
2639 ir_value_code_setaddr(global, code_globals_add(0));
2640 if (global->code.globaladdr < 0)
2642 for (d = 1; d < type_sizeof[global->vtype]; ++d)
2644 if (code_globals_add(0) < 0)
2648 return global->code.globaladdr >= 0;
2651 if (code_defs_add(def) < 0)
2653 ir_value_code_setaddr(global, code_globals_elements);
2654 code_globals_add(code_functions_elements);
2655 return gen_global_function(self, global);
2657 /* assume biggest type */
2658 ir_value_code_setaddr(global, code_globals_add(0));
2659 for (i = 1; i < type_sizeof[TYPE_VARIANT]; ++i)
2660 code_globals_add(0);
2663 /* refuse to create 'void' type or any other fancy business. */
2664 printf("Invalid type for global variable %s\n", global->name);
2669 static bool ir_builder_gen_field(ir_builder *self, ir_value *field)
2671 prog_section_def def;
2672 prog_section_field fld;
2674 def.type = field->vtype;
2675 def.offset = code_globals_elements;
2677 /* create a global named the same as the field */
2678 if (opts_standard == COMPILER_GMQCC) {
2679 /* in our standard, the global gets a dot prefix */
2680 size_t len = strlen(field->name);
2683 /* we really don't want to have to allocate this, and 1024
2684 * bytes is more than enough for a variable/field name
2686 if (len+2 >= sizeof(name)) {
2687 printf("invalid field name size: %u\n", (unsigned int)len);
2692 strcpy(name+1, field->name); /* no strncpy - we used strlen above */
2695 def.name = code_genstring(name);
2696 fld.name = def.name + 1; /* we reuse that string table entry */
2698 /* in plain QC, there cannot be a global with the same name,
2699 * and so we also name the global the same.
2700 * FIXME: fteqcc should create a global as well
2701 * check if it actually uses the same name. Probably does
2703 def.name = code_genstring(field->name);
2704 fld.name = def.name;
2707 field->code.name = def.name;
2709 if (code_defs_add(def) < 0)
2712 fld.type = field->fieldtype;
2714 if (fld.type == TYPE_VOID) {
2715 printf("field is missing a type: %s - don't know its size\n", field->name);
2719 fld.offset = code_alloc_field(type_sizeof[field->fieldtype]);
2721 if (code_fields_add(fld) < 0)
2724 ir_value_code_setaddr(field, code_globals_elements);
2725 if (!code_globals_add(fld.offset))
2727 if (fld.type == TYPE_VECTOR) {
2728 if (!code_globals_add(fld.offset+1))
2730 if (!code_globals_add(fld.offset+2))
2734 return field->code.globaladdr >= 0;
2737 bool ir_builder_generate(ir_builder *self, const char *filename)
2743 for (i = 0; i < self->fields_count; ++i)
2745 if (!ir_builder_gen_field(self, self->fields[i])) {
2750 for (i = 0; i < self->globals_count; ++i)
2752 if (!ir_builder_gen_global(self, self->globals[i])) {
2757 printf("writing '%s'...\n", filename);
2758 return code_write(filename);
2761 /***********************************************************************
2762 *IR DEBUG Dump functions...
2765 #define IND_BUFSZ 1024
2767 const char *qc_opname(int op)
2769 if (op < 0) return "<INVALID>";
2770 if (op < ( sizeof(asm_instr) / sizeof(asm_instr[0]) ))
2771 return asm_instr[op].m;
2773 case VINSTR_PHI: return "PHI";
2774 case VINSTR_JUMP: return "JUMP";
2775 case VINSTR_COND: return "COND";
2776 default: return "<UNK>";
2780 void ir_builder_dump(ir_builder *b, int (*oprintf)(const char*, ...))
2783 char indent[IND_BUFSZ];
2787 oprintf("module %s\n", b->name);
2788 for (i = 0; i < b->globals_count; ++i)
2791 if (b->globals[i]->isconst)
2792 oprintf("%s = ", b->globals[i]->name);
2793 ir_value_dump(b->globals[i], oprintf);
2796 for (i = 0; i < b->functions_count; ++i)
2797 ir_function_dump(b->functions[i], indent, oprintf);
2798 oprintf("endmodule %s\n", b->name);
2801 void ir_function_dump(ir_function *f, char *ind,
2802 int (*oprintf)(const char*, ...))
2805 if (f->builtin != 0) {
2806 oprintf("%sfunction %s = builtin %i\n", ind, f->name, -f->builtin);
2809 oprintf("%sfunction %s\n", ind, f->name);
2810 strncat(ind, "\t", IND_BUFSZ);
2811 if (f->locals_count)
2813 oprintf("%s%i locals:\n", ind, (int)f->locals_count);
2814 for (i = 0; i < f->locals_count; ++i) {
2815 oprintf("%s\t", ind);
2816 ir_value_dump(f->locals[i], oprintf);
2820 if (f->blocks_count)
2822 oprintf("%slife passes (check): %i\n", ind, (int)f->run_id);
2823 for (i = 0; i < f->blocks_count; ++i) {
2824 if (f->blocks[i]->run_id != f->run_id) {
2825 oprintf("%slife pass check fail! %i != %i\n", ind, (int)f->blocks[i]->run_id, (int)f->run_id);
2827 ir_block_dump(f->blocks[i], ind, oprintf);
2831 ind[strlen(ind)-1] = 0;
2832 oprintf("%sendfunction %s\n", ind, f->name);
2835 void ir_block_dump(ir_block* b, char *ind,
2836 int (*oprintf)(const char*, ...))
2839 oprintf("%s:%s\n", ind, b->label);
2840 strncat(ind, "\t", IND_BUFSZ);
2842 for (i = 0; i < b->instr_count; ++i)
2843 ir_instr_dump(b->instr[i], ind, oprintf);
2844 ind[strlen(ind)-1] = 0;
2847 void dump_phi(ir_instr *in, char *ind,
2848 int (*oprintf)(const char*, ...))
2851 oprintf("%s <- phi ", in->_ops[0]->name);
2852 for (i = 0; i < in->phi_count; ++i)
2854 oprintf("([%s] : %s) ", in->phi[i].from->label,
2855 in->phi[i].value->name);
2860 void ir_instr_dump(ir_instr *in, char *ind,
2861 int (*oprintf)(const char*, ...))
2864 const char *comma = NULL;
2866 oprintf("%s (%i) ", ind, (int)in->eid);
2868 if (in->opcode == VINSTR_PHI) {
2869 dump_phi(in, ind, oprintf);
2873 strncat(ind, "\t", IND_BUFSZ);
2875 if (in->_ops[0] && (in->_ops[1] || in->_ops[2])) {
2876 ir_value_dump(in->_ops[0], oprintf);
2877 if (in->_ops[1] || in->_ops[2])
2880 if (in->opcode == INSTR_CALL0) {
2881 oprintf("CALL%i\t", in->params_count);
2883 oprintf("%s\t", qc_opname(in->opcode));
2885 if (in->_ops[0] && !(in->_ops[1] || in->_ops[2])) {
2886 ir_value_dump(in->_ops[0], oprintf);
2891 for (i = 1; i != 3; ++i) {
2895 ir_value_dump(in->_ops[i], oprintf);
2903 oprintf("[%s]", in->bops[0]->label);
2907 oprintf("%s[%s]", comma, in->bops[1]->label);
2909 ind[strlen(ind)-1] = 0;
2912 void ir_value_dump(ir_value* v, int (*oprintf)(const char*, ...))
2921 oprintf("(function)");
2924 oprintf("%g", v->constval.vfloat);
2927 oprintf("'%g %g %g'",
2930 v->constval.vvec.z);
2933 oprintf("(entity)");
2936 oprintf("\"%s\"", v->constval.vstring);
2940 oprintf("%i", v->constval.vint);
2945 v->constval.vpointer->name);
2949 oprintf("%s", v->name);
2953 void ir_value_dump_life(ir_value *self, int (*oprintf)(const char*,...))
2956 oprintf("Life of %s:\n", self->name);
2957 for (i = 0; i < self->life_count; ++i)
2959 oprintf(" + [%i, %i]\n", self->life[i].start, self->life[i].end);