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] = {
48 size_t type_sizeof[TYPE_COUNT] = {
55 1, /* TYPE_FUNCTION */
64 uint16_t type_store_instr[TYPE_COUNT] = {
65 INSTR_STORE_F, /* should use I when having integer support */
72 INSTR_STORE_ENT, /* should use I */
74 INSTR_STORE_I, /* integer type */
79 INSTR_STORE_V, /* variant, should never be accessed */
81 AINSTR_END, /* struct */
82 AINSTR_END, /* union */
83 AINSTR_END, /* array */
86 uint16_t field_store_instr[TYPE_COUNT] = {
96 INSTR_STORE_FLD, /* integer type */
101 INSTR_STORE_V, /* variant, should never be accessed */
103 AINSTR_END, /* struct */
104 AINSTR_END, /* union */
105 AINSTR_END, /* array */
108 uint16_t type_storep_instr[TYPE_COUNT] = {
109 INSTR_STOREP_F, /* should use I when having integer support */
116 INSTR_STOREP_ENT, /* should use I */
118 INSTR_STOREP_ENT, /* integer type */
123 INSTR_STOREP_V, /* variant, should never be accessed */
125 AINSTR_END, /* struct */
126 AINSTR_END, /* union */
127 AINSTR_END, /* array */
130 uint16_t type_eq_instr[TYPE_COUNT] = {
131 INSTR_EQ_F, /* should use I when having integer support */
136 INSTR_EQ_E, /* FLD has no comparison */
138 INSTR_EQ_E, /* should use I */
145 INSTR_EQ_V, /* variant, should never be accessed */
147 AINSTR_END, /* struct */
148 AINSTR_END, /* union */
149 AINSTR_END, /* array */
152 uint16_t type_ne_instr[TYPE_COUNT] = {
153 INSTR_NE_F, /* should use I when having integer support */
158 INSTR_NE_E, /* FLD has no comparison */
160 INSTR_NE_E, /* should use I */
167 INSTR_NE_V, /* variant, should never be accessed */
169 AINSTR_END, /* struct */
170 AINSTR_END, /* union */
171 AINSTR_END, /* array */
174 static void irerror(lex_ctx ctx, const char *msg, ...)
178 con_cvprintmsg((void*)&ctx, LVL_ERROR, "internal error", msg, ap);
182 static bool irwarning(lex_ctx ctx, int warntype, const char *fmt, ...)
185 int lvl = LVL_WARNING;
187 if (warntype && !OPTS_WARN(warntype))
194 con_vprintmsg(lvl, ctx.file, ctx.line, "warning", fmt, ap);
200 /***********************************************************************
201 * Vector utility functions
204 bool GMQCC_WARN vec_ir_value_find(ir_value **vec, ir_value *what, size_t *idx)
207 size_t len = vec_size(vec);
208 for (i = 0; i < len; ++i) {
209 if (vec[i] == what) {
217 bool GMQCC_WARN vec_ir_block_find(ir_block **vec, ir_block *what, size_t *idx)
220 size_t len = vec_size(vec);
221 for (i = 0; i < len; ++i) {
222 if (vec[i] == what) {
230 bool GMQCC_WARN vec_ir_instr_find(ir_instr **vec, ir_instr *what, size_t *idx)
233 size_t len = vec_size(vec);
234 for (i = 0; i < len; ++i) {
235 if (vec[i] == what) {
243 /***********************************************************************
247 static void ir_block_delete_quick(ir_block* self);
248 static void ir_instr_delete_quick(ir_instr *self);
249 static void ir_function_delete_quick(ir_function *self);
251 ir_builder* ir_builder_new(const char *modulename)
255 self = (ir_builder*)mem_a(sizeof(*self));
259 self->functions = NULL;
260 self->globals = NULL;
262 self->extparams = NULL;
263 self->filenames = NULL;
264 self->filestrings = NULL;
266 self->str_immediate = 0;
268 if (!ir_builder_set_name(self, modulename)) {
276 void ir_builder_delete(ir_builder* self)
279 mem_d((void*)self->name);
280 for (i = 0; i != vec_size(self->functions); ++i) {
281 ir_function_delete_quick(self->functions[i]);
283 vec_free(self->functions);
284 for (i = 0; i != vec_size(self->extparams); ++i) {
285 ir_value_delete(self->extparams[i]);
287 vec_free(self->extparams);
288 for (i = 0; i != vec_size(self->globals); ++i) {
289 ir_value_delete(self->globals[i]);
291 vec_free(self->globals);
292 for (i = 0; i != vec_size(self->fields); ++i) {
293 ir_value_delete(self->fields[i]);
295 vec_free(self->fields);
296 vec_free(self->filenames);
297 vec_free(self->filestrings);
301 bool ir_builder_set_name(ir_builder *self, const char *name)
304 mem_d((void*)self->name);
305 self->name = util_strdup(name);
309 ir_function* ir_builder_get_function(ir_builder *self, const char *name)
312 for (i = 0; i < vec_size(self->functions); ++i) {
313 if (!strcmp(name, self->functions[i]->name))
314 return self->functions[i];
319 ir_function* ir_builder_create_function(ir_builder *self, const char *name, int outtype)
321 ir_function *fn = ir_builder_get_function(self, name);
326 fn = ir_function_new(self, outtype);
327 if (!ir_function_set_name(fn, name))
329 ir_function_delete(fn);
332 vec_push(self->functions, fn);
334 fn->value = ir_builder_create_global(self, fn->name, TYPE_FUNCTION);
336 ir_function_delete(fn);
340 fn->value->isconst = true;
341 fn->value->outtype = outtype;
342 fn->value->constval.vfunc = fn;
343 fn->value->context = fn->context;
348 ir_value* ir_builder_get_global(ir_builder *self, const char *name)
351 for (i = 0; i < vec_size(self->globals); ++i) {
352 if (!strcmp(self->globals[i]->name, name))
353 return self->globals[i];
358 ir_value* ir_builder_create_global(ir_builder *self, const char *name, int vtype)
362 if (name && name[0] != '#')
364 ve = ir_builder_get_global(self, name);
370 ve = ir_value_var(name, store_global, vtype);
371 vec_push(self->globals, ve);
375 ir_value* ir_builder_get_field(ir_builder *self, const char *name)
378 for (i = 0; i < vec_size(self->fields); ++i) {
379 if (!strcmp(self->fields[i]->name, name))
380 return self->fields[i];
386 ir_value* ir_builder_create_field(ir_builder *self, const char *name, int vtype)
388 ir_value *ve = ir_builder_get_field(self, name);
393 ve = ir_value_var(name, store_global, TYPE_FIELD);
394 ve->fieldtype = vtype;
395 vec_push(self->fields, ve);
399 /***********************************************************************
403 bool ir_function_naive_phi(ir_function*);
404 void ir_function_enumerate(ir_function*);
405 bool ir_function_calculate_liferanges(ir_function*);
406 bool ir_function_allocate_locals(ir_function*);
408 ir_function* ir_function_new(ir_builder* owner, int outtype)
411 self = (ir_function*)mem_a(sizeof(*self));
416 memset(self, 0, sizeof(*self));
419 if (!ir_function_set_name(self, "<@unnamed>")) {
424 self->context.file = "<@no context>";
425 self->context.line = 0;
426 self->outtype = outtype;
435 self->max_parameters = 0;
437 self->code_function_def = -1;
438 self->allocated_locals = 0;
444 bool ir_function_set_name(ir_function *self, const char *name)
447 mem_d((void*)self->name);
448 self->name = util_strdup(name);
452 static void ir_function_delete_quick(ir_function *self)
455 mem_d((void*)self->name);
457 for (i = 0; i != vec_size(self->blocks); ++i)
458 ir_block_delete_quick(self->blocks[i]);
459 vec_free(self->blocks);
461 vec_free(self->params);
463 for (i = 0; i != vec_size(self->values); ++i)
464 ir_value_delete(self->values[i]);
465 vec_free(self->values);
467 for (i = 0; i != vec_size(self->locals); ++i)
468 ir_value_delete(self->locals[i]);
469 vec_free(self->locals);
471 /* self->value is deleted by the builder */
476 void ir_function_delete(ir_function *self)
479 mem_d((void*)self->name);
481 for (i = 0; i != vec_size(self->blocks); ++i)
482 ir_block_delete(self->blocks[i]);
483 vec_free(self->blocks);
485 vec_free(self->params);
487 for (i = 0; i != vec_size(self->values); ++i)
488 ir_value_delete(self->values[i]);
489 vec_free(self->values);
491 for (i = 0; i != vec_size(self->locals); ++i)
492 ir_value_delete(self->locals[i]);
493 vec_free(self->locals);
495 /* self->value is deleted by the builder */
500 void ir_function_collect_value(ir_function *self, ir_value *v)
502 vec_push(self->values, v);
505 ir_block* ir_function_create_block(ir_function *self, const char *label)
507 ir_block* bn = ir_block_new(self, label);
508 memcpy(&bn->context, &self->context, sizeof(self->context));
509 vec_push(self->blocks, bn);
513 bool ir_function_finalize(ir_function *self)
518 if (!ir_function_naive_phi(self))
521 ir_function_enumerate(self);
523 if (!ir_function_calculate_liferanges(self))
526 if (!ir_function_allocate_locals(self))
531 ir_value* ir_function_get_local(ir_function *self, const char *name)
534 for (i = 0; i < vec_size(self->locals); ++i) {
535 if (!strcmp(self->locals[i]->name, name))
536 return self->locals[i];
541 ir_value* ir_function_create_local(ir_function *self, const char *name, int vtype, bool param)
546 if (ir_function_get_local(self, name))
551 vec_size(self->locals) &&
552 self->locals[vec_size(self->locals)-1]->store != store_param) {
553 irerror(self->context, "cannot add parameters after adding locals");
557 ve = ir_value_var(name, (param ? store_param : store_local), vtype);
558 vec_push(self->locals, ve);
562 /***********************************************************************
566 ir_block* ir_block_new(ir_function* owner, const char *name)
569 self = (ir_block*)mem_a(sizeof(*self));
573 memset(self, 0, sizeof(*self));
576 if (name && !ir_block_set_label(self, name)) {
581 self->context.file = "<@no context>";
582 self->context.line = 0;
586 self->entries = NULL;
590 self->is_return = false;
595 self->generated = false;
600 static void ir_block_delete_quick(ir_block* self)
603 if (self->label) mem_d(self->label);
604 for (i = 0; i != vec_size(self->instr); ++i)
605 ir_instr_delete_quick(self->instr[i]);
606 vec_free(self->instr);
607 vec_free(self->entries);
608 vec_free(self->exits);
609 vec_free(self->living);
613 void ir_block_delete(ir_block* self)
616 if (self->label) mem_d(self->label);
617 for (i = 0; i != vec_size(self->instr); ++i)
618 ir_instr_delete(self->instr[i]);
619 vec_free(self->instr);
620 vec_free(self->entries);
621 vec_free(self->exits);
622 vec_free(self->living);
626 bool ir_block_set_label(ir_block *self, const char *name)
629 mem_d((void*)self->label);
630 self->label = util_strdup(name);
631 return !!self->label;
634 /***********************************************************************
638 ir_instr* ir_instr_new(ir_block* owner, int op)
641 self = (ir_instr*)mem_a(sizeof(*self));
646 self->context.file = "<@no context>";
647 self->context.line = 0;
649 self->_ops[0] = NULL;
650 self->_ops[1] = NULL;
651 self->_ops[2] = NULL;
652 self->bops[0] = NULL;
653 self->bops[1] = NULL;
662 static void ir_instr_delete_quick(ir_instr *self)
665 vec_free(self->params);
669 void ir_instr_delete(ir_instr *self)
672 /* The following calls can only delete from
673 * vectors, we still want to delete this instruction
674 * so ignore the return value. Since with the warn_unused_result attribute
675 * gcc doesn't care about an explicit: (void)foo(); to ignore the result,
676 * I have to improvise here and use if(foo());
678 for (i = 0; i < vec_size(self->phi); ++i) {
680 if (vec_ir_instr_find(self->phi[i].value->writes, self, &idx))
681 vec_remove(self->phi[i].value->writes, idx, 1);
682 if (vec_ir_instr_find(self->phi[i].value->reads, self, &idx))
683 vec_remove(self->phi[i].value->reads, idx, 1);
686 for (i = 0; i < vec_size(self->params); ++i) {
688 if (vec_ir_instr_find(self->params[i]->writes, self, &idx))
689 vec_remove(self->params[i]->writes, idx, 1);
690 if (vec_ir_instr_find(self->params[i]->reads, self, &idx))
691 vec_remove(self->params[i]->reads, idx, 1);
693 vec_free(self->params);
694 (void)!ir_instr_op(self, 0, NULL, false);
695 (void)!ir_instr_op(self, 1, NULL, false);
696 (void)!ir_instr_op(self, 2, NULL, false);
700 bool ir_instr_op(ir_instr *self, int op, ir_value *v, bool writing)
702 if (self->_ops[op]) {
704 if (writing && vec_ir_instr_find(self->_ops[op]->writes, self, &idx))
705 vec_remove(self->_ops[op]->writes, idx, 1);
706 else if (vec_ir_instr_find(self->_ops[op]->reads, self, &idx))
707 vec_remove(self->_ops[op]->reads, idx, 1);
711 vec_push(v->writes, self);
713 vec_push(v->reads, self);
719 /***********************************************************************
723 void ir_value_code_setaddr(ir_value *self, int32_t gaddr)
725 self->code.globaladdr = gaddr;
726 if (self->members[0]) self->members[0]->code.globaladdr = gaddr;
727 if (self->members[1]) self->members[1]->code.globaladdr = gaddr;
728 if (self->members[2]) self->members[2]->code.globaladdr = gaddr;
731 int32_t ir_value_code_addr(const ir_value *self)
733 if (self->store == store_return)
734 return OFS_RETURN + self->code.addroffset;
735 return self->code.globaladdr + self->code.addroffset;
738 ir_value* ir_value_var(const char *name, int storetype, int vtype)
741 self = (ir_value*)mem_a(sizeof(*self));
743 self->fieldtype = TYPE_VOID;
744 self->outtype = TYPE_VOID;
745 self->store = storetype;
750 self->isconst = false;
751 self->context.file = "<@no context>";
752 self->context.line = 0;
754 if (name && !ir_value_set_name(self, name)) {
755 irerror(self->context, "out of memory");
760 memset(&self->constval, 0, sizeof(self->constval));
761 memset(&self->code, 0, sizeof(self->code));
763 self->members[0] = NULL;
764 self->members[1] = NULL;
765 self->members[2] = NULL;
766 self->memberof = NULL;
772 ir_value* ir_value_vector_member(ir_value *self, unsigned int member)
778 if (self->members[member])
779 return self->members[member];
781 if (self->vtype == TYPE_VECTOR)
783 m = ir_value_var(self->name, self->store, TYPE_FLOAT);
786 m->context = self->context;
788 self->members[member] = m;
789 m->code.addroffset = member;
791 else if (self->vtype == TYPE_FIELD)
793 if (self->fieldtype != TYPE_VECTOR)
795 m = ir_value_var(self->name, self->store, TYPE_FIELD);
798 m->fieldtype = TYPE_FLOAT;
799 m->context = self->context;
801 self->members[member] = m;
802 m->code.addroffset = member;
806 irerror(self->context, "invalid member access on %s", self->name);
814 ir_value* ir_value_out(ir_function *owner, const char *name, int storetype, int vtype)
816 ir_value *v = ir_value_var(name, storetype, vtype);
819 ir_function_collect_value(owner, v);
823 void ir_value_delete(ir_value* self)
827 mem_d((void*)self->name);
830 if (self->vtype == TYPE_STRING)
831 mem_d((void*)self->constval.vstring);
833 for (i = 0; i < 3; ++i) {
834 if (self->members[i])
835 ir_value_delete(self->members[i]);
837 vec_free(self->reads);
838 vec_free(self->writes);
839 vec_free(self->life);
843 bool ir_value_set_name(ir_value *self, const char *name)
846 mem_d((void*)self->name);
847 self->name = util_strdup(name);
851 bool ir_value_set_float(ir_value *self, float f)
853 if (self->vtype != TYPE_FLOAT)
855 self->constval.vfloat = f;
856 self->isconst = true;
860 bool ir_value_set_func(ir_value *self, int f)
862 if (self->vtype != TYPE_FUNCTION)
864 self->constval.vint = f;
865 self->isconst = true;
869 bool ir_value_set_vector(ir_value *self, vector v)
871 if (self->vtype != TYPE_VECTOR)
873 self->constval.vvec = v;
874 self->isconst = true;
878 bool ir_value_set_field(ir_value *self, ir_value *fld)
880 if (self->vtype != TYPE_FIELD)
882 self->constval.vpointer = fld;
883 self->isconst = true;
887 static char *ir_strdup(const char *str)
890 /* actually dup empty strings */
891 char *out = mem_a(1);
895 return util_strdup(str);
898 bool ir_value_set_string(ir_value *self, const char *str)
900 if (self->vtype != TYPE_STRING)
902 self->constval.vstring = ir_strdup(str);
903 self->isconst = true;
908 bool ir_value_set_int(ir_value *self, int i)
910 if (self->vtype != TYPE_INTEGER)
912 self->constval.vint = i;
913 self->isconst = true;
918 bool ir_value_lives(ir_value *self, size_t at)
921 for (i = 0; i < vec_size(self->life); ++i)
923 ir_life_entry_t *life = &self->life[i];
924 if (life->start <= at && at <= life->end)
926 if (life->start > at) /* since it's ordered */
932 bool ir_value_life_insert(ir_value *self, size_t idx, ir_life_entry_t e)
935 vec_push(self->life, e);
936 for (k = vec_size(self->life)-1; k > idx; --k)
937 self->life[k] = self->life[k-1];
942 bool ir_value_life_merge(ir_value *self, size_t s)
945 ir_life_entry_t *life = NULL;
946 ir_life_entry_t *before = NULL;
947 ir_life_entry_t new_entry;
949 /* Find the first range >= s */
950 for (i = 0; i < vec_size(self->life); ++i)
953 life = &self->life[i];
957 /* nothing found? append */
958 if (i == vec_size(self->life)) {
960 if (life && life->end+1 == s)
962 /* previous life range can be merged in */
966 if (life && life->end >= s)
969 vec_push(self->life, e);
975 if (before->end + 1 == s &&
976 life->start - 1 == s)
979 before->end = life->end;
980 vec_remove(self->life, i, 1);
983 if (before->end + 1 == s)
989 /* already contained */
990 if (before->end >= s)
994 if (life->start - 1 == s)
999 /* insert a new entry */
1000 new_entry.start = new_entry.end = s;
1001 return ir_value_life_insert(self, i, new_entry);
1004 bool ir_value_life_merge_into(ir_value *self, const ir_value *other)
1008 if (!vec_size(other->life))
1011 if (!vec_size(self->life)) {
1012 size_t count = vec_size(other->life);
1013 ir_life_entry_t *life = vec_add(self->life, count);
1014 memcpy(life, other->life, count * sizeof(*life));
1019 for (i = 0; i < vec_size(other->life); ++i)
1021 const ir_life_entry_t *life = &other->life[i];
1024 ir_life_entry_t *entry = &self->life[myi];
1026 if (life->end+1 < entry->start)
1028 /* adding an interval before entry */
1029 if (!ir_value_life_insert(self, myi, *life))
1035 if (life->start < entry->start &&
1036 life->end+1 >= entry->start)
1038 /* starts earlier and overlaps */
1039 entry->start = life->start;
1042 if (life->end > entry->end &&
1043 life->start <= entry->end+1)
1045 /* ends later and overlaps */
1046 entry->end = life->end;
1049 /* see if our change combines it with the next ranges */
1050 while (myi+1 < vec_size(self->life) &&
1051 entry->end+1 >= self->life[1+myi].start)
1053 /* overlaps with (myi+1) */
1054 if (entry->end < self->life[1+myi].end)
1055 entry->end = self->life[1+myi].end;
1056 vec_remove(self->life, myi+1, 1);
1057 entry = &self->life[myi];
1060 /* see if we're after the entry */
1061 if (life->start > entry->end)
1064 /* append if we're at the end */
1065 if (myi >= vec_size(self->life)) {
1066 vec_push(self->life, *life);
1069 /* otherweise check the next range */
1078 bool ir_values_overlap(const ir_value *a, const ir_value *b)
1080 /* For any life entry in A see if it overlaps with
1081 * any life entry in B.
1082 * Note that the life entries are orderes, so we can make a
1083 * more efficient algorithm there than naively translating the
1087 ir_life_entry_t *la, *lb, *enda, *endb;
1089 /* first of all, if either has no life range, they cannot clash */
1090 if (!vec_size(a->life) || !vec_size(b->life))
1095 enda = la + vec_size(a->life);
1096 endb = lb + vec_size(b->life);
1099 /* check if the entries overlap, for that,
1100 * both must start before the other one ends.
1102 if (la->start < lb->end &&
1103 lb->start < la->end)
1108 /* entries are ordered
1109 * one entry is earlier than the other
1110 * that earlier entry will be moved forward
1112 if (la->start < lb->start)
1114 /* order: A B, move A forward
1115 * check if we hit the end with A
1120 else /* if (lb->start < la->start) actually <= */
1122 /* order: B A, move B forward
1123 * check if we hit the end with B
1132 /***********************************************************************
1136 bool ir_block_create_store_op(ir_block *self, int op, ir_value *target, ir_value *what)
1138 ir_instr *in = ir_instr_new(self, op);
1142 if (target->store == store_value &&
1143 (op < INSTR_STOREP_F || op > INSTR_STOREP_FNC))
1145 irerror(self->context, "cannot store to an SSA value");
1146 irerror(self->context, "trying to store: %s <- %s", target->name, what->name);
1147 irerror(self->context, "instruction: %s", asm_instr[op].m);
1151 if (!ir_instr_op(in, 0, target, true) ||
1152 !ir_instr_op(in, 1, what, false))
1156 vec_push(self->instr, in);
1160 bool ir_block_create_store(ir_block *self, ir_value *target, ir_value *what)
1164 if (target->vtype == TYPE_VARIANT)
1165 vtype = what->vtype;
1167 vtype = target->vtype;
1170 if (vtype == TYPE_FLOAT && what->vtype == TYPE_INTEGER)
1171 op = INSTR_CONV_ITOF;
1172 else if (vtype == TYPE_INTEGER && what->vtype == TYPE_FLOAT)
1173 op = INSTR_CONV_FTOI;
1175 op = type_store_instr[vtype];
1177 if (OPTS_FLAG(ADJUST_VECTOR_FIELDS)) {
1178 if (op == INSTR_STORE_FLD && what->fieldtype == TYPE_VECTOR)
1182 return ir_block_create_store_op(self, op, target, what);
1185 bool ir_block_create_storep(ir_block *self, ir_value *target, ir_value *what)
1190 if (target->vtype != TYPE_POINTER)
1193 /* storing using pointer - target is a pointer, type must be
1194 * inferred from source
1196 vtype = what->vtype;
1198 op = type_storep_instr[vtype];
1199 if (OPTS_FLAG(ADJUST_VECTOR_FIELDS)) {
1200 if (op == INSTR_STOREP_FLD && what->fieldtype == TYPE_VECTOR)
1201 op = INSTR_STOREP_V;
1204 return ir_block_create_store_op(self, op, target, what);
1207 bool ir_block_create_return(ir_block *self, ir_value *v)
1211 irerror(self->context, "block already ended (%s)", self->label);
1215 self->is_return = true;
1216 in = ir_instr_new(self, INSTR_RETURN);
1220 if (v && !ir_instr_op(in, 0, v, false))
1223 vec_push(self->instr, in);
1227 bool ir_block_create_if(ir_block *self, ir_value *v,
1228 ir_block *ontrue, ir_block *onfalse)
1232 irerror(self->context, "block already ended (%s)", self->label);
1236 /*in = ir_instr_new(self, (v->vtype == TYPE_STRING ? INSTR_IF_S : INSTR_IF_F));*/
1237 in = ir_instr_new(self, VINSTR_COND);
1241 if (!ir_instr_op(in, 0, v, false)) {
1242 ir_instr_delete(in);
1246 in->bops[0] = ontrue;
1247 in->bops[1] = onfalse;
1249 vec_push(self->instr, in);
1251 vec_push(self->exits, ontrue);
1252 vec_push(self->exits, onfalse);
1253 vec_push(ontrue->entries, self);
1254 vec_push(onfalse->entries, self);
1258 bool ir_block_create_jump(ir_block *self, ir_block *to)
1262 irerror(self->context, "block already ended (%s)", self->label);
1266 in = ir_instr_new(self, VINSTR_JUMP);
1271 vec_push(self->instr, in);
1273 vec_push(self->exits, to);
1274 vec_push(to->entries, self);
1278 bool ir_block_create_goto(ir_block *self, ir_block *to)
1282 irerror(self->context, "block already ended (%s)", self->label);
1286 in = ir_instr_new(self, INSTR_GOTO);
1291 vec_push(self->instr, in);
1293 vec_push(self->exits, to);
1294 vec_push(to->entries, self);
1298 ir_instr* ir_block_create_phi(ir_block *self, const char *label, int ot)
1302 in = ir_instr_new(self, VINSTR_PHI);
1305 out = ir_value_out(self->owner, label, store_value, ot);
1307 ir_instr_delete(in);
1310 if (!ir_instr_op(in, 0, out, true)) {
1311 ir_instr_delete(in);
1312 ir_value_delete(out);
1315 vec_push(self->instr, in);
1319 ir_value* ir_phi_value(ir_instr *self)
1321 return self->_ops[0];
1324 void ir_phi_add(ir_instr* self, ir_block *b, ir_value *v)
1328 if (!vec_ir_block_find(self->owner->entries, b, NULL)) {
1329 /* Must not be possible to cause this, otherwise the AST
1330 * is doing something wrong.
1332 irerror(self->context, "Invalid entry block for PHI");
1338 vec_push(v->reads, self);
1339 vec_push(self->phi, pe);
1342 /* call related code */
1343 ir_instr* ir_block_create_call(ir_block *self, const char *label, ir_value *func)
1347 in = ir_instr_new(self, INSTR_CALL0);
1350 out = ir_value_out(self->owner, label, (func->outtype == TYPE_VOID) ? store_return : store_value, func->outtype);
1352 ir_instr_delete(in);
1355 if (!ir_instr_op(in, 0, out, true) ||
1356 !ir_instr_op(in, 1, func, false))
1358 ir_instr_delete(in);
1359 ir_value_delete(out);
1362 vec_push(self->instr, in);
1366 ir_value* ir_call_value(ir_instr *self)
1368 return self->_ops[0];
1371 void ir_call_param(ir_instr* self, ir_value *v)
1373 vec_push(self->params, v);
1374 vec_push(v->reads, self);
1377 /* binary op related code */
1379 ir_value* ir_block_create_binop(ir_block *self,
1380 const char *label, int opcode,
1381 ir_value *left, ir_value *right)
1403 case INSTR_SUB_S: /* -- offset of string as float */
1408 case INSTR_BITOR_IF:
1409 case INSTR_BITOR_FI:
1410 case INSTR_BITAND_FI:
1411 case INSTR_BITAND_IF:
1426 case INSTR_BITAND_I:
1429 case INSTR_RSHIFT_I:
1430 case INSTR_LSHIFT_I:
1452 /* boolean operations result in floats */
1453 if (opcode >= INSTR_EQ_F && opcode <= INSTR_GT)
1455 else if (opcode >= INSTR_LE && opcode <= INSTR_GT)
1458 else if (opcode >= INSTR_LE_I && opcode <= INSTR_EQ_FI)
1463 if (ot == TYPE_VOID) {
1464 /* The AST or parser were supposed to check this! */
1468 return ir_block_create_general_instr(self, label, opcode, left, right, ot);
1471 ir_value* ir_block_create_unary(ir_block *self,
1472 const char *label, int opcode,
1475 int ot = TYPE_FLOAT;
1487 /* QC doesn't have other unary operations. We expect extensions to fill
1488 * the above list, otherwise we assume out-type = in-type, eg for an
1492 ot = operand->vtype;
1495 if (ot == TYPE_VOID) {
1496 /* The AST or parser were supposed to check this! */
1500 /* let's use the general instruction creator and pass NULL for OPB */
1501 return ir_block_create_general_instr(self, label, opcode, operand, NULL, ot);
1504 ir_value* ir_block_create_general_instr(ir_block *self, const char *label,
1505 int op, ir_value *a, ir_value *b, int outype)
1510 out = ir_value_out(self->owner, label, store_value, outype);
1514 instr = ir_instr_new(self, op);
1516 ir_value_delete(out);
1520 if (!ir_instr_op(instr, 0, out, true) ||
1521 !ir_instr_op(instr, 1, a, false) ||
1522 !ir_instr_op(instr, 2, b, false) )
1527 vec_push(self->instr, instr);
1531 ir_instr_delete(instr);
1532 ir_value_delete(out);
1536 ir_value* ir_block_create_fieldaddress(ir_block *self, const char *label, ir_value *ent, ir_value *field)
1540 /* Support for various pointer types todo if so desired */
1541 if (ent->vtype != TYPE_ENTITY)
1544 if (field->vtype != TYPE_FIELD)
1547 v = ir_block_create_general_instr(self, label, INSTR_ADDRESS, ent, field, TYPE_POINTER);
1548 v->fieldtype = field->fieldtype;
1552 ir_value* ir_block_create_load_from_ent(ir_block *self, const char *label, ir_value *ent, ir_value *field, int outype)
1555 if (ent->vtype != TYPE_ENTITY)
1558 /* at some point we could redirect for TYPE_POINTER... but that could lead to carelessness */
1559 if (field->vtype != TYPE_FIELD)
1564 case TYPE_FLOAT: op = INSTR_LOAD_F; break;
1565 case TYPE_VECTOR: op = INSTR_LOAD_V; break;
1566 case TYPE_STRING: op = INSTR_LOAD_S; break;
1567 case TYPE_FIELD: op = INSTR_LOAD_FLD; break;
1568 case TYPE_ENTITY: op = INSTR_LOAD_ENT; break;
1569 case TYPE_FUNCTION: op = INSTR_LOAD_FNC; break;
1571 case TYPE_POINTER: op = INSTR_LOAD_I; break;
1572 case TYPE_INTEGER: op = INSTR_LOAD_I; break;
1575 irerror(self->context, "invalid type for ir_block_create_load_from_ent: %s", type_name[outype]);
1579 return ir_block_create_general_instr(self, label, op, ent, field, outype);
1582 ir_value* ir_block_create_add(ir_block *self,
1584 ir_value *left, ir_value *right)
1587 int l = left->vtype;
1588 int r = right->vtype;
1592 irerror(self->context, "invalid type for ir_block_create_add: %s", type_name[l]);
1608 if ( (l == TYPE_FLOAT && r == TYPE_INTEGER) )
1610 else if ( (l == TYPE_INTEGER && r == TYPE_FLOAT) )
1615 irerror(self->context, "invalid type for ir_block_create_add: %s", type_name[l]);
1619 return ir_block_create_binop(self, label, op, left, right);
1622 ir_value* ir_block_create_sub(ir_block *self,
1624 ir_value *left, ir_value *right)
1627 int l = left->vtype;
1628 int r = right->vtype;
1633 irerror(self->context, "invalid type for ir_block_create_sub: %s", type_name[l]);
1649 if ( (l == TYPE_FLOAT && r == TYPE_INTEGER) )
1651 else if ( (l == TYPE_INTEGER && r == TYPE_FLOAT) )
1656 irerror(self->context, "invalid type for ir_block_create_sub: %s", type_name[l]);
1660 return ir_block_create_binop(self, label, op, left, right);
1663 ir_value* ir_block_create_mul(ir_block *self,
1665 ir_value *left, ir_value *right)
1668 int l = left->vtype;
1669 int r = right->vtype;
1674 irerror(self->context, "invalid type for ir_block_create_mul: %s", type_name[l]);
1689 if ( (l == TYPE_VECTOR && r == TYPE_FLOAT) )
1691 else if ( (l == TYPE_FLOAT && r == TYPE_VECTOR) )
1694 else if ( (l == TYPE_VECTOR && r == TYPE_INTEGER) )
1696 else if ( (l == TYPE_INTEGER && r == TYPE_VECTOR) )
1698 else if ( (l == TYPE_FLOAT && r == TYPE_INTEGER) )
1700 else if ( (l == TYPE_INTEGER && r == TYPE_FLOAT) )
1704 irerror(self->context, "invalid type for ir_block_create_mul: %s", type_name[l]);
1708 return ir_block_create_binop(self, label, op, left, right);
1711 ir_value* ir_block_create_div(ir_block *self,
1713 ir_value *left, ir_value *right)
1716 int l = left->vtype;
1717 int r = right->vtype;
1722 irerror(self->context, "invalid type for ir_block_create_div: %s", type_name[l]);
1735 if ( (l == TYPE_VECTOR && r == TYPE_FLOAT) )
1737 else if ( (l == TYPE_FLOAT && r == TYPE_INTEGER) )
1739 else if ( (l == TYPE_INTEGER && r == TYPE_FLOAT) )
1744 irerror(self->context, "invalid type for ir_block_create_div: %s", type_name[l]);
1748 return ir_block_create_binop(self, label, op, left, right);
1751 /* PHI resolving breaks the SSA, and must thus be the last
1752 * step before life-range calculation.
1755 static bool ir_block_naive_phi(ir_block *self);
1756 bool ir_function_naive_phi(ir_function *self)
1760 for (i = 0; i < vec_size(self->blocks); ++i)
1762 if (!ir_block_naive_phi(self->blocks[i]))
1768 static bool ir_naive_phi_emit_store(ir_block *block, size_t iid, ir_value *old, ir_value *what)
1773 /* create a store */
1774 if (!ir_block_create_store(block, old, what))
1777 /* we now move it up */
1778 instr = vec_last(block->instr);
1779 for (i = vec_size(block->instr)-1; i > iid; --i)
1780 block->instr[i] = block->instr[i-1];
1781 block->instr[i] = instr;
1786 static bool ir_block_naive_phi(ir_block *self)
1789 /* FIXME: optionally, create_phi can add the phis
1790 * to a list so we don't need to loop through blocks
1791 * - anyway: "don't optimize YET"
1793 for (i = 0; i < vec_size(self->instr); ++i)
1795 ir_instr *instr = self->instr[i];
1796 if (instr->opcode != VINSTR_PHI)
1799 vec_remove(self->instr, i, 1);
1800 --i; /* NOTE: i+1 below */
1802 for (p = 0; p < vec_size(instr->phi); ++p)
1804 ir_value *v = instr->phi[p].value;
1805 for (w = 0; w < vec_size(v->writes); ++w) {
1808 if (!v->writes[w]->_ops[0])
1811 /* When the write was to a global, we have to emit a mov */
1812 old = v->writes[w]->_ops[0];
1814 /* The original instruction now writes to the PHI target local */
1815 if (v->writes[w]->_ops[0] == v)
1816 v->writes[w]->_ops[0] = instr->_ops[0];
1818 if (old->store != store_value && old->store != store_local && old->store != store_param)
1820 /* If it originally wrote to a global we need to store the value
1823 if (!ir_naive_phi_emit_store(self, i+1, old, v))
1825 if (i+1 < vec_size(self->instr))
1826 instr = self->instr[i+1];
1829 /* In case I forget and access instr later, it'll be NULL
1830 * when it's a problem, to make sure we crash, rather than accessing
1836 /* If it didn't, we can replace all reads by the phi target now. */
1838 for (r = 0; r < vec_size(old->reads); ++r)
1841 ir_instr *ri = old->reads[r];
1842 for (op = 0; op < vec_size(ri->phi); ++op) {
1843 if (ri->phi[op].value == old)
1844 ri->phi[op].value = v;
1846 for (op = 0; op < 3; ++op) {
1847 if (ri->_ops[op] == old)
1854 ir_instr_delete(instr);
1859 /***********************************************************************
1860 *IR Temp allocation code
1861 * Propagating value life ranges by walking through the function backwards
1862 * until no more changes are made.
1863 * In theory this should happen once more than once for every nested loop
1865 * Though this implementation might run an additional time for if nests.
1868 /* Enumerate instructions used by value's life-ranges
1870 static void ir_block_enumerate(ir_block *self, size_t *_eid)
1874 for (i = 0; i < vec_size(self->instr); ++i)
1876 self->instr[i]->eid = eid++;
1881 /* Enumerate blocks and instructions.
1882 * The block-enumeration is unordered!
1883 * We do not really use the block enumreation, however
1884 * the instruction enumeration is important for life-ranges.
1886 void ir_function_enumerate(ir_function *self)
1889 size_t instruction_id = 0;
1890 for (i = 0; i < vec_size(self->blocks); ++i)
1892 self->blocks[i]->eid = i;
1893 self->blocks[i]->run_id = 0;
1894 ir_block_enumerate(self->blocks[i], &instruction_id);
1898 static bool ir_block_life_propagate(ir_block *b, ir_block *prev, bool *changed);
1899 bool ir_function_calculate_liferanges(ir_function *self)
1907 for (i = 0; i != vec_size(self->blocks); ++i)
1909 if (self->blocks[i]->is_return)
1911 vec_free(self->blocks[i]->living);
1912 if (!ir_block_life_propagate(self->blocks[i], NULL, &changed))
1917 if (vec_size(self->blocks)) {
1918 ir_block *block = self->blocks[0];
1919 for (i = 0; i < vec_size(block->living); ++i) {
1920 ir_value *v = block->living[i];
1921 if (v->memberof || v->store != store_local)
1923 if (irwarning(v->context, WARN_USED_UNINITIALIZED,
1924 "variable `%s` may be used uninitialized in this function", v->name))
1933 /* Local-value allocator
1934 * After finishing creating the liferange of all values used in a function
1935 * we can allocate their global-positions.
1936 * This is the counterpart to register-allocation in register machines.
1942 } function_allocator;
1944 static bool function_allocator_alloc(function_allocator *alloc, const ir_value *var)
1947 size_t vsize = type_sizeof[var->vtype];
1949 slot = ir_value_var("reg", store_global, var->vtype);
1953 if (!ir_value_life_merge_into(slot, var))
1956 vec_push(alloc->locals, slot);
1957 vec_push(alloc->sizes, vsize);
1962 ir_value_delete(slot);
1966 bool ir_function_allocate_locals(ir_function *self)
1975 function_allocator alloc;
1977 if (!vec_size(self->locals) && !vec_size(self->values))
1980 alloc.locals = NULL;
1982 alloc.positions = NULL;
1984 for (i = 0; i < vec_size(self->locals); ++i)
1986 if (!function_allocator_alloc(&alloc, self->locals[i]))
1990 /* Allocate a slot for any value that still exists */
1991 for (i = 0; i < vec_size(self->values); ++i)
1993 v = self->values[i];
1995 if (!vec_size(v->life))
1998 for (a = 0; a < vec_size(alloc.locals); ++a)
2000 slot = alloc.locals[a];
2002 if (ir_values_overlap(v, slot))
2005 if (!ir_value_life_merge_into(slot, v))
2008 /* adjust size for this slot */
2009 if (alloc.sizes[a] < type_sizeof[v->vtype])
2010 alloc.sizes[a] = type_sizeof[v->vtype];
2012 self->values[i]->code.local = a;
2015 if (a >= vec_size(alloc.locals)) {
2016 self->values[i]->code.local = vec_size(alloc.locals);
2017 if (!function_allocator_alloc(&alloc, v))
2026 /* Adjust slot positions based on sizes */
2027 vec_push(alloc.positions, 0);
2029 if (vec_size(alloc.sizes))
2030 pos = alloc.positions[0] + alloc.sizes[0];
2033 for (i = 1; i < vec_size(alloc.sizes); ++i)
2035 pos = alloc.positions[i-1] + alloc.sizes[i-1];
2036 vec_push(alloc.positions, pos);
2039 self->allocated_locals = pos + vec_last(alloc.sizes);
2041 /* Take over the actual slot positions */
2042 for (i = 0; i < vec_size(self->values); ++i) {
2043 self->values[i]->code.local = alloc.positions[self->values[i]->code.local];
2051 for (i = 0; i < vec_size(alloc.locals); ++i)
2052 ir_value_delete(alloc.locals[i]);
2053 vec_free(alloc.locals);
2054 vec_free(alloc.sizes);
2055 vec_free(alloc.positions);
2059 /* Get information about which operand
2060 * is read from, or written to.
2062 static void ir_op_read_write(int op, size_t *read, size_t *write)
2082 case INSTR_STOREP_F:
2083 case INSTR_STOREP_V:
2084 case INSTR_STOREP_S:
2085 case INSTR_STOREP_ENT:
2086 case INSTR_STOREP_FLD:
2087 case INSTR_STOREP_FNC:
2098 static bool ir_block_living_add_instr(ir_block *self, size_t eid)
2101 bool changed = false;
2103 for (i = 0; i != vec_size(self->living); ++i)
2105 tempbool = ir_value_life_merge(self->living[i], eid);
2108 irerror(self->context, "block_living_add_instr() value instruction added %s: %i", self->living[i]->_name, (int)eid);
2110 changed = changed || tempbool;
2115 static bool ir_block_life_prop_previous(ir_block* self, ir_block *prev, bool *changed)
2118 /* values which have been read in a previous iteration are now
2119 * in the "living" array even if the previous block doesn't use them.
2120 * So we have to remove whatever does not exist in the previous block.
2121 * They will be re-added on-read, but the liferange merge won't cause
2124 for (i = 0; i < vec_size(self->living); ++i)
2126 if (!vec_ir_value_find(prev->living, self->living[i], NULL)) {
2127 vec_remove(self->living, i, 1);
2132 /* Whatever the previous block still has in its living set
2133 * must now be added to ours as well.
2135 for (i = 0; i < vec_size(prev->living); ++i)
2137 if (vec_ir_value_find(self->living, prev->living[i], NULL))
2139 vec_push(self->living, prev->living[i]);
2141 irerror(self->contextt from prev: %s", self->label, prev->living[i]->_name);
2147 static bool ir_block_life_propagate(ir_block *self, ir_block *prev, bool *changed)
2153 /* bitmasks which operands are read from or written to */
2155 char dbg_ind[16] = { '#', '0' };
2160 if (!ir_block_life_prop_previous(self, prev, changed))
2164 i = vec_size(self->instr);
2167 instr = self->instr[i];
2169 /* PHI operands are always read operands */
2170 for (p = 0; p < vec_size(instr->phi); ++p)
2172 value = instr->phi[p].value;
2173 if (value->memberof)
2174 value = value->memberof;
2175 if (!vec_ir_value_find(self->living, value, NULL))
2176 vec_push(self->living, value);
2179 /* call params are read operands too */
2180 for (p = 0; p < vec_size(instr->params); ++p)
2182 value = instr->params[p];
2183 if (value->memberof)
2184 value = value->memberof;
2185 if (!vec_ir_value_find(self->living, value, NULL))
2186 vec_push(self->living, value);
2189 /* See which operands are read and write operands */
2190 ir_op_read_write(instr->opcode, &read, &write);
2192 if (instr->opcode == INSTR_MUL_VF)
2194 /* the float source will get an additional lifetime */
2195 tempbool = ir_value_life_merge(instr->_ops[2], instr->eid+1);
2196 *changed = *changed || tempbool;
2198 else if (instr->opcode == INSTR_MUL_FV)
2200 /* the float source will get an additional lifetime */
2201 tempbool = ir_value_life_merge(instr->_ops[1], instr->eid+1);
2202 *changed = *changed || tempbool;
2205 /* Go through the 3 main operands */
2206 for (o = 0; o < 3; ++o)
2208 if (!instr->_ops[o]) /* no such operand */
2211 value = instr->_ops[o];
2212 if (value->memberof)
2213 value = value->memberof;
2215 /* We only care about locals */
2216 /* we also calculate parameter liferanges so that locals
2217 * can take up parameter slots */
2218 if (value->store != store_value &&
2219 value->store != store_local &&
2220 value->store != store_param)
2226 if (!vec_ir_value_find(self->living, value, NULL))
2227 vec_push(self->living, value);
2230 /* write operands */
2231 /* When we write to a local, we consider it "dead" for the
2232 * remaining upper part of the function, since in SSA a value
2233 * can only be written once (== created)
2238 bool in_living = vec_ir_value_find(self->living, value, &idx);
2241 /* If the value isn't alive it hasn't been read before... */
2242 /* TODO: See if the warning can be emitted during parsing or AST processing
2243 * otherwise have warning printed here.
2244 * IF printing a warning here: include filecontext_t,
2245 * and make sure it's only printed once
2246 * since this function is run multiple times.
2248 /* For now: debug info: */
2249 /* con_err( "Value only written %s\n", value->name); */
2250 tempbool = ir_value_life_merge(value, instr->eid);
2251 *changed = *changed || tempbool;
2253 ir_instr_dump(instr, dbg_ind, printf);
2257 /* since 'living' won't contain it
2258 * anymore, merge the value, since
2261 tempbool = ir_value_life_merge(value, instr->eid);
2264 con_err( "value added id %s %i\n", value->name, (int)instr->eid);
2266 *changed = *changed || tempbool;
2268 vec_remove(self->living, idx, 1);
2273 tempbool = ir_block_living_add_instr(self, instr->eid);
2274 /*con_err( "living added values\n");*/
2275 *changed = *changed || tempbool;
2279 if (self->run_id == self->owner->run_id)
2282 self->run_id = self->owner->run_id;
2284 for (i = 0; i < vec_size(self->entries); ++i)
2286 ir_block *entry = self->entries[i];
2287 ir_block_life_propagate(entry, self, changed);
2293 /***********************************************************************
2296 * Since the IR has the convention of putting 'write' operands
2297 * at the beginning, we have to rotate the operands of instructions
2298 * properly in order to generate valid QCVM code.
2300 * Having destinations at a fixed position is more convenient. In QC
2301 * this is *mostly* OPC, but FTE adds at least 2 instructions which
2302 * read from from OPA, and store to OPB rather than OPC. Which is
2303 * partially the reason why the implementation of these instructions
2304 * in darkplaces has been delayed for so long.
2306 * Breaking conventions is annoying...
2308 static bool ir_builder_gen_global(ir_builder *self, ir_value *global, bool islocal);
2310 static bool gen_global_field(ir_value *global)
2312 if (global->isconst)
2314 ir_value *fld = global->constval.vpointer;
2316 irerror(global->context, "Invalid field constant with no field: %s", global->name);
2320 /* Now, in this case, a relocation would be impossible to code
2321 * since it looks like this:
2322 * .vector v = origin; <- parse error, wtf is 'origin'?
2325 * But we will need a general relocation support later anyway
2326 * for functions... might as well support that here.
2328 if (!fld->code.globaladdr) {
2329 irerror(global->context, "FIXME: Relocation support");
2333 /* copy the field's value */
2334 ir_value_code_setaddr(global, vec_size(code_globals));
2335 vec_push(code_globals, code_globals[fld->code.globaladdr]);
2336 if (global->fieldtype == TYPE_VECTOR) {
2337 vec_push(code_globals, code_globals[fld->code.globaladdr]+1);
2338 vec_push(code_globals, code_globals[fld->code.globaladdr]+2);
2343 ir_value_code_setaddr(global, vec_size(code_globals));
2344 vec_push(code_globals, 0);
2345 if (global->fieldtype == TYPE_VECTOR) {
2346 vec_push(code_globals, 0);
2347 vec_push(code_globals, 0);
2350 if (global->code.globaladdr < 0)
2355 static bool gen_global_pointer(ir_value *global)
2357 if (global->isconst)
2359 ir_value *target = global->constval.vpointer;
2361 irerror(global->context, "Invalid pointer constant: %s", global->name);
2362 /* NULL pointers are pointing to the NULL constant, which also
2363 * sits at address 0, but still has an ir_value for itself.
2368 /* Here, relocations ARE possible - in fteqcc-enhanced-qc:
2369 * void() foo; <- proto
2370 * void() *fooptr = &foo;
2371 * void() foo = { code }
2373 if (!target->code.globaladdr) {
2374 /* FIXME: Check for the constant nullptr ir_value!
2375 * because then code.globaladdr being 0 is valid.
2377 irerror(global->context, "FIXME: Relocation support");
2381 ir_value_code_setaddr(global, vec_size(code_globals));
2382 vec_push(code_globals, target->code.globaladdr);
2386 ir_value_code_setaddr(global, vec_size(code_globals));
2387 vec_push(code_globals, 0);
2389 if (global->code.globaladdr < 0)
2394 static bool gen_blocks_recursive(ir_function *func, ir_block *block)
2396 prog_section_statement stmt;
2405 block->generated = true;
2406 block->code_start = vec_size(code_statements);
2407 for (i = 0; i < vec_size(block->instr); ++i)
2409 instr = block->instr[i];
2411 if (instr->opcode == VINSTR_PHI) {
2412 irerror(block->context, "cannot generate virtual instruction (phi)");
2416 if (instr->opcode == VINSTR_JUMP) {
2417 target = instr->bops[0];
2418 /* for uncoditional jumps, if the target hasn't been generated
2419 * yet, we generate them right here.
2421 if (!target->generated) {
2426 /* otherwise we generate a jump instruction */
2427 stmt.opcode = INSTR_GOTO;
2428 stmt.o1.s1 = (target->code_start) - vec_size(code_statements);
2431 vec_push(code_statements, stmt);
2433 /* no further instructions can be in this block */
2437 if (instr->opcode == VINSTR_COND) {
2438 ontrue = instr->bops[0];
2439 onfalse = instr->bops[1];
2440 /* TODO: have the AST signal which block should
2441 * come first: eg. optimize IFs without ELSE...
2444 stmt.o1.u1 = ir_value_code_addr(instr->_ops[0]);
2448 if (ontrue->generated) {
2449 stmt.opcode = INSTR_IF;
2450 stmt.o2.s1 = (ontrue->code_start) - vec_size(code_statements);
2451 vec_push(code_statements, stmt);
2453 if (onfalse->generated) {
2454 stmt.opcode = INSTR_IFNOT;
2455 stmt.o2.s1 = (onfalse->code_start) - vec_size(code_statements);
2456 vec_push(code_statements, stmt);
2458 if (!ontrue->generated) {
2459 if (onfalse->generated) {
2464 if (!onfalse->generated) {
2465 if (ontrue->generated) {
2470 /* neither ontrue nor onfalse exist */
2471 stmt.opcode = INSTR_IFNOT;
2472 stidx = vec_size(code_statements);
2473 vec_push(code_statements, stmt);
2474 /* on false we jump, so add ontrue-path */
2475 if (!gen_blocks_recursive(func, ontrue))
2477 /* fixup the jump address */
2478 code_statements[stidx].o2.s1 = vec_size(code_statements) - stidx;
2479 /* generate onfalse path */
2480 if (onfalse->generated) {
2481 /* fixup the jump address */
2482 code_statements[stidx].o2.s1 = (onfalse->code_start) - (stidx);
2483 /* may have been generated in the previous recursive call */
2484 stmt.opcode = INSTR_GOTO;
2485 stmt.o1.s1 = (onfalse->code_start) - vec_size(code_statements);
2488 vec_push(code_statements, stmt);
2491 /* if not, generate now */
2496 if (instr->opcode >= INSTR_CALL0 && instr->opcode <= INSTR_CALL8) {
2497 /* Trivial call translation:
2498 * copy all params to OFS_PARM*
2499 * if the output's storetype is not store_return,
2500 * add append a STORE instruction!
2502 * NOTES on how to do it better without much trouble:
2503 * -) The liferanges!
2504 * Simply check the liferange of all parameters for
2505 * other CALLs. For each param with no CALL in its
2506 * liferange, we can store it in an OFS_PARM at
2507 * generation already. This would even include later
2508 * reuse.... probably... :)
2513 for (p = 0; p < vec_size(instr->params); ++p)
2515 ir_value *param = instr->params[p];
2517 stmt.opcode = INSTR_STORE_F;
2520 if (param->vtype == TYPE_FIELD)
2521 stmt.opcode = field_store_instr[param->fieldtype];
2523 stmt.opcode = type_store_instr[param->vtype];
2524 stmt.o1.u1 = ir_value_code_addr(param);
2525 stmt.o2.u1 = OFS_PARM0 + 3 * p;
2526 vec_push(code_statements, stmt);
2528 stmt.opcode = INSTR_CALL0 + vec_size(instr->params);
2529 if (stmt.opcode > INSTR_CALL8)
2530 stmt.opcode = INSTR_CALL8;
2531 stmt.o1.u1 = ir_value_code_addr(instr->_ops[1]);
2534 vec_push(code_statements, stmt);
2536 retvalue = instr->_ops[0];
2537 if (retvalue && retvalue->store != store_return && vec_size(retvalue->life))
2539 /* not to be kept in OFS_RETURN */
2540 if (retvalue->vtype == TYPE_FIELD)
2541 stmt.opcode = field_store_instr[retvalue->vtype];
2543 stmt.opcode = type_store_instr[retvalue->vtype];
2544 stmt.o1.u1 = OFS_RETURN;
2545 stmt.o2.u1 = ir_value_code_addr(retvalue);
2547 vec_push(code_statements, stmt);
2552 if (instr->opcode == INSTR_STATE) {
2553 irerror(block->context, "TODO: state instruction");
2557 stmt.opcode = instr->opcode;
2562 /* This is the general order of operands */
2564 stmt.o3.u1 = ir_value_code_addr(instr->_ops[0]);
2567 stmt.o1.u1 = ir_value_code_addr(instr->_ops[1]);
2570 stmt.o2.u1 = ir_value_code_addr(instr->_ops[2]);
2572 if (stmt.opcode == INSTR_RETURN || stmt.opcode == INSTR_DONE)
2574 stmt.o1.u1 = stmt.o3.u1;
2577 else if ((stmt.opcode >= INSTR_STORE_F &&
2578 stmt.opcode <= INSTR_STORE_FNC) ||
2579 (stmt.opcode >= INSTR_STOREP_F &&
2580 stmt.opcode <= INSTR_STOREP_FNC))
2582 /* 2-operand instructions with A -> B */
2583 stmt.o2.u1 = stmt.o3.u1;
2587 vec_push(code_statements, stmt);
2592 static bool gen_function_code(ir_function *self)
2595 prog_section_statement stmt;
2597 /* Starting from entry point, we generate blocks "as they come"
2598 * for now. Dead blocks will not be translated obviously.
2600 if (!vec_size(self->blocks)) {
2601 irerror(self->context, "Function '%s' declared without body.", self->name);
2605 block = self->blocks[0];
2606 if (block->generated)
2609 if (!gen_blocks_recursive(self, block)) {
2610 irerror(self->context, "failed to generate blocks for '%s'", self->name);
2614 /* otherwise code_write crashes since it debug-prints functions until AINSTR_END */
2615 stmt.opcode = AINSTR_END;
2619 vec_push(code_statements, stmt);
2623 static qcint ir_builder_filestring(ir_builder *ir, const char *filename)
2625 /* NOTE: filename pointers are copied, we never strdup them,
2626 * thus we can use pointer-comparison to find the string.
2631 for (i = 0; i < vec_size(ir->filenames); ++i) {
2632 if (ir->filenames[i] == filename)
2633 return ir->filestrings[i];
2636 str = code_genstring(filename);
2637 vec_push(ir->filenames, filename);
2638 vec_push(ir->filestrings, str);
2642 static bool gen_global_function(ir_builder *ir, ir_value *global)
2644 prog_section_function fun;
2648 size_t local_var_end;
2650 if (!global->isconst || (!global->constval.vfunc))
2652 irerror(global->context, "Invalid state of function-global: not constant: %s", global->name);
2656 irfun = global->constval.vfunc;
2658 fun.name = global->code.name;
2659 fun.file = ir_builder_filestring(ir, global->context.file);
2660 fun.profile = 0; /* always 0 */
2661 fun.nargs = vec_size(irfun->params);
2663 for (i = 0;i < 8; ++i) {
2667 fun.argsize[i] = type_sizeof[irfun->params[i]];
2670 fun.firstlocal = vec_size(code_globals);
2672 local_var_end = fun.firstlocal;
2673 for (i = 0; i < vec_size(irfun->locals); ++i) {
2674 if (!ir_builder_gen_global(ir, irfun->locals[i], true)) {
2675 irerror(irfun->locals[i]->context, "Failed to generate local %s", irfun->locals[i]->name);
2679 if (vec_size(irfun->locals)) {
2680 ir_value *last = vec_last(irfun->locals);
2681 local_var_end = last->code.globaladdr;
2682 local_var_end += type_sizeof[last->vtype];
2684 for (i = 0; i < vec_size(irfun->values); ++i)
2686 /* generate code.globaladdr for ssa values */
2687 ir_value *v = irfun->values[i];
2688 ir_value_code_setaddr(v, local_var_end + v->code.local);
2690 for (i = 0; i < irfun->allocated_locals; ++i) {
2691 /* fill the locals with zeros */
2692 vec_push(code_globals, 0);
2695 fun.locals = vec_size(code_globals) - fun.firstlocal;
2698 fun.entry = irfun->builtin;
2700 irfun->code_function_def = vec_size(code_functions);
2701 fun.entry = vec_size(code_statements);
2704 vec_push(code_functions, fun);
2708 static void ir_gen_extparam(ir_builder *ir)
2710 prog_section_def def;
2714 snprintf(name, sizeof(name), "EXTPARM%i", (int)(vec_size(ir->extparams)+8));
2715 global = ir_value_var(name, store_global, TYPE_VECTOR);
2717 def.name = code_genstring(name);
2718 def.type = TYPE_VECTOR;
2719 def.offset = vec_size(code_globals);
2721 vec_push(code_defs, def);
2722 ir_value_code_setaddr(global, def.offset);
2723 vec_push(code_globals, 0);
2724 vec_push(code_globals, 0);
2725 vec_push(code_globals, 0);
2727 vec_push(ir->extparams, global);
2730 static bool gen_function_extparam_copy(ir_function *self)
2734 ir_builder *ir = self->owner;
2736 prog_section_statement stmt;
2738 if (!self->max_parameters)
2741 stmt.opcode = INSTR_STORE_F;
2743 for (i = 8; i < self->max_parameters; ++i) {
2745 if (ext >= vec_size(ir->extparams))
2746 ir_gen_extparam(ir);
2748 ep = ir->extparams[ext];
2750 stmt.opcode = type_store_instr[self->locals[i]->vtype];
2751 if (self->locals[i]->vtype == TYPE_FIELD &&
2752 self->locals[i]->fieldtype == TYPE_VECTOR)
2754 stmt.opcode = INSTR_STORE_V;
2756 stmt.o1.u1 = ir_value_code_addr(ep);
2757 stmt.o2.u1 = ir_value_code_addr(self->locals[i]);
2758 vec_push(code_statements, stmt);
2764 static bool gen_global_function_code(ir_builder *ir, ir_value *global)
2766 prog_section_function *fundef;
2769 irfun = global->constval.vfunc;
2771 irwarning(global->context, WARN_IMPLICIT_FUNCTION_POINTER,
2772 "function `%s` has no body and in QC implicitly becomes a function-pointer", global->name);
2773 /* this was a function pointer, don't generate code for those */
2780 if (irfun->code_function_def < 0) {
2781 irerror(irfun->context, "`%s`: IR global wasn't generated, failed to access function-def", irfun->name);
2784 fundef = &code_functions[irfun->code_function_def];
2786 fundef->entry = vec_size(code_statements);
2787 if (!gen_function_extparam_copy(irfun)) {
2788 irerror(irfun->context, "Failed to generate extparam-copy code for function %s", irfun->name);
2791 if (!gen_function_code(irfun)) {
2792 irerror(irfun->context, "Failed to generate code for function %s", irfun->name);
2798 static bool ir_builder_gen_global(ir_builder *self, ir_value *global, bool islocal)
2802 prog_section_def def;
2804 def.type = global->vtype;
2805 def.offset = vec_size(code_globals);
2808 if (global->name[0] == '#') {
2809 if (!self->str_immediate)
2810 self->str_immediate = code_genstring("IMMEDIATE");
2811 def.name = global->code.name = self->str_immediate;
2814 def.name = global->code.name = code_genstring(global->name);
2819 switch (global->vtype)
2822 if (!strcmp(global->name, "end_sys_globals")) {
2823 /* TODO: remember this point... all the defs before this one
2824 * should be checksummed and added to progdefs.h when we generate it.
2827 else if (!strcmp(global->name, "end_sys_fields")) {
2828 /* TODO: same as above but for entity-fields rather than globsl
2832 irwarning(global->context, WARN_VOID_VARIABLES, "unrecognized variable of type void `%s`",
2834 /* I'd argue setting it to 0 is sufficient, but maybe some depend on knowing how far
2835 * the system fields actually go? Though the engine knows this anyway...
2836 * Maybe this could be an -foption
2837 * fteqcc creates data for end_sys_* - of size 1, so let's do the same
2839 ir_value_code_setaddr(global, vec_size(code_globals));
2840 vec_push(code_globals, 0);
2842 vec_push(code_defs, def);
2845 vec_push(code_defs, def);
2846 return gen_global_pointer(global);
2848 vec_push(code_defs, def);
2849 return gen_global_field(global);
2854 ir_value_code_setaddr(global, vec_size(code_globals));
2855 if (global->isconst) {
2856 iptr = (int32_t*)&global->constval.ivec[0];
2857 vec_push(code_globals, *iptr);
2859 vec_push(code_globals, 0);
2861 def.type |= DEF_SAVEGLOBAL;
2863 vec_push(code_defs, def);
2865 return global->code.globaladdr >= 0;
2869 ir_value_code_setaddr(global, vec_size(code_globals));
2870 if (global->isconst) {
2871 vec_push(code_globals, code_genstring(global->constval.vstring));
2873 vec_push(code_globals, 0);
2875 def.type |= DEF_SAVEGLOBAL;
2877 vec_push(code_defs, def);
2878 return global->code.globaladdr >= 0;
2883 ir_value_code_setaddr(global, vec_size(code_globals));
2884 if (global->isconst) {
2885 iptr = (int32_t*)&global->constval.ivec[0];
2886 vec_push(code_globals, iptr[0]);
2887 if (global->code.globaladdr < 0)
2889 for (d = 1; d < type_sizeof[global->vtype]; ++d)
2891 vec_push(code_globals, iptr[d]);
2894 vec_push(code_globals, 0);
2895 if (global->code.globaladdr < 0)
2897 for (d = 1; d < type_sizeof[global->vtype]; ++d)
2899 vec_push(code_globals, 0);
2902 def.type |= DEF_SAVEGLOBAL;
2905 vec_push(code_defs, def);
2906 return global->code.globaladdr >= 0;
2909 ir_value_code_setaddr(global, vec_size(code_globals));
2910 if (!global->isconst) {
2911 vec_push(code_globals, 0);
2912 if (global->code.globaladdr < 0)
2915 vec_push(code_globals, vec_size(code_functions));
2916 if (!gen_global_function(self, global))
2919 def.type |= DEF_SAVEGLOBAL;
2921 vec_push(code_defs, def);
2924 /* assume biggest type */
2925 ir_value_code_setaddr(global, vec_size(code_globals));
2926 vec_push(code_globals, 0);
2927 for (i = 1; i < type_sizeof[TYPE_VARIANT]; ++i)
2928 vec_push(code_globals, 0);
2931 /* refuse to create 'void' type or any other fancy business. */
2932 irerror(global->context, "Invalid type for global variable `%s`: %s",
2933 global->name, type_name[global->vtype]);
2938 static bool ir_builder_gen_field(ir_builder *self, ir_value *field)
2940 prog_section_def def;
2941 prog_section_field fld;
2943 def.type = field->vtype;
2944 def.offset = vec_size(code_globals);
2946 /* create a global named the same as the field */
2947 if (opts_standard == COMPILER_GMQCC) {
2948 /* in our standard, the global gets a dot prefix */
2949 size_t len = strlen(field->name);
2952 /* we really don't want to have to allocate this, and 1024
2953 * bytes is more than enough for a variable/field name
2955 if (len+2 >= sizeof(name)) {
2956 irerror(field->context, "invalid field name size: %u", (unsigned int)len);
2961 memcpy(name+1, field->name, len); /* no strncpy - we used strlen above */
2964 def.name = code_genstring(name);
2965 fld.name = def.name + 1; /* we reuse that string table entry */
2967 /* in plain QC, there cannot be a global with the same name,
2968 * and so we also name the global the same.
2969 * FIXME: fteqcc should create a global as well
2970 * check if it actually uses the same name. Probably does
2972 def.name = code_genstring(field->name);
2973 fld.name = def.name;
2976 field->code.name = def.name;
2978 vec_push(code_defs, def);
2980 fld.type = field->fieldtype;
2982 if (fld.type == TYPE_VOID) {
2983 irerror(field->context, "field is missing a type: %s - don't know its size", field->name);
2987 fld.offset = code_alloc_field(type_sizeof[field->fieldtype]);
2989 vec_push(code_fields, fld);
2991 ir_value_code_setaddr(field, vec_size(code_globals));
2992 vec_push(code_globals, fld.offset);
2993 if (fld.type == TYPE_VECTOR) {
2994 vec_push(code_globals, fld.offset+1);
2995 vec_push(code_globals, fld.offset+2);
2998 return field->code.globaladdr >= 0;
3001 bool ir_builder_generate(ir_builder *self, const char *filename)
3003 prog_section_statement stmt;
3008 for (i = 0; i < vec_size(self->globals); ++i)
3010 if (!ir_builder_gen_global(self, self->globals[i], false)) {
3015 for (i = 0; i < vec_size(self->fields); ++i)
3017 if (!ir_builder_gen_field(self, self->fields[i])) {
3022 /* generate function code */
3023 for (i = 0; i < vec_size(self->globals); ++i)
3025 if (self->globals[i]->vtype == TYPE_FUNCTION) {
3026 if (!gen_global_function_code(self, self->globals[i])) {
3032 /* DP errors if the last instruction is not an INSTR_DONE
3033 * and for debugging purposes we add an additional AINSTR_END
3034 * to the end of functions, so here it goes:
3036 stmt.opcode = INSTR_DONE;
3040 vec_push(code_statements, stmt);
3043 con_out("writing '%s'...\n", filename);
3044 return code_write(filename);
3047 /***********************************************************************
3048 *IR DEBUG Dump functions...
3051 #define IND_BUFSZ 1024
3054 # define strncat(dst, src, sz) strncat_s(dst, sz, src, _TRUNCATE)
3057 const char *qc_opname(int op)
3059 if (op < 0) return "<INVALID>";
3060 if (op < ( sizeof(asm_instr) / sizeof(asm_instr[0]) ))
3061 return asm_instr[op].m;
3063 case VINSTR_PHI: return "PHI";
3064 case VINSTR_JUMP: return "JUMP";
3065 case VINSTR_COND: return "COND";
3066 default: return "<UNK>";
3070 void ir_builder_dump(ir_builder *b, int (*oprintf)(const char*, ...))
3073 char indent[IND_BUFSZ];
3077 oprintf("module %s\n", b->name);
3078 for (i = 0; i < vec_size(b->globals); ++i)
3081 if (b->globals[i]->isconst)
3082 oprintf("%s = ", b->globals[i]->name);
3083 ir_value_dump(b->globals[i], oprintf);
3086 for (i = 0; i < vec_size(b->functions); ++i)
3087 ir_function_dump(b->functions[i], indent, oprintf);
3088 oprintf("endmodule %s\n", b->name);
3091 void ir_function_dump(ir_function *f, char *ind,
3092 int (*oprintf)(const char*, ...))
3095 if (f->builtin != 0) {
3096 oprintf("%sfunction %s = builtin %i\n", ind, f->name, -f->builtin);
3099 oprintf("%sfunction %s\n", ind, f->name);
3100 strncat(ind, "\t", IND_BUFSZ);
3101 if (vec_size(f->locals))
3103 oprintf("%s%i locals:\n", ind, (int)vec_size(f->locals));
3104 for (i = 0; i < vec_size(f->locals); ++i) {
3105 oprintf("%s\t", ind);
3106 ir_value_dump(f->locals[i], oprintf);
3110 oprintf("%sliferanges:\n", ind);
3111 for (i = 0; i < vec_size(f->locals); ++i) {
3113 ir_value *v = f->locals[i];
3114 oprintf("%s\t%s: unique ", ind, v->name);
3115 for (l = 0; l < vec_size(v->life); ++l) {
3116 oprintf("[%i,%i] ", v->life[l].start, v->life[l].end);
3120 for (i = 0; i < vec_size(f->values); ++i) {
3122 ir_value *v = f->values[i];
3123 oprintf("%s\t%s: @%i ", ind, v->name, (int)v->code.local);
3124 for (l = 0; l < vec_size(v->life); ++l) {
3125 oprintf("[%i,%i] ", v->life[l].start, v->life[l].end);
3129 if (vec_size(f->blocks))
3131 oprintf("%slife passes (check): %i\n", ind, (int)f->run_id);
3132 for (i = 0; i < vec_size(f->blocks); ++i) {
3133 if (f->blocks[i]->run_id != f->run_id) {
3134 oprintf("%slife pass check fail! %i != %i\n", ind, (int)f->blocks[i]->run_id, (int)f->run_id);
3136 ir_block_dump(f->blocks[i], ind, oprintf);
3140 ind[strlen(ind)-1] = 0;
3141 oprintf("%sendfunction %s\n", ind, f->name);
3144 void ir_block_dump(ir_block* b, char *ind,
3145 int (*oprintf)(const char*, ...))
3148 oprintf("%s:%s\n", ind, b->label);
3149 strncat(ind, "\t", IND_BUFSZ);
3151 for (i = 0; i < vec_size(b->instr); ++i)
3152 ir_instr_dump(b->instr[i], ind, oprintf);
3153 ind[strlen(ind)-1] = 0;
3156 void dump_phi(ir_instr *in, char *ind,
3157 int (*oprintf)(const char*, ...))
3160 oprintf("%s <- phi ", in->_ops[0]->name);
3161 for (i = 0; i < vec_size(in->phi); ++i)
3163 oprintf("([%s] : %s) ", in->phi[i].from->label,
3164 in->phi[i].value->name);
3169 void ir_instr_dump(ir_instr *in, char *ind,
3170 int (*oprintf)(const char*, ...))
3173 const char *comma = NULL;
3175 oprintf("%s (%i) ", ind, (int)in->eid);
3177 if (in->opcode == VINSTR_PHI) {
3178 dump_phi(in, ind, oprintf);
3182 strncat(ind, "\t", IND_BUFSZ);
3184 if (in->_ops[0] && (in->_ops[1] || in->_ops[2])) {
3185 ir_value_dump(in->_ops[0], oprintf);
3186 if (in->_ops[1] || in->_ops[2])
3189 if (in->opcode == INSTR_CALL0) {
3190 oprintf("CALL%i\t", vec_size(in->params));
3192 oprintf("%s\t", qc_opname(in->opcode));
3194 if (in->_ops[0] && !(in->_ops[1] || in->_ops[2])) {
3195 ir_value_dump(in->_ops[0], oprintf);
3200 for (i = 1; i != 3; ++i) {
3204 ir_value_dump(in->_ops[i], oprintf);
3212 oprintf("[%s]", in->bops[0]->label);
3216 oprintf("%s[%s]", comma, in->bops[1]->label);
3217 if (vec_size(in->params)) {
3218 oprintf("\tparams: ");
3219 for (i = 0; i != vec_size(in->params); ++i) {
3220 oprintf("%s, ", in->params[i]->name);
3224 ind[strlen(ind)-1] = 0;
3227 void ir_value_dump(ir_value* v, int (*oprintf)(const char*, ...))
3236 oprintf("fn:%s", v->name);
3239 oprintf("%g", v->constval.vfloat);
3242 oprintf("'%g %g %g'",
3245 v->constval.vvec.z);
3248 oprintf("(entity)");
3251 oprintf("\"%s\"", v->constval.vstring);
3255 oprintf("%i", v->constval.vint);
3260 v->constval.vpointer->name);
3264 oprintf("%s", v->name);
3268 void ir_value_dump_life(const ir_value *self, int (*oprintf)(const char*,...))
3271 oprintf("Life of %12s:", self->name);
3272 for (i = 0; i < vec_size(self->life); ++i)
3274 oprintf(" + [%i, %i]\n", self->life[i].start, self->life[i].end);