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 /***********************************************************************
32 ir_builder* ir_builder_new(const char *modulename)
36 self = (ir_builder*)mem_a(sizeof(*self));
37 MEM_VECTOR_INIT(self, functions);
38 MEM_VECTOR_INIT(self, globals);
40 if (!ir_builder_set_name(self, modulename)) {
45 /* globals which always exist */
47 /* for now we give it a vector size */
48 ir_builder_create_global(self, "OFS_RETURN", TYPE_VARIANT);
53 MEM_VEC_FUNCTIONS(ir_builder, ir_value*, globals)
54 MEM_VEC_FUNCTIONS(ir_builder, ir_function*, functions)
56 void ir_builder_delete(ir_builder* self)
59 mem_d((void*)self->name);
60 for (i = 0; i != self->functions_count; ++i) {
61 ir_function_delete(self->functions[i]);
63 MEM_VECTOR_CLEAR(self, functions);
64 for (i = 0; i != self->globals_count; ++i) {
65 ir_value_delete(self->globals[i]);
67 MEM_VECTOR_CLEAR(self, globals);
71 bool ir_builder_set_name(ir_builder *self, const char *name)
74 mem_d((void*)self->name);
75 self->name = util_strdup(name);
79 ir_function* ir_builder_get_function(ir_builder *self, const char *name)
82 for (i = 0; i < self->functions_count; ++i) {
83 if (!strcmp(name, self->functions[i]->name))
84 return self->functions[i];
89 ir_function* ir_builder_create_function(ir_builder *self, const char *name)
91 ir_function *fn = ir_builder_get_function(self, name);
96 fn = ir_function_new(self);
97 if (!ir_function_set_name(fn, name) ||
98 !ir_builder_functions_add(self, fn) )
100 ir_function_delete(fn);
106 ir_value* ir_builder_get_global(ir_builder *self, const char *name)
109 for (i = 0; i < self->globals_count; ++i) {
110 if (!strcmp(self->globals[i]->name, name))
111 return self->globals[i];
116 ir_value* ir_builder_create_global(ir_builder *self, const char *name, int vtype)
118 ir_value *ve = ir_builder_get_global(self, name);
123 ve = ir_value_var(name, store_global, vtype);
124 if (!ir_builder_globals_add(self, ve)) {
131 /***********************************************************************
135 bool ir_function_naive_phi(ir_function*);
136 void ir_function_enumerate(ir_function*);
137 bool ir_function_calculate_liferanges(ir_function*);
139 ir_function* ir_function_new(ir_builder* owner)
142 self = (ir_function*)mem_a(sizeof(*self));
144 if (!ir_function_set_name(self, "<@unnamed>")) {
149 self->context.file = "<@no context>";
150 self->context.line = 0;
151 self->retype = TYPE_VOID;
152 MEM_VECTOR_INIT(self, params);
153 MEM_VECTOR_INIT(self, blocks);
154 MEM_VECTOR_INIT(self, values);
155 MEM_VECTOR_INIT(self, locals);
160 MEM_VEC_FUNCTIONS(ir_function, ir_value*, values)
161 MEM_VEC_FUNCTIONS(ir_function, ir_block*, blocks)
162 MEM_VEC_FUNCTIONS(ir_function, ir_value*, locals)
164 bool ir_function_set_name(ir_function *self, const char *name)
167 mem_d((void*)self->name);
168 self->name = util_strdup(name);
172 void ir_function_delete(ir_function *self)
175 mem_d((void*)self->name);
177 for (i = 0; i != self->blocks_count; ++i)
178 ir_block_delete(self->blocks[i]);
179 MEM_VECTOR_CLEAR(self, blocks);
181 MEM_VECTOR_CLEAR(self, params);
183 for (i = 0; i != self->values_count; ++i)
184 ir_value_delete(self->values[i]);
185 MEM_VECTOR_CLEAR(self, values);
187 for (i = 0; i != self->locals_count; ++i)
188 ir_value_delete(self->locals[i]);
189 MEM_VECTOR_CLEAR(self, locals);
194 bool GMQCC_WARN ir_function_collect_value(ir_function *self, ir_value *v)
196 return ir_function_values_add(self, v);
199 ir_block* ir_function_create_block(ir_function *self, const char *label)
201 ir_block* bn = ir_block_new(self, label);
202 memcpy(&bn->context, &self->context, sizeof(self->context));
203 if (!ir_function_blocks_add(self, bn)) {
210 bool ir_function_finalize(ir_function *self)
212 if (!ir_function_naive_phi(self))
215 ir_function_enumerate(self);
217 if (!ir_function_calculate_liferanges(self))
222 ir_value* ir_function_get_local(ir_function *self, const char *name)
225 for (i = 0; i < self->locals_count; ++i) {
226 if (!strcmp(self->locals[i]->name, name))
227 return self->locals[i];
232 ir_value* ir_function_create_local(ir_function *self, const char *name, int vtype)
234 ir_value *ve = ir_function_get_local(self, name);
239 ve = ir_value_var(name, store_local, vtype);
240 if (!ir_function_locals_add(self, ve)) {
247 /***********************************************************************
251 ir_block* ir_block_new(ir_function* owner, const char *name)
254 self = (ir_block*)mem_a(sizeof(*self));
256 if (!ir_block_set_label(self, name)) {
261 self->context.file = "<@no context>";
262 self->context.line = 0;
264 MEM_VECTOR_INIT(self, instr);
265 MEM_VECTOR_INIT(self, entries);
266 MEM_VECTOR_INIT(self, exits);
269 self->is_return = false;
271 MEM_VECTOR_INIT(self, living);
274 MEM_VEC_FUNCTIONS(ir_block, ir_instr*, instr)
275 MEM_VEC_FUNCTIONS_ALL(ir_block, ir_block*, entries)
276 MEM_VEC_FUNCTIONS_ALL(ir_block, ir_block*, exits)
277 MEM_VEC_FUNCTIONS_ALL(ir_block, ir_value*, living)
279 void ir_block_delete(ir_block* self)
283 for (i = 0; i != self->instr_count; ++i)
284 ir_instr_delete(self->instr[i]);
285 MEM_VECTOR_CLEAR(self, instr);
286 MEM_VECTOR_CLEAR(self, entries);
287 MEM_VECTOR_CLEAR(self, exits);
288 MEM_VECTOR_CLEAR(self, living);
292 bool ir_block_set_label(ir_block *self, const char *name)
295 mem_d((void*)self->label);
296 self->label = util_strdup(name);
297 return !!self->label;
300 /***********************************************************************
304 ir_instr* ir_instr_new(ir_block* owner, int op)
307 self = (ir_instr*)mem_a(sizeof(*self));
309 self->context.file = "<@no context>";
310 self->context.line = 0;
312 self->_ops[0] = NULL;
313 self->_ops[1] = NULL;
314 self->_ops[2] = NULL;
315 self->bops[0] = NULL;
316 self->bops[1] = NULL;
317 MEM_VECTOR_INIT(self, phi);
322 MEM_VEC_FUNCTIONS(ir_instr, ir_phi_entry_t, phi)
324 void ir_instr_delete(ir_instr *self)
327 /* The following calls can only delete from
328 * vectors, we still want to delete this instruction
329 * so ignore the return value. Since with the warn_unused_result attribute
330 * gcc doesn't care about an explicit: (void)foo(); to ignore the result,
331 * I have to improvise here and use if(foo());
333 for (i = 0; i < self->phi_count; ++i) {
335 if (ir_value_writes_find(self->phi[i].value, self, &idx))
336 if (ir_value_writes_remove(self->phi[i].value, idx)) GMQCC_SUPRESS_EMPTY_BODY;
337 if (ir_value_reads_find(self->phi[i].value, self, &idx))
338 if (ir_value_reads_remove (self->phi[i].value, idx)) GMQCC_SUPRESS_EMPTY_BODY;
340 MEM_VECTOR_CLEAR(self, phi);
341 if (ir_instr_op(self, 0, NULL, false)) GMQCC_SUPRESS_EMPTY_BODY;
342 if (ir_instr_op(self, 1, NULL, false)) GMQCC_SUPRESS_EMPTY_BODY;
343 if (ir_instr_op(self, 2, NULL, false)) GMQCC_SUPRESS_EMPTY_BODY;
347 bool ir_instr_op(ir_instr *self, int op, ir_value *v, bool writing)
349 if (self->_ops[op]) {
351 if (writing && ir_value_writes_find(self->_ops[op], self, &idx))
353 if (!ir_value_writes_remove(self->_ops[op], idx))
356 else if (ir_value_reads_find(self->_ops[op], self, &idx))
358 if (!ir_value_reads_remove(self->_ops[op], idx))
364 if (!ir_value_writes_add(v, self))
367 if (!ir_value_reads_add(v, self))
375 /***********************************************************************
379 ir_value* ir_value_var(const char *name, int storetype, int vtype)
382 self = (ir_value*)mem_a(sizeof(*self));
384 self->fieldtype = TYPE_VOID;
385 self->store = storetype;
386 MEM_VECTOR_INIT(self, reads);
387 MEM_VECTOR_INIT(self, writes);
388 self->isconst = false;
389 self->context.file = "<@no context>";
390 self->context.line = 0;
392 ir_value_set_name(self, name);
394 memset(&self->constval, 0, sizeof(self->constval));
395 memset(&self->code, 0, sizeof(self->code));
397 MEM_VECTOR_INIT(self, life);
400 MEM_VEC_FUNCTIONS(ir_value, ir_life_entry_t, life)
401 MEM_VEC_FUNCTIONS_ALL(ir_value, ir_instr*, reads)
402 MEM_VEC_FUNCTIONS_ALL(ir_value, ir_instr*, writes)
404 ir_value* ir_value_out(ir_function *owner, const char *name, int storetype, int vtype)
406 ir_value *v = ir_value_var(name, storetype, vtype);
409 if (!ir_function_collect_value(owner, v))
417 void ir_value_delete(ir_value* self)
419 mem_d((void*)self->name);
422 if (self->vtype == TYPE_STRING)
423 mem_d((void*)self->constval.vstring);
425 MEM_VECTOR_CLEAR(self, reads);
426 MEM_VECTOR_CLEAR(self, writes);
427 MEM_VECTOR_CLEAR(self, life);
431 void ir_value_set_name(ir_value *self, const char *name)
434 mem_d((void*)self->name);
435 self->name = util_strdup(name);
438 bool ir_value_set_float(ir_value *self, float f)
440 if (self->vtype != TYPE_FLOAT)
442 self->constval.vfloat = f;
443 self->isconst = true;
447 bool ir_value_set_vector(ir_value *self, vector v)
449 if (self->vtype != TYPE_VECTOR)
451 self->constval.vvec = v;
452 self->isconst = true;
456 bool ir_value_set_string(ir_value *self, const char *str)
458 if (self->vtype != TYPE_STRING)
460 self->constval.vstring = util_strdup(str);
461 self->isconst = true;
466 bool ir_value_set_int(ir_value *self, int i)
468 if (self->vtype != TYPE_INTEGER)
470 self->constval.vint = i;
471 self->isconst = true;
476 bool ir_value_lives(ir_value *self, size_t at)
479 for (i = 0; i < self->life_count; ++i)
481 ir_life_entry_t *life = &self->life[i];
482 if (life->start <= at && at <= life->end)
484 if (life->start > at) /* since it's ordered */
490 bool ir_value_life_insert(ir_value *self, size_t idx, ir_life_entry_t e)
493 if (!ir_value_life_add(self, e)) /* naive... */
495 for (k = self->life_count-1; k > idx; --k)
496 self->life[k] = self->life[k-1];
501 bool ir_value_life_merge(ir_value *self, size_t s)
504 ir_life_entry_t *life = NULL;
505 ir_life_entry_t *before = NULL;
506 ir_life_entry_t new_entry;
508 /* Find the first range >= s */
509 for (i = 0; i < self->life_count; ++i)
512 life = &self->life[i];
516 /* nothing found? append */
517 if (i == self->life_count) {
519 if (life && life->end+1 == s)
521 /* previous life range can be merged in */
525 if (life && life->end >= s)
528 if (!ir_value_life_add(self, e))
529 return false; /* failing */
535 if (before->end + 1 == s &&
536 life->start - 1 == s)
539 before->end = life->end;
540 if (!ir_value_life_remove(self, i))
541 return false; /* failing */
544 if (before->end + 1 == s)
550 /* already contained */
551 if (before->end >= s)
555 if (life->start - 1 == s)
560 /* insert a new entry */
561 new_entry.start = new_entry.end = s;
562 return ir_value_life_insert(self, i, new_entry);
565 bool ir_values_overlap(ir_value *a, ir_value *b)
567 /* For any life entry in A see if it overlaps with
568 * any life entry in B.
569 * Note that the life entries are orderes, so we can make a
570 * more efficient algorithm there than naively translating the
574 ir_life_entry_t *la, *lb, *enda, *endb;
576 /* first of all, if either has no life range, they cannot clash */
577 if (!a->life_count || !b->life_count)
582 enda = la + a->life_count;
583 endb = lb + b->life_count;
586 /* check if the entries overlap, for that,
587 * both must start before the other one ends.
589 #if defined(LIFE_RANGE_WITHOUT_LAST_READ)
590 if (la->start <= lb->end &&
591 lb->start <= la->end)
593 if (la->start < lb->end &&
600 /* entries are ordered
601 * one entry is earlier than the other
602 * that earlier entry will be moved forward
604 if (la->end < lb->end)
606 /* order: A B, move A forward
607 * check if we hit the end with A
612 else if (lb->end < la->end)
614 /* order: B A, move B forward
615 * check if we hit the end with B
624 /***********************************************************************
628 bool ir_block_create_store_op(ir_block *self, int op, ir_value *target, ir_value *what)
630 if (target->store == store_value) {
631 fprintf(stderr, "cannot store to an SSA value\n");
632 fprintf(stderr, "trying to store: %s <- %s\n", target->name, what->name);
635 ir_instr *in = ir_instr_new(self, op);
638 if (!ir_instr_op(in, 0, target, true) ||
639 !ir_instr_op(in, 1, what, false) ||
640 !ir_block_instr_add(self, in) )
648 bool ir_block_create_store(ir_block *self, ir_value *target, ir_value *what)
652 if (target->vtype == TYPE_VARIANT)
655 vtype = target->vtype;
660 if (what->vtype == TYPE_INTEGER)
661 op = INSTR_CONV_ITOF;
670 op = INSTR_STORE_ENT;
676 op = INSTR_STORE_FLD;
680 if (what->vtype == TYPE_INTEGER)
681 op = INSTR_CONV_FTOI;
690 op = INSTR_STORE_ENT;
697 return ir_block_create_store_op(self, op, target, what);
700 bool ir_block_create_storep(ir_block *self, ir_value *target, ir_value *what)
705 if (target->vtype != TYPE_POINTER)
708 /* storing using pointer - target is a pointer, type must be
709 * inferred from source
721 op = INSTR_STOREP_ENT;
727 op = INSTR_STOREP_FLD;
738 op = INSTR_STOREP_ENT;
745 return ir_block_create_store_op(self, op, target, what);
748 bool ir_block_create_return(ir_block *self, ir_value *v)
752 fprintf(stderr, "block already ended (%s)\n", self->label);
756 self->is_return = true;
757 in = ir_instr_new(self, INSTR_RETURN);
761 if (!ir_instr_op(in, 0, v, false) ||
762 !ir_block_instr_add(self, in) )
769 bool ir_block_create_if(ir_block *self, ir_value *v,
770 ir_block *ontrue, ir_block *onfalse)
774 fprintf(stderr, "block already ended (%s)\n", self->label);
778 /*in = ir_instr_new(self, (v->vtype == TYPE_STRING ? INSTR_IF_S : INSTR_IF_F));*/
779 in = ir_instr_new(self, VINSTR_COND);
783 if (!ir_instr_op(in, 0, v, false)) {
788 in->bops[0] = ontrue;
789 in->bops[1] = onfalse;
791 if (!ir_block_instr_add(self, in))
794 if (!ir_block_exits_add(self, ontrue) ||
795 !ir_block_exits_add(self, onfalse) ||
796 !ir_block_entries_add(ontrue, self) ||
797 !ir_block_entries_add(onfalse, self) )
804 bool ir_block_create_jump(ir_block *self, ir_block *to)
808 fprintf(stderr, "block already ended (%s)\n", self->label);
812 in = ir_instr_new(self, VINSTR_JUMP);
817 if (!ir_block_instr_add(self, in))
820 if (!ir_block_exits_add(self, to) ||
821 !ir_block_entries_add(to, self) )
828 bool ir_block_create_goto(ir_block *self, ir_block *to)
832 fprintf(stderr, "block already ended (%s)\n", self->label);
836 in = ir_instr_new(self, INSTR_GOTO);
841 if (!ir_block_instr_add(self, in))
844 if (!ir_block_exits_add(self, to) ||
845 !ir_block_entries_add(to, self) )
852 ir_instr* ir_block_create_phi(ir_block *self, const char *label, int ot)
856 in = ir_instr_new(self, VINSTR_PHI);
859 out = ir_value_out(self->owner, label, store_value, ot);
864 if (!ir_instr_op(in, 0, out, true)) {
866 ir_value_delete(out);
869 if (!ir_block_instr_add(self, in)) {
871 ir_value_delete(out);
877 ir_value* ir_phi_value(ir_instr *self)
879 return self->_ops[0];
882 bool ir_phi_add(ir_instr* self, ir_block *b, ir_value *v)
886 if (!ir_block_entries_find(self->owner, b, NULL)) {
887 /* Must not be possible to cause this, otherwise the AST
888 * is doing something wrong.
890 fprintf(stderr, "Invalid entry block for PHI\n");
896 if (!ir_value_reads_add(v, self))
898 return ir_instr_phi_add(self, pe);
901 /* binary op related code */
903 ir_value* ir_block_create_binop(ir_block *self,
904 const char *label, int opcode,
905 ir_value *left, ir_value *right)
927 case INSTR_SUB_S: /* -- offset of string as float */
934 case INSTR_BITAND_FI:
935 case INSTR_BITAND_IF:
976 /* boolean operations result in floats */
977 if (opcode >= INSTR_EQ_F && opcode <= INSTR_GT)
979 else if (opcode >= INSTR_LE && opcode <= INSTR_GT)
982 else if (opcode >= INSTR_LE_I && opcode <= INSTR_EQ_FI)
987 if (ot == TYPE_VOID) {
988 /* The AST or parser were supposed to check this! */
992 return ir_block_create_general_instr(self, label, opcode, left, right, ot);
995 ir_value* ir_block_create_general_instr(ir_block *self, const char *label,
996 int op, ir_value *a, ir_value *b, int outype)
1001 out = ir_value_out(self->owner, label, store_value, outype);
1005 instr = ir_instr_new(self, op);
1007 ir_value_delete(out);
1011 if (!ir_instr_op(instr, 0, out, true) ||
1012 !ir_instr_op(instr, 1, a, false) ||
1013 !ir_instr_op(instr, 2, b, false) )
1018 if (!ir_block_instr_add(self, instr))
1023 ir_instr_delete(instr);
1024 ir_value_delete(out);
1028 ir_value* ir_block_create_fieldaddress(ir_block *self, const char *label, ir_value *ent, ir_value *field)
1030 /* Support for various pointer types todo if so desired */
1031 if (ent->vtype != TYPE_ENTITY)
1034 if (field->vtype != TYPE_FIELD)
1037 return ir_block_create_general_instr(self, label, INSTR_ADDRESS, ent, field, TYPE_POINTER);
1040 ir_value* ir_block_create_load_from_ent(ir_block *self, const char *label, ir_value *ent, ir_value *field, int outype)
1043 if (ent->vtype != TYPE_ENTITY)
1046 /* at some point we could redirect for TYPE_POINTER... but that could lead to carelessness */
1047 if (field->vtype != TYPE_FIELD)
1052 case TYPE_FLOAT: op = INSTR_LOAD_F; break;
1053 case TYPE_VECTOR: op = INSTR_LOAD_V; break;
1054 case TYPE_STRING: op = INSTR_LOAD_S; break;
1055 case TYPE_FIELD: op = INSTR_LOAD_FLD; break;
1056 case TYPE_ENTITY: op = INSTR_LOAD_ENT; break;
1058 case TYPE_POINTER: op = INSTR_LOAD_I; break;
1059 case TYPE_INTEGER: op = INSTR_LOAD_I; break;
1065 return ir_block_create_general_instr(self, label, op, ent, field, outype);
1068 ir_value* ir_block_create_add(ir_block *self,
1070 ir_value *left, ir_value *right)
1073 int l = left->vtype;
1074 int r = right->vtype;
1093 if ( (l == TYPE_FLOAT && r == TYPE_INTEGER) )
1095 else if ( (l == TYPE_INTEGER && r == TYPE_FLOAT) )
1101 return ir_block_create_binop(self, label, op, left, right);
1104 ir_value* ir_block_create_sub(ir_block *self,
1106 ir_value *left, ir_value *right)
1109 int l = left->vtype;
1110 int r = right->vtype;
1130 if ( (l == TYPE_FLOAT && r == TYPE_INTEGER) )
1132 else if ( (l == TYPE_INTEGER && r == TYPE_FLOAT) )
1138 return ir_block_create_binop(self, label, op, left, right);
1141 ir_value* ir_block_create_mul(ir_block *self,
1143 ir_value *left, ir_value *right)
1146 int l = left->vtype;
1147 int r = right->vtype;
1166 if ( (l == TYPE_VECTOR && r == TYPE_FLOAT) )
1168 else if ( (l == TYPE_FLOAT && r == TYPE_VECTOR) )
1171 else if ( (l == TYPE_VECTOR && r == TYPE_INTEGER) )
1173 else if ( (l == TYPE_INTEGER && r == TYPE_VECTOR) )
1175 else if ( (l == TYPE_FLOAT && r == TYPE_INTEGER) )
1177 else if ( (l == TYPE_INTEGER && r == TYPE_FLOAT) )
1183 return ir_block_create_binop(self, label, op, left, right);
1186 ir_value* ir_block_create_div(ir_block *self,
1188 ir_value *left, ir_value *right)
1191 int l = left->vtype;
1192 int r = right->vtype;
1209 if ( (l == TYPE_VECTOR && r == TYPE_FLOAT) )
1211 else if ( (l == TYPE_FLOAT && r == TYPE_INTEGER) )
1213 else if ( (l == TYPE_INTEGER && r == TYPE_FLOAT) )
1219 return ir_block_create_binop(self, label, op, left, right);
1222 /* PHI resolving breaks the SSA, and must thus be the last
1223 * step before life-range calculation.
1226 static bool ir_block_naive_phi(ir_block *self);
1227 bool ir_function_naive_phi(ir_function *self)
1231 for (i = 0; i < self->blocks_count; ++i)
1233 if (!ir_block_naive_phi(self->blocks[i]))
1239 static bool ir_naive_phi_emit_store(ir_block *block, size_t iid, ir_value *old, ir_value *what)
1244 /* create a store */
1245 if (!ir_block_create_store(block, old, what))
1248 /* we now move it up */
1249 instr = block->instr[block->instr_count-1];
1250 for (i = block->instr_count; i > iid; --i)
1251 block->instr[i] = block->instr[i-1];
1252 block->instr[i] = instr;
1257 static bool ir_block_naive_phi(ir_block *self)
1260 /* FIXME: optionally, create_phi can add the phis
1261 * to a list so we don't need to loop through blocks
1262 * - anyway: "don't optimize YET"
1264 for (i = 0; i < self->instr_count; ++i)
1266 ir_instr *instr = self->instr[i];
1267 if (instr->opcode != VINSTR_PHI)
1270 if (!ir_block_instr_remove(self, i))
1272 --i; /* NOTE: i+1 below */
1274 for (p = 0; p < instr->phi_count; ++p)
1276 ir_value *v = instr->phi[p].value;
1277 for (w = 0; w < v->writes_count; ++w) {
1280 if (!v->writes[w]->_ops[0])
1283 /* When the write was to a global, we have to emit a mov */
1284 old = v->writes[w]->_ops[0];
1286 /* The original instruction now writes to the PHI target local */
1287 if (v->writes[w]->_ops[0] == v)
1288 v->writes[w]->_ops[0] = instr->_ops[0];
1290 if (old->store != store_value && old->store != store_local)
1292 /* If it originally wrote to a global we need to store the value
1295 if (!ir_naive_phi_emit_store(self, i+1, old, v))
1297 if (i+1 < self->instr_count)
1298 instr = self->instr[i+1];
1301 /* In case I forget and access instr later, it'll be NULL
1302 * when it's a problem, to make sure we crash, rather than accessing
1308 /* If it didn't, we can replace all reads by the phi target now. */
1310 for (r = 0; r < old->reads_count; ++r)
1313 ir_instr *ri = old->reads[r];
1314 for (op = 0; op < ri->phi_count; ++op) {
1315 if (ri->phi[op].value == old)
1316 ri->phi[op].value = v;
1318 for (op = 0; op < 3; ++op) {
1319 if (ri->_ops[op] == old)
1326 ir_instr_delete(instr);
1331 /***********************************************************************
1332 *IR Temp allocation code
1333 * Propagating value life ranges by walking through the function backwards
1334 * until no more changes are made.
1335 * In theory this should happen once more than once for every nested loop
1337 * Though this implementation might run an additional time for if nests.
1346 MEM_VEC_FUNCTIONS_ALL(new_reads_t, ir_value*, v)
1348 /* Enumerate instructions used by value's life-ranges
1350 static void ir_block_enumerate(ir_block *self, size_t *_eid)
1354 for (i = 0; i < self->instr_count; ++i)
1356 self->instr[i]->eid = eid++;
1361 /* Enumerate blocks and instructions.
1362 * The block-enumeration is unordered!
1363 * We do not really use the block enumreation, however
1364 * the instruction enumeration is important for life-ranges.
1366 void ir_function_enumerate(ir_function *self)
1369 size_t instruction_id = 0;
1370 for (i = 0; i < self->blocks_count; ++i)
1372 self->blocks[i]->eid = i;
1373 self->blocks[i]->run_id = 0;
1374 ir_block_enumerate(self->blocks[i], &instruction_id);
1378 static bool ir_block_life_propagate(ir_block *b, ir_block *prev, bool *changed);
1379 bool ir_function_calculate_liferanges(ir_function *self)
1387 for (i = 0; i != self->blocks_count; ++i)
1389 if (self->blocks[i]->is_return)
1391 if (!ir_block_life_propagate(self->blocks[i], NULL, &changed))
1399 /* Get information about which operand
1400 * is read from, or written to.
1402 static void ir_op_read_write(int op, size_t *read, size_t *write)
1429 static bool ir_block_living_add_instr(ir_block *self, size_t eid)
1432 bool changed = false;
1434 for (i = 0; i != self->living_count; ++i)
1436 tempbool = ir_value_life_merge(self->living[i], eid);
1439 fprintf(stderr, "block_living_add_instr() value instruction added %s: %i\n", self->living[i]->_name, (int)eid);
1441 changed = changed || tempbool;
1446 static bool ir_block_life_prop_previous(ir_block* self, ir_block *prev, bool *changed)
1449 /* values which have been read in a previous iteration are now
1450 * in the "living" array even if the previous block doesn't use them.
1451 * So we have to remove whatever does not exist in the previous block.
1452 * They will be re-added on-read, but the liferange merge won't cause
1455 for (i = 0; i < self->living_count; ++i)
1457 if (!ir_block_living_find(prev, self->living[i], NULL)) {
1458 if (!ir_block_living_remove(self, i))
1464 /* Whatever the previous block still has in its living set
1465 * must now be added to ours as well.
1467 for (i = 0; i < prev->living_count; ++i)
1469 if (ir_block_living_find(self, prev->living[i], NULL))
1471 if (!ir_block_living_add(self, prev->living[i]))
1474 printf("%s got from prev: %s\n", self->label, prev->living[i]->_name);
1480 static bool ir_block_life_propagate(ir_block *self, ir_block *prev, bool *changed)
1486 /* bitmasks which operands are read from or written to */
1488 #if defined(LIFE_RANGE_WITHOUT_LAST_READ)
1490 new_reads_t new_reads;
1492 char dbg_ind[16] = { '#', '0' };
1495 #if defined(LIFE_RANGE_WITHOUT_LAST_READ)
1496 MEM_VECTOR_INIT(&new_reads, v);
1501 if (!ir_block_life_prop_previous(self, prev, changed))
1505 i = self->instr_count;
1508 instr = self->instr[i];
1510 /* PHI operands are always read operands */
1511 for (p = 0; p < instr->phi_count; ++p)
1513 value = instr->phi[p].value;
1514 #if ! defined(LIFE_RANGE_WITHOUT_LAST_READ)
1515 if (!ir_block_living_find(self, value, NULL) &&
1516 !ir_block_living_add(self, value))
1521 if (!new_reads_t_v_find(&new_reads, value, NULL))
1523 if (!new_reads_t_v_add(&new_reads, value))
1529 /* See which operands are read and write operands */
1530 ir_op_read_write(instr->opcode, &read, &write);
1532 /* Go through the 3 main operands */
1533 for (o = 0; o < 3; ++o)
1535 if (!instr->_ops[o]) /* no such operand */
1538 value = instr->_ops[o];
1540 /* We only care about locals */
1541 if (value->store != store_value &&
1542 value->store != store_local)
1548 #if ! defined(LIFE_RANGE_WITHOUT_LAST_READ)
1549 if (!ir_block_living_find(self, value, NULL) &&
1550 !ir_block_living_add(self, value))
1555 /* fprintf(stderr, "read: %s\n", value->_name); */
1556 if (!new_reads_t_v_find(&new_reads, value, NULL))
1558 if (!new_reads_t_v_add(&new_reads, value))
1564 /* write operands */
1565 /* When we write to a local, we consider it "dead" for the
1566 * remaining upper part of the function, since in SSA a value
1567 * can only be written once (== created)
1572 bool in_living = ir_block_living_find(self, value, &idx);
1573 #if defined(LIFE_RANGE_WITHOUT_LAST_READ)
1575 bool in_reads = new_reads_t_v_find(&new_reads, value, &readidx);
1576 if (!in_living && !in_reads)
1581 /* If the value isn't alive it hasn't been read before... */
1582 /* TODO: See if the warning can be emitted during parsing or AST processing
1583 * otherwise have warning printed here.
1584 * IF printing a warning here: include filecontext_t,
1585 * and make sure it's only printed once
1586 * since this function is run multiple times.
1588 /* For now: debug info: */
1589 fprintf(stderr, "Value only written %s\n", value->name);
1590 tempbool = ir_value_life_merge(value, instr->eid);
1591 *changed = *changed || tempbool;
1593 ir_instr_dump(instr, dbg_ind, printf);
1597 /* since 'living' won't contain it
1598 * anymore, merge the value, since
1601 tempbool = ir_value_life_merge(value, instr->eid);
1604 fprintf(stderr, "value added id %s %i\n", value->name, (int)instr->eid);
1606 *changed = *changed || tempbool;
1608 #if ! defined(LIFE_RANGE_WITHOUT_LAST_READ)
1609 if (!ir_block_living_remove(self, idx))
1614 if (!new_reads_t_v_remove(&new_reads, readidx))
1622 tempbool = ir_block_living_add_instr(self, instr->eid);
1623 /*fprintf(stderr, "living added values\n");*/
1624 *changed = *changed || tempbool;
1626 #if defined(LIFE_RANGE_WITHOUT_LAST_READ)
1628 for (rd = 0; rd < new_reads.v_count; ++rd)
1630 if (!ir_block_living_find(self, new_reads.v[rd], NULL)) {
1631 if (!ir_block_living_add(self, new_reads.v[rd]))
1634 if (!i && !self->entries_count) {
1636 *changed = *changed || ir_value_life_merge(new_reads.v[rd], instr->eid);
1639 MEM_VECTOR_CLEAR(&new_reads, v);
1643 if (self->run_id == self->owner->run_id)
1646 self->run_id = self->owner->run_id;
1648 for (i = 0; i < self->entries_count; ++i)
1650 ir_block *entry = self->entries[i];
1651 ir_block_life_propagate(entry, self, changed);
1656 #if defined(LIFE_RANGE_WITHOUT_LAST_READ)
1657 MEM_VECTOR_CLEAR(&new_reads, v);
1662 /***********************************************************************
1665 * Since the IR has the convention of putting 'write' operands
1666 * at the beginning, we have to rotate the operands of instructions
1667 * properly in order to generate valid QCVM code.
1669 * Having destinations at a fixed position is more convenient. In QC
1670 * this is *mostly* OPC, but FTE adds at least 2 instructions which
1671 * read from from OPA, and store to OPB rather than OPC. Which is
1672 * partially the reason why the implementation of these instructions
1673 * in darkplaces has been delayed for so long.
1675 * Breaking conventions is annoying...
1677 static bool ir_builder_gen_global(ir_builder *self, ir_value *global);
1679 static bool gen_global_field(ir_value *global)
1681 if (global->isconst)
1683 ir_value *fld = global->constval.vpointer;
1685 printf("Invalid field constant with no field: %s\n", global->name);
1689 /* Now, in this case, a relocation would be impossible to code
1690 * since it looks like this:
1691 * .vector v = origin; <- parse error, wtf is 'origin'?
1694 * But we will need a general relocation support later anyway
1695 * for functions... might as well support that here.
1697 if (!fld->code.globaladdr) {
1698 printf("FIXME: Relocation support\n");
1702 /* copy the field's value */
1703 global->code.globaladdr = code_globals_add(code_globals_data[fld->code.globaladdr]);
1707 prog_section_field fld;
1709 fld.name = global->code.name;
1710 fld.offset = code_fields_elements;
1711 fld.type = global->fieldtype;
1713 if (fld.type == TYPE_VOID) {
1714 printf("Field is missing a type: %s\n", global->name);
1718 if (code_fields_add(fld) < 0)
1721 global->code.globaladdr = code_globals_add(fld.offset);
1723 if (global->code.globaladdr < 0)
1728 static bool gen_global_pointer(ir_value *global)
1730 if (global->isconst)
1732 ir_value *target = global->constval.vpointer;
1734 printf("Invalid pointer constant: %s\n", global->name);
1735 /* NULL pointers are pointing to the NULL constant, which also
1736 * sits at address 0, but still has an ir_value for itself.
1741 /* Here, relocations ARE possible - in fteqcc-enhanced-qc:
1742 * void() foo; <- proto
1743 * void() *fooptr = &foo;
1744 * void() foo = { code }
1746 if (!target->code.globaladdr) {
1747 /* FIXME: Check for the constant nullptr ir_value!
1748 * because then code.globaladdr being 0 is valid.
1750 printf("FIXME: Relocation support\n");
1754 global->code.globaladdr = code_globals_add(target->code.globaladdr);
1758 global->code.globaladdr = code_globals_add(0);
1760 if (global->code.globaladdr < 0)
1765 static bool gen_function_code(ir_function *self)
1770 static bool gen_global_function(ir_builder *ir, ir_value *global)
1772 prog_section_function fun;
1777 if (!global->isconst ||
1778 !global->constval.vfunc)
1780 printf("Invalid state of function-global: not constant: %s\n", global->name);
1784 irfun = global->constval.vfunc;
1786 fun.name = global->code.name;
1787 fun.file = code_cachedstring(global->context.file);
1788 fun.profile = 0; /* always 0 */
1789 fun.nargs = irfun->params_count;
1791 for (i = 0;i < 8; ++i) {
1794 else if (irfun->params[i] == TYPE_VECTOR)
1800 fun.locals = irfun->locals_count;
1801 fun.firstlocal = code_globals_elements;
1802 for (i = 0; i < irfun->locals_count; ++i) {
1803 if (!ir_builder_gen_global(ir, irfun->locals[i]))
1807 fun.entry = code_statements_elements;
1808 if (!gen_function_code(irfun))
1811 return (code_functions_add(fun) >= 0);
1814 static bool ir_builder_gen_global(ir_builder *self, ir_value *global)
1817 prog_section_def def;
1820 def.offset = code_globals_elements;
1821 def.name = global->code.name = code_genstring(global->name);
1823 switch (global->vtype)
1827 if (code_defs_add(def) < 0)
1829 return gen_global_pointer(global);
1832 if (code_defs_add(def) < 0)
1834 return gen_global_field(global);
1837 if (code_defs_add(def) < 0)
1843 if (code_defs_add(def) < 0)
1846 if (global->isconst) {
1847 iptr = (int32_t*)&global->constval.vfloat;
1848 global->code.globaladdr = code_globals_add(*iptr);
1850 global->code.globaladdr = code_globals_add(0);
1852 return global->code.globaladdr >= 0;
1857 if (code_defs_add(def) < 0)
1859 if (global->isconst)
1860 global->code.globaladdr = code_globals_add(code_cachedstring(global->constval.vstring));
1862 global->code.globaladdr = code_globals_add(0);
1863 return global->code.globaladdr >= 0;
1869 if (code_defs_add(def) < 0)
1872 if (global->isconst) {
1873 iptr = (int32_t*)&global->constval.vvec;
1874 global->code.globaladdr = code_globals_add(iptr[0]);
1875 if (code_globals_add(iptr[1]) < 0 || code_globals_add(iptr[2]) < 0)
1878 global->code.globaladdr = code_globals_add(0);
1879 if (code_globals_add(0) < 0 || code_globals_add(0) < 0)
1882 return global->code.globaladdr >= 0;
1886 if (code_defs_add(def) < 0)
1888 return gen_global_function(self, global);
1890 /* refuse to create 'void' type or any other fancy business. */
1891 printf("Invalid type for global variable %s\n", global->name);
1896 bool ir_builder_generate(ir_builder *self, const char *filename)
1902 /* FIXME: generate TYPE_FUNCTION globals and link them
1903 * to their ir_function.
1906 for (i = 0; i < self->globals_count; ++i)
1908 if (!ir_builder_gen_global(self, self->globals[i]))
1912 code_write(filename);
1916 /***********************************************************************
1917 *IR DEBUG Dump functions...
1920 #define IND_BUFSZ 1024
1922 const char *qc_opname(int op)
1924 if (op < 0) return "<INVALID>";
1925 if (op < ( sizeof(asm_instr) / sizeof(asm_instr[0]) ))
1926 return asm_instr[op].m;
1928 case VINSTR_PHI: return "PHI";
1929 case VINSTR_JUMP: return "JUMP";
1930 case VINSTR_COND: return "COND";
1931 default: return "<UNK>";
1935 void ir_builder_dump(ir_builder *b, int (*oprintf)(const char*, ...))
1938 char indent[IND_BUFSZ];
1942 oprintf("module %s\n", b->name);
1943 for (i = 0; i < b->globals_count; ++i)
1946 if (b->globals[i]->isconst)
1947 oprintf("%s = ", b->globals[i]->name);
1948 ir_value_dump(b->globals[i], oprintf);
1951 for (i = 0; i < b->functions_count; ++i)
1952 ir_function_dump(b->functions[i], indent, oprintf);
1953 oprintf("endmodule %s\n", b->name);
1956 void ir_function_dump(ir_function *f, char *ind,
1957 int (*oprintf)(const char*, ...))
1960 oprintf("%sfunction %s\n", ind, f->name);
1961 strncat(ind, "\t", IND_BUFSZ);
1962 if (f->locals_count)
1964 oprintf("%s%i locals:\n", ind, (int)f->locals_count);
1965 for (i = 0; i < f->locals_count; ++i) {
1966 oprintf("%s\t", ind);
1967 ir_value_dump(f->locals[i], oprintf);
1971 if (f->blocks_count)
1973 oprintf("%slife passes (check): %i\n", ind, (int)f->run_id);
1974 for (i = 0; i < f->blocks_count; ++i) {
1975 if (f->blocks[i]->run_id != f->run_id) {
1976 oprintf("%slife pass check fail! %i != %i\n", ind, (int)f->blocks[i]->run_id, (int)f->run_id);
1978 ir_block_dump(f->blocks[i], ind, oprintf);
1982 ind[strlen(ind)-1] = 0;
1983 oprintf("%sendfunction %s\n", ind, f->name);
1986 void ir_block_dump(ir_block* b, char *ind,
1987 int (*oprintf)(const char*, ...))
1990 oprintf("%s:%s\n", ind, b->label);
1991 strncat(ind, "\t", IND_BUFSZ);
1993 for (i = 0; i < b->instr_count; ++i)
1994 ir_instr_dump(b->instr[i], ind, oprintf);
1995 ind[strlen(ind)-1] = 0;
1998 void dump_phi(ir_instr *in, char *ind,
1999 int (*oprintf)(const char*, ...))
2002 oprintf("%s <- phi ", in->_ops[0]->name);
2003 for (i = 0; i < in->phi_count; ++i)
2005 oprintf("([%s] : %s) ", in->phi[i].from->label,
2006 in->phi[i].value->name);
2011 void ir_instr_dump(ir_instr *in, char *ind,
2012 int (*oprintf)(const char*, ...))
2015 const char *comma = NULL;
2017 oprintf("%s (%i) ", ind, (int)in->eid);
2019 if (in->opcode == VINSTR_PHI) {
2020 dump_phi(in, ind, oprintf);
2024 strncat(ind, "\t", IND_BUFSZ);
2026 if (in->_ops[0] && (in->_ops[1] || in->_ops[2])) {
2027 ir_value_dump(in->_ops[0], oprintf);
2028 if (in->_ops[1] || in->_ops[2])
2031 oprintf("%s\t", qc_opname(in->opcode));
2032 if (in->_ops[0] && !(in->_ops[1] || in->_ops[2])) {
2033 ir_value_dump(in->_ops[0], oprintf);
2038 for (i = 1; i != 3; ++i) {
2042 ir_value_dump(in->_ops[i], oprintf);
2050 oprintf("[%s]", in->bops[0]->label);
2054 oprintf("%s[%s]", comma, in->bops[1]->label);
2056 ind[strlen(ind)-1] = 0;
2059 void ir_value_dump(ir_value* v, int (*oprintf)(const char*, ...))
2067 oprintf("%g", v->constval.vfloat);
2070 oprintf("'%g %g %g'",
2073 v->constval.vvec.z);
2076 oprintf("(entity)");
2079 oprintf("\"%s\"", v->constval.vstring);
2083 oprintf("%i", v->constval.vint);
2088 v->constval.vpointer->name);
2092 oprintf("%s", v->name);
2096 void ir_value_dump_life(ir_value *self, int (*oprintf)(const char*,...))
2099 oprintf("Life of %s:\n", self->name);
2100 for (i = 0; i < self->life_count; ++i)
2102 oprintf(" + [%i, %i]\n", self->life[i].start, self->life[i].end);