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] = {
50 size_t type_sizeof_[TYPE_COUNT] = {
57 1, /* TYPE_FUNCTION */
67 uint16_t type_store_instr[TYPE_COUNT] = {
68 INSTR_STORE_F, /* should use I when having integer support */
75 INSTR_STORE_ENT, /* should use I */
77 INSTR_STORE_I, /* integer type */
82 INSTR_STORE_V, /* variant, should never be accessed */
84 AINSTR_END, /* struct */
85 AINSTR_END, /* union */
86 AINSTR_END, /* array */
90 uint16_t field_store_instr[TYPE_COUNT] = {
100 INSTR_STORE_FLD, /* integer type */
105 INSTR_STORE_V, /* variant, should never be accessed */
107 AINSTR_END, /* struct */
108 AINSTR_END, /* union */
109 AINSTR_END, /* array */
110 AINSTR_END, /* nil */
113 uint16_t type_storep_instr[TYPE_COUNT] = {
114 INSTR_STOREP_F, /* should use I when having integer support */
121 INSTR_STOREP_ENT, /* should use I */
123 INSTR_STOREP_ENT, /* integer type */
128 INSTR_STOREP_V, /* variant, should never be accessed */
130 AINSTR_END, /* struct */
131 AINSTR_END, /* union */
132 AINSTR_END, /* array */
133 AINSTR_END, /* nil */
136 uint16_t type_eq_instr[TYPE_COUNT] = {
137 INSTR_EQ_F, /* should use I when having integer support */
142 INSTR_EQ_E, /* FLD has no comparison */
144 INSTR_EQ_E, /* should use I */
151 INSTR_EQ_V, /* variant, should never be accessed */
153 AINSTR_END, /* struct */
154 AINSTR_END, /* union */
155 AINSTR_END, /* array */
156 AINSTR_END, /* nil */
159 uint16_t type_ne_instr[TYPE_COUNT] = {
160 INSTR_NE_F, /* should use I when having integer support */
165 INSTR_NE_E, /* FLD has no comparison */
167 INSTR_NE_E, /* should use I */
174 INSTR_NE_V, /* variant, should never be accessed */
176 AINSTR_END, /* struct */
177 AINSTR_END, /* union */
178 AINSTR_END, /* array */
179 AINSTR_END, /* nil */
182 uint16_t type_not_instr[TYPE_COUNT] = {
183 INSTR_NOT_F, /* should use I when having integer support */
190 INSTR_NOT_ENT, /* should use I */
192 INSTR_NOT_I, /* integer type */
197 INSTR_NOT_V, /* variant, should never be accessed */
199 AINSTR_END, /* struct */
200 AINSTR_END, /* union */
201 AINSTR_END, /* array */
202 AINSTR_END, /* nil */
206 static ir_value* ir_gen_extparam_proto(ir_builder *ir);
207 static void ir_gen_extparam (ir_builder *ir);
209 /* error functions */
211 static void irerror(lex_ctx ctx, const char *msg, ...)
215 con_cvprintmsg((void*)&ctx, LVL_ERROR, "internal error", msg, ap);
219 static bool irwarning(lex_ctx ctx, int warntype, const char *fmt, ...)
224 r = vcompile_warning(ctx, warntype, fmt, ap);
229 /***********************************************************************
230 * Vector utility functions
233 bool GMQCC_WARN vec_ir_value_find(ir_value **vec, const ir_value *what, size_t *idx)
236 size_t len = vec_size(vec);
237 for (i = 0; i < len; ++i) {
238 if (vec[i] == what) {
246 bool GMQCC_WARN vec_ir_block_find(ir_block **vec, ir_block *what, size_t *idx)
249 size_t len = vec_size(vec);
250 for (i = 0; i < len; ++i) {
251 if (vec[i] == what) {
259 bool GMQCC_WARN vec_ir_instr_find(ir_instr **vec, ir_instr *what, size_t *idx)
262 size_t len = vec_size(vec);
263 for (i = 0; i < len; ++i) {
264 if (vec[i] == what) {
272 /***********************************************************************
276 static void ir_block_delete_quick(ir_block* self);
277 static void ir_instr_delete_quick(ir_instr *self);
278 static void ir_function_delete_quick(ir_function *self);
280 ir_builder* ir_builder_new(const char *modulename)
284 self = (ir_builder*)mem_a(sizeof(*self));
288 self->functions = NULL;
289 self->globals = NULL;
291 self->filenames = NULL;
292 self->filestrings = NULL;
293 self->htglobals = util_htnew(IR_HT_SIZE);
294 self->htfields = util_htnew(IR_HT_SIZE);
295 self->htfunctions = util_htnew(IR_HT_SIZE);
297 self->extparams = NULL;
298 self->extparam_protos = NULL;
300 self->first_common_globaltemp = 0;
301 self->max_globaltemps = 0;
302 self->first_common_local = 0;
303 self->max_locals = 0;
305 self->str_immediate = 0;
307 if (!ir_builder_set_name(self, modulename)) {
312 self->nil = ir_value_var("nil", store_value, TYPE_NIL);
313 self->nil->cvq = CV_CONST;
318 void ir_builder_delete(ir_builder* self)
321 util_htdel(self->htglobals);
322 util_htdel(self->htfields);
323 util_htdel(self->htfunctions);
324 mem_d((void*)self->name);
325 for (i = 0; i != vec_size(self->functions); ++i) {
326 ir_function_delete_quick(self->functions[i]);
328 vec_free(self->functions);
329 for (i = 0; i != vec_size(self->extparams); ++i) {
330 ir_value_delete(self->extparams[i]);
332 vec_free(self->extparams);
333 for (i = 0; i != vec_size(self->globals); ++i) {
334 ir_value_delete(self->globals[i]);
336 vec_free(self->globals);
337 for (i = 0; i != vec_size(self->fields); ++i) {
338 ir_value_delete(self->fields[i]);
340 ir_value_delete(self->nil);
341 vec_free(self->fields);
342 vec_free(self->filenames);
343 vec_free(self->filestrings);
347 bool ir_builder_set_name(ir_builder *self, const char *name)
350 mem_d((void*)self->name);
351 self->name = util_strdup(name);
355 ir_function* ir_builder_get_function(ir_builder *self, const char *name)
357 return (ir_function*)util_htget(self->htfunctions, name);
360 ir_function* ir_builder_create_function(ir_builder *self, const char *name, int outtype)
362 ir_function *fn = ir_builder_get_function(self, name);
367 fn = ir_function_new(self, outtype);
368 if (!ir_function_set_name(fn, name))
370 ir_function_delete(fn);
373 vec_push(self->functions, fn);
374 util_htset(self->htfunctions, name, fn);
376 fn->value = ir_builder_create_global(self, fn->name, TYPE_FUNCTION);
378 ir_function_delete(fn);
382 fn->value->hasvalue = true;
383 fn->value->outtype = outtype;
384 fn->value->constval.vfunc = fn;
385 fn->value->context = fn->context;
390 ir_value* ir_builder_get_global(ir_builder *self, const char *name)
392 return (ir_value*)util_htget(self->htglobals, name);
395 ir_value* ir_builder_create_global(ir_builder *self, const char *name, int vtype)
399 if (name && name[0] != '#')
401 ve = ir_builder_get_global(self, name);
407 ve = ir_value_var(name, store_global, vtype);
408 vec_push(self->globals, ve);
409 util_htset(self->htglobals, name, ve);
413 ir_value* ir_builder_get_field(ir_builder *self, const char *name)
415 return (ir_value*)util_htget(self->htfields, name);
419 ir_value* ir_builder_create_field(ir_builder *self, const char *name, int vtype)
421 ir_value *ve = ir_builder_get_field(self, name);
426 ve = ir_value_var(name, store_global, TYPE_FIELD);
427 ve->fieldtype = vtype;
428 vec_push(self->fields, ve);
429 util_htset(self->htfields, name, ve);
433 /***********************************************************************
437 bool ir_function_naive_phi(ir_function*);
438 void ir_function_enumerate(ir_function*);
439 bool ir_function_calculate_liferanges(ir_function*);
440 bool ir_function_allocate_locals(ir_function*);
442 ir_function* ir_function_new(ir_builder* owner, int outtype)
445 self = (ir_function*)mem_a(sizeof(*self));
450 memset(self, 0, sizeof(*self));
453 if (!ir_function_set_name(self, "<@unnamed>")) {
460 self->context.file = "<@no context>";
461 self->context.line = 0;
462 self->outtype = outtype;
471 self->code_function_def = -1;
472 self->allocated_locals = 0;
473 self->globaltemps = 0;
479 bool ir_function_set_name(ir_function *self, const char *name)
482 mem_d((void*)self->name);
483 self->name = util_strdup(name);
487 static void ir_function_delete_quick(ir_function *self)
490 mem_d((void*)self->name);
492 for (i = 0; i != vec_size(self->blocks); ++i)
493 ir_block_delete_quick(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_delete(ir_function *self)
514 mem_d((void*)self->name);
516 for (i = 0; i != vec_size(self->blocks); ++i)
517 ir_block_delete(self->blocks[i]);
518 vec_free(self->blocks);
520 vec_free(self->params);
522 for (i = 0; i != vec_size(self->values); ++i)
523 ir_value_delete(self->values[i]);
524 vec_free(self->values);
526 for (i = 0; i != vec_size(self->locals); ++i)
527 ir_value_delete(self->locals[i]);
528 vec_free(self->locals);
530 /* self->value is deleted by the builder */
535 void ir_function_collect_value(ir_function *self, ir_value *v)
537 vec_push(self->values, v);
540 ir_block* ir_function_create_block(lex_ctx ctx, ir_function *self, const char *label)
542 ir_block* bn = ir_block_new(self, label);
544 vec_push(self->blocks, bn);
548 static bool instr_is_operation(uint16_t op)
550 return ( (op >= INSTR_MUL_F && op <= INSTR_GT) ||
551 (op >= INSTR_LOAD_F && op <= INSTR_LOAD_FNC) ||
552 (op == INSTR_ADDRESS) ||
553 (op >= INSTR_NOT_F && op <= INSTR_NOT_FNC) ||
554 (op >= INSTR_AND && op <= INSTR_BITOR) ||
555 (op >= INSTR_CALL0 && op <= INSTR_CALL8) );
558 bool ir_function_pass_peephole(ir_function *self)
562 for (b = 0; b < vec_size(self->blocks); ++b) {
564 ir_block *block = self->blocks[b];
566 for (i = 0; i < vec_size(block->instr); ++i) {
568 inst = block->instr[i];
571 (inst->opcode >= INSTR_STORE_F &&
572 inst->opcode <= INSTR_STORE_FNC))
580 oper = block->instr[i-1];
581 if (!instr_is_operation(oper->opcode))
584 value = oper->_ops[0];
586 /* only do it for SSA values */
587 if (value->store != store_value)
590 /* don't optimize out the temp if it's used later again */
591 if (vec_size(value->reads) != 1)
594 /* The very next store must use this value */
595 if (value->reads[0] != store)
598 /* And of course the store must _read_ from it, so it's in
600 if (store->_ops[1] != value)
603 ++opts_optimizationcount[OPTIM_PEEPHOLE];
604 (void)!ir_instr_op(oper, 0, store->_ops[0], true);
606 vec_remove(block->instr, i, 1);
607 ir_instr_delete(store);
609 else if (inst->opcode == VINSTR_COND)
611 /* COND on a value resulting from a NOT could
612 * remove the NOT and swap its operands
619 value = inst->_ops[0];
621 if (value->store != store_value ||
622 vec_size(value->reads) != 1 ||
623 value->reads[0] != inst)
628 inot = value->writes[0];
629 if (inot->_ops[0] != value ||
630 inot->opcode < INSTR_NOT_F ||
631 inot->opcode > INSTR_NOT_FNC ||
632 inot->opcode == INSTR_NOT_V || /* can't do these */
633 inot->opcode == INSTR_NOT_S)
639 ++opts_optimizationcount[OPTIM_PEEPHOLE];
641 (void)!ir_instr_op(inst, 0, inot->_ops[1], false);
644 for (inotid = 0; inotid < vec_size(tmp->instr); ++inotid) {
645 if (tmp->instr[inotid] == inot)
648 if (inotid >= vec_size(tmp->instr)) {
649 compile_error(inst->context, "sanity-check failed: failed to find instruction to optimize out");
652 vec_remove(tmp->instr, inotid, 1);
653 ir_instr_delete(inot);
654 /* swap ontrue/onfalse */
656 inst->bops[0] = inst->bops[1];
667 bool ir_function_pass_tailrecursion(ir_function *self)
671 for (b = 0; b < vec_size(self->blocks); ++b) {
673 ir_instr *ret, *call, *store = NULL;
674 ir_block *block = self->blocks[b];
676 if (!block->final || vec_size(block->instr) < 2)
679 ret = block->instr[vec_size(block->instr)-1];
680 if (ret->opcode != INSTR_DONE && ret->opcode != INSTR_RETURN)
683 call = block->instr[vec_size(block->instr)-2];
684 if (call->opcode >= INSTR_STORE_F && call->opcode <= INSTR_STORE_FNC) {
685 /* account for the unoptimized
687 * STORE %return, %tmp
691 if (vec_size(block->instr) < 3)
695 call = block->instr[vec_size(block->instr)-3];
698 if (call->opcode < INSTR_CALL0 || call->opcode > INSTR_CALL8)
702 /* optimize out the STORE */
704 ret->_ops[0] == store->_ops[0] &&
705 store->_ops[1] == call->_ops[0])
707 ++opts_optimizationcount[OPTIM_PEEPHOLE];
708 call->_ops[0] = store->_ops[0];
709 vec_remove(block->instr, vec_size(block->instr) - 2, 1);
710 ir_instr_delete(store);
719 funcval = call->_ops[1];
722 if (funcval->vtype != TYPE_FUNCTION || funcval->constval.vfunc != self)
725 /* now we have a CALL and a RET, check if it's a tailcall */
726 if (ret->_ops[0] && call->_ops[0] != ret->_ops[0])
729 ++opts_optimizationcount[OPTIM_TAIL_RECURSION];
730 vec_shrinkby(block->instr, 2);
732 block->final = false; /* open it back up */
734 /* emite parameter-stores */
735 for (p = 0; p < vec_size(call->params); ++p) {
736 /* assert(call->params_count <= self->locals_count); */
737 if (!ir_block_create_store(block, call->context, self->locals[p], call->params[p])) {
738 irerror(call->context, "failed to create tailcall store instruction for parameter %i", (int)p);
742 if (!ir_block_create_jump(block, call->context, self->blocks[0])) {
743 irerror(call->context, "failed to create tailcall jump");
747 ir_instr_delete(call);
748 ir_instr_delete(ret);
754 bool ir_function_finalize(ir_function *self)
761 if (OPTS_OPTIMIZATION(OPTIM_PEEPHOLE)) {
762 if (!ir_function_pass_peephole(self)) {
763 irerror(self->context, "generic optimization pass broke something in `%s`", self->name);
768 if (OPTS_OPTIMIZATION(OPTIM_TAIL_RECURSION)) {
769 if (!ir_function_pass_tailrecursion(self)) {
770 irerror(self->context, "tail-recursion optimization pass broke something in `%s`", self->name);
775 if (!ir_function_naive_phi(self))
778 for (i = 0; i < vec_size(self->locals); ++i) {
779 ir_value *v = self->locals[i];
780 if (v->vtype == TYPE_VECTOR ||
781 (v->vtype == TYPE_FIELD && v->outtype == TYPE_VECTOR))
783 ir_value_vector_member(v, 0);
784 ir_value_vector_member(v, 1);
785 ir_value_vector_member(v, 2);
788 for (i = 0; i < vec_size(self->values); ++i) {
789 ir_value *v = self->values[i];
790 if (v->vtype == TYPE_VECTOR ||
791 (v->vtype == TYPE_FIELD && v->outtype == TYPE_VECTOR))
793 ir_value_vector_member(v, 0);
794 ir_value_vector_member(v, 1);
795 ir_value_vector_member(v, 2);
799 ir_function_enumerate(self);
801 if (!ir_function_calculate_liferanges(self))
803 if (!ir_function_allocate_locals(self))
808 ir_value* ir_function_create_local(ir_function *self, const char *name, int vtype, bool param)
813 vec_size(self->locals) &&
814 self->locals[vec_size(self->locals)-1]->store != store_param) {
815 irerror(self->context, "cannot add parameters after adding locals");
819 ve = ir_value_var(name, (param ? store_param : store_local), vtype);
822 vec_push(self->locals, ve);
826 /***********************************************************************
830 ir_block* ir_block_new(ir_function* owner, const char *name)
833 self = (ir_block*)mem_a(sizeof(*self));
837 memset(self, 0, sizeof(*self));
840 if (name && !ir_block_set_label(self, name)) {
845 self->context.file = "<@no context>";
846 self->context.line = 0;
850 self->entries = NULL;
854 self->is_return = false;
859 self->generated = false;
864 static void ir_block_delete_quick(ir_block* self)
867 if (self->label) mem_d(self->label);
868 for (i = 0; i != vec_size(self->instr); ++i)
869 ir_instr_delete_quick(self->instr[i]);
870 vec_free(self->instr);
871 vec_free(self->entries);
872 vec_free(self->exits);
873 vec_free(self->living);
877 void ir_block_delete(ir_block* self)
880 if (self->label) mem_d(self->label);
881 for (i = 0; i != vec_size(self->instr); ++i)
882 ir_instr_delete(self->instr[i]);
883 vec_free(self->instr);
884 vec_free(self->entries);
885 vec_free(self->exits);
886 vec_free(self->living);
890 bool ir_block_set_label(ir_block *self, const char *name)
893 mem_d((void*)self->label);
894 self->label = util_strdup(name);
895 return !!self->label;
898 /***********************************************************************
902 ir_instr* ir_instr_new(lex_ctx ctx, ir_block* owner, int op)
905 self = (ir_instr*)mem_a(sizeof(*self));
912 self->_ops[0] = NULL;
913 self->_ops[1] = NULL;
914 self->_ops[2] = NULL;
915 self->bops[0] = NULL;
916 self->bops[1] = NULL;
927 static void ir_instr_delete_quick(ir_instr *self)
930 vec_free(self->params);
934 void ir_instr_delete(ir_instr *self)
937 /* The following calls can only delete from
938 * vectors, we still want to delete this instruction
939 * so ignore the return value. Since with the warn_unused_result attribute
940 * gcc doesn't care about an explicit: (void)foo(); to ignore the result,
941 * I have to improvise here and use if(foo());
943 for (i = 0; i < vec_size(self->phi); ++i) {
945 if (vec_ir_instr_find(self->phi[i].value->writes, self, &idx))
946 vec_remove(self->phi[i].value->writes, idx, 1);
947 if (vec_ir_instr_find(self->phi[i].value->reads, self, &idx))
948 vec_remove(self->phi[i].value->reads, idx, 1);
951 for (i = 0; i < vec_size(self->params); ++i) {
953 if (vec_ir_instr_find(self->params[i]->writes, self, &idx))
954 vec_remove(self->params[i]->writes, idx, 1);
955 if (vec_ir_instr_find(self->params[i]->reads, self, &idx))
956 vec_remove(self->params[i]->reads, idx, 1);
958 vec_free(self->params);
959 (void)!ir_instr_op(self, 0, NULL, false);
960 (void)!ir_instr_op(self, 1, NULL, false);
961 (void)!ir_instr_op(self, 2, NULL, false);
965 bool ir_instr_op(ir_instr *self, int op, ir_value *v, bool writing)
967 if (self->_ops[op]) {
969 if (writing && vec_ir_instr_find(self->_ops[op]->writes, self, &idx))
970 vec_remove(self->_ops[op]->writes, idx, 1);
971 else if (vec_ir_instr_find(self->_ops[op]->reads, self, &idx))
972 vec_remove(self->_ops[op]->reads, idx, 1);
976 vec_push(v->writes, self);
978 vec_push(v->reads, self);
984 /***********************************************************************
988 void ir_value_code_setaddr(ir_value *self, int32_t gaddr)
990 self->code.globaladdr = gaddr;
991 if (self->members[0]) self->members[0]->code.globaladdr = gaddr;
992 if (self->members[1]) self->members[1]->code.globaladdr = gaddr;
993 if (self->members[2]) self->members[2]->code.globaladdr = gaddr;
996 int32_t ir_value_code_addr(const ir_value *self)
998 if (self->store == store_return)
999 return OFS_RETURN + self->code.addroffset;
1000 return self->code.globaladdr + self->code.addroffset;
1003 ir_value* ir_value_var(const char *name, int storetype, int vtype)
1006 self = (ir_value*)mem_a(sizeof(*self));
1007 self->vtype = vtype;
1008 self->fieldtype = TYPE_VOID;
1009 self->outtype = TYPE_VOID;
1010 self->store = storetype;
1013 self->writes = NULL;
1015 self->cvq = CV_NONE;
1016 self->hasvalue = false;
1017 self->context.file = "<@no context>";
1018 self->context.line = 0;
1020 if (name && !ir_value_set_name(self, name)) {
1021 irerror(self->context, "out of memory");
1026 memset(&self->constval, 0, sizeof(self->constval));
1027 memset(&self->code, 0, sizeof(self->code));
1029 self->members[0] = NULL;
1030 self->members[1] = NULL;
1031 self->members[2] = NULL;
1032 self->memberof = NULL;
1034 self->unique_life = false;
1035 self->locked = false;
1036 self->callparam = false;
1042 ir_value* ir_value_vector_member(ir_value *self, unsigned int member)
1050 if (self->members[member])
1051 return self->members[member];
1054 len = strlen(self->name);
1055 name = (char*)mem_a(len + 3);
1056 memcpy(name, self->name, len);
1058 name[len+1] = 'x' + member;
1064 if (self->vtype == TYPE_VECTOR)
1066 m = ir_value_var(name, self->store, TYPE_FLOAT);
1071 m->context = self->context;
1073 self->members[member] = m;
1074 m->code.addroffset = member;
1076 else if (self->vtype == TYPE_FIELD)
1078 if (self->fieldtype != TYPE_VECTOR)
1080 m = ir_value_var(name, self->store, TYPE_FIELD);
1085 m->fieldtype = TYPE_FLOAT;
1086 m->context = self->context;
1088 self->members[member] = m;
1089 m->code.addroffset = member;
1093 irerror(self->context, "invalid member access on %s", self->name);
1101 static GMQCC_INLINE size_t ir_value_sizeof(const ir_value *self)
1103 if (self->vtype == TYPE_FIELD && self->fieldtype == TYPE_VECTOR)
1104 return type_sizeof_[TYPE_VECTOR];
1105 return type_sizeof_[self->vtype];
1108 ir_value* ir_value_out(ir_function *owner, const char *name, int storetype, int vtype)
1110 ir_value *v = ir_value_var(name, storetype, vtype);
1113 ir_function_collect_value(owner, v);
1117 void ir_value_delete(ir_value* self)
1121 mem_d((void*)self->name);
1124 if (self->vtype == TYPE_STRING)
1125 mem_d((void*)self->constval.vstring);
1127 for (i = 0; i < 3; ++i) {
1128 if (self->members[i])
1129 ir_value_delete(self->members[i]);
1131 vec_free(self->reads);
1132 vec_free(self->writes);
1133 vec_free(self->life);
1137 bool ir_value_set_name(ir_value *self, const char *name)
1140 mem_d((void*)self->name);
1141 self->name = util_strdup(name);
1142 return !!self->name;
1145 bool ir_value_set_float(ir_value *self, float f)
1147 if (self->vtype != TYPE_FLOAT)
1149 self->constval.vfloat = f;
1150 self->hasvalue = true;
1154 bool ir_value_set_func(ir_value *self, int f)
1156 if (self->vtype != TYPE_FUNCTION)
1158 self->constval.vint = f;
1159 self->hasvalue = true;
1163 bool ir_value_set_vector(ir_value *self, vector v)
1165 if (self->vtype != TYPE_VECTOR)
1167 self->constval.vvec = v;
1168 self->hasvalue = true;
1172 bool ir_value_set_field(ir_value *self, ir_value *fld)
1174 if (self->vtype != TYPE_FIELD)
1176 self->constval.vpointer = fld;
1177 self->hasvalue = true;
1181 static char *ir_strdup(const char *str)
1184 /* actually dup empty strings */
1185 char *out = (char*)mem_a(1);
1189 return util_strdup(str);
1192 bool ir_value_set_string(ir_value *self, const char *str)
1194 if (self->vtype != TYPE_STRING)
1196 self->constval.vstring = ir_strdup(str);
1197 self->hasvalue = true;
1202 bool ir_value_set_int(ir_value *self, int i)
1204 if (self->vtype != TYPE_INTEGER)
1206 self->constval.vint = i;
1207 self->hasvalue = true;
1212 bool ir_value_lives(ir_value *self, size_t at)
1215 for (i = 0; i < vec_size(self->life); ++i)
1217 ir_life_entry_t *life = &self->life[i];
1218 if (life->start <= at && at <= life->end)
1220 if (life->start > at) /* since it's ordered */
1226 bool ir_value_life_insert(ir_value *self, size_t idx, ir_life_entry_t e)
1229 vec_push(self->life, e);
1230 for (k = vec_size(self->life)-1; k > idx; --k)
1231 self->life[k] = self->life[k-1];
1232 self->life[idx] = e;
1236 bool ir_value_life_merge(ir_value *self, size_t s)
1239 ir_life_entry_t *life = NULL;
1240 ir_life_entry_t *before = NULL;
1241 ir_life_entry_t new_entry;
1243 /* Find the first range >= s */
1244 for (i = 0; i < vec_size(self->life); ++i)
1247 life = &self->life[i];
1248 if (life->start > s)
1251 /* nothing found? append */
1252 if (i == vec_size(self->life)) {
1254 if (life && life->end+1 == s)
1256 /* previous life range can be merged in */
1260 if (life && life->end >= s)
1262 e.start = e.end = s;
1263 vec_push(self->life, e);
1269 if (before->end + 1 == s &&
1270 life->start - 1 == s)
1273 before->end = life->end;
1274 vec_remove(self->life, i, 1);
1277 if (before->end + 1 == s)
1283 /* already contained */
1284 if (before->end >= s)
1288 if (life->start - 1 == s)
1293 /* insert a new entry */
1294 new_entry.start = new_entry.end = s;
1295 return ir_value_life_insert(self, i, new_entry);
1298 bool ir_value_life_merge_into(ir_value *self, const ir_value *other)
1302 if (!vec_size(other->life))
1305 if (!vec_size(self->life)) {
1306 size_t count = vec_size(other->life);
1307 ir_life_entry_t *life = vec_add(self->life, count);
1308 memcpy(life, other->life, count * sizeof(*life));
1313 for (i = 0; i < vec_size(other->life); ++i)
1315 const ir_life_entry_t *life = &other->life[i];
1318 ir_life_entry_t *entry = &self->life[myi];
1320 if (life->end+1 < entry->start)
1322 /* adding an interval before entry */
1323 if (!ir_value_life_insert(self, myi, *life))
1329 if (life->start < entry->start &&
1330 life->end+1 >= entry->start)
1332 /* starts earlier and overlaps */
1333 entry->start = life->start;
1336 if (life->end > entry->end &&
1337 life->start <= entry->end+1)
1339 /* ends later and overlaps */
1340 entry->end = life->end;
1343 /* see if our change combines it with the next ranges */
1344 while (myi+1 < vec_size(self->life) &&
1345 entry->end+1 >= self->life[1+myi].start)
1347 /* overlaps with (myi+1) */
1348 if (entry->end < self->life[1+myi].end)
1349 entry->end = self->life[1+myi].end;
1350 vec_remove(self->life, myi+1, 1);
1351 entry = &self->life[myi];
1354 /* see if we're after the entry */
1355 if (life->start > entry->end)
1358 /* append if we're at the end */
1359 if (myi >= vec_size(self->life)) {
1360 vec_push(self->life, *life);
1363 /* otherweise check the next range */
1372 bool ir_values_overlap(const ir_value *a, const ir_value *b)
1374 /* For any life entry in A see if it overlaps with
1375 * any life entry in B.
1376 * Note that the life entries are orderes, so we can make a
1377 * more efficient algorithm there than naively translating the
1381 ir_life_entry_t *la, *lb, *enda, *endb;
1383 /* first of all, if either has no life range, they cannot clash */
1384 if (!vec_size(a->life) || !vec_size(b->life))
1389 enda = la + vec_size(a->life);
1390 endb = lb + vec_size(b->life);
1393 /* check if the entries overlap, for that,
1394 * both must start before the other one ends.
1396 if (la->start < lb->end &&
1397 lb->start < la->end)
1402 /* entries are ordered
1403 * one entry is earlier than the other
1404 * that earlier entry will be moved forward
1406 if (la->start < lb->start)
1408 /* order: A B, move A forward
1409 * check if we hit the end with A
1414 else /* if (lb->start < la->start) actually <= */
1416 /* order: B A, move B forward
1417 * check if we hit the end with B
1426 /***********************************************************************
1430 static bool ir_check_unreachable(ir_block *self)
1432 /* The IR should never have to deal with unreachable code */
1433 if (!self->final/* || OPTS_FLAG(ALLOW_UNREACHABLE_CODE)*/)
1435 irerror(self->context, "unreachable statement (%s)", self->label);
1439 bool ir_block_create_store_op(ir_block *self, lex_ctx ctx, int op, ir_value *target, ir_value *what)
1442 if (!ir_check_unreachable(self))
1445 if (target->store == store_value &&
1446 (op < INSTR_STOREP_F || op > INSTR_STOREP_FNC))
1448 irerror(self->context, "cannot store to an SSA value");
1449 irerror(self->context, "trying to store: %s <- %s", target->name, what->name);
1450 irerror(self->context, "instruction: %s", asm_instr[op].m);
1454 in = ir_instr_new(ctx, self, op);
1458 if (!ir_instr_op(in, 0, target, (op < INSTR_STOREP_F || op > INSTR_STOREP_FNC)) ||
1459 !ir_instr_op(in, 1, what, false))
1461 ir_instr_delete(in);
1464 vec_push(self->instr, in);
1468 bool ir_block_create_store(ir_block *self, lex_ctx ctx, ir_value *target, ir_value *what)
1472 if (target->vtype == TYPE_VARIANT)
1473 vtype = what->vtype;
1475 vtype = target->vtype;
1478 if (vtype == TYPE_FLOAT && what->vtype == TYPE_INTEGER)
1479 op = INSTR_CONV_ITOF;
1480 else if (vtype == TYPE_INTEGER && what->vtype == TYPE_FLOAT)
1481 op = INSTR_CONV_FTOI;
1483 op = type_store_instr[vtype];
1485 if (OPTS_FLAG(ADJUST_VECTOR_FIELDS)) {
1486 if (op == INSTR_STORE_FLD && what->fieldtype == TYPE_VECTOR)
1490 return ir_block_create_store_op(self, ctx, op, target, what);
1493 bool ir_block_create_storep(ir_block *self, lex_ctx ctx, ir_value *target, ir_value *what)
1498 if (target->vtype != TYPE_POINTER)
1501 /* storing using pointer - target is a pointer, type must be
1502 * inferred from source
1504 vtype = what->vtype;
1506 op = type_storep_instr[vtype];
1507 if (OPTS_FLAG(ADJUST_VECTOR_FIELDS)) {
1508 if (op == INSTR_STOREP_FLD && what->fieldtype == TYPE_VECTOR)
1509 op = INSTR_STOREP_V;
1512 return ir_block_create_store_op(self, ctx, op, target, what);
1515 bool ir_block_create_return(ir_block *self, lex_ctx ctx, ir_value *v)
1518 if (!ir_check_unreachable(self))
1521 self->is_return = true;
1522 in = ir_instr_new(ctx, self, INSTR_RETURN);
1526 if (v && !ir_instr_op(in, 0, v, false)) {
1527 ir_instr_delete(in);
1531 vec_push(self->instr, in);
1535 bool ir_block_create_if(ir_block *self, lex_ctx ctx, ir_value *v,
1536 ir_block *ontrue, ir_block *onfalse)
1539 if (!ir_check_unreachable(self))
1542 /*in = ir_instr_new(ctx, self, (v->vtype == TYPE_STRING ? INSTR_IF_S : INSTR_IF_F));*/
1543 in = ir_instr_new(ctx, self, VINSTR_COND);
1547 if (!ir_instr_op(in, 0, v, false)) {
1548 ir_instr_delete(in);
1552 in->bops[0] = ontrue;
1553 in->bops[1] = onfalse;
1555 vec_push(self->instr, in);
1557 vec_push(self->exits, ontrue);
1558 vec_push(self->exits, onfalse);
1559 vec_push(ontrue->entries, self);
1560 vec_push(onfalse->entries, self);
1564 bool ir_block_create_jump(ir_block *self, lex_ctx ctx, ir_block *to)
1567 if (!ir_check_unreachable(self))
1570 in = ir_instr_new(ctx, self, VINSTR_JUMP);
1575 vec_push(self->instr, in);
1577 vec_push(self->exits, to);
1578 vec_push(to->entries, self);
1582 bool ir_block_create_goto(ir_block *self, lex_ctx ctx, ir_block *to)
1584 self->owner->flags |= IR_FLAG_HAS_GOTO;
1585 return ir_block_create_jump(self, ctx, to);
1588 ir_instr* ir_block_create_phi(ir_block *self, lex_ctx ctx, const char *label, int ot)
1592 if (!ir_check_unreachable(self))
1594 in = ir_instr_new(ctx, self, VINSTR_PHI);
1597 out = ir_value_out(self->owner, label, store_value, ot);
1599 ir_instr_delete(in);
1602 if (!ir_instr_op(in, 0, out, true)) {
1603 ir_instr_delete(in);
1604 ir_value_delete(out);
1607 vec_push(self->instr, in);
1611 ir_value* ir_phi_value(ir_instr *self)
1613 return self->_ops[0];
1616 void ir_phi_add(ir_instr* self, ir_block *b, ir_value *v)
1620 if (!vec_ir_block_find(self->owner->entries, b, NULL)) {
1621 /* Must not be possible to cause this, otherwise the AST
1622 * is doing something wrong.
1624 irerror(self->context, "Invalid entry block for PHI");
1630 vec_push(v->reads, self);
1631 vec_push(self->phi, pe);
1634 /* call related code */
1635 ir_instr* ir_block_create_call(ir_block *self, lex_ctx ctx, const char *label, ir_value *func, bool noreturn)
1639 if (!ir_check_unreachable(self))
1641 in = ir_instr_new(ctx, self, (noreturn ? VINSTR_NRCALL : INSTR_CALL0));
1646 self->is_return = true;
1648 out = ir_value_out(self->owner, label, (func->outtype == TYPE_VOID) ? store_return : store_value, func->outtype);
1650 ir_instr_delete(in);
1653 if (!ir_instr_op(in, 0, out, true) ||
1654 !ir_instr_op(in, 1, func, false))
1656 ir_instr_delete(in);
1657 ir_value_delete(out);
1660 vec_push(self->instr, in);
1663 if (!ir_block_create_return(self, ctx, NULL)) {
1664 compile_error(ctx, "internal error: failed to generate dummy-return instruction");
1665 ir_instr_delete(in);
1673 ir_value* ir_call_value(ir_instr *self)
1675 return self->_ops[0];
1678 void ir_call_param(ir_instr* self, ir_value *v)
1680 vec_push(self->params, v);
1681 vec_push(v->reads, self);
1684 /* binary op related code */
1686 ir_value* ir_block_create_binop(ir_block *self, lex_ctx ctx,
1687 const char *label, int opcode,
1688 ir_value *left, ir_value *right)
1710 case INSTR_SUB_S: /* -- offset of string as float */
1715 case INSTR_BITOR_IF:
1716 case INSTR_BITOR_FI:
1717 case INSTR_BITAND_FI:
1718 case INSTR_BITAND_IF:
1733 case INSTR_BITAND_I:
1736 case INSTR_RSHIFT_I:
1737 case INSTR_LSHIFT_I:
1759 /* boolean operations result in floats */
1760 if (opcode >= INSTR_EQ_F && opcode <= INSTR_GT)
1762 else if (opcode >= INSTR_LE && opcode <= INSTR_GT)
1765 else if (opcode >= INSTR_LE_I && opcode <= INSTR_EQ_FI)
1770 if (ot == TYPE_VOID) {
1771 /* The AST or parser were supposed to check this! */
1775 return ir_block_create_general_instr(self, ctx, label, opcode, left, right, ot);
1778 ir_value* ir_block_create_unary(ir_block *self, lex_ctx ctx,
1779 const char *label, int opcode,
1782 int ot = TYPE_FLOAT;
1794 /* QC doesn't have other unary operations. We expect extensions to fill
1795 * the above list, otherwise we assume out-type = in-type, eg for an
1799 ot = operand->vtype;
1802 if (ot == TYPE_VOID) {
1803 /* The AST or parser were supposed to check this! */
1807 /* let's use the general instruction creator and pass NULL for OPB */
1808 return ir_block_create_general_instr(self, ctx, label, opcode, operand, NULL, ot);
1811 ir_value* ir_block_create_general_instr(ir_block *self, lex_ctx ctx, const char *label,
1812 int op, ir_value *a, ir_value *b, int outype)
1817 out = ir_value_out(self->owner, label, store_value, outype);
1821 instr = ir_instr_new(ctx, self, op);
1823 ir_value_delete(out);
1827 if (!ir_instr_op(instr, 0, out, true) ||
1828 !ir_instr_op(instr, 1, a, false) ||
1829 !ir_instr_op(instr, 2, b, false) )
1834 vec_push(self->instr, instr);
1838 ir_instr_delete(instr);
1839 ir_value_delete(out);
1843 ir_value* ir_block_create_fieldaddress(ir_block *self, lex_ctx ctx, const char *label, ir_value *ent, ir_value *field)
1847 /* Support for various pointer types todo if so desired */
1848 if (ent->vtype != TYPE_ENTITY)
1851 if (field->vtype != TYPE_FIELD)
1854 v = ir_block_create_general_instr(self, ctx, label, INSTR_ADDRESS, ent, field, TYPE_POINTER);
1855 v->fieldtype = field->fieldtype;
1859 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)
1862 if (ent->vtype != TYPE_ENTITY)
1865 /* at some point we could redirect for TYPE_POINTER... but that could lead to carelessness */
1866 if (field->vtype != TYPE_FIELD)
1871 case TYPE_FLOAT: op = INSTR_LOAD_F; break;
1872 case TYPE_VECTOR: op = INSTR_LOAD_V; break;
1873 case TYPE_STRING: op = INSTR_LOAD_S; break;
1874 case TYPE_FIELD: op = INSTR_LOAD_FLD; break;
1875 case TYPE_ENTITY: op = INSTR_LOAD_ENT; break;
1876 case TYPE_FUNCTION: op = INSTR_LOAD_FNC; break;
1878 case TYPE_POINTER: op = INSTR_LOAD_I; break;
1879 case TYPE_INTEGER: op = INSTR_LOAD_I; break;
1882 irerror(self->context, "invalid type for ir_block_create_load_from_ent: %s", type_name[outype]);
1886 return ir_block_create_general_instr(self, ctx, label, op, ent, field, outype);
1889 /* PHI resolving breaks the SSA, and must thus be the last
1890 * step before life-range calculation.
1893 static bool ir_block_naive_phi(ir_block *self);
1894 bool ir_function_naive_phi(ir_function *self)
1898 for (i = 0; i < vec_size(self->blocks); ++i)
1900 if (!ir_block_naive_phi(self->blocks[i]))
1907 static bool ir_naive_phi_emit_store(ir_block *block, size_t iid, ir_value *old, ir_value *what)
1912 /* create a store */
1913 if (!ir_block_create_store(block, old, what))
1916 /* we now move it up */
1917 instr = vec_last(block->instr);
1918 for (i = vec_size(block->instr)-1; i > iid; --i)
1919 block->instr[i] = block->instr[i-1];
1920 block->instr[i] = instr;
1926 static bool ir_block_naive_phi(ir_block *self)
1928 size_t i, p; /*, w;*/
1929 /* FIXME: optionally, create_phi can add the phis
1930 * to a list so we don't need to loop through blocks
1931 * - anyway: "don't optimize YET"
1933 for (i = 0; i < vec_size(self->instr); ++i)
1935 ir_instr *instr = self->instr[i];
1936 if (instr->opcode != VINSTR_PHI)
1939 vec_remove(self->instr, i, 1);
1940 --i; /* NOTE: i+1 below */
1942 for (p = 0; p < vec_size(instr->phi); ++p)
1944 ir_value *v = instr->phi[p].value;
1945 ir_block *b = instr->phi[p].from;
1947 if (v->store == store_value &&
1948 vec_size(v->reads) == 1 &&
1949 vec_size(v->writes) == 1)
1951 /* replace the value */
1952 if (!ir_instr_op(v->writes[0], 0, instr->_ops[0], true))
1957 /* force a move instruction */
1958 ir_instr *prevjump = vec_last(b->instr);
1961 instr->_ops[0]->store = store_global;
1962 if (!ir_block_create_store(b, instr->context, instr->_ops[0], v))
1964 instr->_ops[0]->store = store_value;
1965 vec_push(b->instr, prevjump);
1970 ir_value *v = instr->phi[p].value;
1971 for (w = 0; w < vec_size(v->writes); ++w) {
1974 if (!v->writes[w]->_ops[0])
1977 /* When the write was to a global, we have to emit a mov */
1978 old = v->writes[w]->_ops[0];
1980 /* The original instruction now writes to the PHI target local */
1981 if (v->writes[w]->_ops[0] == v)
1982 v->writes[w]->_ops[0] = instr->_ops[0];
1984 if (old->store != store_value && old->store != store_local && old->store != store_param)
1986 /* If it originally wrote to a global we need to store the value
1989 if (!ir_naive_phi_emit_store(self, i+1, old, v))
1991 if (i+1 < vec_size(self->instr))
1992 instr = self->instr[i+1];
1995 /* In case I forget and access instr later, it'll be NULL
1996 * when it's a problem, to make sure we crash, rather than accessing
2002 /* If it didn't, we can replace all reads by the phi target now. */
2004 for (r = 0; r < vec_size(old->reads); ++r)
2007 ir_instr *ri = old->reads[r];
2008 for (op = 0; op < vec_size(ri->phi); ++op) {
2009 if (ri->phi[op].value == old)
2010 ri->phi[op].value = v;
2012 for (op = 0; op < 3; ++op) {
2013 if (ri->_ops[op] == old)
2021 ir_instr_delete(instr);
2026 /***********************************************************************
2027 *IR Temp allocation code
2028 * Propagating value life ranges by walking through the function backwards
2029 * until no more changes are made.
2030 * In theory this should happen once more than once for every nested loop
2032 * Though this implementation might run an additional time for if nests.
2035 /* Enumerate instructions used by value's life-ranges
2037 static void ir_block_enumerate(ir_block *self, size_t *_eid)
2041 for (i = 0; i < vec_size(self->instr); ++i)
2043 self->instr[i]->eid = eid++;
2048 /* Enumerate blocks and instructions.
2049 * The block-enumeration is unordered!
2050 * We do not really use the block enumreation, however
2051 * the instruction enumeration is important for life-ranges.
2053 void ir_function_enumerate(ir_function *self)
2056 size_t instruction_id = 1;
2057 for (i = 0; i < vec_size(self->blocks); ++i)
2059 self->blocks[i]->eid = i;
2060 self->blocks[i]->run_id = 0;
2061 ir_block_enumerate(self->blocks[i], &instruction_id);
2065 static bool ir_block_life_propagate(ir_block *b, ir_block *prev, bool *changed);
2066 bool ir_function_calculate_liferanges(ir_function *self)
2071 /* parameters live at 0 */
2072 for (i = 0; i < vec_size(self->params); ++i)
2073 ir_value_life_merge(self->locals[i], 0);
2078 for (i = 0; i != vec_size(self->blocks); ++i)
2080 if (self->blocks[i]->is_return)
2082 vec_free(self->blocks[i]->living);
2083 if (!ir_block_life_propagate(self->blocks[i], NULL, &changed))
2088 if (vec_size(self->blocks)) {
2089 ir_block *block = self->blocks[0];
2090 for (i = 0; i < vec_size(block->living); ++i) {
2091 ir_value *v = block->living[i];
2092 if (v->store != store_local)
2094 if (v->vtype == TYPE_VECTOR)
2096 self->flags |= IR_FLAG_HAS_UNINITIALIZED;
2097 /* find the instruction reading from it */
2098 for (s = 0; s < vec_size(v->reads); ++s) {
2099 if (v->reads[s]->eid == v->life[0].end)
2102 if (s < vec_size(v->reads)) {
2103 if (irwarning(v->context, WARN_USED_UNINITIALIZED,
2104 "variable `%s` may be used uninitialized in this function\n"
2107 v->reads[s]->context.file, v->reads[s]->context.line)
2115 ir_value *vec = v->memberof;
2116 for (s = 0; s < vec_size(vec->reads); ++s) {
2117 if (vec->reads[s]->eid == v->life[0].end)
2120 if (s < vec_size(vec->reads)) {
2121 if (irwarning(v->context, WARN_USED_UNINITIALIZED,
2122 "variable `%s` may be used uninitialized in this function\n"
2125 vec->reads[s]->context.file, vec->reads[s]->context.line)
2133 if (irwarning(v->context, WARN_USED_UNINITIALIZED,
2134 "variable `%s` may be used uninitialized in this function", v->name))
2143 /* Local-value allocator
2144 * After finishing creating the liferange of all values used in a function
2145 * we can allocate their global-positions.
2146 * This is the counterpart to register-allocation in register machines.
2153 } function_allocator;
2155 static bool function_allocator_alloc(function_allocator *alloc, ir_value *var)
2158 size_t vsize = ir_value_sizeof(var);
2160 var->code.local = vec_size(alloc->locals);
2162 slot = ir_value_var("reg", store_global, var->vtype);
2166 if (!ir_value_life_merge_into(slot, var))
2169 vec_push(alloc->locals, slot);
2170 vec_push(alloc->sizes, vsize);
2171 vec_push(alloc->unique, var->unique_life);
2176 ir_value_delete(slot);
2180 static bool ir_function_allocator_assign(ir_function *self, function_allocator *alloc, ir_value *v)
2185 for (a = 0; a < vec_size(alloc->locals); ++a)
2187 /* if it's reserved for a unique liferange: skip */
2188 if (alloc->unique[a])
2191 slot = alloc->locals[a];
2193 /* never resize parameters
2194 * will be required later when overlapping temps + locals
2196 if (a < vec_size(self->params) &&
2197 alloc->sizes[a] < ir_value_sizeof(v))
2202 if (ir_values_overlap(v, slot))
2205 if (!ir_value_life_merge_into(slot, v))
2208 /* adjust size for this slot */
2209 if (alloc->sizes[a] < ir_value_sizeof(v))
2210 alloc->sizes[a] = ir_value_sizeof(v);
2215 if (a >= vec_size(alloc->locals)) {
2216 if (!function_allocator_alloc(alloc, v))
2222 bool ir_function_allocate_locals(ir_function *self)
2227 bool opt_gt = OPTS_OPTIMIZATION(OPTIM_GLOBAL_TEMPS);
2231 function_allocator lockalloc, globalloc;
2233 if (!vec_size(self->locals) && !vec_size(self->values))
2236 globalloc.locals = NULL;
2237 globalloc.sizes = NULL;
2238 globalloc.positions = NULL;
2239 globalloc.unique = NULL;
2240 lockalloc.locals = NULL;
2241 lockalloc.sizes = NULL;
2242 lockalloc.positions = NULL;
2243 lockalloc.unique = NULL;
2245 for (i = 0; i < vec_size(self->locals); ++i)
2247 v = self->locals[i];
2248 if (!OPTS_OPTIMIZATION(OPTIM_LOCAL_TEMPS)) {
2250 v->unique_life = true;
2252 else if (i >= vec_size(self->params))
2255 v->locked = true; /* lock parameters locals */
2256 if (!function_allocator_alloc((v->locked || !opt_gt ? &lockalloc : &globalloc), self->locals[i]))
2259 for (; i < vec_size(self->locals); ++i)
2261 v = self->locals[i];
2262 if (!vec_size(v->life))
2264 if (!ir_function_allocator_assign(self, (v->locked || !opt_gt ? &lockalloc : &globalloc), v))
2268 /* Allocate a slot for any value that still exists */
2269 for (i = 0; i < vec_size(self->values); ++i)
2271 v = self->values[i];
2273 if (!vec_size(v->life))
2276 /* CALL optimization:
2277 * If the value is a parameter-temp: 1 write, 1 read from a CALL
2278 * and it's not "locked", write it to the OFS_PARM directly.
2280 if (OPTS_OPTIMIZATION(OPTIM_CALL_STORES) && !v->locked && !v->unique_life) {
2281 if (vec_size(v->reads) == 1 && vec_size(v->writes) == 1 &&
2282 (v->reads[0]->opcode == VINSTR_NRCALL ||
2283 (v->reads[0]->opcode >= INSTR_CALL0 && v->reads[0]->opcode <= INSTR_CALL8)
2288 ir_instr *call = v->reads[0];
2289 if (!vec_ir_value_find(call->params, v, ¶m)) {
2290 irerror(call->context, "internal error: unlocked parameter %s not found", v->name);
2294 ++opts_optimizationcount[OPTIM_CALL_STORES];
2295 v->callparam = true;
2297 ir_value_code_setaddr(v, OFS_PARM0 + 3*param);
2301 if (vec_size(self->owner->extparam_protos) <= param)
2302 ep = ir_gen_extparam_proto(self->owner);
2304 ep = self->owner->extparam_protos[param];
2305 ir_instr_op(v->writes[0], 0, ep, true);
2306 call->params[param+8] = ep;
2310 if (vec_size(v->writes) == 1 && v->writes[0]->opcode == INSTR_CALL0)
2312 v->store = store_return;
2313 if (v->members[0]) v->members[0]->store = store_return;
2314 if (v->members[1]) v->members[1]->store = store_return;
2315 if (v->members[2]) v->members[2]->store = store_return;
2316 ++opts_optimizationcount[OPTIM_CALL_STORES];
2321 if (!ir_function_allocator_assign(self, (v->locked || !opt_gt ? &lockalloc : &globalloc), v))
2325 if (!lockalloc.sizes && !globalloc.sizes) {
2328 vec_push(lockalloc.positions, 0);
2329 vec_push(globalloc.positions, 0);
2331 /* Adjust slot positions based on sizes */
2332 if (lockalloc.sizes) {
2333 pos = (vec_size(lockalloc.sizes) ? lockalloc.positions[0] : 0);
2334 for (i = 1; i < vec_size(lockalloc.sizes); ++i)
2336 pos = lockalloc.positions[i-1] + lockalloc.sizes[i-1];
2337 vec_push(lockalloc.positions, pos);
2339 self->allocated_locals = pos + vec_last(lockalloc.sizes);
2341 if (globalloc.sizes) {
2342 pos = (vec_size(globalloc.sizes) ? globalloc.positions[0] : 0);
2343 for (i = 1; i < vec_size(globalloc.sizes); ++i)
2345 pos = globalloc.positions[i-1] + globalloc.sizes[i-1];
2346 vec_push(globalloc.positions, pos);
2348 self->globaltemps = pos + vec_last(globalloc.sizes);
2351 /* Locals need to know their new position */
2352 for (i = 0; i < vec_size(self->locals); ++i) {
2353 v = self->locals[i];
2354 if (i >= vec_size(self->params) && !vec_size(v->life))
2356 if (v->locked || !opt_gt)
2357 v->code.local = lockalloc.positions[v->code.local];
2359 v->code.local = globalloc.positions[v->code.local];
2361 /* Take over the actual slot positions on values */
2362 for (i = 0; i < vec_size(self->values); ++i) {
2363 v = self->values[i];
2364 if (!vec_size(v->life))
2366 if (v->locked || !opt_gt)
2367 v->code.local = lockalloc.positions[v->code.local];
2369 v->code.local = globalloc.positions[v->code.local];
2377 for (i = 0; i < vec_size(lockalloc.locals); ++i)
2378 ir_value_delete(lockalloc.locals[i]);
2379 for (i = 0; i < vec_size(globalloc.locals); ++i)
2380 ir_value_delete(globalloc.locals[i]);
2381 vec_free(globalloc.unique);
2382 vec_free(globalloc.locals);
2383 vec_free(globalloc.sizes);
2384 vec_free(globalloc.positions);
2385 vec_free(lockalloc.unique);
2386 vec_free(lockalloc.locals);
2387 vec_free(lockalloc.sizes);
2388 vec_free(lockalloc.positions);
2392 /* Get information about which operand
2393 * is read from, or written to.
2395 static void ir_op_read_write(int op, size_t *read, size_t *write)
2415 case INSTR_STOREP_F:
2416 case INSTR_STOREP_V:
2417 case INSTR_STOREP_S:
2418 case INSTR_STOREP_ENT:
2419 case INSTR_STOREP_FLD:
2420 case INSTR_STOREP_FNC:
2431 static bool ir_block_living_add_instr(ir_block *self, size_t eid)
2434 bool changed = false;
2436 for (i = 0; i != vec_size(self->living); ++i)
2438 tempbool = ir_value_life_merge(self->living[i], eid);
2439 changed = changed || tempbool;
2444 static bool ir_block_living_lock(ir_block *self)
2447 bool changed = false;
2448 for (i = 0; i != vec_size(self->living); ++i)
2450 if (!self->living[i]->locked)
2452 self->living[i]->locked = true;
2457 static bool ir_block_life_prop_previous(ir_block* self, ir_block *prev, bool *changed)
2463 /* values which have been read in a previous iteration are now
2464 * in the "living" array even if the previous block doesn't use them.
2465 * So we have to remove whatever does not exist in the previous block.
2466 * They will be re-added on-read, but the liferange merge won't cause
2468 for (i = 0; i < vec_size(self->living); ++i)
2470 if (!vec_ir_value_find(prev->living, self->living[i], NULL)) {
2471 vec_remove(self->living, i, 1);
2477 /* Whatever the previous block still has in its living set
2478 * must now be added to ours as well.
2480 for (i = 0; i < vec_size(prev->living); ++i)
2482 if (vec_ir_value_find(self->living, prev->living[i], NULL))
2484 vec_push(self->living, prev->living[i]);
2486 irerror(self->contextt from prev: %s", self->label, prev->living[i]->_name);
2492 static bool ir_block_life_propagate(ir_block *self, ir_block *prev, bool *changed)
2497 size_t i, o, p, mem;
2498 /* bitmasks which operands are read from or written to */
2507 if (!ir_block_life_prop_previous(self, prev, changed))
2511 i = vec_size(self->instr);
2514 instr = self->instr[i];
2516 /* See which operands are read and write operands */
2517 ir_op_read_write(instr->opcode, &read, &write);
2519 if (instr->opcode == INSTR_MUL_VF)
2521 /* the float source will get an additional lifetime */
2522 tempbool = ir_value_life_merge(instr->_ops[2], instr->eid+1);
2523 *changed = *changed || tempbool;
2525 else if (instr->opcode == INSTR_MUL_FV)
2527 /* the float source will get an additional lifetime */
2528 tempbool = ir_value_life_merge(instr->_ops[1], instr->eid+1);
2529 *changed = *changed || tempbool;
2532 /* Go through the 3 main operands
2533 * writes first, then reads
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)
2550 /* write operands */
2551 /* When we write to a local, we consider it "dead" for the
2552 * remaining upper part of the function, since in SSA a value
2553 * can only be written once (== created)
2558 bool in_living = vec_ir_value_find(self->living, value, &idx);
2561 /* If the value isn't alive it hasn't been read before... */
2562 /* TODO: See if the warning can be emitted during parsing or AST processing
2563 * otherwise have warning printed here.
2564 * IF printing a warning here: include filecontext_t,
2565 * and make sure it's only printed once
2566 * since this function is run multiple times.
2568 /* con_err( "Value only written %s\n", value->name); */
2569 tempbool = ir_value_life_merge(value, instr->eid);
2570 *changed = *changed || tempbool;
2572 /* since 'living' won't contain it
2573 * anymore, merge the value, since
2576 tempbool = ir_value_life_merge(value, instr->eid);
2577 *changed = *changed || tempbool;
2579 vec_remove(self->living, idx, 1);
2581 /* Removing a vector removes all members */
2582 for (mem = 0; mem < 3; ++mem) {
2583 if (value->members[mem] && vec_ir_value_find(self->living, value->members[mem], &idx)) {
2584 tempbool = ir_value_life_merge(value->members[mem], instr->eid);
2585 *changed = *changed || tempbool;
2586 vec_remove(self->living, idx, 1);
2589 /* Removing the last member removes the vector */
2590 if (value->memberof) {
2591 value = value->memberof;
2592 for (mem = 0; mem < 3; ++mem) {
2593 if (value->members[mem] && vec_ir_value_find(self->living, value->members[mem], NULL))
2596 if (mem == 3 && vec_ir_value_find(self->living, value, &idx)) {
2597 tempbool = ir_value_life_merge(value, instr->eid);
2598 *changed = *changed || tempbool;
2599 vec_remove(self->living, idx, 1);
2605 for (o = 0; o < 3; ++o)
2607 if (!instr->_ops[o]) /* no such operand */
2610 value = instr->_ops[o];
2612 /* We only care about locals */
2613 /* we also calculate parameter liferanges so that locals
2614 * can take up parameter slots */
2615 if (value->store != store_value &&
2616 value->store != store_local &&
2617 value->store != store_param)
2623 if (!vec_ir_value_find(self->living, value, NULL))
2624 vec_push(self->living, value);
2625 /* reading adds the full vector */
2626 if (value->memberof && !vec_ir_value_find(self->living, value->memberof, NULL))
2627 vec_push(self->living, value->memberof);
2628 for (mem = 0; mem < 3; ++mem) {
2629 if (value->members[mem] && !vec_ir_value_find(self->living, value->members[mem], NULL))
2630 vec_push(self->living, value->members[mem]);
2634 /* PHI operands are always read operands */
2635 for (p = 0; p < vec_size(instr->phi); ++p)
2637 value = instr->phi[p].value;
2638 if (!vec_ir_value_find(self->living, value, NULL))
2639 vec_push(self->living, value);
2640 /* reading adds the full vector */
2641 if (value->memberof && !vec_ir_value_find(self->living, value->memberof, NULL))
2642 vec_push(self->living, value->memberof);
2643 for (mem = 0; mem < 3; ++mem) {
2644 if (value->members[mem] && !vec_ir_value_find(self->living, value->members[mem], NULL))
2645 vec_push(self->living, value->members[mem]);
2649 /* on a call, all these values must be "locked" */
2650 if (instr->opcode >= INSTR_CALL0 && instr->opcode <= INSTR_CALL8) {
2651 if (ir_block_living_lock(self))
2654 /* call params are read operands too */
2655 for (p = 0; p < vec_size(instr->params); ++p)
2657 value = instr->params[p];
2658 if (!vec_ir_value_find(self->living, value, NULL))
2659 vec_push(self->living, value);
2660 /* reading adds the full vector */
2661 if (value->memberof && !vec_ir_value_find(self->living, value->memberof, NULL))
2662 vec_push(self->living, value->memberof);
2663 for (mem = 0; mem < 3; ++mem) {
2664 if (value->members[mem] && !vec_ir_value_find(self->living, value->members[mem], NULL))
2665 vec_push(self->living, value->members[mem]);
2670 tempbool = ir_block_living_add_instr(self, instr->eid);
2671 /*con_err( "living added values\n");*/
2672 *changed = *changed || tempbool;
2676 if (self->run_id == self->owner->run_id)
2679 self->run_id = self->owner->run_id;
2681 for (i = 0; i < vec_size(self->entries); ++i)
2683 ir_block *entry = self->entries[i];
2684 ir_block_life_propagate(entry, self, changed);
2690 /***********************************************************************
2693 * Since the IR has the convention of putting 'write' operands
2694 * at the beginning, we have to rotate the operands of instructions
2695 * properly in order to generate valid QCVM code.
2697 * Having destinations at a fixed position is more convenient. In QC
2698 * this is *mostly* OPC, but FTE adds at least 2 instructions which
2699 * read from from OPA, and store to OPB rather than OPC. Which is
2700 * partially the reason why the implementation of these instructions
2701 * in darkplaces has been delayed for so long.
2703 * Breaking conventions is annoying...
2705 static bool ir_builder_gen_global(ir_builder *self, ir_value *global, bool islocal);
2707 static bool gen_global_field(ir_value *global)
2709 if (global->hasvalue)
2711 ir_value *fld = global->constval.vpointer;
2713 irerror(global->context, "Invalid field constant with no field: %s", global->name);
2717 /* copy the field's value */
2718 ir_value_code_setaddr(global, vec_size(code_globals));
2719 vec_push(code_globals, fld->code.fieldaddr);
2720 if (global->fieldtype == TYPE_VECTOR) {
2721 vec_push(code_globals, fld->code.fieldaddr+1);
2722 vec_push(code_globals, fld->code.fieldaddr+2);
2727 ir_value_code_setaddr(global, vec_size(code_globals));
2728 vec_push(code_globals, 0);
2729 if (global->fieldtype == TYPE_VECTOR) {
2730 vec_push(code_globals, 0);
2731 vec_push(code_globals, 0);
2734 if (global->code.globaladdr < 0)
2739 static bool gen_global_pointer(ir_value *global)
2741 if (global->hasvalue)
2743 ir_value *target = global->constval.vpointer;
2745 irerror(global->context, "Invalid pointer constant: %s", global->name);
2746 /* NULL pointers are pointing to the NULL constant, which also
2747 * sits at address 0, but still has an ir_value for itself.
2752 /* Here, relocations ARE possible - in fteqcc-enhanced-qc:
2753 * void() foo; <- proto
2754 * void() *fooptr = &foo;
2755 * void() foo = { code }
2757 if (!target->code.globaladdr) {
2758 /* FIXME: Check for the constant nullptr ir_value!
2759 * because then code.globaladdr being 0 is valid.
2761 irerror(global->context, "FIXME: Relocation support");
2765 ir_value_code_setaddr(global, vec_size(code_globals));
2766 vec_push(code_globals, target->code.globaladdr);
2770 ir_value_code_setaddr(global, vec_size(code_globals));
2771 vec_push(code_globals, 0);
2773 if (global->code.globaladdr < 0)
2778 static bool gen_blocks_recursive(ir_function *func, ir_block *block)
2780 prog_section_statement stmt;
2789 block->generated = true;
2790 block->code_start = vec_size(code_statements);
2791 for (i = 0; i < vec_size(block->instr); ++i)
2793 instr = block->instr[i];
2795 if (instr->opcode == VINSTR_PHI) {
2796 irerror(block->context, "cannot generate virtual instruction (phi)");
2800 if (instr->opcode == VINSTR_JUMP) {
2801 target = instr->bops[0];
2802 /* for uncoditional jumps, if the target hasn't been generated
2803 * yet, we generate them right here.
2805 if (!target->generated) {
2810 /* otherwise we generate a jump instruction */
2811 stmt.opcode = INSTR_GOTO;
2812 stmt.o1.s1 = (target->code_start) - vec_size(code_statements);
2815 if (stmt.o1.s1 != 1)
2816 code_push_statement(&stmt, instr->context.line);
2818 /* no further instructions can be in this block */
2822 if (instr->opcode == VINSTR_COND) {
2823 ontrue = instr->bops[0];
2824 onfalse = instr->bops[1];
2825 /* TODO: have the AST signal which block should
2826 * come first: eg. optimize IFs without ELSE...
2829 stmt.o1.u1 = ir_value_code_addr(instr->_ops[0]);
2833 if (ontrue->generated) {
2834 stmt.opcode = INSTR_IF;
2835 stmt.o2.s1 = (ontrue->code_start) - vec_size(code_statements);
2836 if (stmt.o2.s1 != 1)
2837 code_push_statement(&stmt, instr->context.line);
2839 if (onfalse->generated) {
2840 stmt.opcode = INSTR_IFNOT;
2841 stmt.o2.s1 = (onfalse->code_start) - vec_size(code_statements);
2842 if (stmt.o2.s1 != 1)
2843 code_push_statement(&stmt, instr->context.line);
2845 if (!ontrue->generated) {
2846 if (onfalse->generated) {
2851 if (!onfalse->generated) {
2852 if (ontrue->generated) {
2857 /* neither ontrue nor onfalse exist */
2858 stmt.opcode = INSTR_IFNOT;
2859 if (!instr->likely) {
2860 /* Honor the likelyhood hint */
2861 ir_block *tmp = onfalse;
2862 stmt.opcode = INSTR_IF;
2866 stidx = vec_size(code_statements);
2867 code_push_statement(&stmt, instr->context.line);
2868 /* on false we jump, so add ontrue-path */
2869 if (!gen_blocks_recursive(func, ontrue))
2871 /* fixup the jump address */
2872 code_statements[stidx].o2.s1 = vec_size(code_statements) - stidx;
2873 /* generate onfalse path */
2874 if (onfalse->generated) {
2875 /* fixup the jump address */
2876 code_statements[stidx].o2.s1 = (onfalse->code_start) - (stidx);
2877 if (code_statements[stidx].o2.s1 == 1) {
2878 code_statements[stidx] = code_statements[stidx+1];
2879 if (code_statements[stidx].o1.s1 < 0)
2880 code_statements[stidx].o1.s1++;
2881 code_pop_statement();
2883 stmt.opcode = vec_last(code_statements).opcode;
2884 if (stmt.opcode == INSTR_GOTO ||
2885 stmt.opcode == INSTR_IF ||
2886 stmt.opcode == INSTR_IFNOT ||
2887 stmt.opcode == INSTR_RETURN ||
2888 stmt.opcode == INSTR_DONE)
2890 /* no use jumping from here */
2893 /* may have been generated in the previous recursive call */
2894 stmt.opcode = INSTR_GOTO;
2895 stmt.o1.s1 = (onfalse->code_start) - vec_size(code_statements);
2898 if (stmt.o1.s1 != 1)
2899 code_push_statement(&stmt, instr->context.line);
2902 else if (code_statements[stidx].o2.s1 == 1) {
2903 code_statements[stidx] = code_statements[stidx+1];
2904 if (code_statements[stidx].o1.s1 < 0)
2905 code_statements[stidx].o1.s1++;
2906 code_pop_statement();
2908 /* if not, generate now */
2913 if ( (instr->opcode >= INSTR_CALL0 && instr->opcode <= INSTR_CALL8)
2914 || instr->opcode == VINSTR_NRCALL)
2919 first = vec_size(instr->params);
2922 for (p = 0; p < first; ++p)
2924 ir_value *param = instr->params[p];
2925 if (param->callparam)
2928 stmt.opcode = INSTR_STORE_F;
2931 if (param->vtype == TYPE_FIELD)
2932 stmt.opcode = field_store_instr[param->fieldtype];
2934 stmt.opcode = type_store_instr[param->vtype];
2935 stmt.o1.u1 = ir_value_code_addr(param);
2936 stmt.o2.u1 = OFS_PARM0 + 3 * p;
2937 code_push_statement(&stmt, instr->context.line);
2939 /* Now handle extparams */
2940 first = vec_size(instr->params);
2941 for (; p < first; ++p)
2943 ir_builder *ir = func->owner;
2944 ir_value *param = instr->params[p];
2945 ir_value *targetparam;
2947 if (param->callparam)
2950 if (p-8 >= vec_size(ir->extparams))
2951 ir_gen_extparam(ir);
2953 targetparam = ir->extparams[p-8];
2955 stmt.opcode = INSTR_STORE_F;
2958 if (param->vtype == TYPE_FIELD)
2959 stmt.opcode = field_store_instr[param->fieldtype];
2961 stmt.opcode = type_store_instr[param->vtype];
2962 stmt.o1.u1 = ir_value_code_addr(param);
2963 stmt.o2.u1 = ir_value_code_addr(targetparam);
2964 code_push_statement(&stmt, instr->context.line);
2967 stmt.opcode = INSTR_CALL0 + vec_size(instr->params);
2968 if (stmt.opcode > INSTR_CALL8)
2969 stmt.opcode = INSTR_CALL8;
2970 stmt.o1.u1 = ir_value_code_addr(instr->_ops[1]);
2973 code_push_statement(&stmt, instr->context.line);
2975 retvalue = instr->_ops[0];
2976 if (retvalue && retvalue->store != store_return &&
2977 (retvalue->store == store_global || vec_size(retvalue->life)))
2979 /* not to be kept in OFS_RETURN */
2980 if (retvalue->vtype == TYPE_FIELD && OPTS_FLAG(ADJUST_VECTOR_FIELDS))
2981 stmt.opcode = field_store_instr[retvalue->fieldtype];
2983 stmt.opcode = type_store_instr[retvalue->vtype];
2984 stmt.o1.u1 = OFS_RETURN;
2985 stmt.o2.u1 = ir_value_code_addr(retvalue);
2987 code_push_statement(&stmt, instr->context.line);
2992 if (instr->opcode == INSTR_STATE) {
2993 irerror(block->context, "TODO: state instruction");
2997 stmt.opcode = instr->opcode;
3002 /* This is the general order of operands */
3004 stmt.o3.u1 = ir_value_code_addr(instr->_ops[0]);
3007 stmt.o1.u1 = ir_value_code_addr(instr->_ops[1]);
3010 stmt.o2.u1 = ir_value_code_addr(instr->_ops[2]);
3012 if (stmt.opcode == INSTR_RETURN || stmt.opcode == INSTR_DONE)
3014 stmt.o1.u1 = stmt.o3.u1;
3017 else if ((stmt.opcode >= INSTR_STORE_F &&
3018 stmt.opcode <= INSTR_STORE_FNC) ||
3019 (stmt.opcode >= INSTR_STOREP_F &&
3020 stmt.opcode <= INSTR_STOREP_FNC))
3022 /* 2-operand instructions with A -> B */
3023 stmt.o2.u1 = stmt.o3.u1;
3026 /* tiny optimization, don't output
3029 if (stmt.o2.u1 == stmt.o1.u1 &&
3030 OPTS_OPTIMIZATION(OPTIM_PEEPHOLE))
3032 ++opts_optimizationcount[OPTIM_PEEPHOLE];
3037 code_push_statement(&stmt, instr->context.line);
3042 static bool gen_function_code(ir_function *self)
3045 prog_section_statement stmt, *retst;
3047 /* Starting from entry point, we generate blocks "as they come"
3048 * for now. Dead blocks will not be translated obviously.
3050 if (!vec_size(self->blocks)) {
3051 irerror(self->context, "Function '%s' declared without body.", self->name);
3055 block = self->blocks[0];
3056 if (block->generated)
3059 if (!gen_blocks_recursive(self, block)) {
3060 irerror(self->context, "failed to generate blocks for '%s'", self->name);
3064 /* code_write and qcvm -disasm need to know that the function ends here */
3065 retst = &vec_last(code_statements);
3066 if (OPTS_OPTIMIZATION(OPTIM_VOID_RETURN) &&
3067 self->outtype == TYPE_VOID &&
3068 retst->opcode == INSTR_RETURN &&
3069 !retst->o1.u1 && !retst->o2.u1 && !retst->o3.u1)
3071 retst->opcode = INSTR_DONE;
3072 ++opts_optimizationcount[OPTIM_VOID_RETURN];
3074 stmt.opcode = INSTR_DONE;
3078 code_push_statement(&stmt, vec_last(code_linenums));
3083 static qcint ir_builder_filestring(ir_builder *ir, const char *filename)
3085 /* NOTE: filename pointers are copied, we never strdup them,
3086 * thus we can use pointer-comparison to find the string.
3091 for (i = 0; i < vec_size(ir->filenames); ++i) {
3092 if (ir->filenames[i] == filename)
3093 return ir->filestrings[i];
3096 str = code_genstring(filename);
3097 vec_push(ir->filenames, filename);
3098 vec_push(ir->filestrings, str);
3102 static bool gen_global_function(ir_builder *ir, ir_value *global)
3104 prog_section_function fun;
3109 if (!global->hasvalue || (!global->constval.vfunc))
3111 irerror(global->context, "Invalid state of function-global: not constant: %s", global->name);
3115 irfun = global->constval.vfunc;
3117 fun.name = global->code.name;
3118 fun.file = ir_builder_filestring(ir, global->context.file);
3119 fun.profile = 0; /* always 0 */
3120 fun.nargs = vec_size(irfun->params);
3124 for (i = 0;i < 8; ++i) {
3125 if ((int32_t)i >= fun.nargs)
3128 fun.argsize[i] = type_sizeof_[irfun->params[i]];
3132 fun.locals = irfun->allocated_locals;
3135 fun.entry = irfun->builtin+1;
3137 irfun->code_function_def = vec_size(code_functions);
3138 fun.entry = vec_size(code_statements);
3141 vec_push(code_functions, fun);
3145 static ir_value* ir_gen_extparam_proto(ir_builder *ir)
3150 snprintf(name, sizeof(name), "EXTPARM#%i", (int)(vec_size(ir->extparam_protos)+8));
3151 global = ir_value_var(name, store_global, TYPE_VECTOR);
3153 vec_push(ir->extparam_protos, global);
3157 static void ir_gen_extparam(ir_builder *ir)
3159 prog_section_def def;
3162 if (vec_size(ir->extparam_protos) < vec_size(ir->extparams)+1)
3163 global = ir_gen_extparam_proto(ir);
3165 global = ir->extparam_protos[vec_size(ir->extparams)];
3167 def.name = code_genstring(global->name);
3168 def.type = TYPE_VECTOR;
3169 def.offset = vec_size(code_globals);
3171 vec_push(code_defs, def);
3172 ir_value_code_setaddr(global, def.offset);
3173 vec_push(code_globals, 0);
3174 vec_push(code_globals, 0);
3175 vec_push(code_globals, 0);
3177 vec_push(ir->extparams, global);
3180 static bool gen_function_extparam_copy(ir_function *self)
3182 size_t i, ext, numparams;
3184 ir_builder *ir = self->owner;
3186 prog_section_statement stmt;
3188 numparams = vec_size(self->params);
3192 stmt.opcode = INSTR_STORE_F;
3194 for (i = 8; i < numparams; ++i) {
3196 if (ext >= vec_size(ir->extparams))
3197 ir_gen_extparam(ir);
3199 ep = ir->extparams[ext];
3201 stmt.opcode = type_store_instr[self->locals[i]->vtype];
3202 if (self->locals[i]->vtype == TYPE_FIELD &&
3203 self->locals[i]->fieldtype == TYPE_VECTOR)
3205 stmt.opcode = INSTR_STORE_V;
3207 stmt.o1.u1 = ir_value_code_addr(ep);
3208 stmt.o2.u1 = ir_value_code_addr(self->locals[i]);
3209 code_push_statement(&stmt, self->context.line);
3215 static bool gen_function_locals(ir_builder *ir, ir_value *global)
3217 prog_section_function *def;
3220 uint32_t firstlocal, firstglobal;
3222 irfun = global->constval.vfunc;
3223 def = code_functions + irfun->code_function_def;
3225 if (opts.g || !OPTS_OPTIMIZATION(OPTIM_OVERLAP_LOCALS) || (irfun->flags & IR_FLAG_MASK_NO_OVERLAP))
3226 firstlocal = def->firstlocal = vec_size(code_globals);
3228 firstlocal = def->firstlocal = ir->first_common_local;
3229 ++opts_optimizationcount[OPTIM_OVERLAP_LOCALS];
3232 firstglobal = (OPTS_OPTIMIZATION(OPTIM_GLOBAL_TEMPS) ? ir->first_common_globaltemp : firstlocal);
3234 for (i = vec_size(code_globals); i < firstlocal + irfun->allocated_locals; ++i)
3235 vec_push(code_globals, 0);
3236 for (i = 0; i < vec_size(irfun->locals); ++i) {
3237 ir_value *v = irfun->locals[i];
3238 if (v->locked || !OPTS_OPTIMIZATION(OPTIM_GLOBAL_TEMPS)) {
3239 ir_value_code_setaddr(v, firstlocal + v->code.local);
3240 if (!ir_builder_gen_global(ir, irfun->locals[i], true)) {
3241 irerror(irfun->locals[i]->context, "failed to generate local %s", irfun->locals[i]->name);
3246 ir_value_code_setaddr(v, firstglobal + v->code.local);
3248 for (i = 0; i < vec_size(irfun->values); ++i)
3250 ir_value *v = irfun->values[i];
3254 ir_value_code_setaddr(v, firstlocal + v->code.local);
3256 ir_value_code_setaddr(v, firstglobal + v->code.local);
3261 static bool gen_global_function_code(ir_builder *ir, ir_value *global)
3263 prog_section_function *fundef;
3268 irfun = global->constval.vfunc;
3270 if (global->cvq == CV_NONE) {
3271 irwarning(global->context, WARN_IMPLICIT_FUNCTION_POINTER,
3272 "function `%s` has no body and in QC implicitly becomes a function-pointer", global->name);
3274 /* this was a function pointer, don't generate code for those */
3281 if (irfun->code_function_def < 0) {
3282 irerror(irfun->context, "`%s`: IR global wasn't generated, failed to access function-def", irfun->name);
3285 fundef = &code_functions[irfun->code_function_def];
3287 fundef->entry = vec_size(code_statements);
3288 if (!gen_function_locals(ir, global)) {
3289 irerror(irfun->context, "Failed to generate locals for function %s", irfun->name);
3292 if (!gen_function_extparam_copy(irfun)) {
3293 irerror(irfun->context, "Failed to generate extparam-copy code for function %s", irfun->name);
3296 if (!gen_function_code(irfun)) {
3297 irerror(irfun->context, "Failed to generate code for function %s", irfun->name);
3303 static void gen_vector_defs(prog_section_def def, const char *name)
3308 if (!name || name[0] == '#' || OPTS_FLAG(SINGLE_VECTOR_DEFS))
3311 def.type = TYPE_FLOAT;
3315 component = (char*)mem_a(len+3);
3316 memcpy(component, name, len);
3318 component[len-0] = 0;
3319 component[len-2] = '_';
3321 component[len-1] = 'x';
3323 for (i = 0; i < 3; ++i) {
3324 def.name = code_genstring(component);
3325 vec_push(code_defs, def);
3331 static void gen_vector_fields(prog_section_field fld, const char *name)
3336 if (!name || OPTS_FLAG(SINGLE_VECTOR_DEFS))
3339 fld.type = TYPE_FLOAT;
3343 component = (char*)mem_a(len+3);
3344 memcpy(component, name, len);
3346 component[len-0] = 0;
3347 component[len-2] = '_';
3349 component[len-1] = 'x';
3351 for (i = 0; i < 3; ++i) {
3352 fld.name = code_genstring(component);
3353 vec_push(code_fields, fld);
3359 static bool ir_builder_gen_global(ir_builder *self, ir_value *global, bool islocal)
3363 prog_section_def def;
3364 bool pushdef = false;
3366 def.type = global->vtype;
3367 def.offset = vec_size(code_globals);
3369 if (opts.g || !islocal)
3373 if (OPTS_OPTIMIZATION(OPTIM_STRIP_CONSTANT_NAMES) &&
3374 (global->name[0] == '#' || global->cvq == CV_CONST))
3379 if (pushdef && global->name) {
3380 if (global->name[0] == '#') {
3381 if (!self->str_immediate)
3382 self->str_immediate = code_genstring("IMMEDIATE");
3383 def.name = global->code.name = self->str_immediate;
3386 def.name = global->code.name = code_genstring(global->name);
3391 def.offset = ir_value_code_addr(global);
3392 vec_push(code_defs, def);
3393 if (global->vtype == TYPE_VECTOR)
3394 gen_vector_defs(def, global->name);
3395 else if (global->vtype == TYPE_FIELD && global->fieldtype == TYPE_VECTOR)
3396 gen_vector_defs(def, global->name);
3403 switch (global->vtype)
3406 if (!strcmp(global->name, "end_sys_globals")) {
3407 /* TODO: remember this point... all the defs before this one
3408 * should be checksummed and added to progdefs.h when we generate it.
3411 else if (!strcmp(global->name, "end_sys_fields")) {
3412 /* TODO: same as above but for entity-fields rather than globsl
3416 irwarning(global->context, WARN_VOID_VARIABLES, "unrecognized variable of type void `%s`",
3418 /* I'd argue setting it to 0 is sufficient, but maybe some depend on knowing how far
3419 * the system fields actually go? Though the engine knows this anyway...
3420 * Maybe this could be an -foption
3421 * fteqcc creates data for end_sys_* - of size 1, so let's do the same
3423 ir_value_code_setaddr(global, vec_size(code_globals));
3424 vec_push(code_globals, 0);
3426 if (pushdef) vec_push(code_defs, def);
3429 if (pushdef) vec_push(code_defs, def);
3430 return gen_global_pointer(global);
3433 vec_push(code_defs, def);
3434 if (global->fieldtype == TYPE_VECTOR)
3435 gen_vector_defs(def, global->name);
3437 return gen_global_field(global);
3442 ir_value_code_setaddr(global, vec_size(code_globals));
3443 if (global->hasvalue) {
3444 iptr = (int32_t*)&global->constval.ivec[0];
3445 vec_push(code_globals, *iptr);
3447 vec_push(code_globals, 0);
3449 if (!islocal && global->cvq != CV_CONST)
3450 def.type |= DEF_SAVEGLOBAL;
3451 if (pushdef) vec_push(code_defs, def);
3453 return global->code.globaladdr >= 0;
3457 ir_value_code_setaddr(global, vec_size(code_globals));
3458 if (global->hasvalue) {
3459 vec_push(code_globals, code_genstring(global->constval.vstring));
3461 vec_push(code_globals, 0);
3463 if (!islocal && global->cvq != CV_CONST)
3464 def.type |= DEF_SAVEGLOBAL;
3465 if (pushdef) vec_push(code_defs, def);
3466 return global->code.globaladdr >= 0;
3471 ir_value_code_setaddr(global, vec_size(code_globals));
3472 if (global->hasvalue) {
3473 iptr = (int32_t*)&global->constval.ivec[0];
3474 vec_push(code_globals, iptr[0]);
3475 if (global->code.globaladdr < 0)
3477 for (d = 1; d < type_sizeof_[global->vtype]; ++d) {
3478 vec_push(code_globals, iptr[d]);
3481 vec_push(code_globals, 0);
3482 if (global->code.globaladdr < 0)
3484 for (d = 1; d < type_sizeof_[global->vtype]; ++d) {
3485 vec_push(code_globals, 0);
3488 if (!islocal && global->cvq != CV_CONST)
3489 def.type |= DEF_SAVEGLOBAL;
3492 vec_push(code_defs, def);
3493 def.type &= ~DEF_SAVEGLOBAL;
3494 gen_vector_defs(def, global->name);
3496 return global->code.globaladdr >= 0;
3499 ir_value_code_setaddr(global, vec_size(code_globals));
3500 if (!global->hasvalue) {
3501 vec_push(code_globals, 0);
3502 if (global->code.globaladdr < 0)
3505 vec_push(code_globals, vec_size(code_functions));
3506 if (!gen_global_function(self, global))
3509 if (!islocal && global->cvq != CV_CONST)
3510 def.type |= DEF_SAVEGLOBAL;
3511 if (pushdef) vec_push(code_defs, def);
3514 /* assume biggest type */
3515 ir_value_code_setaddr(global, vec_size(code_globals));
3516 vec_push(code_globals, 0);
3517 for (i = 1; i < type_sizeof_[TYPE_VARIANT]; ++i)
3518 vec_push(code_globals, 0);
3521 /* refuse to create 'void' type or any other fancy business. */
3522 irerror(global->context, "Invalid type for global variable `%s`: %s",
3523 global->name, type_name[global->vtype]);
3528 static void ir_builder_prepare_field(ir_value *field)
3530 field->code.fieldaddr = code_alloc_field(type_sizeof_[field->fieldtype]);
3533 static bool ir_builder_gen_field(ir_builder *self, ir_value *field)
3535 prog_section_def def;
3536 prog_section_field fld;
3540 def.type = (uint16_t)field->vtype;
3541 def.offset = (uint16_t)vec_size(code_globals);
3543 /* create a global named the same as the field */
3544 if (opts.standard == COMPILER_GMQCC) {
3545 /* in our standard, the global gets a dot prefix */
3546 size_t len = strlen(field->name);
3549 /* we really don't want to have to allocate this, and 1024
3550 * bytes is more than enough for a variable/field name
3552 if (len+2 >= sizeof(name)) {
3553 irerror(field->context, "invalid field name size: %u", (unsigned int)len);
3558 memcpy(name+1, field->name, len); /* no strncpy - we used strlen above */
3561 def.name = code_genstring(name);
3562 fld.name = def.name + 1; /* we reuse that string table entry */
3564 /* in plain QC, there cannot be a global with the same name,
3565 * and so we also name the global the same.
3566 * FIXME: fteqcc should create a global as well
3567 * check if it actually uses the same name. Probably does
3569 def.name = code_genstring(field->name);
3570 fld.name = def.name;
3573 field->code.name = def.name;
3575 vec_push(code_defs, def);
3577 fld.type = field->fieldtype;
3579 if (fld.type == TYPE_VOID) {
3580 irerror(field->context, "field is missing a type: %s - don't know its size", field->name);
3584 fld.offset = field->code.fieldaddr;
3586 vec_push(code_fields, fld);
3588 ir_value_code_setaddr(field, vec_size(code_globals));
3589 vec_push(code_globals, fld.offset);
3590 if (fld.type == TYPE_VECTOR) {
3591 vec_push(code_globals, fld.offset+1);
3592 vec_push(code_globals, fld.offset+2);
3595 if (field->fieldtype == TYPE_VECTOR) {
3596 gen_vector_defs(def, field->name);
3597 gen_vector_fields(fld, field->name);
3600 return field->code.globaladdr >= 0;
3603 bool ir_builder_generate(ir_builder *self, const char *filename)
3605 prog_section_statement stmt;
3607 char *lnofile = NULL;
3611 for (i = 0; i < vec_size(self->fields); ++i)
3613 ir_builder_prepare_field(self->fields[i]);
3616 for (i = 0; i < vec_size(self->globals); ++i)
3618 if (!ir_builder_gen_global(self, self->globals[i], false)) {
3621 if (self->globals[i]->vtype == TYPE_FUNCTION) {
3622 ir_function *func = self->globals[i]->constval.vfunc;
3623 if (func && self->max_locals < func->allocated_locals &&
3624 !(func->flags & IR_FLAG_MASK_NO_OVERLAP))
3626 self->max_locals = func->allocated_locals;
3628 if (func && self->max_globaltemps < func->globaltemps)
3629 self->max_globaltemps = func->globaltemps;
3633 for (i = 0; i < vec_size(self->fields); ++i)
3635 if (!ir_builder_gen_field(self, self->fields[i])) {
3640 /* generate global temps */
3641 self->first_common_globaltemp = vec_size(code_globals);
3642 for (i = 0; i < self->max_globaltemps; ++i) {
3643 vec_push(code_globals, 0);
3645 /* generate common locals */
3646 self->first_common_local = vec_size(code_globals);
3647 for (i = 0; i < self->max_locals; ++i) {
3648 vec_push(code_globals, 0);
3651 /* generate function code */
3652 for (i = 0; i < vec_size(self->globals); ++i)
3654 if (self->globals[i]->vtype == TYPE_FUNCTION) {
3655 if (!gen_global_function_code(self, self->globals[i])) {
3661 if (vec_size(code_globals) >= 65536) {
3662 irerror(vec_last(self->globals)->context, "This progs file would require more globals than the metadata can handle. Bailing out.");
3666 /* DP errors if the last instruction is not an INSTR_DONE. */
3667 if (vec_last(code_statements).opcode != INSTR_DONE)
3669 stmt.opcode = INSTR_DONE;
3673 code_push_statement(&stmt, vec_last(code_linenums));
3679 if (vec_size(code_statements) != vec_size(code_linenums)) {
3680 con_err("Linecounter wrong: %lu != %lu\n",
3681 (unsigned long)vec_size(code_statements),
3682 (unsigned long)vec_size(code_linenums));
3683 } else if (OPTS_FLAG(LNO)) {
3685 size_t filelen = strlen(filename);
3687 memcpy(vec_add(lnofile, filelen+1), filename, filelen+1);
3688 dot = strrchr(lnofile, '.');
3692 vec_shrinkto(lnofile, dot - lnofile);
3694 memcpy(vec_add(lnofile, 5), ".lno", 5);
3699 con_out("writing '%s' and '%s'...\n", filename, lnofile);
3701 con_out("writing '%s'\n", filename);
3703 if (!code_write(filename, lnofile)) {
3711 /***********************************************************************
3712 *IR DEBUG Dump functions...
3715 #define IND_BUFSZ 1024
3718 # define strncat(dst, src, sz) strncat_s(dst, sz, src, _TRUNCATE)
3721 const char *qc_opname(int op)
3723 if (op < 0) return "<INVALID>";
3724 if (op < (int)( sizeof(asm_instr) / sizeof(asm_instr[0]) ))
3725 return asm_instr[op].m;
3727 case VINSTR_PHI: return "PHI";
3728 case VINSTR_JUMP: return "JUMP";
3729 case VINSTR_COND: return "COND";
3730 default: return "<UNK>";
3734 void ir_builder_dump(ir_builder *b, int (*oprintf)(const char*, ...))
3737 char indent[IND_BUFSZ];
3741 oprintf("module %s\n", b->name);
3742 for (i = 0; i < vec_size(b->globals); ++i)
3745 if (b->globals[i]->hasvalue)
3746 oprintf("%s = ", b->globals[i]->name);
3747 ir_value_dump(b->globals[i], oprintf);
3750 for (i = 0; i < vec_size(b->functions); ++i)
3751 ir_function_dump(b->functions[i], indent, oprintf);
3752 oprintf("endmodule %s\n", b->name);
3755 void ir_function_dump(ir_function *f, char *ind,
3756 int (*oprintf)(const char*, ...))
3759 if (f->builtin != 0) {
3760 oprintf("%sfunction %s = builtin %i\n", ind, f->name, -f->builtin);
3763 oprintf("%sfunction %s\n", ind, f->name);
3764 strncat(ind, "\t", IND_BUFSZ);
3765 if (vec_size(f->locals))
3767 oprintf("%s%i locals:\n", ind, (int)vec_size(f->locals));
3768 for (i = 0; i < vec_size(f->locals); ++i) {
3769 oprintf("%s\t", ind);
3770 ir_value_dump(f->locals[i], oprintf);
3774 oprintf("%sliferanges:\n", ind);
3775 for (i = 0; i < vec_size(f->locals); ++i) {
3776 const char *attr = "";
3778 ir_value *v = f->locals[i];
3779 if (v->unique_life && v->locked)
3780 attr = "unique,locked ";
3781 else if (v->unique_life)
3785 oprintf("%s\t%s: %s %s@%i ", ind, v->name, type_name[v->vtype], attr, (int)v->code.local);
3786 for (l = 0; l < vec_size(v->life); ++l) {
3787 oprintf("[%i,%i] ", v->life[l].start, v->life[l].end);
3790 for (m = 0; m < 3; ++m) {
3791 ir_value *vm = v->members[m];
3794 if (vm->unique_life && vm->locked)
3795 attr = "unique,locked ";
3796 else if (vm->unique_life)
3798 else if (vm->locked)
3800 oprintf("%s\t%s: %s@%i ", ind, vm->name, attr, (int)vm->code.local);
3801 for (l = 0; l < vec_size(vm->life); ++l) {
3802 oprintf("[%i,%i] ", vm->life[l].start, vm->life[l].end);
3807 for (i = 0; i < vec_size(f->values); ++i) {
3808 const char *attr = "";
3810 ir_value *v = f->values[i];
3811 if (v->unique_life && v->locked)
3812 attr = "unique,locked ";
3813 else if (v->unique_life)
3817 oprintf("%s\t%s: %s %s@%i ", ind, v->name, type_name[v->vtype], attr, (int)v->code.local);
3818 for (l = 0; l < vec_size(v->life); ++l) {
3819 oprintf("[%i,%i] ", v->life[l].start, v->life[l].end);
3822 for (m = 0; m < 3; ++m) {
3823 ir_value *vm = v->members[m];
3826 if (vm->unique_life && vm->locked)
3827 attr = "unique,locked ";
3828 else if (vm->unique_life)
3830 else if (vm->locked)
3832 oprintf("%s\t%s: %s@%i ", ind, vm->name, attr, (int)vm->code.local);
3833 for (l = 0; l < vec_size(vm->life); ++l) {
3834 oprintf("[%i,%i] ", vm->life[l].start, vm->life[l].end);
3839 if (vec_size(f->blocks))
3841 oprintf("%slife passes (check): %i\n", ind, (int)f->run_id);
3842 for (i = 0; i < vec_size(f->blocks); ++i) {
3843 if (f->blocks[i]->run_id != f->run_id) {
3844 oprintf("%slife pass check fail! %i != %i\n", ind, (int)f->blocks[i]->run_id, (int)f->run_id);
3846 ir_block_dump(f->blocks[i], ind, oprintf);
3850 ind[strlen(ind)-1] = 0;
3851 oprintf("%sendfunction %s\n", ind, f->name);
3854 void ir_block_dump(ir_block* b, char *ind,
3855 int (*oprintf)(const char*, ...))
3858 oprintf("%s:%s\n", ind, b->label);
3859 strncat(ind, "\t", IND_BUFSZ);
3861 for (i = 0; i < vec_size(b->instr); ++i)
3862 ir_instr_dump(b->instr[i], ind, oprintf);
3863 ind[strlen(ind)-1] = 0;
3866 void dump_phi(ir_instr *in, int (*oprintf)(const char*, ...))
3869 oprintf("%s <- phi ", in->_ops[0]->name);
3870 for (i = 0; i < vec_size(in->phi); ++i)
3872 oprintf("([%s] : %s) ", in->phi[i].from->label,
3873 in->phi[i].value->name);
3878 void ir_instr_dump(ir_instr *in, char *ind,
3879 int (*oprintf)(const char*, ...))
3882 const char *comma = NULL;
3884 oprintf("%s (%i) ", ind, (int)in->eid);
3886 if (in->opcode == VINSTR_PHI) {
3887 dump_phi(in, oprintf);
3891 strncat(ind, "\t", IND_BUFSZ);
3893 if (in->_ops[0] && (in->_ops[1] || in->_ops[2])) {
3894 ir_value_dump(in->_ops[0], oprintf);
3895 if (in->_ops[1] || in->_ops[2])
3898 if (in->opcode == INSTR_CALL0 || in->opcode == VINSTR_NRCALL) {
3899 oprintf("CALL%i\t", vec_size(in->params));
3901 oprintf("%s\t", qc_opname(in->opcode));
3903 if (in->_ops[0] && !(in->_ops[1] || in->_ops[2])) {
3904 ir_value_dump(in->_ops[0], oprintf);
3909 for (i = 1; i != 3; ++i) {
3913 ir_value_dump(in->_ops[i], oprintf);
3921 oprintf("[%s]", in->bops[0]->label);
3925 oprintf("%s[%s]", comma, in->bops[1]->label);
3926 if (vec_size(in->params)) {
3927 oprintf("\tparams: ");
3928 for (i = 0; i != vec_size(in->params); ++i) {
3929 oprintf("%s, ", in->params[i]->name);
3933 ind[strlen(ind)-1] = 0;
3936 void ir_value_dump_string(const char *str, int (*oprintf)(const char*, ...))
3939 for (; *str; ++str) {
3941 case '\n': oprintf("\\n"); break;
3942 case '\r': oprintf("\\r"); break;
3943 case '\t': oprintf("\\t"); break;
3944 case '\v': oprintf("\\v"); break;
3945 case '\f': oprintf("\\f"); break;
3946 case '\b': oprintf("\\b"); break;
3947 case '\a': oprintf("\\a"); break;
3948 case '\\': oprintf("\\\\"); break;
3949 case '"': oprintf("\\\""); break;
3950 default: oprintf("%c", *str); break;
3956 void ir_value_dump(ir_value* v, int (*oprintf)(const char*, ...))
3965 oprintf("fn:%s", v->name);
3968 oprintf("%g", v->constval.vfloat);
3971 oprintf("'%g %g %g'",
3974 v->constval.vvec.z);
3977 oprintf("(entity)");
3980 ir_value_dump_string(v->constval.vstring, oprintf);
3984 oprintf("%i", v->constval.vint);
3989 v->constval.vpointer->name);
3993 oprintf("%s", v->name);
3997 void ir_value_dump_life(const ir_value *self, int (*oprintf)(const char*,...))
4000 oprintf("Life of %12s:", self->name);
4001 for (i = 0; i < vec_size(self->life); ++i)
4003 oprintf(" + [%i, %i]\n", self->life[i].start, self->life[i].end);