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 uint16_t type_not_instr[TYPE_COUNT] = {
175 INSTR_NOT_F, /* should use I when having integer support */
182 INSTR_NOT_ENT, /* should use I */
184 INSTR_NOT_I, /* integer type */
189 INSTR_NOT_V, /* variant, should never be accessed */
191 AINSTR_END, /* struct */
192 AINSTR_END, /* union */
193 AINSTR_END, /* array */
197 static void ir_gen_extparam(ir_builder *ir);
199 /* error functions */
201 static void irerror(lex_ctx ctx, const char *msg, ...)
205 con_cvprintmsg((void*)&ctx, LVL_ERROR, "internal error", msg, ap);
209 static bool irwarning(lex_ctx ctx, int warntype, const char *fmt, ...)
214 r = vcompile_warning(ctx, warntype, fmt, ap);
219 /***********************************************************************
220 * Vector utility functions
223 bool GMQCC_WARN vec_ir_value_find(ir_value **vec, ir_value *what, size_t *idx)
226 size_t len = vec_size(vec);
227 for (i = 0; i < len; ++i) {
228 if (vec[i] == what) {
236 bool GMQCC_WARN vec_ir_block_find(ir_block **vec, ir_block *what, size_t *idx)
239 size_t len = vec_size(vec);
240 for (i = 0; i < len; ++i) {
241 if (vec[i] == what) {
249 bool GMQCC_WARN vec_ir_instr_find(ir_instr **vec, ir_instr *what, size_t *idx)
252 size_t len = vec_size(vec);
253 for (i = 0; i < len; ++i) {
254 if (vec[i] == what) {
262 /***********************************************************************
266 static void ir_block_delete_quick(ir_block* self);
267 static void ir_instr_delete_quick(ir_instr *self);
268 static void ir_function_delete_quick(ir_function *self);
270 ir_builder* ir_builder_new(const char *modulename)
274 self = (ir_builder*)mem_a(sizeof(*self));
278 self->functions = NULL;
279 self->globals = NULL;
281 self->extparams = NULL;
282 self->filenames = NULL;
283 self->filestrings = NULL;
284 self->htglobals = util_htnew(IR_HT_SIZE);
285 self->htfields = util_htnew(IR_HT_SIZE);
286 self->htfunctions = util_htnew(IR_HT_SIZE);
288 self->str_immediate = 0;
290 if (!ir_builder_set_name(self, modulename)) {
298 void ir_builder_delete(ir_builder* self)
301 util_htdel(self->htglobals);
302 util_htdel(self->htfields);
303 util_htdel(self->htfunctions);
304 mem_d((void*)self->name);
305 for (i = 0; i != vec_size(self->functions); ++i) {
306 ir_function_delete_quick(self->functions[i]);
308 vec_free(self->functions);
309 for (i = 0; i != vec_size(self->extparams); ++i) {
310 ir_value_delete(self->extparams[i]);
312 vec_free(self->extparams);
313 for (i = 0; i != vec_size(self->globals); ++i) {
314 ir_value_delete(self->globals[i]);
316 vec_free(self->globals);
317 for (i = 0; i != vec_size(self->fields); ++i) {
318 ir_value_delete(self->fields[i]);
320 vec_free(self->fields);
321 vec_free(self->filenames);
322 vec_free(self->filestrings);
326 bool ir_builder_set_name(ir_builder *self, const char *name)
329 mem_d((void*)self->name);
330 self->name = util_strdup(name);
334 ir_function* ir_builder_get_function(ir_builder *self, const char *name)
336 return (ir_function*)util_htget(self->htfunctions, name);
339 ir_function* ir_builder_create_function(ir_builder *self, const char *name, int outtype)
341 ir_function *fn = ir_builder_get_function(self, name);
346 fn = ir_function_new(self, outtype);
347 if (!ir_function_set_name(fn, name))
349 ir_function_delete(fn);
352 vec_push(self->functions, fn);
353 util_htset(self->htfunctions, name, fn);
355 fn->value = ir_builder_create_global(self, fn->name, TYPE_FUNCTION);
357 ir_function_delete(fn);
361 fn->value->hasvalue = true;
362 fn->value->outtype = outtype;
363 fn->value->constval.vfunc = fn;
364 fn->value->context = fn->context;
369 ir_value* ir_builder_get_global(ir_builder *self, const char *name)
371 return (ir_value*)util_htget(self->htglobals, name);
374 ir_value* ir_builder_create_global(ir_builder *self, const char *name, int vtype)
378 if (name && name[0] != '#')
380 ve = ir_builder_get_global(self, name);
386 ve = ir_value_var(name, store_global, vtype);
387 vec_push(self->globals, ve);
388 util_htset(self->htglobals, name, ve);
392 ir_value* ir_builder_get_field(ir_builder *self, const char *name)
394 return (ir_value*)util_htget(self->htfields, name);
398 ir_value* ir_builder_create_field(ir_builder *self, const char *name, int vtype)
400 ir_value *ve = ir_builder_get_field(self, name);
405 ve = ir_value_var(name, store_global, TYPE_FIELD);
406 ve->fieldtype = vtype;
407 vec_push(self->fields, ve);
408 util_htset(self->htfields, name, ve);
412 /***********************************************************************
416 bool ir_function_naive_phi(ir_function*);
417 void ir_function_enumerate(ir_function*);
418 bool ir_function_calculate_liferanges(ir_function*);
419 bool ir_function_allocate_locals(ir_function*);
421 ir_function* ir_function_new(ir_builder* owner, int outtype)
424 self = (ir_function*)mem_a(sizeof(*self));
429 memset(self, 0, sizeof(*self));
432 if (!ir_function_set_name(self, "<@unnamed>")) {
437 self->context.file = "<@no context>";
438 self->context.line = 0;
439 self->outtype = outtype;
448 self->code_function_def = -1;
449 self->allocated_locals = 0;
455 bool ir_function_set_name(ir_function *self, const char *name)
458 mem_d((void*)self->name);
459 self->name = util_strdup(name);
463 static void ir_function_delete_quick(ir_function *self)
466 mem_d((void*)self->name);
468 for (i = 0; i != vec_size(self->blocks); ++i)
469 ir_block_delete_quick(self->blocks[i]);
470 vec_free(self->blocks);
472 vec_free(self->params);
474 for (i = 0; i != vec_size(self->values); ++i)
475 ir_value_delete(self->values[i]);
476 vec_free(self->values);
478 for (i = 0; i != vec_size(self->locals); ++i)
479 ir_value_delete(self->locals[i]);
480 vec_free(self->locals);
482 /* self->value is deleted by the builder */
487 void ir_function_delete(ir_function *self)
490 mem_d((void*)self->name);
492 for (i = 0; i != vec_size(self->blocks); ++i)
493 ir_block_delete(self->blocks[i]);
494 vec_free(self->blocks);
496 vec_free(self->params);
498 for (i = 0; i != vec_size(self->values); ++i)
499 ir_value_delete(self->values[i]);
500 vec_free(self->values);
502 for (i = 0; i != vec_size(self->locals); ++i)
503 ir_value_delete(self->locals[i]);
504 vec_free(self->locals);
506 /* self->value is deleted by the builder */
511 void ir_function_collect_value(ir_function *self, ir_value *v)
513 vec_push(self->values, v);
516 ir_block* ir_function_create_block(lex_ctx ctx, ir_function *self, const char *label)
518 ir_block* bn = ir_block_new(self, label);
520 vec_push(self->blocks, bn);
524 static bool instr_is_operation(uint16_t op)
526 return ( (op >= INSTR_MUL_F && op <= INSTR_GT) ||
527 (op >= INSTR_LOAD_F && op <= INSTR_LOAD_FNC) ||
528 (op == INSTR_ADDRESS) ||
529 (op >= INSTR_NOT_F && op <= INSTR_NOT_FNC) ||
530 (op >= INSTR_AND && op <= INSTR_BITOR) ||
531 (op >= INSTR_CALL0 && op <= INSTR_CALL8) );
534 bool ir_function_pass_peephole(ir_function *self)
538 for (b = 0; b < vec_size(self->blocks); ++b) {
540 ir_block *block = self->blocks[b];
542 for (i = 0; i < vec_size(block->instr); ++i) {
544 inst = block->instr[i];
547 (inst->opcode >= INSTR_STORE_F &&
548 inst->opcode <= INSTR_STORE_FNC))
556 oper = block->instr[i-1];
557 if (!instr_is_operation(oper->opcode))
560 value = oper->_ops[0];
562 /* only do it for SSA values */
563 if (value->store != store_value)
566 /* don't optimize out the temp if it's used later again */
567 if (vec_size(value->reads) != 1)
570 /* The very next store must use this value */
571 if (value->reads[0] != store)
574 /* And of course the store must _read_ from it, so it's in
576 if (store->_ops[1] != value)
579 ++opts_optimizationcount[OPTIM_PEEPHOLE];
580 (void)!ir_instr_op(oper, 0, store->_ops[0], true);
582 vec_remove(block->instr, i, 1);
583 ir_instr_delete(store);
585 else if (inst->opcode == VINSTR_COND)
587 /* COND on a value resulting from a NOT could
588 * remove the NOT and swap its operands
595 value = inst->_ops[0];
597 if (value->store != store_value ||
598 vec_size(value->reads) != 1 ||
599 value->reads[0] != inst)
604 inot = value->writes[0];
605 if (inot->_ops[0] != value ||
606 inot->opcode < INSTR_NOT_F ||
607 inot->opcode > INSTR_NOT_FNC ||
608 inot->opcode == INSTR_NOT_V) /* can't do this one */
614 ++opts_optimizationcount[OPTIM_PEEPHOLE];
616 (void)!ir_instr_op(inst, 0, inot->_ops[1], false);
619 for (inotid = 0; inotid < vec_size(tmp->instr); ++inotid) {
620 if (tmp->instr[inotid] == inot)
623 if (inotid >= vec_size(tmp->instr)) {
624 compile_error(inst->context, "sanity-check failed: failed to find instruction to optimize out");
627 vec_remove(tmp->instr, inotid, 1);
628 ir_instr_delete(inot);
629 /* swap ontrue/onfalse */
631 inst->bops[0] = inst->bops[1];
642 bool ir_function_pass_tailrecursion(ir_function *self)
646 for (b = 0; b < vec_size(self->blocks); ++b) {
648 ir_instr *ret, *call, *store = NULL;
649 ir_block *block = self->blocks[b];
651 if (!block->final || vec_size(block->instr) < 2)
654 ret = block->instr[vec_size(block->instr)-1];
655 if (ret->opcode != INSTR_DONE && ret->opcode != INSTR_RETURN)
658 call = block->instr[vec_size(block->instr)-2];
659 if (call->opcode >= INSTR_STORE_F && call->opcode <= INSTR_STORE_FNC) {
660 /* account for the unoptimized
662 * STORE %return, %tmp
666 if (vec_size(block->instr) < 3)
670 call = block->instr[vec_size(block->instr)-3];
673 if (call->opcode < INSTR_CALL0 || call->opcode > INSTR_CALL8)
677 /* optimize out the STORE */
679 ret->_ops[0] == store->_ops[0] &&
680 store->_ops[1] == call->_ops[0])
682 ++opts_optimizationcount[OPTIM_PEEPHOLE];
683 call->_ops[0] = store->_ops[0];
684 vec_remove(block->instr, vec_size(block->instr) - 2, 1);
685 ir_instr_delete(store);
694 funcval = call->_ops[1];
697 if (funcval->vtype != TYPE_FUNCTION || funcval->constval.vfunc != self)
700 /* now we have a CALL and a RET, check if it's a tailcall */
701 if (ret->_ops[0] && call->_ops[0] != ret->_ops[0])
704 ++opts_optimizationcount[OPTIM_TAIL_RECURSION];
705 vec_shrinkby(block->instr, 2);
707 block->final = false; /* open it back up */
709 /* emite parameter-stores */
710 for (p = 0; p < vec_size(call->params); ++p) {
711 /* assert(call->params_count <= self->locals_count); */
712 if (!ir_block_create_store(block, call->context, self->locals[p], call->params[p])) {
713 irerror(call->context, "failed to create tailcall store instruction for parameter %i", (int)p);
717 if (!ir_block_create_jump(block, call->context, self->blocks[0])) {
718 irerror(call->context, "failed to create tailcall jump");
722 ir_instr_delete(call);
723 ir_instr_delete(ret);
729 bool ir_function_finalize(ir_function *self)
734 if (OPTS_OPTIMIZATION(OPTIM_PEEPHOLE)) {
735 if (!ir_function_pass_peephole(self)) {
736 irerror(self->context, "generic optimization pass broke something in `%s`", self->name);
741 if (OPTS_OPTIMIZATION(OPTIM_TAIL_RECURSION)) {
742 if (!ir_function_pass_tailrecursion(self)) {
743 irerror(self->context, "tail-recursion optimization pass broke something in `%s`", self->name);
748 if (!ir_function_naive_phi(self))
751 ir_function_enumerate(self);
753 if (!ir_function_calculate_liferanges(self))
755 if (!ir_function_allocate_locals(self))
760 ir_value* ir_function_create_local(ir_function *self, const char *name, int vtype, bool param)
765 vec_size(self->locals) &&
766 self->locals[vec_size(self->locals)-1]->store != store_param) {
767 irerror(self->context, "cannot add parameters after adding locals");
771 ve = ir_value_var(name, (param ? store_param : store_local), vtype);
772 vec_push(self->locals, ve);
776 /***********************************************************************
780 ir_block* ir_block_new(ir_function* owner, const char *name)
783 self = (ir_block*)mem_a(sizeof(*self));
787 memset(self, 0, sizeof(*self));
790 if (name && !ir_block_set_label(self, name)) {
795 self->context.file = "<@no context>";
796 self->context.line = 0;
800 self->entries = NULL;
804 self->is_return = false;
809 self->generated = false;
814 static void ir_block_delete_quick(ir_block* self)
817 if (self->label) mem_d(self->label);
818 for (i = 0; i != vec_size(self->instr); ++i)
819 ir_instr_delete_quick(self->instr[i]);
820 vec_free(self->instr);
821 vec_free(self->entries);
822 vec_free(self->exits);
823 vec_free(self->living);
827 void ir_block_delete(ir_block* self)
830 if (self->label) mem_d(self->label);
831 for (i = 0; i != vec_size(self->instr); ++i)
832 ir_instr_delete(self->instr[i]);
833 vec_free(self->instr);
834 vec_free(self->entries);
835 vec_free(self->exits);
836 vec_free(self->living);
840 bool ir_block_set_label(ir_block *self, const char *name)
843 mem_d((void*)self->label);
844 self->label = util_strdup(name);
845 return !!self->label;
848 /***********************************************************************
852 ir_instr* ir_instr_new(lex_ctx ctx, ir_block* owner, int op)
855 self = (ir_instr*)mem_a(sizeof(*self));
862 self->_ops[0] = NULL;
863 self->_ops[1] = NULL;
864 self->_ops[2] = NULL;
865 self->bops[0] = NULL;
866 self->bops[1] = NULL;
877 static void ir_instr_delete_quick(ir_instr *self)
880 vec_free(self->params);
884 void ir_instr_delete(ir_instr *self)
887 /* The following calls can only delete from
888 * vectors, we still want to delete this instruction
889 * so ignore the return value. Since with the warn_unused_result attribute
890 * gcc doesn't care about an explicit: (void)foo(); to ignore the result,
891 * I have to improvise here and use if(foo());
893 for (i = 0; i < vec_size(self->phi); ++i) {
895 if (vec_ir_instr_find(self->phi[i].value->writes, self, &idx))
896 vec_remove(self->phi[i].value->writes, idx, 1);
897 if (vec_ir_instr_find(self->phi[i].value->reads, self, &idx))
898 vec_remove(self->phi[i].value->reads, idx, 1);
901 for (i = 0; i < vec_size(self->params); ++i) {
903 if (vec_ir_instr_find(self->params[i]->writes, self, &idx))
904 vec_remove(self->params[i]->writes, idx, 1);
905 if (vec_ir_instr_find(self->params[i]->reads, self, &idx))
906 vec_remove(self->params[i]->reads, idx, 1);
908 vec_free(self->params);
909 (void)!ir_instr_op(self, 0, NULL, false);
910 (void)!ir_instr_op(self, 1, NULL, false);
911 (void)!ir_instr_op(self, 2, NULL, false);
915 bool ir_instr_op(ir_instr *self, int op, ir_value *v, bool writing)
917 if (self->_ops[op]) {
919 if (writing && vec_ir_instr_find(self->_ops[op]->writes, self, &idx))
920 vec_remove(self->_ops[op]->writes, idx, 1);
921 else if (vec_ir_instr_find(self->_ops[op]->reads, self, &idx))
922 vec_remove(self->_ops[op]->reads, idx, 1);
926 vec_push(v->writes, self);
928 vec_push(v->reads, self);
934 /***********************************************************************
938 void ir_value_code_setaddr(ir_value *self, int32_t gaddr)
940 self->code.globaladdr = gaddr;
941 if (self->members[0]) self->members[0]->code.globaladdr = gaddr;
942 if (self->members[1]) self->members[1]->code.globaladdr = gaddr;
943 if (self->members[2]) self->members[2]->code.globaladdr = gaddr;
946 int32_t ir_value_code_addr(const ir_value *self)
948 if (self->store == store_return)
949 return OFS_RETURN + self->code.addroffset;
950 return self->code.globaladdr + self->code.addroffset;
953 ir_value* ir_value_var(const char *name, int storetype, int vtype)
956 self = (ir_value*)mem_a(sizeof(*self));
958 self->fieldtype = TYPE_VOID;
959 self->outtype = TYPE_VOID;
960 self->store = storetype;
966 self->hasvalue = false;
967 self->context.file = "<@no context>";
968 self->context.line = 0;
970 if (name && !ir_value_set_name(self, name)) {
971 irerror(self->context, "out of memory");
976 memset(&self->constval, 0, sizeof(self->constval));
977 memset(&self->code, 0, sizeof(self->code));
979 self->members[0] = NULL;
980 self->members[1] = NULL;
981 self->members[2] = NULL;
982 self->memberof = NULL;
984 self->unique_life = false;
990 ir_value* ir_value_vector_member(ir_value *self, unsigned int member)
998 if (self->members[member])
999 return self->members[member];
1001 len = strlen(self->name);
1002 name = (char*)mem_a(len + 3);
1003 memcpy(name, self->name, len);
1005 name[len+1] = 'x' + member;
1007 if (self->vtype == TYPE_VECTOR)
1009 m = ir_value_var(name, self->store, TYPE_FLOAT);
1013 m->context = self->context;
1015 self->members[member] = m;
1016 m->code.addroffset = member;
1018 else if (self->vtype == TYPE_FIELD)
1020 if (self->fieldtype != TYPE_VECTOR)
1022 m = ir_value_var(name, self->store, TYPE_FIELD);
1026 m->fieldtype = TYPE_FLOAT;
1027 m->context = self->context;
1029 self->members[member] = m;
1030 m->code.addroffset = member;
1034 irerror(self->context, "invalid member access on %s", self->name);
1042 static GMQCC_INLINE size_t ir_value_sizeof(const ir_value *self)
1044 if (self->vtype == TYPE_FIELD && self->fieldtype == TYPE_VECTOR)
1045 return type_sizeof_[TYPE_VECTOR];
1046 return type_sizeof_[self->vtype];
1049 ir_value* ir_value_out(ir_function *owner, const char *name, int storetype, int vtype)
1051 ir_value *v = ir_value_var(name, storetype, vtype);
1054 ir_function_collect_value(owner, v);
1058 void ir_value_delete(ir_value* self)
1062 mem_d((void*)self->name);
1065 if (self->vtype == TYPE_STRING)
1066 mem_d((void*)self->constval.vstring);
1068 for (i = 0; i < 3; ++i) {
1069 if (self->members[i])
1070 ir_value_delete(self->members[i]);
1072 vec_free(self->reads);
1073 vec_free(self->writes);
1074 vec_free(self->life);
1078 bool ir_value_set_name(ir_value *self, const char *name)
1081 mem_d((void*)self->name);
1082 self->name = util_strdup(name);
1083 return !!self->name;
1086 bool ir_value_set_float(ir_value *self, float f)
1088 if (self->vtype != TYPE_FLOAT)
1090 self->constval.vfloat = f;
1091 self->hasvalue = true;
1095 bool ir_value_set_func(ir_value *self, int f)
1097 if (self->vtype != TYPE_FUNCTION)
1099 self->constval.vint = f;
1100 self->hasvalue = true;
1104 bool ir_value_set_vector(ir_value *self, vector v)
1106 if (self->vtype != TYPE_VECTOR)
1108 self->constval.vvec = v;
1109 self->hasvalue = true;
1113 bool ir_value_set_field(ir_value *self, ir_value *fld)
1115 if (self->vtype != TYPE_FIELD)
1117 self->constval.vpointer = fld;
1118 self->hasvalue = true;
1122 static char *ir_strdup(const char *str)
1125 /* actually dup empty strings */
1126 char *out = mem_a(1);
1130 return util_strdup(str);
1133 bool ir_value_set_string(ir_value *self, const char *str)
1135 if (self->vtype != TYPE_STRING)
1137 self->constval.vstring = ir_strdup(str);
1138 self->hasvalue = true;
1143 bool ir_value_set_int(ir_value *self, int i)
1145 if (self->vtype != TYPE_INTEGER)
1147 self->constval.vint = i;
1148 self->hasvalue = true;
1153 bool ir_value_lives(ir_value *self, size_t at)
1156 for (i = 0; i < vec_size(self->life); ++i)
1158 ir_life_entry_t *life = &self->life[i];
1159 if (life->start <= at && at <= life->end)
1161 if (life->start > at) /* since it's ordered */
1167 bool ir_value_life_insert(ir_value *self, size_t idx, ir_life_entry_t e)
1170 vec_push(self->life, e);
1171 for (k = vec_size(self->life)-1; k > idx; --k)
1172 self->life[k] = self->life[k-1];
1173 self->life[idx] = e;
1177 bool ir_value_life_merge(ir_value *self, size_t s)
1180 ir_life_entry_t *life = NULL;
1181 ir_life_entry_t *before = NULL;
1182 ir_life_entry_t new_entry;
1184 /* Find the first range >= s */
1185 for (i = 0; i < vec_size(self->life); ++i)
1188 life = &self->life[i];
1189 if (life->start > s)
1192 /* nothing found? append */
1193 if (i == vec_size(self->life)) {
1195 if (life && life->end+1 == s)
1197 /* previous life range can be merged in */
1201 if (life && life->end >= s)
1203 e.start = e.end = s;
1204 vec_push(self->life, e);
1210 if (before->end + 1 == s &&
1211 life->start - 1 == s)
1214 before->end = life->end;
1215 vec_remove(self->life, i, 1);
1218 if (before->end + 1 == s)
1224 /* already contained */
1225 if (before->end >= s)
1229 if (life->start - 1 == s)
1234 /* insert a new entry */
1235 new_entry.start = new_entry.end = s;
1236 return ir_value_life_insert(self, i, new_entry);
1239 bool ir_value_life_merge_into(ir_value *self, const ir_value *other)
1243 if (!vec_size(other->life))
1246 if (!vec_size(self->life)) {
1247 size_t count = vec_size(other->life);
1248 ir_life_entry_t *life = vec_add(self->life, count);
1249 memcpy(life, other->life, count * sizeof(*life));
1254 for (i = 0; i < vec_size(other->life); ++i)
1256 const ir_life_entry_t *life = &other->life[i];
1259 ir_life_entry_t *entry = &self->life[myi];
1261 if (life->end+1 < entry->start)
1263 /* adding an interval before entry */
1264 if (!ir_value_life_insert(self, myi, *life))
1270 if (life->start < entry->start &&
1271 life->end+1 >= entry->start)
1273 /* starts earlier and overlaps */
1274 entry->start = life->start;
1277 if (life->end > entry->end &&
1278 life->start <= entry->end+1)
1280 /* ends later and overlaps */
1281 entry->end = life->end;
1284 /* see if our change combines it with the next ranges */
1285 while (myi+1 < vec_size(self->life) &&
1286 entry->end+1 >= self->life[1+myi].start)
1288 /* overlaps with (myi+1) */
1289 if (entry->end < self->life[1+myi].end)
1290 entry->end = self->life[1+myi].end;
1291 vec_remove(self->life, myi+1, 1);
1292 entry = &self->life[myi];
1295 /* see if we're after the entry */
1296 if (life->start > entry->end)
1299 /* append if we're at the end */
1300 if (myi >= vec_size(self->life)) {
1301 vec_push(self->life, *life);
1304 /* otherweise check the next range */
1313 bool ir_values_overlap(const ir_value *a, const ir_value *b)
1315 /* For any life entry in A see if it overlaps with
1316 * any life entry in B.
1317 * Note that the life entries are orderes, so we can make a
1318 * more efficient algorithm there than naively translating the
1322 ir_life_entry_t *la, *lb, *enda, *endb;
1324 /* first of all, if either has no life range, they cannot clash */
1325 if (!vec_size(a->life) || !vec_size(b->life))
1330 enda = la + vec_size(a->life);
1331 endb = lb + vec_size(b->life);
1334 /* check if the entries overlap, for that,
1335 * both must start before the other one ends.
1337 if (la->start < lb->end &&
1338 lb->start < la->end)
1343 /* entries are ordered
1344 * one entry is earlier than the other
1345 * that earlier entry will be moved forward
1347 if (la->start < lb->start)
1349 /* order: A B, move A forward
1350 * check if we hit the end with A
1355 else /* if (lb->start < la->start) actually <= */
1357 /* order: B A, move B forward
1358 * check if we hit the end with B
1367 /***********************************************************************
1371 static bool ir_check_unreachable(ir_block *self)
1373 /* The IR should never have to deal with unreachable code */
1374 if (!self->final/* || OPTS_FLAG(ALLOW_UNREACHABLE_CODE)*/)
1376 irerror(self->context, "unreachable statement (%s)", self->label);
1380 bool ir_block_create_store_op(ir_block *self, lex_ctx ctx, int op, ir_value *target, ir_value *what)
1383 if (!ir_check_unreachable(self))
1386 if (target->store == store_value &&
1387 (op < INSTR_STOREP_F || op > INSTR_STOREP_FNC))
1389 irerror(self->context, "cannot store to an SSA value");
1390 irerror(self->context, "trying to store: %s <- %s", target->name, what->name);
1391 irerror(self->context, "instruction: %s", asm_instr[op].m);
1395 in = ir_instr_new(ctx, self, op);
1399 if (!ir_instr_op(in, 0, target, true) ||
1400 !ir_instr_op(in, 1, what, false))
1402 ir_instr_delete(in);
1405 vec_push(self->instr, in);
1409 bool ir_block_create_store(ir_block *self, lex_ctx ctx, ir_value *target, ir_value *what)
1413 if (target->vtype == TYPE_VARIANT)
1414 vtype = what->vtype;
1416 vtype = target->vtype;
1419 if (vtype == TYPE_FLOAT && what->vtype == TYPE_INTEGER)
1420 op = INSTR_CONV_ITOF;
1421 else if (vtype == TYPE_INTEGER && what->vtype == TYPE_FLOAT)
1422 op = INSTR_CONV_FTOI;
1424 op = type_store_instr[vtype];
1426 if (OPTS_FLAG(ADJUST_VECTOR_FIELDS)) {
1427 if (op == INSTR_STORE_FLD && what->fieldtype == TYPE_VECTOR)
1431 return ir_block_create_store_op(self, ctx, op, target, what);
1434 bool ir_block_create_storep(ir_block *self, lex_ctx ctx, ir_value *target, ir_value *what)
1439 if (target->vtype != TYPE_POINTER)
1442 /* storing using pointer - target is a pointer, type must be
1443 * inferred from source
1445 vtype = what->vtype;
1447 op = type_storep_instr[vtype];
1448 if (OPTS_FLAG(ADJUST_VECTOR_FIELDS)) {
1449 if (op == INSTR_STOREP_FLD && what->fieldtype == TYPE_VECTOR)
1450 op = INSTR_STOREP_V;
1453 return ir_block_create_store_op(self, ctx, op, target, what);
1456 bool ir_block_create_return(ir_block *self, lex_ctx ctx, ir_value *v)
1459 if (!ir_check_unreachable(self))
1462 self->is_return = true;
1463 in = ir_instr_new(ctx, self, INSTR_RETURN);
1467 if (v && !ir_instr_op(in, 0, v, false)) {
1468 ir_instr_delete(in);
1472 vec_push(self->instr, in);
1476 bool ir_block_create_if(ir_block *self, lex_ctx ctx, ir_value *v,
1477 ir_block *ontrue, ir_block *onfalse)
1480 if (!ir_check_unreachable(self))
1483 /*in = ir_instr_new(ctx, self, (v->vtype == TYPE_STRING ? INSTR_IF_S : INSTR_IF_F));*/
1484 in = ir_instr_new(ctx, self, VINSTR_COND);
1488 if (!ir_instr_op(in, 0, v, false)) {
1489 ir_instr_delete(in);
1493 in->bops[0] = ontrue;
1494 in->bops[1] = onfalse;
1496 vec_push(self->instr, in);
1498 vec_push(self->exits, ontrue);
1499 vec_push(self->exits, onfalse);
1500 vec_push(ontrue->entries, self);
1501 vec_push(onfalse->entries, self);
1505 bool ir_block_create_jump(ir_block *self, lex_ctx ctx, ir_block *to)
1508 if (!ir_check_unreachable(self))
1511 in = ir_instr_new(ctx, self, VINSTR_JUMP);
1516 vec_push(self->instr, in);
1518 vec_push(self->exits, to);
1519 vec_push(to->entries, self);
1523 bool ir_block_create_goto(ir_block *self, lex_ctx ctx, ir_block *to)
1526 if (!ir_check_unreachable(self))
1529 in = ir_instr_new(ctx, self, INSTR_GOTO);
1534 vec_push(self->instr, in);
1536 vec_push(self->exits, to);
1537 vec_push(to->entries, self);
1541 ir_instr* ir_block_create_phi(ir_block *self, lex_ctx ctx, const char *label, int ot)
1545 if (!ir_check_unreachable(self))
1547 in = ir_instr_new(ctx, self, VINSTR_PHI);
1550 out = ir_value_out(self->owner, label, store_value, ot);
1552 ir_instr_delete(in);
1555 if (!ir_instr_op(in, 0, out, true)) {
1556 ir_instr_delete(in);
1557 ir_value_delete(out);
1560 vec_push(self->instr, in);
1564 ir_value* ir_phi_value(ir_instr *self)
1566 return self->_ops[0];
1569 void ir_phi_add(ir_instr* self, ir_block *b, ir_value *v)
1573 if (!vec_ir_block_find(self->owner->entries, b, NULL)) {
1574 /* Must not be possible to cause this, otherwise the AST
1575 * is doing something wrong.
1577 irerror(self->context, "Invalid entry block for PHI");
1583 vec_push(v->reads, self);
1584 vec_push(self->phi, pe);
1587 /* call related code */
1588 ir_instr* ir_block_create_call(ir_block *self, lex_ctx ctx, const char *label, ir_value *func, bool noreturn)
1592 if (!ir_check_unreachable(self))
1594 in = ir_instr_new(ctx, self, (noreturn ? VINSTR_NRCALL : INSTR_CALL0));
1599 self->is_return = true;
1601 out = ir_value_out(self->owner, label, (func->outtype == TYPE_VOID) ? store_return : store_value, func->outtype);
1603 ir_instr_delete(in);
1606 if (!ir_instr_op(in, 0, out, true) ||
1607 !ir_instr_op(in, 1, func, false))
1609 ir_instr_delete(in);
1610 ir_value_delete(out);
1613 vec_push(self->instr, in);
1616 if (!ir_block_create_return(self, ctx, NULL)) {
1617 compile_error(ctx, "internal error: failed to generate dummy-return instruction");
1618 ir_instr_delete(in);
1626 ir_value* ir_call_value(ir_instr *self)
1628 return self->_ops[0];
1631 void ir_call_param(ir_instr* self, ir_value *v)
1633 vec_push(self->params, v);
1634 vec_push(v->reads, self);
1637 /* binary op related code */
1639 ir_value* ir_block_create_binop(ir_block *self, lex_ctx ctx,
1640 const char *label, int opcode,
1641 ir_value *left, ir_value *right)
1663 case INSTR_SUB_S: /* -- offset of string as float */
1668 case INSTR_BITOR_IF:
1669 case INSTR_BITOR_FI:
1670 case INSTR_BITAND_FI:
1671 case INSTR_BITAND_IF:
1686 case INSTR_BITAND_I:
1689 case INSTR_RSHIFT_I:
1690 case INSTR_LSHIFT_I:
1712 /* boolean operations result in floats */
1713 if (opcode >= INSTR_EQ_F && opcode <= INSTR_GT)
1715 else if (opcode >= INSTR_LE && opcode <= INSTR_GT)
1718 else if (opcode >= INSTR_LE_I && opcode <= INSTR_EQ_FI)
1723 if (ot == TYPE_VOID) {
1724 /* The AST or parser were supposed to check this! */
1728 return ir_block_create_general_instr(self, ctx, label, opcode, left, right, ot);
1731 ir_value* ir_block_create_unary(ir_block *self, lex_ctx ctx,
1732 const char *label, int opcode,
1735 int ot = TYPE_FLOAT;
1747 /* QC doesn't have other unary operations. We expect extensions to fill
1748 * the above list, otherwise we assume out-type = in-type, eg for an
1752 ot = operand->vtype;
1755 if (ot == TYPE_VOID) {
1756 /* The AST or parser were supposed to check this! */
1760 /* let's use the general instruction creator and pass NULL for OPB */
1761 return ir_block_create_general_instr(self, ctx, label, opcode, operand, NULL, ot);
1764 ir_value* ir_block_create_general_instr(ir_block *self, lex_ctx ctx, const char *label,
1765 int op, ir_value *a, ir_value *b, int outype)
1770 out = ir_value_out(self->owner, label, store_value, outype);
1774 instr = ir_instr_new(ctx, self, op);
1776 ir_value_delete(out);
1780 if (!ir_instr_op(instr, 0, out, true) ||
1781 !ir_instr_op(instr, 1, a, false) ||
1782 !ir_instr_op(instr, 2, b, false) )
1787 vec_push(self->instr, instr);
1791 ir_instr_delete(instr);
1792 ir_value_delete(out);
1796 ir_value* ir_block_create_fieldaddress(ir_block *self, lex_ctx ctx, const char *label, ir_value *ent, ir_value *field)
1800 /* Support for various pointer types todo if so desired */
1801 if (ent->vtype != TYPE_ENTITY)
1804 if (field->vtype != TYPE_FIELD)
1807 v = ir_block_create_general_instr(self, ctx, label, INSTR_ADDRESS, ent, field, TYPE_POINTER);
1808 v->fieldtype = field->fieldtype;
1812 ir_value* ir_block_create_load_from_ent(ir_block *self, lex_ctx ctx, const char *label, ir_value *ent, ir_value *field, int outype)
1815 if (ent->vtype != TYPE_ENTITY)
1818 /* at some point we could redirect for TYPE_POINTER... but that could lead to carelessness */
1819 if (field->vtype != TYPE_FIELD)
1824 case TYPE_FLOAT: op = INSTR_LOAD_F; break;
1825 case TYPE_VECTOR: op = INSTR_LOAD_V; break;
1826 case TYPE_STRING: op = INSTR_LOAD_S; break;
1827 case TYPE_FIELD: op = INSTR_LOAD_FLD; break;
1828 case TYPE_ENTITY: op = INSTR_LOAD_ENT; break;
1829 case TYPE_FUNCTION: op = INSTR_LOAD_FNC; break;
1831 case TYPE_POINTER: op = INSTR_LOAD_I; break;
1832 case TYPE_INTEGER: op = INSTR_LOAD_I; break;
1835 irerror(self->context, "invalid type for ir_block_create_load_from_ent: %s", type_name[outype]);
1839 return ir_block_create_general_instr(self, ctx, label, op, ent, field, outype);
1842 ir_value* ir_block_create_add(ir_block *self, lex_ctx ctx,
1844 ir_value *left, ir_value *right)
1847 int l = left->vtype;
1848 int r = right->vtype;
1852 irerror(self->context, "invalid type for ir_block_create_add: %s", type_name[l]);
1868 if ( (l == TYPE_FLOAT && r == TYPE_INTEGER) )
1870 else if ( (l == TYPE_INTEGER && r == TYPE_FLOAT) )
1875 irerror(self->context, "invalid type for ir_block_create_add: %s", type_name[l]);
1879 return ir_block_create_binop(self, ctx, label, op, left, right);
1882 ir_value* ir_block_create_sub(ir_block *self, lex_ctx ctx,
1884 ir_value *left, ir_value *right)
1887 int l = left->vtype;
1888 int r = right->vtype;
1893 irerror(self->context, "invalid type for ir_block_create_sub: %s", type_name[l]);
1909 if ( (l == TYPE_FLOAT && r == TYPE_INTEGER) )
1911 else if ( (l == TYPE_INTEGER && r == TYPE_FLOAT) )
1916 irerror(self->context, "invalid type for ir_block_create_sub: %s", type_name[l]);
1920 return ir_block_create_binop(self, ctx, label, op, left, right);
1923 ir_value* ir_block_create_mul(ir_block *self, lex_ctx ctx,
1925 ir_value *left, ir_value *right)
1928 int l = left->vtype;
1929 int r = right->vtype;
1934 irerror(self->context, "invalid type for ir_block_create_mul: %s", type_name[l]);
1949 if ( (l == TYPE_VECTOR && r == TYPE_FLOAT) )
1951 else if ( (l == TYPE_FLOAT && r == TYPE_VECTOR) )
1954 else if ( (l == TYPE_VECTOR && r == TYPE_INTEGER) )
1956 else if ( (l == TYPE_INTEGER && r == TYPE_VECTOR) )
1958 else if ( (l == TYPE_FLOAT && r == TYPE_INTEGER) )
1960 else if ( (l == TYPE_INTEGER && r == TYPE_FLOAT) )
1964 irerror(self->context, "invalid type for ir_block_create_mul: %s", type_name[l]);
1968 return ir_block_create_binop(self, ctx, label, op, left, right);
1971 ir_value* ir_block_create_div(ir_block *self, lex_ctx ctx,
1973 ir_value *left, ir_value *right)
1976 int l = left->vtype;
1977 int r = right->vtype;
1982 irerror(self->context, "invalid type for ir_block_create_div: %s", type_name[l]);
1995 if ( (l == TYPE_VECTOR && r == TYPE_FLOAT) )
1997 else if ( (l == TYPE_FLOAT && r == TYPE_INTEGER) )
1999 else if ( (l == TYPE_INTEGER && r == TYPE_FLOAT) )
2004 irerror(self->context, "invalid type for ir_block_create_div: %s", type_name[l]);
2008 return ir_block_create_binop(self, ctx, label, op, left, right);
2011 /* PHI resolving breaks the SSA, and must thus be the last
2012 * step before life-range calculation.
2015 static bool ir_block_naive_phi(ir_block *self);
2016 bool ir_function_naive_phi(ir_function *self)
2020 for (i = 0; i < vec_size(self->blocks); ++i)
2022 if (!ir_block_naive_phi(self->blocks[i]))
2029 static bool ir_naive_phi_emit_store(ir_block *block, size_t iid, ir_value *old, ir_value *what)
2034 /* create a store */
2035 if (!ir_block_create_store(block, old, what))
2038 /* we now move it up */
2039 instr = vec_last(block->instr);
2040 for (i = vec_size(block->instr)-1; i > iid; --i)
2041 block->instr[i] = block->instr[i-1];
2042 block->instr[i] = instr;
2048 static bool ir_block_naive_phi(ir_block *self)
2050 size_t i, p; /*, w;*/
2051 /* FIXME: optionally, create_phi can add the phis
2052 * to a list so we don't need to loop through blocks
2053 * - anyway: "don't optimize YET"
2055 for (i = 0; i < vec_size(self->instr); ++i)
2057 ir_instr *instr = self->instr[i];
2058 if (instr->opcode != VINSTR_PHI)
2061 vec_remove(self->instr, i, 1);
2062 --i; /* NOTE: i+1 below */
2064 for (p = 0; p < vec_size(instr->phi); ++p)
2066 ir_value *v = instr->phi[p].value;
2067 ir_block *b = instr->phi[p].from;
2069 if (v->store == store_value &&
2070 vec_size(v->reads) == 1 &&
2071 vec_size(v->writes) == 1)
2073 /* replace the value */
2074 if (!ir_instr_op(v->writes[0], 0, instr->_ops[0], true))
2079 /* force a move instruction */
2080 ir_instr *prevjump = vec_last(b->instr);
2083 instr->_ops[0]->store = store_global;
2084 if (!ir_block_create_store(b, instr->context, instr->_ops[0], v))
2086 instr->_ops[0]->store = store_value;
2087 vec_push(b->instr, prevjump);
2092 ir_value *v = instr->phi[p].value;
2093 for (w = 0; w < vec_size(v->writes); ++w) {
2096 if (!v->writes[w]->_ops[0])
2099 /* When the write was to a global, we have to emit a mov */
2100 old = v->writes[w]->_ops[0];
2102 /* The original instruction now writes to the PHI target local */
2103 if (v->writes[w]->_ops[0] == v)
2104 v->writes[w]->_ops[0] = instr->_ops[0];
2106 if (old->store != store_value && old->store != store_local && old->store != store_param)
2108 /* If it originally wrote to a global we need to store the value
2111 if (!ir_naive_phi_emit_store(self, i+1, old, v))
2113 if (i+1 < vec_size(self->instr))
2114 instr = self->instr[i+1];
2117 /* In case I forget and access instr later, it'll be NULL
2118 * when it's a problem, to make sure we crash, rather than accessing
2124 /* If it didn't, we can replace all reads by the phi target now. */
2126 for (r = 0; r < vec_size(old->reads); ++r)
2129 ir_instr *ri = old->reads[r];
2130 for (op = 0; op < vec_size(ri->phi); ++op) {
2131 if (ri->phi[op].value == old)
2132 ri->phi[op].value = v;
2134 for (op = 0; op < 3; ++op) {
2135 if (ri->_ops[op] == old)
2143 ir_instr_delete(instr);
2148 /***********************************************************************
2149 *IR Temp allocation code
2150 * Propagating value life ranges by walking through the function backwards
2151 * until no more changes are made.
2152 * In theory this should happen once more than once for every nested loop
2154 * Though this implementation might run an additional time for if nests.
2157 /* Enumerate instructions used by value's life-ranges
2159 static void ir_block_enumerate(ir_block *self, size_t *_eid)
2163 for (i = 0; i < vec_size(self->instr); ++i)
2165 self->instr[i]->eid = eid++;
2170 /* Enumerate blocks and instructions.
2171 * The block-enumeration is unordered!
2172 * We do not really use the block enumreation, however
2173 * the instruction enumeration is important for life-ranges.
2175 void ir_function_enumerate(ir_function *self)
2178 size_t instruction_id = 0;
2179 for (i = 0; i < vec_size(self->blocks); ++i)
2181 self->blocks[i]->eid = i;
2182 self->blocks[i]->run_id = 0;
2183 ir_block_enumerate(self->blocks[i], &instruction_id);
2187 static bool ir_block_life_propagate(ir_block *b, ir_block *prev, bool *changed);
2188 bool ir_function_calculate_liferanges(ir_function *self)
2196 for (i = 0; i != vec_size(self->blocks); ++i)
2198 if (self->blocks[i]->is_return)
2200 vec_free(self->blocks[i]->living);
2201 if (!ir_block_life_propagate(self->blocks[i], NULL, &changed))
2206 if (vec_size(self->blocks)) {
2207 ir_block *block = self->blocks[0];
2208 for (i = 0; i < vec_size(block->living); ++i) {
2209 ir_value *v = block->living[i];
2210 if (v->store != store_local)
2212 if ((v->members[0] && v->members[1] && v->members[2])) {
2213 /* all vector members have been accessed - only treat this as uninitialized
2214 * if any of them is also uninitialized.
2216 if (!vec_ir_value_find(block->living, v->members[0], NULL) &&
2217 !vec_ir_value_find(block->living, v->members[1], NULL) &&
2218 !vec_ir_value_find(block->living, v->members[2], NULL))
2224 /* A member is only uninitialized if the whole vector is also uninitialized */
2225 if (!vec_ir_value_find(block->living, v->memberof, NULL))
2228 if (irwarning(v->context, WARN_USED_UNINITIALIZED,
2229 "variable `%s` may be used uninitialized in this function", v->name))
2238 /* Local-value allocator
2239 * After finishing creating the liferange of all values used in a function
2240 * we can allocate their global-positions.
2241 * This is the counterpart to register-allocation in register machines.
2248 } function_allocator;
2250 static bool function_allocator_alloc(function_allocator *alloc, const ir_value *var)
2253 size_t vsize = ir_value_sizeof(var);
2255 slot = ir_value_var("reg", store_global, var->vtype);
2259 if (!ir_value_life_merge_into(slot, var))
2262 vec_push(alloc->locals, slot);
2263 vec_push(alloc->sizes, vsize);
2264 vec_push(alloc->unique, var->unique_life);
2269 ir_value_delete(slot);
2273 bool ir_function_allocate_locals(ir_function *self)
2282 function_allocator alloc;
2284 if (!vec_size(self->locals) && !vec_size(self->values))
2287 alloc.locals = NULL;
2289 alloc.positions = NULL;
2290 alloc.unique = NULL;
2292 for (i = 0; i < vec_size(self->locals); ++i)
2295 if (!OPTS_OPTIMIZATION(OPTIM_LOCALTEMPS))
2297 self->locals[i]->unique_life = true;
2298 if (!function_allocator_alloc(&alloc, self->locals[i]))
2302 /* Allocate a slot for any value that still exists */
2303 for (i = 0; i < vec_size(self->values); ++i)
2305 v = self->values[i];
2307 if (!vec_size(v->life))
2310 for (a = 0; a < vec_size(alloc.locals); ++a)
2312 /* if it's reserved for a unique liferange: skip */
2313 if (alloc.unique[a])
2316 slot = alloc.locals[a];
2318 /* never resize parameters
2319 * will be required later when overlapping temps + locals
2321 if (a < vec_size(self->params) &&
2322 alloc.sizes[a] < ir_value_sizeof(v))
2327 if (ir_values_overlap(v, slot))
2330 if (!ir_value_life_merge_into(slot, v))
2333 /* adjust size for this slot */
2334 if (alloc.sizes[a] < ir_value_sizeof(v))
2335 alloc.sizes[a] = ir_value_sizeof(v);
2337 self->values[i]->code.local = a;
2340 if (a >= vec_size(alloc.locals)) {
2341 self->values[i]->code.local = vec_size(alloc.locals);
2342 if (!function_allocator_alloc(&alloc, v))
2351 /* Adjust slot positions based on sizes */
2352 vec_push(alloc.positions, 0);
2354 if (vec_size(alloc.sizes))
2355 pos = alloc.positions[0] + alloc.sizes[0];
2358 for (i = 1; i < vec_size(alloc.sizes); ++i)
2360 pos = alloc.positions[i-1] + alloc.sizes[i-1];
2361 vec_push(alloc.positions, pos);
2364 self->allocated_locals = pos + vec_last(alloc.sizes);
2366 /* Locals need to know their new position */
2367 for (i = 0; i < vec_size(self->locals); ++i) {
2368 self->locals[i]->code.local = alloc.positions[i];
2370 /* Take over the actual slot positions on values */
2371 for (i = 0; i < vec_size(self->values); ++i) {
2372 self->values[i]->code.local = alloc.positions[self->values[i]->code.local];
2380 for (i = 0; i < vec_size(alloc.locals); ++i)
2381 ir_value_delete(alloc.locals[i]);
2382 vec_free(alloc.unique);
2383 vec_free(alloc.locals);
2384 vec_free(alloc.sizes);
2385 vec_free(alloc.positions);
2389 /* Get information about which operand
2390 * is read from, or written to.
2392 static void ir_op_read_write(int op, size_t *read, size_t *write)
2412 case INSTR_STOREP_F:
2413 case INSTR_STOREP_V:
2414 case INSTR_STOREP_S:
2415 case INSTR_STOREP_ENT:
2416 case INSTR_STOREP_FLD:
2417 case INSTR_STOREP_FNC:
2428 static bool ir_block_living_add_instr(ir_block *self, size_t eid)
2431 bool changed = false;
2433 for (i = 0; i != vec_size(self->living); ++i)
2435 tempbool = ir_value_life_merge(self->living[i], eid);
2438 irerror(self->context, "block_living_add_instr() value instruction added %s: %i", self->living[i]->_name, (int)eid);
2440 changed = changed || tempbool;
2445 static bool ir_block_life_prop_previous(ir_block* self, ir_block *prev, bool *changed)
2451 /* values which have been read in a previous iteration are now
2452 * in the "living" array even if the previous block doesn't use them.
2453 * So we have to remove whatever does not exist in the previous block.
2454 * They will be re-added on-read, but the liferange merge won't cause
2456 for (i = 0; i < vec_size(self->living); ++i)
2458 if (!vec_ir_value_find(prev->living, self->living[i], NULL)) {
2459 vec_remove(self->living, i, 1);
2465 /* Whatever the previous block still has in its living set
2466 * must now be added to ours as well.
2468 for (i = 0; i < vec_size(prev->living); ++i)
2470 if (vec_ir_value_find(self->living, prev->living[i], NULL))
2472 vec_push(self->living, prev->living[i]);
2474 irerror(self->contextt from prev: %s", self->label, prev->living[i]->_name);
2480 static bool ir_block_life_propagate(ir_block *self, ir_block *prev, bool *changed)
2486 /* bitmasks which operands are read from or written to */
2488 char dbg_ind[16] = { '#', '0' };
2493 if (!ir_block_life_prop_previous(self, prev, changed))
2497 i = vec_size(self->instr);
2500 instr = self->instr[i];
2502 /* PHI operands are always read operands */
2503 for (p = 0; p < vec_size(instr->phi); ++p)
2505 value = instr->phi[p].value;
2506 if (!vec_ir_value_find(self->living, value, NULL))
2507 vec_push(self->living, value);
2510 /* call params are read operands too */
2511 for (p = 0; p < vec_size(instr->params); ++p)
2513 value = instr->params[p];
2514 if (!vec_ir_value_find(self->living, value, NULL))
2515 vec_push(self->living, value);
2518 /* See which operands are read and write operands */
2519 ir_op_read_write(instr->opcode, &read, &write);
2521 if (instr->opcode == INSTR_MUL_VF)
2523 /* the float source will get an additional lifetime */
2524 tempbool = ir_value_life_merge(instr->_ops[2], instr->eid+1);
2525 *changed = *changed || tempbool;
2527 else if (instr->opcode == INSTR_MUL_FV)
2529 /* the float source will get an additional lifetime */
2530 tempbool = ir_value_life_merge(instr->_ops[1], instr->eid+1);
2531 *changed = *changed || tempbool;
2534 /* Go through the 3 main operands */
2535 for (o = 0; o < 3; ++o)
2537 if (!instr->_ops[o]) /* no such operand */
2540 value = instr->_ops[o];
2542 /* We only care about locals */
2543 /* we also calculate parameter liferanges so that locals
2544 * can take up parameter slots */
2545 if (value->store != store_value &&
2546 value->store != store_local &&
2547 value->store != store_param)
2553 if (!vec_ir_value_find(self->living, value, NULL))
2554 vec_push(self->living, value);
2557 /* write operands */
2558 /* When we write to a local, we consider it "dead" for the
2559 * remaining upper part of the function, since in SSA a value
2560 * can only be written once (== created)
2565 bool in_living = vec_ir_value_find(self->living, value, &idx);
2568 /* If the value isn't alive it hasn't been read before... */
2569 /* TODO: See if the warning can be emitted during parsing or AST processing
2570 * otherwise have warning printed here.
2571 * IF printing a warning here: include filecontext_t,
2572 * and make sure it's only printed once
2573 * since this function is run multiple times.
2575 /* For now: debug info: */
2576 /* con_err( "Value only written %s\n", value->name); */
2577 tempbool = ir_value_life_merge(value, instr->eid);
2578 *changed = *changed || tempbool;
2580 ir_instr_dump(instr, dbg_ind, printf);
2584 /* since 'living' won't contain it
2585 * anymore, merge the value, since
2588 tempbool = ir_value_life_merge(value, instr->eid);
2591 con_err( "value added id %s %i\n", value->name, (int)instr->eid);
2593 *changed = *changed || tempbool;
2595 vec_remove(self->living, idx, 1);
2600 tempbool = ir_block_living_add_instr(self, instr->eid);
2601 /*con_err( "living added values\n");*/
2602 *changed = *changed || tempbool;
2606 if (self->run_id == self->owner->run_id)
2609 self->run_id = self->owner->run_id;
2611 for (i = 0; i < vec_size(self->entries); ++i)
2613 ir_block *entry = self->entries[i];
2614 ir_block_life_propagate(entry, self, changed);
2620 /***********************************************************************
2623 * Since the IR has the convention of putting 'write' operands
2624 * at the beginning, we have to rotate the operands of instructions
2625 * properly in order to generate valid QCVM code.
2627 * Having destinations at a fixed position is more convenient. In QC
2628 * this is *mostly* OPC, but FTE adds at least 2 instructions which
2629 * read from from OPA, and store to OPB rather than OPC. Which is
2630 * partially the reason why the implementation of these instructions
2631 * in darkplaces has been delayed for so long.
2633 * Breaking conventions is annoying...
2635 static bool ir_builder_gen_global(ir_builder *self, ir_value *global, bool islocal);
2637 static bool gen_global_field(ir_value *global)
2639 if (global->hasvalue)
2641 ir_value *fld = global->constval.vpointer;
2643 irerror(global->context, "Invalid field constant with no field: %s", global->name);
2647 /* copy the field's value */
2648 ir_value_code_setaddr(global, vec_size(code_globals));
2649 vec_push(code_globals, fld->code.fieldaddr);
2650 if (global->fieldtype == TYPE_VECTOR) {
2651 vec_push(code_globals, fld->code.fieldaddr+1);
2652 vec_push(code_globals, fld->code.fieldaddr+2);
2657 ir_value_code_setaddr(global, vec_size(code_globals));
2658 vec_push(code_globals, 0);
2659 if (global->fieldtype == TYPE_VECTOR) {
2660 vec_push(code_globals, 0);
2661 vec_push(code_globals, 0);
2664 if (global->code.globaladdr < 0)
2669 static bool gen_global_pointer(ir_value *global)
2671 if (global->hasvalue)
2673 ir_value *target = global->constval.vpointer;
2675 irerror(global->context, "Invalid pointer constant: %s", global->name);
2676 /* NULL pointers are pointing to the NULL constant, which also
2677 * sits at address 0, but still has an ir_value for itself.
2682 /* Here, relocations ARE possible - in fteqcc-enhanced-qc:
2683 * void() foo; <- proto
2684 * void() *fooptr = &foo;
2685 * void() foo = { code }
2687 if (!target->code.globaladdr) {
2688 /* FIXME: Check for the constant nullptr ir_value!
2689 * because then code.globaladdr being 0 is valid.
2691 irerror(global->context, "FIXME: Relocation support");
2695 ir_value_code_setaddr(global, vec_size(code_globals));
2696 vec_push(code_globals, target->code.globaladdr);
2700 ir_value_code_setaddr(global, vec_size(code_globals));
2701 vec_push(code_globals, 0);
2703 if (global->code.globaladdr < 0)
2708 static bool gen_blocks_recursive(ir_function *func, ir_block *block)
2710 prog_section_statement stmt;
2719 block->generated = true;
2720 block->code_start = vec_size(code_statements);
2721 for (i = 0; i < vec_size(block->instr); ++i)
2723 instr = block->instr[i];
2725 if (instr->opcode == VINSTR_PHI) {
2726 irerror(block->context, "cannot generate virtual instruction (phi)");
2730 if (instr->opcode == VINSTR_JUMP) {
2731 target = instr->bops[0];
2732 /* for uncoditional jumps, if the target hasn't been generated
2733 * yet, we generate them right here.
2735 if (!target->generated) {
2740 /* otherwise we generate a jump instruction */
2741 stmt.opcode = INSTR_GOTO;
2742 stmt.o1.s1 = (target->code_start) - vec_size(code_statements);
2745 if (stmt.o1.s1 != 1)
2746 code_push_statement(&stmt, instr->context.line);
2748 /* no further instructions can be in this block */
2752 if (instr->opcode == VINSTR_COND) {
2753 ontrue = instr->bops[0];
2754 onfalse = instr->bops[1];
2755 /* TODO: have the AST signal which block should
2756 * come first: eg. optimize IFs without ELSE...
2759 stmt.o1.u1 = ir_value_code_addr(instr->_ops[0]);
2763 if (ontrue->generated) {
2764 stmt.opcode = INSTR_IF;
2765 stmt.o2.s1 = (ontrue->code_start) - vec_size(code_statements);
2766 if (stmt.o2.s1 != 1)
2767 code_push_statement(&stmt, instr->context.line);
2769 if (onfalse->generated) {
2770 stmt.opcode = INSTR_IFNOT;
2771 stmt.o2.s1 = (onfalse->code_start) - vec_size(code_statements);
2772 if (stmt.o2.s1 != 1)
2773 code_push_statement(&stmt, instr->context.line);
2775 if (!ontrue->generated) {
2776 if (onfalse->generated) {
2781 if (!onfalse->generated) {
2782 if (ontrue->generated) {
2787 /* neither ontrue nor onfalse exist */
2788 stmt.opcode = INSTR_IFNOT;
2789 if (!instr->likely) {
2790 /* Honor the likelyhood hint */
2791 ir_block *tmp = onfalse;
2792 stmt.opcode = INSTR_IF;
2796 stidx = vec_size(code_statements);
2797 code_push_statement(&stmt, instr->context.line);
2798 /* on false we jump, so add ontrue-path */
2799 if (!gen_blocks_recursive(func, ontrue))
2801 /* fixup the jump address */
2802 code_statements[stidx].o2.s1 = vec_size(code_statements) - stidx;
2803 /* generate onfalse path */
2804 if (onfalse->generated) {
2805 /* fixup the jump address */
2806 code_statements[stidx].o2.s1 = (onfalse->code_start) - (stidx);
2807 if (code_statements[stidx].o2.s1 == 1) {
2808 code_statements[stidx] = code_statements[stidx+1];
2809 if (code_statements[stidx].o1.s1 < 0)
2810 code_statements[stidx].o1.s1++;
2811 code_pop_statement();
2813 stmt.opcode = vec_last(code_statements).opcode;
2814 if (stmt.opcode == INSTR_GOTO ||
2815 stmt.opcode == INSTR_IF ||
2816 stmt.opcode == INSTR_IFNOT ||
2817 stmt.opcode == INSTR_RETURN ||
2818 stmt.opcode == INSTR_DONE)
2820 /* no use jumping from here */
2823 /* may have been generated in the previous recursive call */
2824 stmt.opcode = INSTR_GOTO;
2825 stmt.o1.s1 = (onfalse->code_start) - vec_size(code_statements);
2828 if (stmt.o1.s1 != 1)
2829 code_push_statement(&stmt, instr->context.line);
2832 else if (code_statements[stidx].o2.s1 == 1) {
2833 code_statements[stidx] = code_statements[stidx+1];
2834 if (code_statements[stidx].o1.s1 < 0)
2835 code_statements[stidx].o1.s1++;
2836 code_pop_statement();
2838 /* if not, generate now */
2843 if ( (instr->opcode >= INSTR_CALL0 && instr->opcode <= INSTR_CALL8)
2844 || instr->opcode == VINSTR_NRCALL)
2846 /* Trivial call translation:
2847 * copy all params to OFS_PARM*
2848 * if the output's storetype is not store_return,
2849 * add append a STORE instruction!
2851 * NOTES on how to do it better without much trouble:
2852 * -) The liferanges!
2853 * Simply check the liferange of all parameters for
2854 * other CALLs. For each param with no CALL in its
2855 * liferange, we can store it in an OFS_PARM at
2856 * generation already. This would even include later
2857 * reuse.... probably... :)
2862 first = vec_size(instr->params);
2865 for (p = 0; p < first; ++p)
2867 ir_value *param = instr->params[p];
2869 stmt.opcode = INSTR_STORE_F;
2872 if (param->vtype == TYPE_FIELD)
2873 stmt.opcode = field_store_instr[param->fieldtype];
2875 stmt.opcode = type_store_instr[param->vtype];
2876 stmt.o1.u1 = ir_value_code_addr(param);
2877 stmt.o2.u1 = OFS_PARM0 + 3 * p;
2878 code_push_statement(&stmt, instr->context.line);
2880 /* Now handle extparams */
2881 first = vec_size(instr->params);
2882 for (; p < first; ++p)
2884 ir_builder *ir = func->owner;
2885 ir_value *param = instr->params[p];
2886 ir_value *targetparam;
2888 if (p-8 >= vec_size(ir->extparams))
2889 ir_gen_extparam(ir);
2891 targetparam = ir->extparams[p-8];
2893 stmt.opcode = INSTR_STORE_F;
2896 if (param->vtype == TYPE_FIELD)
2897 stmt.opcode = field_store_instr[param->fieldtype];
2899 stmt.opcode = type_store_instr[param->vtype];
2900 stmt.o1.u1 = ir_value_code_addr(param);
2901 stmt.o2.u1 = ir_value_code_addr(targetparam);
2902 code_push_statement(&stmt, instr->context.line);
2905 stmt.opcode = INSTR_CALL0 + vec_size(instr->params);
2906 if (stmt.opcode > INSTR_CALL8)
2907 stmt.opcode = INSTR_CALL8;
2908 stmt.o1.u1 = ir_value_code_addr(instr->_ops[1]);
2911 code_push_statement(&stmt, instr->context.line);
2913 retvalue = instr->_ops[0];
2914 if (retvalue && retvalue->store != store_return && (vec_size(retvalue->life) || retvalue->store == store_global))
2916 /* not to be kept in OFS_RETURN */
2917 if (retvalue->vtype == TYPE_FIELD && OPTS_FLAG(ADJUST_VECTOR_FIELDS))
2918 stmt.opcode = field_store_instr[retvalue->fieldtype];
2920 stmt.opcode = type_store_instr[retvalue->vtype];
2921 stmt.o1.u1 = OFS_RETURN;
2922 stmt.o2.u1 = ir_value_code_addr(retvalue);
2924 code_push_statement(&stmt, instr->context.line);
2929 if (instr->opcode == INSTR_STATE) {
2930 irerror(block->context, "TODO: state instruction");
2934 stmt.opcode = instr->opcode;
2939 /* This is the general order of operands */
2941 stmt.o3.u1 = ir_value_code_addr(instr->_ops[0]);
2944 stmt.o1.u1 = ir_value_code_addr(instr->_ops[1]);
2947 stmt.o2.u1 = ir_value_code_addr(instr->_ops[2]);
2949 if (stmt.opcode == INSTR_RETURN || stmt.opcode == INSTR_DONE)
2951 stmt.o1.u1 = stmt.o3.u1;
2954 else if ((stmt.opcode >= INSTR_STORE_F &&
2955 stmt.opcode <= INSTR_STORE_FNC) ||
2956 (stmt.opcode >= INSTR_STOREP_F &&
2957 stmt.opcode <= INSTR_STOREP_FNC))
2959 /* 2-operand instructions with A -> B */
2960 stmt.o2.u1 = stmt.o3.u1;
2963 /* tiny optimization, don't output
2966 if (stmt.o2.u1 == stmt.o1.u1 &&
2967 OPTS_OPTIMIZATION(OPTIM_PEEPHOLE))
2969 ++opts_optimizationcount[OPTIM_PEEPHOLE];
2974 code_push_statement(&stmt, instr->context.line);
2979 static bool gen_function_code(ir_function *self)
2982 prog_section_statement stmt;
2984 /* Starting from entry point, we generate blocks "as they come"
2985 * for now. Dead blocks will not be translated obviously.
2987 if (!vec_size(self->blocks)) {
2988 irerror(self->context, "Function '%s' declared without body.", self->name);
2992 block = self->blocks[0];
2993 if (block->generated)
2996 if (!gen_blocks_recursive(self, block)) {
2997 irerror(self->context, "failed to generate blocks for '%s'", self->name);
3001 /* code_write and qcvm -disasm need to know that the function ends here */
3002 stmt.opcode = INSTR_DONE;
3006 code_push_statement(&stmt, vec_last(code_linenums));
3010 static qcint ir_builder_filestring(ir_builder *ir, const char *filename)
3012 /* NOTE: filename pointers are copied, we never strdup them,
3013 * thus we can use pointer-comparison to find the string.
3018 for (i = 0; i < vec_size(ir->filenames); ++i) {
3019 if (ir->filenames[i] == filename)
3020 return ir->filestrings[i];
3023 str = code_genstring(filename);
3024 vec_push(ir->filenames, filename);
3025 vec_push(ir->filestrings, str);
3029 static bool gen_global_function(ir_builder *ir, ir_value *global)
3031 prog_section_function fun;
3036 if (!global->hasvalue || (!global->constval.vfunc))
3038 irerror(global->context, "Invalid state of function-global: not constant: %s", global->name);
3042 irfun = global->constval.vfunc;
3044 fun.name = global->code.name;
3045 fun.file = ir_builder_filestring(ir, global->context.file);
3046 fun.profile = 0; /* always 0 */
3047 fun.nargs = vec_size(irfun->params);
3051 for (i = 0;i < 8; ++i) {
3052 if ((int32_t)i >= fun.nargs)
3055 fun.argsize[i] = type_sizeof_[irfun->params[i]];
3058 fun.firstlocal = vec_size(code_globals);
3060 fun.locals = irfun->allocated_locals;
3061 for (i = 0; i < vec_size(irfun->locals); ++i) {
3062 if (!ir_builder_gen_global(ir, irfun->locals[i], true)) {
3063 irerror(irfun->locals[i]->context, "Failed to generate local %s", irfun->locals[i]->name);
3066 ir_value_code_setaddr(irfun->locals[i], fun.firstlocal + irfun->locals[i]->code.local);
3068 for (i = 0; i < vec_size(irfun->values); ++i)
3070 /* generate code.globaladdr for ssa values */
3071 ir_value *v = irfun->values[i];
3072 ir_value_code_setaddr(v, fun.firstlocal + v->code.local);
3074 for (i = vec_size(code_globals); i < fun.firstlocal + irfun->allocated_locals; ++i)
3075 vec_push(code_globals, 0);
3078 fun.entry = irfun->builtin+1;
3080 irfun->code_function_def = vec_size(code_functions);
3081 fun.entry = vec_size(code_statements);
3084 vec_push(code_functions, fun);
3088 static void ir_gen_extparam(ir_builder *ir)
3090 prog_section_def def;
3094 snprintf(name, sizeof(name), "EXTPARM#%i", (int)(vec_size(ir->extparams)+8));
3095 global = ir_value_var(name, store_global, TYPE_VECTOR);
3097 def.name = code_genstring(name);
3098 def.type = TYPE_VECTOR;
3099 def.offset = vec_size(code_globals);
3101 vec_push(code_defs, def);
3102 ir_value_code_setaddr(global, def.offset);
3103 vec_push(code_globals, 0);
3104 vec_push(code_globals, 0);
3105 vec_push(code_globals, 0);
3107 vec_push(ir->extparams, global);
3110 static bool gen_function_extparam_copy(ir_function *self)
3112 size_t i, ext, numparams;
3114 ir_builder *ir = self->owner;
3116 prog_section_statement stmt;
3118 numparams = vec_size(self->params);
3122 stmt.opcode = INSTR_STORE_F;
3124 for (i = 8; i < numparams; ++i) {
3126 if (ext >= vec_size(ir->extparams))
3127 ir_gen_extparam(ir);
3129 ep = ir->extparams[ext];
3131 stmt.opcode = type_store_instr[self->locals[i]->vtype];
3132 if (self->locals[i]->vtype == TYPE_FIELD &&
3133 self->locals[i]->fieldtype == TYPE_VECTOR)
3135 stmt.opcode = INSTR_STORE_V;
3137 stmt.o1.u1 = ir_value_code_addr(ep);
3138 stmt.o2.u1 = ir_value_code_addr(self->locals[i]);
3139 code_push_statement(&stmt, self->context.line);
3145 static bool gen_global_function_code(ir_builder *ir, ir_value *global)
3147 prog_section_function *fundef;
3152 irfun = global->constval.vfunc;
3154 if (global->cvq == CV_NONE) {
3155 irwarning(global->context, WARN_IMPLICIT_FUNCTION_POINTER,
3156 "function `%s` has no body and in QC implicitly becomes a function-pointer", global->name);
3158 /* this was a function pointer, don't generate code for those */
3165 if (irfun->code_function_def < 0) {
3166 irerror(irfun->context, "`%s`: IR global wasn't generated, failed to access function-def", irfun->name);
3169 fundef = &code_functions[irfun->code_function_def];
3171 fundef->entry = vec_size(code_statements);
3172 if (!gen_function_extparam_copy(irfun)) {
3173 irerror(irfun->context, "Failed to generate extparam-copy code for function %s", irfun->name);
3176 if (!gen_function_code(irfun)) {
3177 irerror(irfun->context, "Failed to generate code for function %s", irfun->name);
3183 static void gen_vector_defs(prog_section_def def, const char *name)
3188 if (!name || OPTS_FLAG(SINGLE_VECTOR_DEFS))
3191 def.type = TYPE_FLOAT;
3195 component = (char*)mem_a(len+3);
3196 memcpy(component, name, len);
3198 component[len-0] = 0;
3199 component[len-2] = '_';
3201 component[len-1] = 'x';
3203 for (i = 0; i < 3; ++i) {
3204 def.name = code_genstring(component);
3205 vec_push(code_defs, def);
3211 static void gen_vector_fields(prog_section_field fld, const char *name)
3216 if (!name || OPTS_FLAG(SINGLE_VECTOR_DEFS))
3219 fld.type = TYPE_FLOAT;
3223 component = (char*)mem_a(len+3);
3224 memcpy(component, name, len);
3226 component[len-0] = 0;
3227 component[len-2] = '_';
3229 component[len-1] = 'x';
3231 for (i = 0; i < 3; ++i) {
3232 fld.name = code_genstring(component);
3233 vec_push(code_fields, fld);
3239 static bool ir_builder_gen_global(ir_builder *self, ir_value *global, bool islocal)
3243 prog_section_def def;
3245 def.type = global->vtype;
3246 def.offset = vec_size(code_globals);
3249 if (global->name[0] == '#') {
3250 if (!self->str_immediate)
3251 self->str_immediate = code_genstring("IMMEDIATE");
3252 def.name = global->code.name = self->str_immediate;
3255 def.name = global->code.name = code_genstring(global->name);
3260 switch (global->vtype)
3263 if (!strcmp(global->name, "end_sys_globals")) {
3264 /* TODO: remember this point... all the defs before this one
3265 * should be checksummed and added to progdefs.h when we generate it.
3268 else if (!strcmp(global->name, "end_sys_fields")) {
3269 /* TODO: same as above but for entity-fields rather than globsl
3273 irwarning(global->context, WARN_VOID_VARIABLES, "unrecognized variable of type void `%s`",
3275 /* I'd argue setting it to 0 is sufficient, but maybe some depend on knowing how far
3276 * the system fields actually go? Though the engine knows this anyway...
3277 * Maybe this could be an -foption
3278 * fteqcc creates data for end_sys_* - of size 1, so let's do the same
3280 ir_value_code_setaddr(global, vec_size(code_globals));
3281 vec_push(code_globals, 0);
3283 vec_push(code_defs, def);
3286 vec_push(code_defs, def);
3287 return gen_global_pointer(global);
3289 vec_push(code_defs, def);
3290 gen_vector_defs(def, global->name);
3291 return gen_global_field(global);
3296 ir_value_code_setaddr(global, vec_size(code_globals));
3297 if (global->hasvalue) {
3298 iptr = (int32_t*)&global->constval.ivec[0];
3299 vec_push(code_globals, *iptr);
3301 vec_push(code_globals, 0);
3303 if (!islocal && global->cvq != CV_CONST)
3304 def.type |= DEF_SAVEGLOBAL;
3305 vec_push(code_defs, def);
3307 return global->code.globaladdr >= 0;
3311 ir_value_code_setaddr(global, vec_size(code_globals));
3312 if (global->hasvalue) {
3313 vec_push(code_globals, code_genstring(global->constval.vstring));
3315 vec_push(code_globals, 0);
3317 if (!islocal && global->cvq != CV_CONST)
3318 def.type |= DEF_SAVEGLOBAL;
3319 vec_push(code_defs, def);
3320 return global->code.globaladdr >= 0;
3325 ir_value_code_setaddr(global, vec_size(code_globals));
3326 if (global->hasvalue) {
3327 iptr = (int32_t*)&global->constval.ivec[0];
3328 vec_push(code_globals, iptr[0]);
3329 if (global->code.globaladdr < 0)
3331 for (d = 1; d < type_sizeof_[global->vtype]; ++d) {
3332 vec_push(code_globals, iptr[d]);
3335 vec_push(code_globals, 0);
3336 if (global->code.globaladdr < 0)
3338 for (d = 1; d < type_sizeof_[global->vtype]; ++d) {
3339 vec_push(code_globals, 0);
3342 if (!islocal && global->cvq != CV_CONST)
3343 def.type |= DEF_SAVEGLOBAL;
3345 vec_push(code_defs, def);
3346 def.type &= ~DEF_SAVEGLOBAL;
3347 gen_vector_defs(def, global->name);
3348 return global->code.globaladdr >= 0;
3351 ir_value_code_setaddr(global, vec_size(code_globals));
3352 if (!global->hasvalue) {
3353 vec_push(code_globals, 0);
3354 if (global->code.globaladdr < 0)
3357 vec_push(code_globals, vec_size(code_functions));
3358 if (!gen_global_function(self, global))
3361 if (!islocal && global->cvq != CV_CONST)
3362 def.type |= DEF_SAVEGLOBAL;
3363 vec_push(code_defs, def);
3366 /* assume biggest type */
3367 ir_value_code_setaddr(global, vec_size(code_globals));
3368 vec_push(code_globals, 0);
3369 for (i = 1; i < type_sizeof_[TYPE_VARIANT]; ++i)
3370 vec_push(code_globals, 0);
3373 /* refuse to create 'void' type or any other fancy business. */
3374 irerror(global->context, "Invalid type for global variable `%s`: %s",
3375 global->name, type_name[global->vtype]);
3380 static void ir_builder_prepare_field(ir_value *field)
3382 field->code.fieldaddr = code_alloc_field(type_sizeof_[field->fieldtype]);
3385 static bool ir_builder_gen_field(ir_builder *self, ir_value *field)
3387 prog_section_def def;
3388 prog_section_field fld;
3392 def.type = (uint16_t)field->vtype;
3393 def.offset = (uint16_t)vec_size(code_globals);
3395 /* create a global named the same as the field */
3396 if (opts.standard == COMPILER_GMQCC) {
3397 /* in our standard, the global gets a dot prefix */
3398 size_t len = strlen(field->name);
3401 /* we really don't want to have to allocate this, and 1024
3402 * bytes is more than enough for a variable/field name
3404 if (len+2 >= sizeof(name)) {
3405 irerror(field->context, "invalid field name size: %u", (unsigned int)len);
3410 memcpy(name+1, field->name, len); /* no strncpy - we used strlen above */
3413 def.name = code_genstring(name);
3414 fld.name = def.name + 1; /* we reuse that string table entry */
3416 /* in plain QC, there cannot be a global with the same name,
3417 * and so we also name the global the same.
3418 * FIXME: fteqcc should create a global as well
3419 * check if it actually uses the same name. Probably does
3421 def.name = code_genstring(field->name);
3422 fld.name = def.name;
3425 field->code.name = def.name;
3427 vec_push(code_defs, def);
3429 fld.type = field->fieldtype;
3431 if (fld.type == TYPE_VOID) {
3432 irerror(field->context, "field is missing a type: %s - don't know its size", field->name);
3436 fld.offset = field->code.fieldaddr;
3438 vec_push(code_fields, fld);
3440 ir_value_code_setaddr(field, vec_size(code_globals));
3441 vec_push(code_globals, fld.offset);
3442 if (fld.type == TYPE_VECTOR) {
3443 vec_push(code_globals, fld.offset+1);
3444 vec_push(code_globals, fld.offset+2);
3447 if (field->fieldtype == TYPE_VECTOR) {
3448 gen_vector_defs(def, field->name);
3449 gen_vector_fields(fld, field->name);
3452 return field->code.globaladdr >= 0;
3455 bool ir_builder_generate(ir_builder *self, const char *filename)
3457 prog_section_statement stmt;
3459 char *lnofile = NULL;
3463 for (i = 0; i < vec_size(self->fields); ++i)
3465 ir_builder_prepare_field(self->fields[i]);
3468 for (i = 0; i < vec_size(self->globals); ++i)
3470 if (!ir_builder_gen_global(self, self->globals[i], false)) {
3475 for (i = 0; i < vec_size(self->fields); ++i)
3477 if (!ir_builder_gen_field(self, self->fields[i])) {
3482 /* generate function code */
3483 for (i = 0; i < vec_size(self->globals); ++i)
3485 if (self->globals[i]->vtype == TYPE_FUNCTION) {
3486 if (!gen_global_function_code(self, self->globals[i])) {
3492 if (vec_size(code_globals) >= 65536) {
3493 irerror(vec_last(self->globals)->context, "This progs file would require more globals than the metadata can handle. Bailing out.");
3497 /* DP errors if the last instruction is not an INSTR_DONE. */
3498 if (vec_last(code_statements).opcode != INSTR_DONE)
3500 stmt.opcode = INSTR_DONE;
3504 code_push_statement(&stmt, vec_last(code_linenums));
3510 if (vec_size(code_statements) != vec_size(code_linenums)) {
3511 con_err("Linecounter wrong: %lu != %lu\n",
3512 (unsigned long)vec_size(code_statements),
3513 (unsigned long)vec_size(code_linenums));
3514 } else if (OPTS_FLAG(LNO)) {
3516 size_t filelen = strlen(filename);
3518 memcpy(vec_add(lnofile, filelen+1), filename, filelen+1);
3519 dot = strrchr(lnofile, '.');
3523 vec_shrinkto(lnofile, dot - lnofile);
3525 memcpy(vec_add(lnofile, 5), ".lno", 5);
3529 con_out("writing '%s' and '%s'...\n", filename, lnofile);
3531 con_out("writing '%s'\n", filename);
3532 if (!code_write(filename, lnofile)) {
3540 /***********************************************************************
3541 *IR DEBUG Dump functions...
3544 #define IND_BUFSZ 1024
3547 # define strncat(dst, src, sz) strncat_s(dst, sz, src, _TRUNCATE)
3550 const char *qc_opname(int op)
3552 if (op < 0) return "<INVALID>";
3553 if (op < (int)( sizeof(asm_instr) / sizeof(asm_instr[0]) ))
3554 return asm_instr[op].m;
3556 case VINSTR_PHI: return "PHI";
3557 case VINSTR_JUMP: return "JUMP";
3558 case VINSTR_COND: return "COND";
3559 default: return "<UNK>";
3563 void ir_builder_dump(ir_builder *b, int (*oprintf)(const char*, ...))
3566 char indent[IND_BUFSZ];
3570 oprintf("module %s\n", b->name);
3571 for (i = 0; i < vec_size(b->globals); ++i)
3574 if (b->globals[i]->hasvalue)
3575 oprintf("%s = ", b->globals[i]->name);
3576 ir_value_dump(b->globals[i], oprintf);
3579 for (i = 0; i < vec_size(b->functions); ++i)
3580 ir_function_dump(b->functions[i], indent, oprintf);
3581 oprintf("endmodule %s\n", b->name);
3584 void ir_function_dump(ir_function *f, char *ind,
3585 int (*oprintf)(const char*, ...))
3588 if (f->builtin != 0) {
3589 oprintf("%sfunction %s = builtin %i\n", ind, f->name, -f->builtin);
3592 oprintf("%sfunction %s\n", ind, f->name);
3593 strncat(ind, "\t", IND_BUFSZ);
3594 if (vec_size(f->locals))
3596 oprintf("%s%i locals:\n", ind, (int)vec_size(f->locals));
3597 for (i = 0; i < vec_size(f->locals); ++i) {
3598 oprintf("%s\t", ind);
3599 ir_value_dump(f->locals[i], oprintf);
3603 oprintf("%sliferanges:\n", ind);
3604 for (i = 0; i < vec_size(f->locals); ++i) {
3606 ir_value *v = f->locals[i];
3607 oprintf("%s\t%s: %s@%i ", ind, v->name, (v->unique_life ? "unique " : ""), (int)v->code.local);
3608 for (l = 0; l < vec_size(v->life); ++l) {
3609 oprintf("[%i,%i] ", v->life[l].start, v->life[l].end);
3613 for (i = 0; i < vec_size(f->values); ++i) {
3615 ir_value *v = f->values[i];
3616 oprintf("%s\t%s: @%i ", ind, v->name, (int)v->code.local);
3617 for (l = 0; l < vec_size(v->life); ++l) {
3618 oprintf("[%i,%i] ", v->life[l].start, v->life[l].end);
3622 if (vec_size(f->blocks))
3624 oprintf("%slife passes (check): %i\n", ind, (int)f->run_id);
3625 for (i = 0; i < vec_size(f->blocks); ++i) {
3626 if (f->blocks[i]->run_id != f->run_id) {
3627 oprintf("%slife pass check fail! %i != %i\n", ind, (int)f->blocks[i]->run_id, (int)f->run_id);
3629 ir_block_dump(f->blocks[i], ind, oprintf);
3633 ind[strlen(ind)-1] = 0;
3634 oprintf("%sendfunction %s\n", ind, f->name);
3637 void ir_block_dump(ir_block* b, char *ind,
3638 int (*oprintf)(const char*, ...))
3641 oprintf("%s:%s\n", ind, b->label);
3642 strncat(ind, "\t", IND_BUFSZ);
3644 for (i = 0; i < vec_size(b->instr); ++i)
3645 ir_instr_dump(b->instr[i], ind, oprintf);
3646 ind[strlen(ind)-1] = 0;
3649 void dump_phi(ir_instr *in, int (*oprintf)(const char*, ...))
3652 oprintf("%s <- phi ", in->_ops[0]->name);
3653 for (i = 0; i < vec_size(in->phi); ++i)
3655 oprintf("([%s] : %s) ", in->phi[i].from->label,
3656 in->phi[i].value->name);
3661 void ir_instr_dump(ir_instr *in, char *ind,
3662 int (*oprintf)(const char*, ...))
3665 const char *comma = NULL;
3667 oprintf("%s (%i) ", ind, (int)in->eid);
3669 if (in->opcode == VINSTR_PHI) {
3670 dump_phi(in, oprintf);
3674 strncat(ind, "\t", IND_BUFSZ);
3676 if (in->_ops[0] && (in->_ops[1] || in->_ops[2])) {
3677 ir_value_dump(in->_ops[0], oprintf);
3678 if (in->_ops[1] || in->_ops[2])
3681 if (in->opcode == INSTR_CALL0 || in->opcode == VINSTR_NRCALL) {
3682 oprintf("CALL%i\t", vec_size(in->params));
3684 oprintf("%s\t", qc_opname(in->opcode));
3686 if (in->_ops[0] && !(in->_ops[1] || in->_ops[2])) {
3687 ir_value_dump(in->_ops[0], oprintf);
3692 for (i = 1; i != 3; ++i) {
3696 ir_value_dump(in->_ops[i], oprintf);
3704 oprintf("[%s]", in->bops[0]->label);
3708 oprintf("%s[%s]", comma, in->bops[1]->label);
3709 if (vec_size(in->params)) {
3710 oprintf("\tparams: ");
3711 for (i = 0; i != vec_size(in->params); ++i) {
3712 oprintf("%s, ", in->params[i]->name);
3716 ind[strlen(ind)-1] = 0;
3719 void ir_value_dump_string(const char *str, int (*oprintf)(const char*, ...))
3722 for (; *str; ++str) {
3724 case '\n': oprintf("\\n"); break;
3725 case '\r': oprintf("\\r"); break;
3726 case '\t': oprintf("\\t"); break;
3727 case '\v': oprintf("\\v"); break;
3728 case '\f': oprintf("\\f"); break;
3729 case '\b': oprintf("\\b"); break;
3730 case '\a': oprintf("\\a"); break;
3731 case '\\': oprintf("\\\\"); break;
3732 case '"': oprintf("\\\""); break;
3733 default: oprintf("%c", *str); break;
3739 void ir_value_dump(ir_value* v, int (*oprintf)(const char*, ...))
3748 oprintf("fn:%s", v->name);
3751 oprintf("%g", v->constval.vfloat);
3754 oprintf("'%g %g %g'",
3757 v->constval.vvec.z);
3760 oprintf("(entity)");
3763 ir_value_dump_string(v->constval.vstring, oprintf);
3767 oprintf("%i", v->constval.vint);
3772 v->constval.vpointer->name);
3776 oprintf("%s", v->name);
3780 void ir_value_dump_life(const ir_value *self, int (*oprintf)(const char*,...))
3783 oprintf("Life of %12s:", self->name);
3784 for (i = 0; i < vec_size(self->life); ++i)
3786 oprintf(" + [%i, %i]\n", self->life[i].start, self->life[i].end);