2 * Copyright (C) 2012, 2013
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] = {
51 static size_t type_sizeof_[TYPE_COUNT] = {
58 1, /* TYPE_FUNCTION */
69 const uint16_t type_store_instr[TYPE_COUNT] = {
70 INSTR_STORE_F, /* should use I when having integer support */
77 INSTR_STORE_ENT, /* should use I */
79 INSTR_STORE_I, /* integer type */
84 INSTR_STORE_V, /* variant, should never be accessed */
86 VINSTR_END, /* struct */
87 VINSTR_END, /* union */
88 VINSTR_END, /* array */
90 VINSTR_END, /* noexpr */
93 const uint16_t field_store_instr[TYPE_COUNT] = {
103 INSTR_STORE_FLD, /* integer type */
108 INSTR_STORE_V, /* variant, should never be accessed */
110 VINSTR_END, /* struct */
111 VINSTR_END, /* union */
112 VINSTR_END, /* array */
113 VINSTR_END, /* nil */
114 VINSTR_END, /* noexpr */
117 const uint16_t type_storep_instr[TYPE_COUNT] = {
118 INSTR_STOREP_F, /* should use I when having integer support */
125 INSTR_STOREP_ENT, /* should use I */
127 INSTR_STOREP_ENT, /* integer type */
132 INSTR_STOREP_V, /* variant, should never be accessed */
134 VINSTR_END, /* struct */
135 VINSTR_END, /* union */
136 VINSTR_END, /* array */
137 VINSTR_END, /* nil */
138 VINSTR_END, /* noexpr */
141 const uint16_t type_eq_instr[TYPE_COUNT] = {
142 INSTR_EQ_F, /* should use I when having integer support */
147 INSTR_EQ_E, /* FLD has no comparison */
149 INSTR_EQ_E, /* should use I */
156 INSTR_EQ_V, /* variant, should never be accessed */
158 VINSTR_END, /* struct */
159 VINSTR_END, /* union */
160 VINSTR_END, /* array */
161 VINSTR_END, /* nil */
162 VINSTR_END, /* noexpr */
165 const uint16_t type_ne_instr[TYPE_COUNT] = {
166 INSTR_NE_F, /* should use I when having integer support */
171 INSTR_NE_E, /* FLD has no comparison */
173 INSTR_NE_E, /* should use I */
180 INSTR_NE_V, /* variant, should never be accessed */
182 VINSTR_END, /* struct */
183 VINSTR_END, /* union */
184 VINSTR_END, /* array */
185 VINSTR_END, /* nil */
186 VINSTR_END, /* noexpr */
189 const uint16_t type_not_instr[TYPE_COUNT] = {
190 INSTR_NOT_F, /* should use I when having integer support */
191 VINSTR_END, /* not to be used, depends on string related -f flags */
197 INSTR_NOT_ENT, /* should use I */
199 INSTR_NOT_I, /* integer type */
204 INSTR_NOT_V, /* variant, should never be accessed */
206 VINSTR_END, /* struct */
207 VINSTR_END, /* union */
208 VINSTR_END, /* array */
209 VINSTR_END, /* nil */
210 VINSTR_END, /* noexpr */
214 static ir_value* ir_gen_extparam_proto(ir_builder *ir);
215 static void ir_gen_extparam (ir_builder *ir);
217 /* error functions */
219 static void irerror(lex_ctx ctx, const char *msg, ...)
223 con_cvprintmsg((void*)&ctx, LVL_ERROR, "internal error", msg, ap);
227 static bool irwarning(lex_ctx ctx, int warntype, const char *fmt, ...)
232 r = vcompile_warning(ctx, warntype, fmt, ap);
237 /***********************************************************************
238 * Vector utility functions
241 bool GMQCC_WARN vec_ir_value_find(ir_value **vec, const ir_value *what, size_t *idx)
244 size_t len = vec_size(vec);
245 for (i = 0; i < len; ++i) {
246 if (vec[i] == what) {
254 bool GMQCC_WARN vec_ir_block_find(ir_block **vec, ir_block *what, size_t *idx)
257 size_t len = vec_size(vec);
258 for (i = 0; i < len; ++i) {
259 if (vec[i] == what) {
267 bool GMQCC_WARN vec_ir_instr_find(ir_instr **vec, ir_instr *what, size_t *idx)
270 size_t len = vec_size(vec);
271 for (i = 0; i < len; ++i) {
272 if (vec[i] == what) {
280 /***********************************************************************
284 static void ir_block_delete_quick(ir_block* self);
285 static void ir_instr_delete_quick(ir_instr *self);
286 static void ir_function_delete_quick(ir_function *self);
288 ir_builder* ir_builder_new(const char *modulename)
292 self = (ir_builder*)mem_a(sizeof(*self));
296 self->functions = NULL;
297 self->globals = NULL;
299 self->filenames = NULL;
300 self->filestrings = NULL;
301 self->htglobals = util_htnew(IR_HT_SIZE);
302 self->htfields = util_htnew(IR_HT_SIZE);
303 self->htfunctions = util_htnew(IR_HT_SIZE);
305 self->extparams = NULL;
306 self->extparam_protos = NULL;
308 self->first_common_globaltemp = 0;
309 self->max_globaltemps = 0;
310 self->first_common_local = 0;
311 self->max_locals = 0;
313 self->str_immediate = 0;
315 if (!ir_builder_set_name(self, modulename)) {
320 self->nil = ir_value_var("nil", store_value, TYPE_NIL);
321 self->nil->cvq = CV_CONST;
323 self->reserved_va_count = NULL;
328 void ir_builder_delete(ir_builder* self)
331 util_htdel(self->htglobals);
332 util_htdel(self->htfields);
333 util_htdel(self->htfunctions);
334 mem_d((void*)self->name);
335 for (i = 0; i != vec_size(self->functions); ++i) {
336 ir_function_delete_quick(self->functions[i]);
338 vec_free(self->functions);
339 for (i = 0; i != vec_size(self->extparams); ++i) {
340 ir_value_delete(self->extparams[i]);
342 vec_free(self->extparams);
343 for (i = 0; i != vec_size(self->globals); ++i) {
344 ir_value_delete(self->globals[i]);
346 vec_free(self->globals);
347 for (i = 0; i != vec_size(self->fields); ++i) {
348 ir_value_delete(self->fields[i]);
350 ir_value_delete(self->nil);
351 vec_free(self->fields);
352 vec_free(self->filenames);
353 vec_free(self->filestrings);
357 bool ir_builder_set_name(ir_builder *self, const char *name)
360 mem_d((void*)self->name);
361 self->name = util_strdup(name);
365 ir_function* ir_builder_get_function(ir_builder *self, const char *name)
367 return (ir_function*)util_htget(self->htfunctions, name);
370 ir_function* ir_builder_create_function(ir_builder *self, const char *name, int outtype)
372 ir_function *fn = ir_builder_get_function(self, name);
377 fn = ir_function_new(self, outtype);
378 if (!ir_function_set_name(fn, name))
380 ir_function_delete(fn);
383 vec_push(self->functions, fn);
384 util_htset(self->htfunctions, name, fn);
386 fn->value = ir_builder_create_global(self, fn->name, TYPE_FUNCTION);
388 ir_function_delete(fn);
392 fn->value->hasvalue = true;
393 fn->value->outtype = outtype;
394 fn->value->constval.vfunc = fn;
395 fn->value->context = fn->context;
400 ir_value* ir_builder_get_global(ir_builder *self, const char *name)
402 return (ir_value*)util_htget(self->htglobals, name);
405 ir_value* ir_builder_create_global(ir_builder *self, const char *name, int vtype)
409 if (name && name[0] != '#')
411 ve = ir_builder_get_global(self, name);
417 ve = ir_value_var(name, store_global, vtype);
418 vec_push(self->globals, ve);
419 util_htset(self->htglobals, name, ve);
423 ir_value* ir_builder_get_va_count(ir_builder *self)
425 if (self->reserved_va_count)
426 return self->reserved_va_count;
427 return (self->reserved_va_count = ir_builder_create_global(self, "reserved:va_count", TYPE_FLOAT));
430 ir_value* ir_builder_get_field(ir_builder *self, const char *name)
432 return (ir_value*)util_htget(self->htfields, name);
436 ir_value* ir_builder_create_field(ir_builder *self, const char *name, int vtype)
438 ir_value *ve = ir_builder_get_field(self, name);
443 ve = ir_value_var(name, store_global, TYPE_FIELD);
444 ve->fieldtype = vtype;
445 vec_push(self->fields, ve);
446 util_htset(self->htfields, name, ve);
450 /***********************************************************************
454 bool ir_function_naive_phi(ir_function*);
455 void ir_function_enumerate(ir_function*);
456 bool ir_function_calculate_liferanges(ir_function*);
457 bool ir_function_allocate_locals(ir_function*);
459 ir_function* ir_function_new(ir_builder* owner, int outtype)
462 self = (ir_function*)mem_a(sizeof(*self));
467 memset(self, 0, sizeof(*self));
470 if (!ir_function_set_name(self, "<@unnamed>")) {
477 self->context.file = "<@no context>";
478 self->context.line = 0;
479 self->outtype = outtype;
488 self->max_varargs = 0;
490 self->code_function_def = -1;
491 self->allocated_locals = 0;
492 self->globaltemps = 0;
498 bool ir_function_set_name(ir_function *self, const char *name)
501 mem_d((void*)self->name);
502 self->name = util_strdup(name);
506 static void ir_function_delete_quick(ir_function *self)
509 mem_d((void*)self->name);
511 for (i = 0; i != vec_size(self->blocks); ++i)
512 ir_block_delete_quick(self->blocks[i]);
513 vec_free(self->blocks);
515 vec_free(self->params);
517 for (i = 0; i != vec_size(self->values); ++i)
518 ir_value_delete(self->values[i]);
519 vec_free(self->values);
521 for (i = 0; i != vec_size(self->locals); ++i)
522 ir_value_delete(self->locals[i]);
523 vec_free(self->locals);
525 /* self->value is deleted by the builder */
530 void ir_function_delete(ir_function *self)
533 mem_d((void*)self->name);
535 for (i = 0; i != vec_size(self->blocks); ++i)
536 ir_block_delete(self->blocks[i]);
537 vec_free(self->blocks);
539 vec_free(self->params);
541 for (i = 0; i != vec_size(self->values); ++i)
542 ir_value_delete(self->values[i]);
543 vec_free(self->values);
545 for (i = 0; i != vec_size(self->locals); ++i)
546 ir_value_delete(self->locals[i]);
547 vec_free(self->locals);
549 /* self->value is deleted by the builder */
554 void ir_function_collect_value(ir_function *self, ir_value *v)
556 vec_push(self->values, v);
559 ir_block* ir_function_create_block(lex_ctx ctx, ir_function *self, const char *label)
561 ir_block* bn = ir_block_new(self, label);
563 vec_push(self->blocks, bn);
567 static bool instr_is_operation(uint16_t op)
569 return ( (op >= INSTR_MUL_F && op <= INSTR_GT) ||
570 (op >= INSTR_LOAD_F && op <= INSTR_LOAD_FNC) ||
571 (op == INSTR_ADDRESS) ||
572 (op >= INSTR_NOT_F && op <= INSTR_NOT_FNC) ||
573 (op >= INSTR_AND && op <= INSTR_BITOR) ||
574 (op >= INSTR_CALL0 && op <= INSTR_CALL8) );
577 bool ir_function_pass_peephole(ir_function *self)
581 for (b = 0; b < vec_size(self->blocks); ++b) {
583 ir_block *block = self->blocks[b];
585 for (i = 0; i < vec_size(block->instr); ++i) {
587 inst = block->instr[i];
590 (inst->opcode >= INSTR_STORE_F &&
591 inst->opcode <= INSTR_STORE_FNC))
599 oper = block->instr[i-1];
600 if (!instr_is_operation(oper->opcode))
603 if (OPTS_FLAG(LEGACY_VECTOR_MATHS)) {
604 if (oper->opcode == INSTR_MUL_VF && oper->_ops[2]->memberof == oper->_ops[1])
606 if (oper->opcode == INSTR_MUL_FV && oper->_ops[1]->memberof == oper->_ops[2])
610 value = oper->_ops[0];
612 /* only do it for SSA values */
613 if (value->store != store_value)
616 /* don't optimize out the temp if it's used later again */
617 if (vec_size(value->reads) != 1)
620 /* The very next store must use this value */
621 if (value->reads[0] != store)
624 /* And of course the store must _read_ from it, so it's in
626 if (store->_ops[1] != value)
629 ++opts_optimizationcount[OPTIM_PEEPHOLE];
630 (void)!ir_instr_op(oper, 0, store->_ops[0], true);
632 vec_remove(block->instr, i, 1);
633 ir_instr_delete(store);
635 else if (inst->opcode == VINSTR_COND)
637 /* COND on a value resulting from a NOT could
638 * remove the NOT and swap its operands
645 value = inst->_ops[0];
647 if (value->store != store_value ||
648 vec_size(value->reads) != 1 ||
649 value->reads[0] != inst)
654 inot = value->writes[0];
655 if (inot->_ops[0] != value ||
656 inot->opcode < INSTR_NOT_F ||
657 inot->opcode > INSTR_NOT_FNC ||
658 inot->opcode == INSTR_NOT_V || /* can't do these */
659 inot->opcode == INSTR_NOT_S)
665 ++opts_optimizationcount[OPTIM_PEEPHOLE];
667 (void)!ir_instr_op(inst, 0, inot->_ops[1], false);
670 for (inotid = 0; inotid < vec_size(tmp->instr); ++inotid) {
671 if (tmp->instr[inotid] == inot)
674 if (inotid >= vec_size(tmp->instr)) {
675 compile_error(inst->context, "sanity-check failed: failed to find instruction to optimize out");
678 vec_remove(tmp->instr, inotid, 1);
679 ir_instr_delete(inot);
680 /* swap ontrue/onfalse */
682 inst->bops[0] = inst->bops[1];
693 bool ir_function_pass_tailrecursion(ir_function *self)
697 for (b = 0; b < vec_size(self->blocks); ++b) {
699 ir_instr *ret, *call, *store = NULL;
700 ir_block *block = self->blocks[b];
702 if (!block->final || vec_size(block->instr) < 2)
705 ret = block->instr[vec_size(block->instr)-1];
706 if (ret->opcode != INSTR_DONE && ret->opcode != INSTR_RETURN)
709 call = block->instr[vec_size(block->instr)-2];
710 if (call->opcode >= INSTR_STORE_F && call->opcode <= INSTR_STORE_FNC) {
711 /* account for the unoptimized
713 * STORE %return, %tmp
717 if (vec_size(block->instr) < 3)
721 call = block->instr[vec_size(block->instr)-3];
724 if (call->opcode < INSTR_CALL0 || call->opcode > INSTR_CALL8)
728 /* optimize out the STORE */
730 ret->_ops[0] == store->_ops[0] &&
731 store->_ops[1] == call->_ops[0])
733 ++opts_optimizationcount[OPTIM_PEEPHOLE];
734 call->_ops[0] = store->_ops[0];
735 vec_remove(block->instr, vec_size(block->instr) - 2, 1);
736 ir_instr_delete(store);
745 funcval = call->_ops[1];
748 if (funcval->vtype != TYPE_FUNCTION || funcval->constval.vfunc != self)
751 /* now we have a CALL and a RET, check if it's a tailcall */
752 if (ret->_ops[0] && call->_ops[0] != ret->_ops[0])
755 ++opts_optimizationcount[OPTIM_TAIL_RECURSION];
756 vec_shrinkby(block->instr, 2);
758 block->final = false; /* open it back up */
760 /* emite parameter-stores */
761 for (p = 0; p < vec_size(call->params); ++p) {
762 /* assert(call->params_count <= self->locals_count); */
763 if (!ir_block_create_store(block, call->context, self->locals[p], call->params[p])) {
764 irerror(call->context, "failed to create tailcall store instruction for parameter %i", (int)p);
768 if (!ir_block_create_jump(block, call->context, self->blocks[0])) {
769 irerror(call->context, "failed to create tailcall jump");
773 ir_instr_delete(call);
774 ir_instr_delete(ret);
780 bool ir_function_finalize(ir_function *self)
787 if (OPTS_OPTIMIZATION(OPTIM_PEEPHOLE)) {
788 if (!ir_function_pass_peephole(self)) {
789 irerror(self->context, "generic optimization pass broke something in `%s`", self->name);
794 if (OPTS_OPTIMIZATION(OPTIM_TAIL_RECURSION)) {
795 if (!ir_function_pass_tailrecursion(self)) {
796 irerror(self->context, "tail-recursion optimization pass broke something in `%s`", self->name);
801 if (!ir_function_naive_phi(self)) {
802 irerror(self->context, "internal error: ir_function_naive_phi failed");
806 for (i = 0; i < vec_size(self->locals); ++i) {
807 ir_value *v = self->locals[i];
808 if (v->vtype == TYPE_VECTOR ||
809 (v->vtype == TYPE_FIELD && v->outtype == TYPE_VECTOR))
811 ir_value_vector_member(v, 0);
812 ir_value_vector_member(v, 1);
813 ir_value_vector_member(v, 2);
816 for (i = 0; i < vec_size(self->values); ++i) {
817 ir_value *v = self->values[i];
818 if (v->vtype == TYPE_VECTOR ||
819 (v->vtype == TYPE_FIELD && v->outtype == TYPE_VECTOR))
821 ir_value_vector_member(v, 0);
822 ir_value_vector_member(v, 1);
823 ir_value_vector_member(v, 2);
827 ir_function_enumerate(self);
829 if (!ir_function_calculate_liferanges(self))
831 if (!ir_function_allocate_locals(self))
836 ir_value* ir_function_create_local(ir_function *self, const char *name, int vtype, bool param)
841 vec_size(self->locals) &&
842 self->locals[vec_size(self->locals)-1]->store != store_param) {
843 irerror(self->context, "cannot add parameters after adding locals");
847 ve = ir_value_var(name, (param ? store_param : store_local), vtype);
850 vec_push(self->locals, ve);
854 /***********************************************************************
858 ir_block* ir_block_new(ir_function* owner, const char *name)
861 self = (ir_block*)mem_a(sizeof(*self));
865 memset(self, 0, sizeof(*self));
868 if (name && !ir_block_set_label(self, name)) {
873 self->context.file = "<@no context>";
874 self->context.line = 0;
878 self->entries = NULL;
882 self->is_return = false;
886 self->generated = false;
891 static void ir_block_delete_quick(ir_block* self)
894 if (self->label) mem_d(self->label);
895 for (i = 0; i != vec_size(self->instr); ++i)
896 ir_instr_delete_quick(self->instr[i]);
897 vec_free(self->instr);
898 vec_free(self->entries);
899 vec_free(self->exits);
900 vec_free(self->living);
904 void ir_block_delete(ir_block* self)
907 if (self->label) mem_d(self->label);
908 for (i = 0; i != vec_size(self->instr); ++i)
909 ir_instr_delete(self->instr[i]);
910 vec_free(self->instr);
911 vec_free(self->entries);
912 vec_free(self->exits);
913 vec_free(self->living);
917 bool ir_block_set_label(ir_block *self, const char *name)
920 mem_d((void*)self->label);
921 self->label = util_strdup(name);
922 return !!self->label;
925 /***********************************************************************
929 ir_instr* ir_instr_new(lex_ctx ctx, ir_block* owner, int op)
932 self = (ir_instr*)mem_a(sizeof(*self));
939 self->_ops[0] = NULL;
940 self->_ops[1] = NULL;
941 self->_ops[2] = NULL;
942 self->bops[0] = NULL;
943 self->bops[1] = NULL;
954 static void ir_instr_delete_quick(ir_instr *self)
957 vec_free(self->params);
961 void ir_instr_delete(ir_instr *self)
964 /* The following calls can only delete from
965 * vectors, we still want to delete this instruction
966 * so ignore the return value. Since with the warn_unused_result attribute
967 * gcc doesn't care about an explicit: (void)foo(); to ignore the result,
968 * I have to improvise here and use if(foo());
970 for (i = 0; i < vec_size(self->phi); ++i) {
972 if (vec_ir_instr_find(self->phi[i].value->writes, self, &idx))
973 vec_remove(self->phi[i].value->writes, idx, 1);
974 if (vec_ir_instr_find(self->phi[i].value->reads, self, &idx))
975 vec_remove(self->phi[i].value->reads, idx, 1);
978 for (i = 0; i < vec_size(self->params); ++i) {
980 if (vec_ir_instr_find(self->params[i]->writes, self, &idx))
981 vec_remove(self->params[i]->writes, idx, 1);
982 if (vec_ir_instr_find(self->params[i]->reads, self, &idx))
983 vec_remove(self->params[i]->reads, idx, 1);
985 vec_free(self->params);
986 (void)!ir_instr_op(self, 0, NULL, false);
987 (void)!ir_instr_op(self, 1, NULL, false);
988 (void)!ir_instr_op(self, 2, NULL, false);
992 bool ir_instr_op(ir_instr *self, int op, ir_value *v, bool writing)
994 if (self->_ops[op]) {
996 if (writing && vec_ir_instr_find(self->_ops[op]->writes, self, &idx))
997 vec_remove(self->_ops[op]->writes, idx, 1);
998 else if (vec_ir_instr_find(self->_ops[op]->reads, self, &idx))
999 vec_remove(self->_ops[op]->reads, idx, 1);
1003 vec_push(v->writes, self);
1005 vec_push(v->reads, self);
1011 /***********************************************************************
1015 void ir_value_code_setaddr(ir_value *self, int32_t gaddr)
1017 self->code.globaladdr = gaddr;
1018 if (self->members[0]) self->members[0]->code.globaladdr = gaddr;
1019 if (self->members[1]) self->members[1]->code.globaladdr = gaddr;
1020 if (self->members[2]) self->members[2]->code.globaladdr = gaddr;
1023 int32_t ir_value_code_addr(const ir_value *self)
1025 if (self->store == store_return)
1026 return OFS_RETURN + self->code.addroffset;
1027 return self->code.globaladdr + self->code.addroffset;
1030 ir_value* ir_value_var(const char *name, int storetype, int vtype)
1033 self = (ir_value*)mem_a(sizeof(*self));
1034 self->vtype = vtype;
1035 self->fieldtype = TYPE_VOID;
1036 self->outtype = TYPE_VOID;
1037 self->store = storetype;
1041 self->writes = NULL;
1043 self->cvq = CV_NONE;
1044 self->hasvalue = false;
1045 self->context.file = "<@no context>";
1046 self->context.line = 0;
1048 if (name && !ir_value_set_name(self, name)) {
1049 irerror(self->context, "out of memory");
1054 memset(&self->constval, 0, sizeof(self->constval));
1055 memset(&self->code, 0, sizeof(self->code));
1057 self->members[0] = NULL;
1058 self->members[1] = NULL;
1059 self->members[2] = NULL;
1060 self->memberof = NULL;
1062 self->unique_life = false;
1063 self->locked = false;
1064 self->callparam = false;
1070 ir_value* ir_value_vector_member(ir_value *self, unsigned int member)
1078 if (self->members[member])
1079 return self->members[member];
1082 len = strlen(self->name);
1083 name = (char*)mem_a(len + 3);
1084 memcpy(name, self->name, len);
1086 name[len+1] = 'x' + member;
1092 if (self->vtype == TYPE_VECTOR)
1094 m = ir_value_var(name, self->store, TYPE_FLOAT);
1099 m->context = self->context;
1101 self->members[member] = m;
1102 m->code.addroffset = member;
1104 else if (self->vtype == TYPE_FIELD)
1106 if (self->fieldtype != TYPE_VECTOR)
1108 m = ir_value_var(name, self->store, TYPE_FIELD);
1113 m->fieldtype = TYPE_FLOAT;
1114 m->context = self->context;
1116 self->members[member] = m;
1117 m->code.addroffset = member;
1121 irerror(self->context, "invalid member access on %s", self->name);
1129 static GMQCC_INLINE size_t ir_value_sizeof(const ir_value *self)
1131 if (self->vtype == TYPE_FIELD && self->fieldtype == TYPE_VECTOR)
1132 return type_sizeof_[TYPE_VECTOR];
1133 return type_sizeof_[self->vtype];
1136 ir_value* ir_value_out(ir_function *owner, const char *name, int storetype, int vtype)
1138 ir_value *v = ir_value_var(name, storetype, vtype);
1141 ir_function_collect_value(owner, v);
1145 void ir_value_delete(ir_value* self)
1149 mem_d((void*)self->name);
1152 if (self->vtype == TYPE_STRING)
1153 mem_d((void*)self->constval.vstring);
1155 for (i = 0; i < 3; ++i) {
1156 if (self->members[i])
1157 ir_value_delete(self->members[i]);
1159 vec_free(self->reads);
1160 vec_free(self->writes);
1161 vec_free(self->life);
1165 bool ir_value_set_name(ir_value *self, const char *name)
1168 mem_d((void*)self->name);
1169 self->name = util_strdup(name);
1170 return !!self->name;
1173 bool ir_value_set_float(ir_value *self, float f)
1175 if (self->vtype != TYPE_FLOAT)
1177 self->constval.vfloat = f;
1178 self->hasvalue = true;
1182 bool ir_value_set_func(ir_value *self, int f)
1184 if (self->vtype != TYPE_FUNCTION)
1186 self->constval.vint = f;
1187 self->hasvalue = true;
1191 bool ir_value_set_vector(ir_value *self, vector v)
1193 if (self->vtype != TYPE_VECTOR)
1195 self->constval.vvec = v;
1196 self->hasvalue = true;
1200 bool ir_value_set_field(ir_value *self, ir_value *fld)
1202 if (self->vtype != TYPE_FIELD)
1204 self->constval.vpointer = fld;
1205 self->hasvalue = true;
1209 bool ir_value_set_string(ir_value *self, const char *str)
1211 if (self->vtype != TYPE_STRING)
1213 self->constval.vstring = util_strdupe(str);
1214 self->hasvalue = true;
1219 bool ir_value_set_int(ir_value *self, int i)
1221 if (self->vtype != TYPE_INTEGER)
1223 self->constval.vint = i;
1224 self->hasvalue = true;
1229 bool ir_value_lives(ir_value *self, size_t at)
1232 for (i = 0; i < vec_size(self->life); ++i)
1234 ir_life_entry_t *life = &self->life[i];
1235 if (life->start <= at && at <= life->end)
1237 if (life->start > at) /* since it's ordered */
1243 bool ir_value_life_insert(ir_value *self, size_t idx, ir_life_entry_t e)
1246 vec_push(self->life, e);
1247 for (k = vec_size(self->life)-1; k > idx; --k)
1248 self->life[k] = self->life[k-1];
1249 self->life[idx] = e;
1253 bool ir_value_life_merge(ir_value *self, size_t s)
1256 const size_t vs = vec_size(self->life);
1257 ir_life_entry_t *life = NULL;
1258 ir_life_entry_t *before = NULL;
1259 ir_life_entry_t new_entry;
1261 /* Find the first range >= s */
1262 for (i = 0; i < vs; ++i)
1265 life = &self->life[i];
1266 if (life->start > s)
1269 /* nothing found? append */
1272 if (life && life->end+1 == s)
1274 /* previous life range can be merged in */
1278 if (life && life->end >= s)
1280 e.start = e.end = s;
1281 vec_push(self->life, e);
1287 if (before->end + 1 == s &&
1288 life->start - 1 == s)
1291 before->end = life->end;
1292 vec_remove(self->life, i, 1);
1295 if (before->end + 1 == s)
1301 /* already contained */
1302 if (before->end >= s)
1306 if (life->start - 1 == s)
1311 /* insert a new entry */
1312 new_entry.start = new_entry.end = s;
1313 return ir_value_life_insert(self, i, new_entry);
1316 bool ir_value_life_merge_into(ir_value *self, const ir_value *other)
1320 if (!vec_size(other->life))
1323 if (!vec_size(self->life)) {
1324 size_t count = vec_size(other->life);
1325 ir_life_entry_t *life = vec_add(self->life, count);
1326 memcpy(life, other->life, count * sizeof(*life));
1331 for (i = 0; i < vec_size(other->life); ++i)
1333 const ir_life_entry_t *life = &other->life[i];
1336 ir_life_entry_t *entry = &self->life[myi];
1338 if (life->end+1 < entry->start)
1340 /* adding an interval before entry */
1341 if (!ir_value_life_insert(self, myi, *life))
1347 if (life->start < entry->start &&
1348 life->end+1 >= entry->start)
1350 /* starts earlier and overlaps */
1351 entry->start = life->start;
1354 if (life->end > entry->end &&
1355 life->start <= entry->end+1)
1357 /* ends later and overlaps */
1358 entry->end = life->end;
1361 /* see if our change combines it with the next ranges */
1362 while (myi+1 < vec_size(self->life) &&
1363 entry->end+1 >= self->life[1+myi].start)
1365 /* overlaps with (myi+1) */
1366 if (entry->end < self->life[1+myi].end)
1367 entry->end = self->life[1+myi].end;
1368 vec_remove(self->life, myi+1, 1);
1369 entry = &self->life[myi];
1372 /* see if we're after the entry */
1373 if (life->start > entry->end)
1376 /* append if we're at the end */
1377 if (myi >= vec_size(self->life)) {
1378 vec_push(self->life, *life);
1381 /* otherweise check the next range */
1390 bool ir_values_overlap(const ir_value *a, const ir_value *b)
1392 /* For any life entry in A see if it overlaps with
1393 * any life entry in B.
1394 * Note that the life entries are orderes, so we can make a
1395 * more efficient algorithm there than naively translating the
1399 ir_life_entry_t *la, *lb, *enda, *endb;
1401 /* first of all, if either has no life range, they cannot clash */
1402 if (!vec_size(a->life) || !vec_size(b->life))
1407 enda = la + vec_size(a->life);
1408 endb = lb + vec_size(b->life);
1411 /* check if the entries overlap, for that,
1412 * both must start before the other one ends.
1414 if (la->start < lb->end &&
1415 lb->start < la->end)
1420 /* entries are ordered
1421 * one entry is earlier than the other
1422 * that earlier entry will be moved forward
1424 if (la->start < lb->start)
1426 /* order: A B, move A forward
1427 * check if we hit the end with A
1432 else /* if (lb->start < la->start) actually <= */
1434 /* order: B A, move B forward
1435 * check if we hit the end with B
1444 /***********************************************************************
1448 static bool ir_check_unreachable(ir_block *self)
1450 /* The IR should never have to deal with unreachable code */
1451 if (!self->final/* || OPTS_FLAG(ALLOW_UNREACHABLE_CODE)*/)
1453 irerror(self->context, "unreachable statement (%s)", self->label);
1457 bool ir_block_create_store_op(ir_block *self, lex_ctx ctx, int op, ir_value *target, ir_value *what)
1460 if (!ir_check_unreachable(self))
1463 if (target->store == store_value &&
1464 (op < INSTR_STOREP_F || op > INSTR_STOREP_FNC))
1466 irerror(self->context, "cannot store to an SSA value");
1467 irerror(self->context, "trying to store: %s <- %s", target->name, what->name);
1468 irerror(self->context, "instruction: %s", asm_instr[op].m);
1472 in = ir_instr_new(ctx, self, op);
1476 if (!ir_instr_op(in, 0, target, (op < INSTR_STOREP_F || op > INSTR_STOREP_FNC)) ||
1477 !ir_instr_op(in, 1, what, false))
1479 ir_instr_delete(in);
1482 vec_push(self->instr, in);
1486 bool ir_block_create_store(ir_block *self, lex_ctx ctx, ir_value *target, ir_value *what)
1490 if (target->vtype == TYPE_VARIANT)
1491 vtype = what->vtype;
1493 vtype = target->vtype;
1496 if (vtype == TYPE_FLOAT && what->vtype == TYPE_INTEGER)
1497 op = INSTR_CONV_ITOF;
1498 else if (vtype == TYPE_INTEGER && what->vtype == TYPE_FLOAT)
1499 op = INSTR_CONV_FTOI;
1501 op = type_store_instr[vtype];
1503 if (OPTS_FLAG(ADJUST_VECTOR_FIELDS)) {
1504 if (op == INSTR_STORE_FLD && what->fieldtype == TYPE_VECTOR)
1508 return ir_block_create_store_op(self, ctx, op, target, what);
1511 bool ir_block_create_storep(ir_block *self, lex_ctx ctx, ir_value *target, ir_value *what)
1516 if (target->vtype != TYPE_POINTER)
1519 /* storing using pointer - target is a pointer, type must be
1520 * inferred from source
1522 vtype = what->vtype;
1524 op = type_storep_instr[vtype];
1525 if (OPTS_FLAG(ADJUST_VECTOR_FIELDS)) {
1526 if (op == INSTR_STOREP_FLD && what->fieldtype == TYPE_VECTOR)
1527 op = INSTR_STOREP_V;
1530 return ir_block_create_store_op(self, ctx, op, target, what);
1533 bool ir_block_create_return(ir_block *self, lex_ctx ctx, ir_value *v)
1536 if (!ir_check_unreachable(self))
1539 self->is_return = true;
1540 in = ir_instr_new(ctx, self, INSTR_RETURN);
1544 if (v && !ir_instr_op(in, 0, v, false)) {
1545 ir_instr_delete(in);
1549 vec_push(self->instr, in);
1553 bool ir_block_create_if(ir_block *self, lex_ctx ctx, ir_value *v,
1554 ir_block *ontrue, ir_block *onfalse)
1557 if (!ir_check_unreachable(self))
1560 /*in = ir_instr_new(ctx, self, (v->vtype == TYPE_STRING ? INSTR_IF_S : INSTR_IF_F));*/
1561 in = ir_instr_new(ctx, self, VINSTR_COND);
1565 if (!ir_instr_op(in, 0, v, false)) {
1566 ir_instr_delete(in);
1570 in->bops[0] = ontrue;
1571 in->bops[1] = onfalse;
1573 vec_push(self->instr, in);
1575 vec_push(self->exits, ontrue);
1576 vec_push(self->exits, onfalse);
1577 vec_push(ontrue->entries, self);
1578 vec_push(onfalse->entries, self);
1582 bool ir_block_create_jump(ir_block *self, lex_ctx ctx, ir_block *to)
1585 if (!ir_check_unreachable(self))
1588 in = ir_instr_new(ctx, self, VINSTR_JUMP);
1593 vec_push(self->instr, in);
1595 vec_push(self->exits, to);
1596 vec_push(to->entries, self);
1600 bool ir_block_create_goto(ir_block *self, lex_ctx ctx, ir_block *to)
1602 self->owner->flags |= IR_FLAG_HAS_GOTO;
1603 return ir_block_create_jump(self, ctx, to);
1606 ir_instr* ir_block_create_phi(ir_block *self, lex_ctx ctx, const char *label, int ot)
1610 if (!ir_check_unreachable(self))
1612 in = ir_instr_new(ctx, self, VINSTR_PHI);
1615 out = ir_value_out(self->owner, label, store_value, ot);
1617 ir_instr_delete(in);
1620 if (!ir_instr_op(in, 0, out, true)) {
1621 ir_instr_delete(in);
1622 ir_value_delete(out);
1625 vec_push(self->instr, in);
1629 ir_value* ir_phi_value(ir_instr *self)
1631 return self->_ops[0];
1634 void ir_phi_add(ir_instr* self, ir_block *b, ir_value *v)
1638 if (!vec_ir_block_find(self->owner->entries, b, NULL)) {
1639 /* Must not be possible to cause this, otherwise the AST
1640 * is doing something wrong.
1642 irerror(self->context, "Invalid entry block for PHI");
1648 vec_push(v->reads, self);
1649 vec_push(self->phi, pe);
1652 /* call related code */
1653 ir_instr* ir_block_create_call(ir_block *self, lex_ctx ctx, const char *label, ir_value *func, bool noreturn)
1657 if (!ir_check_unreachable(self))
1659 in = ir_instr_new(ctx, self, (noreturn ? VINSTR_NRCALL : INSTR_CALL0));
1664 self->is_return = true;
1666 out = ir_value_out(self->owner, label, (func->outtype == TYPE_VOID) ? store_return : store_value, func->outtype);
1668 ir_instr_delete(in);
1671 if (!ir_instr_op(in, 0, out, true) ||
1672 !ir_instr_op(in, 1, func, false))
1674 ir_instr_delete(in);
1675 ir_value_delete(out);
1678 vec_push(self->instr, in);
1681 if (!ir_block_create_return(self, ctx, NULL)) {
1682 compile_error(ctx, "internal error: failed to generate dummy-return instruction");
1683 ir_instr_delete(in);
1691 ir_value* ir_call_value(ir_instr *self)
1693 return self->_ops[0];
1696 void ir_call_param(ir_instr* self, ir_value *v)
1698 vec_push(self->params, v);
1699 vec_push(v->reads, self);
1702 /* binary op related code */
1704 ir_value* ir_block_create_binop(ir_block *self, lex_ctx ctx,
1705 const char *label, int opcode,
1706 ir_value *left, ir_value *right)
1728 case INSTR_SUB_S: /* -- offset of string as float */
1733 case INSTR_BITOR_IF:
1734 case INSTR_BITOR_FI:
1735 case INSTR_BITAND_FI:
1736 case INSTR_BITAND_IF:
1751 case INSTR_BITAND_I:
1754 case INSTR_RSHIFT_I:
1755 case INSTR_LSHIFT_I:
1777 /* boolean operations result in floats */
1778 if (opcode >= INSTR_EQ_F && opcode <= INSTR_GT)
1780 else if (opcode >= INSTR_LE && opcode <= INSTR_GT)
1783 else if (opcode >= INSTR_LE_I && opcode <= INSTR_EQ_FI)
1788 if (ot == TYPE_VOID) {
1789 /* The AST or parser were supposed to check this! */
1793 return ir_block_create_general_instr(self, ctx, label, opcode, left, right, ot);
1796 ir_value* ir_block_create_unary(ir_block *self, lex_ctx ctx,
1797 const char *label, int opcode,
1800 int ot = TYPE_FLOAT;
1812 /* QC doesn't have other unary operations. We expect extensions to fill
1813 * the above list, otherwise we assume out-type = in-type, eg for an
1817 ot = operand->vtype;
1820 if (ot == TYPE_VOID) {
1821 /* The AST or parser were supposed to check this! */
1825 /* let's use the general instruction creator and pass NULL for OPB */
1826 return ir_block_create_general_instr(self, ctx, label, opcode, operand, NULL, ot);
1829 ir_value* ir_block_create_general_instr(ir_block *self, lex_ctx ctx, const char *label,
1830 int op, ir_value *a, ir_value *b, int outype)
1835 out = ir_value_out(self->owner, label, store_value, outype);
1839 instr = ir_instr_new(ctx, self, op);
1841 ir_value_delete(out);
1845 if (!ir_instr_op(instr, 0, out, true) ||
1846 !ir_instr_op(instr, 1, a, false) ||
1847 !ir_instr_op(instr, 2, b, false) )
1852 vec_push(self->instr, instr);
1856 ir_instr_delete(instr);
1857 ir_value_delete(out);
1861 ir_value* ir_block_create_fieldaddress(ir_block *self, lex_ctx ctx, const char *label, ir_value *ent, ir_value *field)
1865 /* Support for various pointer types todo if so desired */
1866 if (ent->vtype != TYPE_ENTITY)
1869 if (field->vtype != TYPE_FIELD)
1872 v = ir_block_create_general_instr(self, ctx, label, INSTR_ADDRESS, ent, field, TYPE_POINTER);
1873 v->fieldtype = field->fieldtype;
1877 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)
1880 if (ent->vtype != TYPE_ENTITY)
1883 /* at some point we could redirect for TYPE_POINTER... but that could lead to carelessness */
1884 if (field->vtype != TYPE_FIELD)
1889 case TYPE_FLOAT: op = INSTR_LOAD_F; break;
1890 case TYPE_VECTOR: op = INSTR_LOAD_V; break;
1891 case TYPE_STRING: op = INSTR_LOAD_S; break;
1892 case TYPE_FIELD: op = INSTR_LOAD_FLD; break;
1893 case TYPE_ENTITY: op = INSTR_LOAD_ENT; break;
1894 case TYPE_FUNCTION: op = INSTR_LOAD_FNC; break;
1896 case TYPE_POINTER: op = INSTR_LOAD_I; break;
1897 case TYPE_INTEGER: op = INSTR_LOAD_I; break;
1900 irerror(self->context, "invalid type for ir_block_create_load_from_ent: %s", type_name[outype]);
1904 return ir_block_create_general_instr(self, ctx, label, op, ent, field, outype);
1907 /* PHI resolving breaks the SSA, and must thus be the last
1908 * step before life-range calculation.
1911 static bool ir_block_naive_phi(ir_block *self);
1912 bool ir_function_naive_phi(ir_function *self)
1916 for (i = 0; i < vec_size(self->blocks); ++i)
1918 if (!ir_block_naive_phi(self->blocks[i]))
1924 static bool ir_block_naive_phi(ir_block *self)
1926 size_t i, p; /*, w;*/
1927 /* FIXME: optionally, create_phi can add the phis
1928 * to a list so we don't need to loop through blocks
1929 * - anyway: "don't optimize YET"
1931 for (i = 0; i < vec_size(self->instr); ++i)
1933 ir_instr *instr = self->instr[i];
1934 if (instr->opcode != VINSTR_PHI)
1937 vec_remove(self->instr, i, 1);
1938 --i; /* NOTE: i+1 below */
1940 for (p = 0; p < vec_size(instr->phi); ++p)
1942 ir_value *v = instr->phi[p].value;
1943 ir_block *b = instr->phi[p].from;
1945 if (v->store == store_value &&
1946 vec_size(v->reads) == 1 &&
1947 vec_size(v->writes) == 1)
1949 /* replace the value */
1950 if (!ir_instr_op(v->writes[0], 0, instr->_ops[0], true))
1955 /* force a move instruction */
1956 ir_instr *prevjump = vec_last(b->instr);
1959 instr->_ops[0]->store = store_global;
1960 if (!ir_block_create_store(b, instr->context, instr->_ops[0], v))
1962 instr->_ops[0]->store = store_value;
1963 vec_push(b->instr, prevjump);
1967 ir_instr_delete(instr);
1972 /***********************************************************************
1973 *IR Temp allocation code
1974 * Propagating value life ranges by walking through the function backwards
1975 * until no more changes are made.
1976 * In theory this should happen once more than once for every nested loop
1978 * Though this implementation might run an additional time for if nests.
1981 /* Enumerate instructions used by value's life-ranges
1983 static void ir_block_enumerate(ir_block *self, size_t *_eid)
1987 for (i = 0; i < vec_size(self->instr); ++i)
1989 self->instr[i]->eid = eid++;
1994 /* Enumerate blocks and instructions.
1995 * The block-enumeration is unordered!
1996 * We do not really use the block enumreation, however
1997 * the instruction enumeration is important for life-ranges.
1999 void ir_function_enumerate(ir_function *self)
2002 size_t instruction_id = 0;
2003 for (i = 0; i < vec_size(self->blocks); ++i)
2005 /* each block now gets an additional "entry" instruction id
2006 * we can use to avoid point-life issues
2008 self->blocks[i]->entry_id = instruction_id;
2011 self->blocks[i]->eid = i;
2012 ir_block_enumerate(self->blocks[i], &instruction_id);
2016 /* Local-value allocator
2017 * After finishing creating the liferange of all values used in a function
2018 * we can allocate their global-positions.
2019 * This is the counterpart to register-allocation in register machines.
2026 } function_allocator;
2028 static bool function_allocator_alloc(function_allocator *alloc, ir_value *var)
2031 size_t vsize = ir_value_sizeof(var);
2033 var->code.local = vec_size(alloc->locals);
2035 slot = ir_value_var("reg", store_global, var->vtype);
2039 if (!ir_value_life_merge_into(slot, var))
2042 vec_push(alloc->locals, slot);
2043 vec_push(alloc->sizes, vsize);
2044 vec_push(alloc->unique, var->unique_life);
2049 ir_value_delete(slot);
2053 static bool ir_function_allocator_assign(ir_function *self, function_allocator *alloc, ir_value *v)
2059 return function_allocator_alloc(alloc, v);
2061 for (a = 0; a < vec_size(alloc->locals); ++a)
2063 /* if it's reserved for a unique liferange: skip */
2064 if (alloc->unique[a])
2067 slot = alloc->locals[a];
2069 /* never resize parameters
2070 * will be required later when overlapping temps + locals
2072 if (a < vec_size(self->params) &&
2073 alloc->sizes[a] < ir_value_sizeof(v))
2078 if (ir_values_overlap(v, slot))
2081 if (!ir_value_life_merge_into(slot, v))
2084 /* adjust size for this slot */
2085 if (alloc->sizes[a] < ir_value_sizeof(v))
2086 alloc->sizes[a] = ir_value_sizeof(v);
2091 if (a >= vec_size(alloc->locals)) {
2092 if (!function_allocator_alloc(alloc, v))
2098 bool ir_function_allocate_locals(ir_function *self)
2103 bool opt_gt = OPTS_OPTIMIZATION(OPTIM_GLOBAL_TEMPS);
2107 function_allocator lockalloc, globalloc;
2109 if (!vec_size(self->locals) && !vec_size(self->values))
2112 globalloc.locals = NULL;
2113 globalloc.sizes = NULL;
2114 globalloc.positions = NULL;
2115 globalloc.unique = NULL;
2116 lockalloc.locals = NULL;
2117 lockalloc.sizes = NULL;
2118 lockalloc.positions = NULL;
2119 lockalloc.unique = NULL;
2121 for (i = 0; i < vec_size(self->locals); ++i)
2123 v = self->locals[i];
2124 if ((self->flags & IR_FLAG_MASK_NO_LOCAL_TEMPS) || !OPTS_OPTIMIZATION(OPTIM_LOCAL_TEMPS)) {
2126 v->unique_life = true;
2128 else if (i >= vec_size(self->params))
2131 v->locked = true; /* lock parameters locals */
2132 if (!function_allocator_alloc((v->locked || !opt_gt ? &lockalloc : &globalloc), v))
2135 for (; i < vec_size(self->locals); ++i)
2137 v = self->locals[i];
2138 if (!vec_size(v->life))
2140 if (!ir_function_allocator_assign(self, (v->locked || !opt_gt ? &lockalloc : &globalloc), v))
2144 /* Allocate a slot for any value that still exists */
2145 for (i = 0; i < vec_size(self->values); ++i)
2147 v = self->values[i];
2149 if (!vec_size(v->life))
2152 /* CALL optimization:
2153 * If the value is a parameter-temp: 1 write, 1 read from a CALL
2154 * and it's not "locked", write it to the OFS_PARM directly.
2156 if (OPTS_OPTIMIZATION(OPTIM_CALL_STORES) && !v->locked && !v->unique_life) {
2157 if (vec_size(v->reads) == 1 && vec_size(v->writes) == 1 &&
2158 (v->reads[0]->opcode == VINSTR_NRCALL ||
2159 (v->reads[0]->opcode >= INSTR_CALL0 && v->reads[0]->opcode <= INSTR_CALL8)
2164 ir_instr *call = v->reads[0];
2165 if (!vec_ir_value_find(call->params, v, ¶m)) {
2166 irerror(call->context, "internal error: unlocked parameter %s not found", v->name);
2169 ++opts_optimizationcount[OPTIM_CALL_STORES];
2170 v->callparam = true;
2172 ir_value_code_setaddr(v, OFS_PARM0 + 3*param);
2174 size_t nprotos = vec_size(self->owner->extparam_protos);
2177 if (nprotos > param)
2178 ep = self->owner->extparam_protos[param];
2181 ep = ir_gen_extparam_proto(self->owner);
2182 while (++nprotos <= param)
2183 ep = ir_gen_extparam_proto(self->owner);
2185 ir_instr_op(v->writes[0], 0, ep, true);
2186 call->params[param+8] = ep;
2190 if (vec_size(v->writes) == 1 && v->writes[0]->opcode == INSTR_CALL0)
2192 v->store = store_return;
2193 if (v->members[0]) v->members[0]->store = store_return;
2194 if (v->members[1]) v->members[1]->store = store_return;
2195 if (v->members[2]) v->members[2]->store = store_return;
2196 ++opts_optimizationcount[OPTIM_CALL_STORES];
2201 if (!ir_function_allocator_assign(self, (v->locked || !opt_gt ? &lockalloc : &globalloc), v))
2205 if (!lockalloc.sizes && !globalloc.sizes) {
2208 vec_push(lockalloc.positions, 0);
2209 vec_push(globalloc.positions, 0);
2211 /* Adjust slot positions based on sizes */
2212 if (lockalloc.sizes) {
2213 pos = (vec_size(lockalloc.sizes) ? lockalloc.positions[0] : 0);
2214 for (i = 1; i < vec_size(lockalloc.sizes); ++i)
2216 pos = lockalloc.positions[i-1] + lockalloc.sizes[i-1];
2217 vec_push(lockalloc.positions, pos);
2219 self->allocated_locals = pos + vec_last(lockalloc.sizes);
2221 if (globalloc.sizes) {
2222 pos = (vec_size(globalloc.sizes) ? globalloc.positions[0] : 0);
2223 for (i = 1; i < vec_size(globalloc.sizes); ++i)
2225 pos = globalloc.positions[i-1] + globalloc.sizes[i-1];
2226 vec_push(globalloc.positions, pos);
2228 self->globaltemps = pos + vec_last(globalloc.sizes);
2231 /* Locals need to know their new position */
2232 for (i = 0; i < vec_size(self->locals); ++i) {
2233 v = self->locals[i];
2234 if (v->locked || !opt_gt)
2235 v->code.local = lockalloc.positions[v->code.local];
2237 v->code.local = globalloc.positions[v->code.local];
2239 /* Take over the actual slot positions on values */
2240 for (i = 0; i < vec_size(self->values); ++i) {
2241 v = self->values[i];
2242 if (v->locked || !opt_gt)
2243 v->code.local = lockalloc.positions[v->code.local];
2245 v->code.local = globalloc.positions[v->code.local];
2253 for (i = 0; i < vec_size(lockalloc.locals); ++i)
2254 ir_value_delete(lockalloc.locals[i]);
2255 for (i = 0; i < vec_size(globalloc.locals); ++i)
2256 ir_value_delete(globalloc.locals[i]);
2257 vec_free(globalloc.unique);
2258 vec_free(globalloc.locals);
2259 vec_free(globalloc.sizes);
2260 vec_free(globalloc.positions);
2261 vec_free(lockalloc.unique);
2262 vec_free(lockalloc.locals);
2263 vec_free(lockalloc.sizes);
2264 vec_free(lockalloc.positions);
2268 /* Get information about which operand
2269 * is read from, or written to.
2271 static void ir_op_read_write(int op, size_t *read, size_t *write)
2291 case INSTR_STOREP_F:
2292 case INSTR_STOREP_V:
2293 case INSTR_STOREP_S:
2294 case INSTR_STOREP_ENT:
2295 case INSTR_STOREP_FLD:
2296 case INSTR_STOREP_FNC:
2307 static bool ir_block_living_add_instr(ir_block *self, size_t eid)
2310 const size_t vs = vec_size(self->living);
2311 bool changed = false;
2312 for (i = 0; i != vs; ++i)
2314 if (ir_value_life_merge(self->living[i], eid))
2320 static bool ir_block_living_lock(ir_block *self)
2323 bool changed = false;
2324 for (i = 0; i != vec_size(self->living); ++i)
2326 if (!self->living[i]->locked) {
2327 self->living[i]->locked = true;
2334 static bool ir_block_life_propagate(ir_block *self, bool *changed)
2338 size_t i, o, p, mem, cnt;
2339 /* bitmasks which operands are read from or written to */
2346 vec_free(self->living);
2348 p = vec_size(self->exits);
2349 for (i = 0; i < p; ++i) {
2350 ir_block *prev = self->exits[i];
2351 cnt = vec_size(prev->living);
2352 for (o = 0; o < cnt; ++o) {
2353 if (!vec_ir_value_find(self->living, prev->living[o], NULL))
2354 vec_push(self->living, prev->living[o]);
2358 i = vec_size(self->instr);
2361 instr = self->instr[i];
2363 /* See which operands are read and write operands */
2364 ir_op_read_write(instr->opcode, &read, &write);
2366 /* Go through the 3 main operands
2367 * writes first, then reads
2369 for (o = 0; o < 3; ++o)
2371 if (!instr->_ops[o]) /* no such operand */
2374 value = instr->_ops[o];
2376 /* We only care about locals */
2377 /* we also calculate parameter liferanges so that locals
2378 * can take up parameter slots */
2379 if (value->store != store_value &&
2380 value->store != store_local &&
2381 value->store != store_param)
2384 /* write operands */
2385 /* When we write to a local, we consider it "dead" for the
2386 * remaining upper part of the function, since in SSA a value
2387 * can only be written once (== created)
2392 bool in_living = vec_ir_value_find(self->living, value, &idx);
2395 /* If the value isn't alive it hasn't been read before... */
2396 /* TODO: See if the warning can be emitted during parsing or AST processing
2397 * otherwise have warning printed here.
2398 * IF printing a warning here: include filecontext_t,
2399 * and make sure it's only printed once
2400 * since this function is run multiple times.
2402 /* con_err( "Value only written %s\n", value->name); */
2403 if (ir_value_life_merge(value, instr->eid))
2406 /* since 'living' won't contain it
2407 * anymore, merge the value, since
2410 if (ir_value_life_merge(value, instr->eid))
2413 vec_remove(self->living, idx, 1);
2415 /* Removing a vector removes all members */
2416 for (mem = 0; mem < 3; ++mem) {
2417 if (value->members[mem] && vec_ir_value_find(self->living, value->members[mem], &idx)) {
2418 if (ir_value_life_merge(value->members[mem], instr->eid))
2420 vec_remove(self->living, idx, 1);
2423 /* Removing the last member removes the vector */
2424 if (value->memberof) {
2425 value = value->memberof;
2426 for (mem = 0; mem < 3; ++mem) {
2427 if (value->members[mem] && vec_ir_value_find(self->living, value->members[mem], NULL))
2430 if (mem == 3 && vec_ir_value_find(self->living, value, &idx)) {
2431 if (ir_value_life_merge(value, instr->eid))
2433 vec_remove(self->living, idx, 1);
2439 if (instr->opcode == INSTR_MUL_VF)
2441 value = instr->_ops[2];
2442 /* the float source will get an additional lifetime */
2443 if (ir_value_life_merge(value, instr->eid+1))
2445 if (value->memberof && ir_value_life_merge(value->memberof, instr->eid+1))
2448 else if (instr->opcode == INSTR_MUL_FV || instr->opcode == INSTR_LOAD_V)
2450 value = instr->_ops[1];
2451 /* the float source will get an additional lifetime */
2452 if (ir_value_life_merge(value, instr->eid+1))
2454 if (value->memberof && ir_value_life_merge(value->memberof, instr->eid+1))
2458 for (o = 0; o < 3; ++o)
2460 if (!instr->_ops[o]) /* no such operand */
2463 value = instr->_ops[o];
2465 /* We only care about locals */
2466 /* we also calculate parameter liferanges so that locals
2467 * can take up parameter slots */
2468 if (value->store != store_value &&
2469 value->store != store_local &&
2470 value->store != store_param)
2476 if (!vec_ir_value_find(self->living, value, NULL))
2477 vec_push(self->living, value);
2478 /* reading adds the full vector */
2479 if (value->memberof && !vec_ir_value_find(self->living, value->memberof, NULL))
2480 vec_push(self->living, value->memberof);
2481 for (mem = 0; mem < 3; ++mem) {
2482 if (value->members[mem] && !vec_ir_value_find(self->living, value->members[mem], NULL))
2483 vec_push(self->living, value->members[mem]);
2487 /* PHI operands are always read operands */
2488 for (p = 0; p < vec_size(instr->phi); ++p)
2490 value = instr->phi[p].value;
2491 if (!vec_ir_value_find(self->living, value, NULL))
2492 vec_push(self->living, value);
2493 /* reading adds the full vector */
2494 if (value->memberof && !vec_ir_value_find(self->living, value->memberof, NULL))
2495 vec_push(self->living, value->memberof);
2496 for (mem = 0; mem < 3; ++mem) {
2497 if (value->members[mem] && !vec_ir_value_find(self->living, value->members[mem], NULL))
2498 vec_push(self->living, value->members[mem]);
2502 /* on a call, all these values must be "locked" */
2503 if (instr->opcode >= INSTR_CALL0 && instr->opcode <= INSTR_CALL8) {
2504 if (ir_block_living_lock(self))
2507 /* call params are read operands too */
2508 for (p = 0; p < vec_size(instr->params); ++p)
2510 value = instr->params[p];
2511 if (!vec_ir_value_find(self->living, value, NULL))
2512 vec_push(self->living, value);
2513 /* reading adds the full vector */
2514 if (value->memberof && !vec_ir_value_find(self->living, value->memberof, NULL))
2515 vec_push(self->living, value->memberof);
2516 for (mem = 0; mem < 3; ++mem) {
2517 if (value->members[mem] && !vec_ir_value_find(self->living, value->members[mem], NULL))
2518 vec_push(self->living, value->members[mem]);
2523 if (ir_block_living_add_instr(self, instr->eid))
2526 /* the "entry" instruction ID */
2527 if (ir_block_living_add_instr(self, self->entry_id))
2533 bool ir_function_calculate_liferanges(ir_function *self)
2538 /* parameters live at 0 */
2539 for (i = 0; i < vec_size(self->params); ++i)
2540 ir_value_life_merge(self->locals[i], 0);
2545 i = vec_size(self->blocks);
2547 ir_block_life_propagate(self->blocks[i], &changed);
2551 if (vec_size(self->blocks)) {
2552 ir_block *block = self->blocks[0];
2553 for (i = 0; i < vec_size(block->living); ++i) {
2554 ir_value *v = block->living[i];
2555 if (v->store != store_local)
2557 if (v->vtype == TYPE_VECTOR)
2559 self->flags |= IR_FLAG_HAS_UNINITIALIZED;
2560 /* find the instruction reading from it */
2561 for (s = 0; s < vec_size(v->reads); ++s) {
2562 if (v->reads[s]->eid == v->life[0].end)
2565 if (s < vec_size(v->reads)) {
2566 if (irwarning(v->context, WARN_USED_UNINITIALIZED,
2567 "variable `%s` may be used uninitialized in this function\n"
2570 v->reads[s]->context.file, v->reads[s]->context.line)
2578 ir_value *vec = v->memberof;
2579 for (s = 0; s < vec_size(vec->reads); ++s) {
2580 if (vec->reads[s]->eid == v->life[0].end)
2583 if (s < vec_size(vec->reads)) {
2584 if (irwarning(v->context, WARN_USED_UNINITIALIZED,
2585 "variable `%s` may be used uninitialized in this function\n"
2588 vec->reads[s]->context.file, vec->reads[s]->context.line)
2596 if (irwarning(v->context, WARN_USED_UNINITIALIZED,
2597 "variable `%s` may be used uninitialized in this function", v->name))
2606 /***********************************************************************
2609 * Since the IR has the convention of putting 'write' operands
2610 * at the beginning, we have to rotate the operands of instructions
2611 * properly in order to generate valid QCVM code.
2613 * Having destinations at a fixed position is more convenient. In QC
2614 * this is *mostly* OPC, but FTE adds at least 2 instructions which
2615 * read from from OPA, and store to OPB rather than OPC. Which is
2616 * partially the reason why the implementation of these instructions
2617 * in darkplaces has been delayed for so long.
2619 * Breaking conventions is annoying...
2621 static bool ir_builder_gen_global(ir_builder *self, ir_value *global, bool islocal);
2623 static bool gen_global_field(ir_value *global)
2625 if (global->hasvalue)
2627 ir_value *fld = global->constval.vpointer;
2629 irerror(global->context, "Invalid field constant with no field: %s", global->name);
2633 /* copy the field's value */
2634 ir_value_code_setaddr(global, vec_size(code_globals));
2635 vec_push(code_globals, fld->code.fieldaddr);
2636 if (global->fieldtype == TYPE_VECTOR) {
2637 vec_push(code_globals, fld->code.fieldaddr+1);
2638 vec_push(code_globals, fld->code.fieldaddr+2);
2643 ir_value_code_setaddr(global, vec_size(code_globals));
2644 vec_push(code_globals, 0);
2645 if (global->fieldtype == TYPE_VECTOR) {
2646 vec_push(code_globals, 0);
2647 vec_push(code_globals, 0);
2650 if (global->code.globaladdr < 0)
2655 static bool gen_global_pointer(ir_value *global)
2657 if (global->hasvalue)
2659 ir_value *target = global->constval.vpointer;
2661 irerror(global->context, "Invalid pointer constant: %s", global->name);
2662 /* NULL pointers are pointing to the NULL constant, which also
2663 * sits at address 0, but still has an ir_value for itself.
2668 /* Here, relocations ARE possible - in fteqcc-enhanced-qc:
2669 * void() foo; <- proto
2670 * void() *fooptr = &foo;
2671 * void() foo = { code }
2673 if (!target->code.globaladdr) {
2674 /* FIXME: Check for the constant nullptr ir_value!
2675 * because then code.globaladdr being 0 is valid.
2677 irerror(global->context, "FIXME: Relocation support");
2681 ir_value_code_setaddr(global, vec_size(code_globals));
2682 vec_push(code_globals, target->code.globaladdr);
2686 ir_value_code_setaddr(global, vec_size(code_globals));
2687 vec_push(code_globals, 0);
2689 if (global->code.globaladdr < 0)
2694 static bool gen_blocks_recursive(ir_function *func, ir_block *block)
2696 prog_section_statement stmt;
2704 block->generated = true;
2705 block->code_start = vec_size(code_statements);
2706 for (i = 0; i < vec_size(block->instr); ++i)
2708 instr = block->instr[i];
2710 if (instr->opcode == VINSTR_PHI) {
2711 irerror(block->context, "cannot generate virtual instruction (phi)");
2715 if (instr->opcode == VINSTR_JUMP) {
2716 target = instr->bops[0];
2717 /* for uncoditional jumps, if the target hasn't been generated
2718 * yet, we generate them right here.
2720 if (!target->generated)
2721 return gen_blocks_recursive(func, target);
2723 /* otherwise we generate a jump instruction */
2724 stmt.opcode = INSTR_GOTO;
2725 stmt.o1.s1 = (target->code_start) - vec_size(code_statements);
2728 if (stmt.o1.s1 != 1)
2729 code_push_statement(&stmt, instr->context.line);
2731 /* no further instructions can be in this block */
2735 if (instr->opcode == VINSTR_COND) {
2736 ontrue = instr->bops[0];
2737 onfalse = instr->bops[1];
2738 /* TODO: have the AST signal which block should
2739 * come first: eg. optimize IFs without ELSE...
2742 stmt.o1.u1 = ir_value_code_addr(instr->_ops[0]);
2746 if (ontrue->generated) {
2747 stmt.opcode = INSTR_IF;
2748 stmt.o2.s1 = (ontrue->code_start) - vec_size(code_statements);
2749 if (stmt.o2.s1 != 1)
2750 code_push_statement(&stmt, instr->context.line);
2752 if (onfalse->generated) {
2753 stmt.opcode = INSTR_IFNOT;
2754 stmt.o2.s1 = (onfalse->code_start) - vec_size(code_statements);
2755 if (stmt.o2.s1 != 1)
2756 code_push_statement(&stmt, instr->context.line);
2758 if (!ontrue->generated) {
2759 if (onfalse->generated)
2760 return gen_blocks_recursive(func, ontrue);
2762 if (!onfalse->generated) {
2763 if (ontrue->generated)
2764 return gen_blocks_recursive(func, onfalse);
2766 /* neither ontrue nor onfalse exist */
2767 stmt.opcode = INSTR_IFNOT;
2768 if (!instr->likely) {
2769 /* Honor the likelyhood hint */
2770 ir_block *tmp = onfalse;
2771 stmt.opcode = INSTR_IF;
2775 stidx = vec_size(code_statements);
2776 code_push_statement(&stmt, instr->context.line);
2777 /* on false we jump, so add ontrue-path */
2778 if (!gen_blocks_recursive(func, ontrue))
2780 /* fixup the jump address */
2781 code_statements[stidx].o2.s1 = vec_size(code_statements) - stidx;
2782 /* generate onfalse path */
2783 if (onfalse->generated) {
2784 /* fixup the jump address */
2785 code_statements[stidx].o2.s1 = (onfalse->code_start) - (stidx);
2786 if (stidx+2 == vec_size(code_statements) && code_statements[stidx].o2.s1 == 1) {
2787 code_statements[stidx] = code_statements[stidx+1];
2788 if (code_statements[stidx].o1.s1 < 0)
2789 code_statements[stidx].o1.s1++;
2790 code_pop_statement();
2792 stmt.opcode = vec_last(code_statements).opcode;
2793 if (stmt.opcode == INSTR_GOTO ||
2794 stmt.opcode == INSTR_IF ||
2795 stmt.opcode == INSTR_IFNOT ||
2796 stmt.opcode == INSTR_RETURN ||
2797 stmt.opcode == INSTR_DONE)
2799 /* no use jumping from here */
2802 /* may have been generated in the previous recursive call */
2803 stmt.opcode = INSTR_GOTO;
2804 stmt.o1.s1 = (onfalse->code_start) - vec_size(code_statements);
2807 if (stmt.o1.s1 != 1)
2808 code_push_statement(&stmt, instr->context.line);
2811 else if (stidx+2 == vec_size(code_statements) && code_statements[stidx].o2.s1 == 1) {
2812 code_statements[stidx] = code_statements[stidx+1];
2813 if (code_statements[stidx].o1.s1 < 0)
2814 code_statements[stidx].o1.s1++;
2815 code_pop_statement();
2817 /* if not, generate now */
2818 return gen_blocks_recursive(func, onfalse);
2821 if ( (instr->opcode >= INSTR_CALL0 && instr->opcode <= INSTR_CALL8)
2822 || instr->opcode == VINSTR_NRCALL)
2827 first = vec_size(instr->params);
2830 for (p = 0; p < first; ++p)
2832 ir_value *param = instr->params[p];
2833 if (param->callparam)
2836 stmt.opcode = INSTR_STORE_F;
2839 if (param->vtype == TYPE_FIELD)
2840 stmt.opcode = field_store_instr[param->fieldtype];
2841 else if (param->vtype == TYPE_NIL)
2842 stmt.opcode = INSTR_STORE_V;
2844 stmt.opcode = type_store_instr[param->vtype];
2845 stmt.o1.u1 = ir_value_code_addr(param);
2846 stmt.o2.u1 = OFS_PARM0 + 3 * p;
2847 code_push_statement(&stmt, instr->context.line);
2849 /* Now handle extparams */
2850 first = vec_size(instr->params);
2851 for (; p < first; ++p)
2853 ir_builder *ir = func->owner;
2854 ir_value *param = instr->params[p];
2855 ir_value *targetparam;
2857 if (param->callparam)
2860 if (p-8 >= vec_size(ir->extparams))
2861 ir_gen_extparam(ir);
2863 targetparam = ir->extparams[p-8];
2865 stmt.opcode = INSTR_STORE_F;
2868 if (param->vtype == TYPE_FIELD)
2869 stmt.opcode = field_store_instr[param->fieldtype];
2870 else if (param->vtype == TYPE_NIL)
2871 stmt.opcode = INSTR_STORE_V;
2873 stmt.opcode = type_store_instr[param->vtype];
2874 stmt.o1.u1 = ir_value_code_addr(param);
2875 stmt.o2.u1 = ir_value_code_addr(targetparam);
2876 code_push_statement(&stmt, instr->context.line);
2879 stmt.opcode = INSTR_CALL0 + vec_size(instr->params);
2880 if (stmt.opcode > INSTR_CALL8)
2881 stmt.opcode = INSTR_CALL8;
2882 stmt.o1.u1 = ir_value_code_addr(instr->_ops[1]);
2885 code_push_statement(&stmt, instr->context.line);
2887 retvalue = instr->_ops[0];
2888 if (retvalue && retvalue->store != store_return &&
2889 (retvalue->store == store_global || vec_size(retvalue->life)))
2891 /* not to be kept in OFS_RETURN */
2892 if (retvalue->vtype == TYPE_FIELD && OPTS_FLAG(ADJUST_VECTOR_FIELDS))
2893 stmt.opcode = field_store_instr[retvalue->fieldtype];
2895 stmt.opcode = type_store_instr[retvalue->vtype];
2896 stmt.o1.u1 = OFS_RETURN;
2897 stmt.o2.u1 = ir_value_code_addr(retvalue);
2899 code_push_statement(&stmt, instr->context.line);
2904 if (instr->opcode == INSTR_STATE) {
2905 irerror(block->context, "TODO: state instruction");
2909 stmt.opcode = instr->opcode;
2914 /* This is the general order of operands */
2916 stmt.o3.u1 = ir_value_code_addr(instr->_ops[0]);
2919 stmt.o1.u1 = ir_value_code_addr(instr->_ops[1]);
2922 stmt.o2.u1 = ir_value_code_addr(instr->_ops[2]);
2924 if (stmt.opcode == INSTR_RETURN || stmt.opcode == INSTR_DONE)
2926 stmt.o1.u1 = stmt.o3.u1;
2929 else if ((stmt.opcode >= INSTR_STORE_F &&
2930 stmt.opcode <= INSTR_STORE_FNC) ||
2931 (stmt.opcode >= INSTR_STOREP_F &&
2932 stmt.opcode <= INSTR_STOREP_FNC))
2934 /* 2-operand instructions with A -> B */
2935 stmt.o2.u1 = stmt.o3.u1;
2938 /* tiny optimization, don't output
2941 if (stmt.o2.u1 == stmt.o1.u1 &&
2942 OPTS_OPTIMIZATION(OPTIM_PEEPHOLE))
2944 ++opts_optimizationcount[OPTIM_PEEPHOLE];
2949 code_push_statement(&stmt, instr->context.line);
2954 static bool gen_function_code(ir_function *self)
2957 prog_section_statement stmt, *retst;
2959 /* Starting from entry point, we generate blocks "as they come"
2960 * for now. Dead blocks will not be translated obviously.
2962 if (!vec_size(self->blocks)) {
2963 irerror(self->context, "Function '%s' declared without body.", self->name);
2967 block = self->blocks[0];
2968 if (block->generated)
2971 if (!gen_blocks_recursive(self, block)) {
2972 irerror(self->context, "failed to generate blocks for '%s'", self->name);
2976 /* code_write and qcvm -disasm need to know that the function ends here */
2977 retst = &vec_last(code_statements);
2978 if (OPTS_OPTIMIZATION(OPTIM_VOID_RETURN) &&
2979 self->outtype == TYPE_VOID &&
2980 retst->opcode == INSTR_RETURN &&
2981 !retst->o1.u1 && !retst->o2.u1 && !retst->o3.u1)
2983 retst->opcode = INSTR_DONE;
2984 ++opts_optimizationcount[OPTIM_VOID_RETURN];
2986 stmt.opcode = INSTR_DONE;
2990 code_push_statement(&stmt, vec_last(code_linenums));
2995 static qcint ir_builder_filestring(ir_builder *ir, const char *filename)
2997 /* NOTE: filename pointers are copied, we never strdup them,
2998 * thus we can use pointer-comparison to find the string.
3003 for (i = 0; i < vec_size(ir->filenames); ++i) {
3004 if (ir->filenames[i] == filename)
3005 return ir->filestrings[i];
3008 str = code_genstring(filename);
3009 vec_push(ir->filenames, filename);
3010 vec_push(ir->filestrings, str);
3014 static bool gen_global_function(ir_builder *ir, ir_value *global)
3016 prog_section_function fun;
3021 if (!global->hasvalue || (!global->constval.vfunc))
3023 irerror(global->context, "Invalid state of function-global: not constant: %s", global->name);
3027 irfun = global->constval.vfunc;
3029 fun.name = global->code.name;
3030 fun.file = ir_builder_filestring(ir, global->context.file);
3031 fun.profile = 0; /* always 0 */
3032 fun.nargs = vec_size(irfun->params);
3036 for (i = 0;i < 8; ++i) {
3037 if ((int32_t)i >= fun.nargs)
3040 fun.argsize[i] = type_sizeof_[irfun->params[i]];
3044 fun.locals = irfun->allocated_locals;
3047 fun.entry = irfun->builtin+1;
3049 irfun->code_function_def = vec_size(code_functions);
3050 fun.entry = vec_size(code_statements);
3053 vec_push(code_functions, fun);
3057 static ir_value* ir_gen_extparam_proto(ir_builder *ir)
3062 util_snprintf(name, sizeof(name), "EXTPARM#%i", (int)(vec_size(ir->extparam_protos)));
3063 global = ir_value_var(name, store_global, TYPE_VECTOR);
3065 vec_push(ir->extparam_protos, global);
3069 static void ir_gen_extparam(ir_builder *ir)
3071 prog_section_def def;
3074 if (vec_size(ir->extparam_protos) < vec_size(ir->extparams)+1)
3075 global = ir_gen_extparam_proto(ir);
3077 global = ir->extparam_protos[vec_size(ir->extparams)];
3079 def.name = code_genstring(global->name);
3080 def.type = TYPE_VECTOR;
3081 def.offset = vec_size(code_globals);
3083 vec_push(code_defs, def);
3084 ir_value_code_setaddr(global, def.offset);
3085 vec_push(code_globals, 0);
3086 vec_push(code_globals, 0);
3087 vec_push(code_globals, 0);
3089 vec_push(ir->extparams, global);
3092 static bool gen_function_extparam_copy(ir_function *self)
3094 size_t i, ext, numparams;
3096 ir_builder *ir = self->owner;
3098 prog_section_statement stmt;
3100 numparams = vec_size(self->params);
3104 stmt.opcode = INSTR_STORE_F;
3106 for (i = 8; i < numparams; ++i) {
3108 if (ext >= vec_size(ir->extparams))
3109 ir_gen_extparam(ir);
3111 ep = ir->extparams[ext];
3113 stmt.opcode = type_store_instr[self->locals[i]->vtype];
3114 if (self->locals[i]->vtype == TYPE_FIELD &&
3115 self->locals[i]->fieldtype == TYPE_VECTOR)
3117 stmt.opcode = INSTR_STORE_V;
3119 stmt.o1.u1 = ir_value_code_addr(ep);
3120 stmt.o2.u1 = ir_value_code_addr(self->locals[i]);
3121 code_push_statement(&stmt, self->context.line);
3127 static bool gen_function_varargs_copy(ir_function *self)
3129 size_t i, ext, numparams, maxparams;
3131 ir_builder *ir = self->owner;
3133 prog_section_statement stmt;
3135 numparams = vec_size(self->params);
3139 stmt.opcode = INSTR_STORE_V;
3141 maxparams = numparams + self->max_varargs;
3142 for (i = numparams; i < maxparams; ++i) {
3144 stmt.o1.u1 = OFS_PARM0 + 3*i;
3145 stmt.o2.u1 = ir_value_code_addr(self->locals[i]);
3146 code_push_statement(&stmt, self->context.line);
3150 while (ext >= vec_size(ir->extparams))
3151 ir_gen_extparam(ir);
3153 ep = ir->extparams[ext];
3155 stmt.o1.u1 = ir_value_code_addr(ep);
3156 stmt.o2.u1 = ir_value_code_addr(self->locals[i]);
3157 code_push_statement(&stmt, self->context.line);
3163 static bool gen_function_locals(ir_builder *ir, ir_value *global)
3165 prog_section_function *def;
3168 uint32_t firstlocal, firstglobal;
3170 irfun = global->constval.vfunc;
3171 def = code_functions + irfun->code_function_def;
3173 if (OPTS_OPTION_BOOL(OPTION_G) ||
3174 !OPTS_OPTIMIZATION(OPTIM_OVERLAP_LOCALS) ||
3175 (irfun->flags & IR_FLAG_MASK_NO_OVERLAP))
3177 firstlocal = def->firstlocal = vec_size(code_globals);
3179 firstlocal = def->firstlocal = ir->first_common_local;
3180 ++opts_optimizationcount[OPTIM_OVERLAP_LOCALS];
3183 firstglobal = (OPTS_OPTIMIZATION(OPTIM_GLOBAL_TEMPS) ? ir->first_common_globaltemp : firstlocal);
3185 for (i = vec_size(code_globals); i < firstlocal + irfun->allocated_locals; ++i)
3186 vec_push(code_globals, 0);
3187 for (i = 0; i < vec_size(irfun->locals); ++i) {
3188 ir_value *v = irfun->locals[i];
3189 if (v->locked || !OPTS_OPTIMIZATION(OPTIM_GLOBAL_TEMPS)) {
3190 ir_value_code_setaddr(v, firstlocal + v->code.local);
3191 if (!ir_builder_gen_global(ir, irfun->locals[i], true)) {
3192 irerror(irfun->locals[i]->context, "failed to generate local %s", irfun->locals[i]->name);
3197 ir_value_code_setaddr(v, firstglobal + v->code.local);
3199 for (i = 0; i < vec_size(irfun->values); ++i)
3201 ir_value *v = irfun->values[i];
3205 ir_value_code_setaddr(v, firstlocal + v->code.local);
3207 ir_value_code_setaddr(v, firstglobal + v->code.local);
3212 static bool gen_global_function_code(ir_builder *ir, ir_value *global)
3214 prog_section_function *fundef;
3219 irfun = global->constval.vfunc;
3221 if (global->cvq == CV_NONE) {
3222 irwarning(global->context, WARN_IMPLICIT_FUNCTION_POINTER,
3223 "function `%s` has no body and in QC implicitly becomes a function-pointer", global->name);
3225 /* this was a function pointer, don't generate code for those */
3232 if (irfun->code_function_def < 0) {
3233 irerror(irfun->context, "`%s`: IR global wasn't generated, failed to access function-def", irfun->name);
3236 fundef = &code_functions[irfun->code_function_def];
3238 fundef->entry = vec_size(code_statements);
3239 if (!gen_function_locals(ir, global)) {
3240 irerror(irfun->context, "Failed to generate locals for function %s", irfun->name);
3243 if (!gen_function_extparam_copy(irfun)) {
3244 irerror(irfun->context, "Failed to generate extparam-copy code for function %s", irfun->name);
3247 if (irfun->max_varargs && !gen_function_varargs_copy(irfun)) {
3248 irerror(irfun->context, "Failed to generate vararg-copy code for function %s", irfun->name);
3251 if (!gen_function_code(irfun)) {
3252 irerror(irfun->context, "Failed to generate code for function %s", irfun->name);
3258 static void gen_vector_defs(prog_section_def def, const char *name)
3263 if (!name || name[0] == '#' || OPTS_FLAG(SINGLE_VECTOR_DEFS))
3266 def.type = TYPE_FLOAT;
3270 component = (char*)mem_a(len+3);
3271 memcpy(component, name, len);
3273 component[len-0] = 0;
3274 component[len-2] = '_';
3276 component[len-1] = 'x';
3278 for (i = 0; i < 3; ++i) {
3279 def.name = code_genstring(component);
3280 vec_push(code_defs, def);
3288 static void gen_vector_fields(prog_section_field fld, const char *name)
3293 if (!name || OPTS_FLAG(SINGLE_VECTOR_DEFS))
3296 fld.type = TYPE_FLOAT;
3300 component = (char*)mem_a(len+3);
3301 memcpy(component, name, len);
3303 component[len-0] = 0;
3304 component[len-2] = '_';
3306 component[len-1] = 'x';
3308 for (i = 0; i < 3; ++i) {
3309 fld.name = code_genstring(component);
3310 vec_push(code_fields, fld);
3318 static bool ir_builder_gen_global(ir_builder *self, ir_value *global, bool islocal)
3322 prog_section_def def;
3323 bool pushdef = opts.optimizeoff;
3325 def.type = global->vtype;
3326 def.offset = vec_size(code_globals);
3328 if (OPTS_OPTION_BOOL(OPTION_G) || !islocal)
3332 if (OPTS_OPTIMIZATION(OPTIM_STRIP_CONSTANT_NAMES) &&
3333 !(global->flags & IR_FLAG_INCLUDE_DEF) &&
3334 (global->name[0] == '#' || global->cvq == CV_CONST))
3339 if (pushdef && global->name) {
3340 if (global->name[0] == '#') {
3341 if (!self->str_immediate)
3342 self->str_immediate = code_genstring("IMMEDIATE");
3343 def.name = global->code.name = self->str_immediate;
3346 def.name = global->code.name = code_genstring(global->name);
3351 def.offset = ir_value_code_addr(global);
3352 vec_push(code_defs, def);
3353 if (global->vtype == TYPE_VECTOR)
3354 gen_vector_defs(def, global->name);
3355 else if (global->vtype == TYPE_FIELD && global->fieldtype == TYPE_VECTOR)
3356 gen_vector_defs(def, global->name);
3363 switch (global->vtype)
3366 if (!strcmp(global->name, "end_sys_globals")) {
3367 /* TODO: remember this point... all the defs before this one
3368 * should be checksummed and added to progdefs.h when we generate it.
3371 else if (!strcmp(global->name, "end_sys_fields")) {
3372 /* TODO: same as above but for entity-fields rather than globsl
3376 irwarning(global->context, WARN_VOID_VARIABLES, "unrecognized variable of type void `%s`",
3378 /* I'd argue setting it to 0 is sufficient, but maybe some depend on knowing how far
3379 * the system fields actually go? Though the engine knows this anyway...
3380 * Maybe this could be an -foption
3381 * fteqcc creates data for end_sys_* - of size 1, so let's do the same
3383 ir_value_code_setaddr(global, vec_size(code_globals));
3384 vec_push(code_globals, 0);
3386 if (pushdef) vec_push(code_defs, def);
3389 if (pushdef) vec_push(code_defs, def);
3390 return gen_global_pointer(global);
3393 vec_push(code_defs, def);
3394 if (global->fieldtype == TYPE_VECTOR)
3395 gen_vector_defs(def, global->name);
3397 return gen_global_field(global);
3402 ir_value_code_setaddr(global, vec_size(code_globals));
3403 if (global->hasvalue) {
3404 iptr = (int32_t*)&global->constval.ivec[0];
3405 vec_push(code_globals, *iptr);
3407 vec_push(code_globals, 0);
3409 if (!islocal && global->cvq != CV_CONST)
3410 def.type |= DEF_SAVEGLOBAL;
3411 if (pushdef) vec_push(code_defs, def);
3413 return global->code.globaladdr >= 0;
3417 ir_value_code_setaddr(global, vec_size(code_globals));
3418 if (global->hasvalue) {
3419 vec_push(code_globals, code_genstring(global->constval.vstring));
3421 vec_push(code_globals, 0);
3423 if (!islocal && global->cvq != CV_CONST)
3424 def.type |= DEF_SAVEGLOBAL;
3425 if (pushdef) vec_push(code_defs, def);
3426 return global->code.globaladdr >= 0;
3431 ir_value_code_setaddr(global, vec_size(code_globals));
3432 if (global->hasvalue) {
3433 iptr = (int32_t*)&global->constval.ivec[0];
3434 vec_push(code_globals, iptr[0]);
3435 if (global->code.globaladdr < 0)
3437 for (d = 1; d < type_sizeof_[global->vtype]; ++d) {
3438 vec_push(code_globals, iptr[d]);
3441 vec_push(code_globals, 0);
3442 if (global->code.globaladdr < 0)
3444 for (d = 1; d < type_sizeof_[global->vtype]; ++d) {
3445 vec_push(code_globals, 0);
3448 if (!islocal && global->cvq != CV_CONST)
3449 def.type |= DEF_SAVEGLOBAL;
3452 vec_push(code_defs, def);
3453 def.type &= ~DEF_SAVEGLOBAL;
3454 gen_vector_defs(def, global->name);
3456 return global->code.globaladdr >= 0;
3459 ir_value_code_setaddr(global, vec_size(code_globals));
3460 if (!global->hasvalue) {
3461 vec_push(code_globals, 0);
3462 if (global->code.globaladdr < 0)
3465 vec_push(code_globals, vec_size(code_functions));
3466 if (!gen_global_function(self, global))
3469 if (!islocal && global->cvq != CV_CONST)
3470 def.type |= DEF_SAVEGLOBAL;
3471 if (pushdef) vec_push(code_defs, def);
3474 /* assume biggest type */
3475 ir_value_code_setaddr(global, vec_size(code_globals));
3476 vec_push(code_globals, 0);
3477 for (i = 1; i < type_sizeof_[TYPE_VARIANT]; ++i)
3478 vec_push(code_globals, 0);
3481 /* refuse to create 'void' type or any other fancy business. */
3482 irerror(global->context, "Invalid type for global variable `%s`: %s",
3483 global->name, type_name[global->vtype]);
3488 static void ir_builder_prepare_field(ir_value *field)
3490 field->code.fieldaddr = code_alloc_field(type_sizeof_[field->fieldtype]);
3493 static bool ir_builder_gen_field(ir_builder *self, ir_value *field)
3495 prog_section_def def;
3496 prog_section_field fld;
3500 def.type = (uint16_t)field->vtype;
3501 def.offset = (uint16_t)vec_size(code_globals);
3503 /* create a global named the same as the field */
3504 if (OPTS_OPTION_U32(OPTION_STANDARD) == COMPILER_GMQCC) {
3505 /* in our standard, the global gets a dot prefix */
3506 size_t len = strlen(field->name);
3509 /* we really don't want to have to allocate this, and 1024
3510 * bytes is more than enough for a variable/field name
3512 if (len+2 >= sizeof(name)) {
3513 irerror(field->context, "invalid field name size: %u", (unsigned int)len);
3518 memcpy(name+1, field->name, len); /* no strncpy - we used strlen above */
3521 def.name = code_genstring(name);
3522 fld.name = def.name + 1; /* we reuse that string table entry */
3524 /* in plain QC, there cannot be a global with the same name,
3525 * and so we also name the global the same.
3526 * FIXME: fteqcc should create a global as well
3527 * check if it actually uses the same name. Probably does
3529 def.name = code_genstring(field->name);
3530 fld.name = def.name;
3533 field->code.name = def.name;
3535 vec_push(code_defs, def);
3537 fld.type = field->fieldtype;
3539 if (fld.type == TYPE_VOID) {
3540 irerror(field->context, "field is missing a type: %s - don't know its size", field->name);
3544 fld.offset = field->code.fieldaddr;
3546 vec_push(code_fields, fld);
3548 ir_value_code_setaddr(field, vec_size(code_globals));
3549 vec_push(code_globals, fld.offset);
3550 if (fld.type == TYPE_VECTOR) {
3551 vec_push(code_globals, fld.offset+1);
3552 vec_push(code_globals, fld.offset+2);
3555 if (field->fieldtype == TYPE_VECTOR) {
3556 gen_vector_defs(def, field->name);
3557 gen_vector_fields(fld, field->name);
3560 return field->code.globaladdr >= 0;
3563 bool ir_builder_generate(ir_builder *self, const char *filename)
3565 prog_section_statement stmt;
3567 char *lnofile = NULL;
3571 for (i = 0; i < vec_size(self->fields); ++i)
3573 ir_builder_prepare_field(self->fields[i]);
3576 for (i = 0; i < vec_size(self->globals); ++i)
3578 if (!ir_builder_gen_global(self, self->globals[i], false)) {
3581 if (self->globals[i]->vtype == TYPE_FUNCTION) {
3582 ir_function *func = self->globals[i]->constval.vfunc;
3583 if (func && self->max_locals < func->allocated_locals &&
3584 !(func->flags & IR_FLAG_MASK_NO_OVERLAP))
3586 self->max_locals = func->allocated_locals;
3588 if (func && self->max_globaltemps < func->globaltemps)
3589 self->max_globaltemps = func->globaltemps;
3593 for (i = 0; i < vec_size(self->fields); ++i)
3595 if (!ir_builder_gen_field(self, self->fields[i])) {
3601 ir_value_code_setaddr(self->nil, vec_size(code_globals));
3602 vec_push(code_globals, 0);
3603 vec_push(code_globals, 0);
3604 vec_push(code_globals, 0);
3606 /* generate global temps */
3607 self->first_common_globaltemp = vec_size(code_globals);
3608 for (i = 0; i < self->max_globaltemps; ++i) {
3609 vec_push(code_globals, 0);
3611 /* generate common locals */
3612 self->first_common_local = vec_size(code_globals);
3613 for (i = 0; i < self->max_locals; ++i) {
3614 vec_push(code_globals, 0);
3617 /* generate function code */
3618 for (i = 0; i < vec_size(self->globals); ++i)
3620 if (self->globals[i]->vtype == TYPE_FUNCTION) {
3621 if (!gen_global_function_code(self, self->globals[i])) {
3627 if (vec_size(code_globals) >= 65536) {
3628 irerror(vec_last(self->globals)->context, "This progs file would require more globals than the metadata can handle. Bailing out.");
3632 /* DP errors if the last instruction is not an INSTR_DONE. */
3633 if (vec_last(code_statements).opcode != INSTR_DONE)
3635 stmt.opcode = INSTR_DONE;
3639 code_push_statement(&stmt, vec_last(code_linenums));
3642 if (OPTS_OPTION_BOOL(OPTION_PP_ONLY))
3645 if (vec_size(code_statements) != vec_size(code_linenums)) {
3646 con_err("Linecounter wrong: %lu != %lu\n",
3647 (unsigned long)vec_size(code_statements),
3648 (unsigned long)vec_size(code_linenums));
3649 } else if (OPTS_FLAG(LNO)) {
3651 size_t filelen = strlen(filename);
3653 memcpy(vec_add(lnofile, filelen+1), filename, filelen+1);
3654 dot = strrchr(lnofile, '.');
3658 vec_shrinkto(lnofile, dot - lnofile);
3660 memcpy(vec_add(lnofile, 5), ".lno", 5);
3663 if (!OPTS_OPTION_BOOL(OPTION_QUIET)) {
3665 con_out("writing '%s' and '%s'...\n", filename, lnofile);
3667 con_out("writing '%s'\n", filename);
3669 if (!code_write(filename, lnofile)) {
3677 /***********************************************************************
3678 *IR DEBUG Dump functions...
3681 #define IND_BUFSZ 1024
3684 # define strncat(dst, src, sz) strncat_s(dst, sz, src, _TRUNCATE)
3687 const char *qc_opname(int op)
3689 if (op < 0) return "<INVALID>";
3690 if (op < (int)( sizeof(asm_instr) / sizeof(asm_instr[0]) ))
3691 return asm_instr[op].m;
3693 case VINSTR_PHI: return "PHI";
3694 case VINSTR_JUMP: return "JUMP";
3695 case VINSTR_COND: return "COND";
3696 default: return "<UNK>";
3700 void ir_builder_dump(ir_builder *b, int (*oprintf)(const char*, ...))
3703 char indent[IND_BUFSZ];
3707 oprintf("module %s\n", b->name);
3708 for (i = 0; i < vec_size(b->globals); ++i)
3711 if (b->globals[i]->hasvalue)
3712 oprintf("%s = ", b->globals[i]->name);
3713 ir_value_dump(b->globals[i], oprintf);
3716 for (i = 0; i < vec_size(b->functions); ++i)
3717 ir_function_dump(b->functions[i], indent, oprintf);
3718 oprintf("endmodule %s\n", b->name);
3721 static const char *storenames[] = {
3722 "[global]", "[local]", "[param]", "[value]", "[return]"
3725 void ir_function_dump(ir_function *f, char *ind,
3726 int (*oprintf)(const char*, ...))
3729 if (f->builtin != 0) {
3730 oprintf("%sfunction %s = builtin %i\n", ind, f->name, -f->builtin);
3733 oprintf("%sfunction %s\n", ind, f->name);
3734 strncat(ind, "\t", IND_BUFSZ);
3735 if (vec_size(f->locals))
3737 oprintf("%s%i locals:\n", ind, (int)vec_size(f->locals));
3738 for (i = 0; i < vec_size(f->locals); ++i) {
3739 oprintf("%s\t", ind);
3740 ir_value_dump(f->locals[i], oprintf);
3744 oprintf("%sliferanges:\n", ind);
3745 for (i = 0; i < vec_size(f->locals); ++i) {
3746 const char *attr = "";
3748 ir_value *v = f->locals[i];
3749 if (v->unique_life && v->locked)
3750 attr = "unique,locked ";
3751 else if (v->unique_life)
3755 oprintf("%s\t%s: %s %s %s%s@%i ", ind, v->name, type_name[v->vtype],
3756 storenames[v->store],
3757 attr, (v->callparam ? "callparam " : ""),
3758 (int)v->code.local);
3761 for (l = 0; l < vec_size(v->life); ++l) {
3762 oprintf("[%i,%i] ", v->life[l].start, v->life[l].end);
3765 for (m = 0; m < 3; ++m) {
3766 ir_value *vm = v->members[m];
3769 oprintf("%s\t%s: @%i ", ind, vm->name, (int)vm->code.local);
3770 for (l = 0; l < vec_size(vm->life); ++l) {
3771 oprintf("[%i,%i] ", vm->life[l].start, vm->life[l].end);
3776 for (i = 0; i < vec_size(f->values); ++i) {
3777 const char *attr = "";
3779 ir_value *v = f->values[i];
3780 if (v->unique_life && v->locked)
3781 attr = "unique,locked ";
3782 else if (v->unique_life)
3786 oprintf("%s\t%s: %s %s %s%s@%i ", ind, v->name, type_name[v->vtype],
3787 storenames[v->store],
3788 attr, (v->callparam ? "callparam " : ""),
3789 (int)v->code.local);
3792 for (l = 0; l < vec_size(v->life); ++l) {
3793 oprintf("[%i,%i] ", v->life[l].start, v->life[l].end);
3796 for (m = 0; m < 3; ++m) {
3797 ir_value *vm = v->members[m];
3800 if (vm->unique_life && vm->locked)
3801 attr = "unique,locked ";
3802 else if (vm->unique_life)
3804 else if (vm->locked)
3806 oprintf("%s\t%s: %s@%i ", ind, vm->name, attr, (int)vm->code.local);
3807 for (l = 0; l < vec_size(vm->life); ++l) {
3808 oprintf("[%i,%i] ", vm->life[l].start, vm->life[l].end);
3813 if (vec_size(f->blocks))
3815 oprintf("%slife passes: %i\n", ind, (int)f->run_id);
3816 for (i = 0; i < vec_size(f->blocks); ++i) {
3817 ir_block_dump(f->blocks[i], ind, oprintf);
3821 ind[strlen(ind)-1] = 0;
3822 oprintf("%sendfunction %s\n", ind, f->name);
3825 void ir_block_dump(ir_block* b, char *ind,
3826 int (*oprintf)(const char*, ...))
3829 oprintf("%s:%s\n", ind, b->label);
3830 strncat(ind, "\t", IND_BUFSZ);
3832 if (b->instr && b->instr[0])
3833 oprintf("%s (%i) [entry]\n", ind, (int)(b->instr[0]->eid-1));
3834 for (i = 0; i < vec_size(b->instr); ++i)
3835 ir_instr_dump(b->instr[i], ind, oprintf);
3836 ind[strlen(ind)-1] = 0;
3839 void dump_phi(ir_instr *in, int (*oprintf)(const char*, ...))
3842 oprintf("%s <- phi ", in->_ops[0]->name);
3843 for (i = 0; i < vec_size(in->phi); ++i)
3845 oprintf("([%s] : %s) ", in->phi[i].from->label,
3846 in->phi[i].value->name);
3851 void ir_instr_dump(ir_instr *in, char *ind,
3852 int (*oprintf)(const char*, ...))
3855 const char *comma = NULL;
3857 oprintf("%s (%i) ", ind, (int)in->eid);
3859 if (in->opcode == VINSTR_PHI) {
3860 dump_phi(in, oprintf);
3864 strncat(ind, "\t", IND_BUFSZ);
3866 if (in->_ops[0] && (in->_ops[1] || in->_ops[2])) {
3867 ir_value_dump(in->_ops[0], oprintf);
3868 if (in->_ops[1] || in->_ops[2])