5 * Permission is hereby granted, free of charge, to any person obtaining a copy of
6 * this software and associated documentation files (the "Software"), to deal in
7 * the Software without restriction, including without limitation the rights to
8 * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
9 * of the Software, and to permit persons to whom the Software is furnished to do
10 * so, subject to the following conditions:
12 * The above copyright notice and this permission notice shall be included in all
13 * copies or substantial portions of the Software.
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
28 /***********************************************************************
29 * Type sizes used at multiple points in the IR codegen
32 const char *type_name[TYPE_COUNT] = {
48 size_t type_sizeof_[TYPE_COUNT] = {
55 1, /* TYPE_FUNCTION */
64 uint16_t type_store_instr[TYPE_COUNT] = {
65 INSTR_STORE_F, /* should use I when having integer support */
72 INSTR_STORE_ENT, /* should use I */
74 INSTR_STORE_I, /* integer type */
79 INSTR_STORE_V, /* variant, should never be accessed */
81 AINSTR_END, /* struct */
82 AINSTR_END, /* union */
83 AINSTR_END, /* array */
86 uint16_t field_store_instr[TYPE_COUNT] = {
96 INSTR_STORE_FLD, /* integer type */
101 INSTR_STORE_V, /* variant, should never be accessed */
103 AINSTR_END, /* struct */
104 AINSTR_END, /* union */
105 AINSTR_END, /* array */
108 uint16_t type_storep_instr[TYPE_COUNT] = {
109 INSTR_STOREP_F, /* should use I when having integer support */
116 INSTR_STOREP_ENT, /* should use I */
118 INSTR_STOREP_ENT, /* integer type */
123 INSTR_STOREP_V, /* variant, should never be accessed */
125 AINSTR_END, /* struct */
126 AINSTR_END, /* union */
127 AINSTR_END, /* array */
130 uint16_t type_eq_instr[TYPE_COUNT] = {
131 INSTR_EQ_F, /* should use I when having integer support */
136 INSTR_EQ_E, /* FLD has no comparison */
138 INSTR_EQ_E, /* should use I */
145 INSTR_EQ_V, /* variant, should never be accessed */
147 AINSTR_END, /* struct */
148 AINSTR_END, /* union */
149 AINSTR_END, /* array */
152 uint16_t type_ne_instr[TYPE_COUNT] = {
153 INSTR_NE_F, /* should use I when having integer support */
158 INSTR_NE_E, /* FLD has no comparison */
160 INSTR_NE_E, /* should use I */
167 INSTR_NE_V, /* variant, should never be accessed */
169 AINSTR_END, /* struct */
170 AINSTR_END, /* union */
171 AINSTR_END, /* array */
174 uint16_t type_not_instr[TYPE_COUNT] = {
175 INSTR_NOT_F, /* should use I when having integer support */
182 INSTR_NOT_ENT, /* should use I */
184 INSTR_NOT_I, /* integer type */
189 INSTR_NOT_V, /* variant, should never be accessed */
191 AINSTR_END, /* struct */
192 AINSTR_END, /* union */
193 AINSTR_END, /* array */
197 static void ir_gen_extparam(ir_builder *ir);
199 /* error functions */
201 static void irerror(lex_ctx ctx, const char *msg, ...)
205 con_cvprintmsg((void*)&ctx, LVL_ERROR, "internal error", msg, ap);
209 static bool irwarning(lex_ctx ctx, int warntype, const char *fmt, ...)
214 r = vcompile_warning(ctx, warntype, fmt, ap);
219 /***********************************************************************
220 * Vector utility functions
223 bool GMQCC_WARN vec_ir_value_find(ir_value **vec, ir_value *what, size_t *idx)
226 size_t len = vec_size(vec);
227 for (i = 0; i < len; ++i) {
228 if (vec[i] == what) {
236 bool GMQCC_WARN vec_ir_block_find(ir_block **vec, ir_block *what, size_t *idx)
239 size_t len = vec_size(vec);
240 for (i = 0; i < len; ++i) {
241 if (vec[i] == what) {
249 bool GMQCC_WARN vec_ir_instr_find(ir_instr **vec, ir_instr *what, size_t *idx)
252 size_t len = vec_size(vec);
253 for (i = 0; i < len; ++i) {
254 if (vec[i] == what) {
262 /***********************************************************************
266 static void ir_block_delete_quick(ir_block* self);
267 static void ir_instr_delete_quick(ir_instr *self);
268 static void ir_function_delete_quick(ir_function *self);
270 ir_builder* ir_builder_new(const char *modulename)
274 self = (ir_builder*)mem_a(sizeof(*self));
278 self->functions = NULL;
279 self->globals = NULL;
281 self->extparams = NULL;
282 self->filenames = NULL;
283 self->filestrings = NULL;
284 self->htglobals = util_htnew(IR_HT_SIZE);
285 self->htfields = util_htnew(IR_HT_SIZE);
286 self->htfunctions = util_htnew(IR_HT_SIZE);
288 self->max_locals = 0;
290 self->str_immediate = 0;
292 if (!ir_builder_set_name(self, modulename)) {
300 void ir_builder_delete(ir_builder* self)
303 util_htdel(self->htglobals);
304 util_htdel(self->htfields);
305 util_htdel(self->htfunctions);
306 mem_d((void*)self->name);
307 for (i = 0; i != vec_size(self->functions); ++i) {
308 ir_function_delete_quick(self->functions[i]);
310 vec_free(self->functions);
311 for (i = 0; i != vec_size(self->extparams); ++i) {
312 ir_value_delete(self->extparams[i]);
314 vec_free(self->extparams);
315 for (i = 0; i != vec_size(self->globals); ++i) {
316 ir_value_delete(self->globals[i]);
318 vec_free(self->globals);
319 for (i = 0; i != vec_size(self->fields); ++i) {
320 ir_value_delete(self->fields[i]);
322 vec_free(self->fields);
323 vec_free(self->filenames);
324 vec_free(self->filestrings);
328 bool ir_builder_set_name(ir_builder *self, const char *name)
331 mem_d((void*)self->name);
332 self->name = util_strdup(name);
336 ir_function* ir_builder_get_function(ir_builder *self, const char *name)
338 return (ir_function*)util_htget(self->htfunctions, name);
341 ir_function* ir_builder_create_function(ir_builder *self, const char *name, int outtype)
343 ir_function *fn = ir_builder_get_function(self, name);
348 fn = ir_function_new(self, outtype);
349 if (!ir_function_set_name(fn, name))
351 ir_function_delete(fn);
354 vec_push(self->functions, fn);
355 util_htset(self->htfunctions, name, fn);
357 fn->value = ir_builder_create_global(self, fn->name, TYPE_FUNCTION);
359 ir_function_delete(fn);
363 fn->value->hasvalue = true;
364 fn->value->outtype = outtype;
365 fn->value->constval.vfunc = fn;
366 fn->value->context = fn->context;
371 ir_value* ir_builder_get_global(ir_builder *self, const char *name)
373 return (ir_value*)util_htget(self->htglobals, name);
376 ir_value* ir_builder_create_global(ir_builder *self, const char *name, int vtype)
380 if (name && name[0] != '#')
382 ve = ir_builder_get_global(self, name);
388 ve = ir_value_var(name, store_global, vtype);
389 vec_push(self->globals, ve);
390 util_htset(self->htglobals, name, ve);
394 ir_value* ir_builder_get_field(ir_builder *self, const char *name)
396 return (ir_value*)util_htget(self->htfields, name);
400 ir_value* ir_builder_create_field(ir_builder *self, const char *name, int vtype)
402 ir_value *ve = ir_builder_get_field(self, name);
407 ve = ir_value_var(name, store_global, TYPE_FIELD);
408 ve->fieldtype = vtype;
409 vec_push(self->fields, ve);
410 util_htset(self->htfields, name, ve);
414 /***********************************************************************
418 bool ir_function_naive_phi(ir_function*);
419 void ir_function_enumerate(ir_function*);
420 bool ir_function_calculate_liferanges(ir_function*);
421 bool ir_function_allocate_locals(ir_function*);
423 ir_function* ir_function_new(ir_builder* owner, int outtype)
426 self = (ir_function*)mem_a(sizeof(*self));
431 memset(self, 0, sizeof(*self));
434 if (!ir_function_set_name(self, "<@unnamed>")) {
441 self->context.file = "<@no context>";
442 self->context.line = 0;
443 self->outtype = outtype;
452 self->code_function_def = -1;
453 self->allocated_locals = 0;
459 bool ir_function_set_name(ir_function *self, const char *name)
462 mem_d((void*)self->name);
463 self->name = util_strdup(name);
467 static void ir_function_delete_quick(ir_function *self)
470 mem_d((void*)self->name);
472 for (i = 0; i != vec_size(self->blocks); ++i)
473 ir_block_delete_quick(self->blocks[i]);
474 vec_free(self->blocks);
476 vec_free(self->params);
478 for (i = 0; i != vec_size(self->values); ++i)
479 ir_value_delete(self->values[i]);
480 vec_free(self->values);
482 for (i = 0; i != vec_size(self->locals); ++i)
483 ir_value_delete(self->locals[i]);
484 vec_free(self->locals);
486 /* self->value is deleted by the builder */
491 void ir_function_delete(ir_function *self)
494 mem_d((void*)self->name);
496 for (i = 0; i != vec_size(self->blocks); ++i)
497 ir_block_delete(self->blocks[i]);
498 vec_free(self->blocks);
500 vec_free(self->params);
502 for (i = 0; i != vec_size(self->values); ++i)
503 ir_value_delete(self->values[i]);
504 vec_free(self->values);
506 for (i = 0; i != vec_size(self->locals); ++i)
507 ir_value_delete(self->locals[i]);
508 vec_free(self->locals);
510 /* self->value is deleted by the builder */
515 void ir_function_collect_value(ir_function *self, ir_value *v)
517 vec_push(self->values, v);
520 ir_block* ir_function_create_block(lex_ctx ctx, ir_function *self, const char *label)
522 ir_block* bn = ir_block_new(self, label);
524 vec_push(self->blocks, bn);
528 static bool instr_is_operation(uint16_t op)
530 return ( (op >= INSTR_MUL_F && op <= INSTR_GT) ||
531 (op >= INSTR_LOAD_F && op <= INSTR_LOAD_FNC) ||
532 (op == INSTR_ADDRESS) ||
533 (op >= INSTR_NOT_F && op <= INSTR_NOT_FNC) ||
534 (op >= INSTR_AND && op <= INSTR_BITOR) ||
535 (op >= INSTR_CALL0 && op <= INSTR_CALL8) );
538 bool ir_function_pass_peephole(ir_function *self)
542 for (b = 0; b < vec_size(self->blocks); ++b) {
544 ir_block *block = self->blocks[b];
546 for (i = 0; i < vec_size(block->instr); ++i) {
548 inst = block->instr[i];
551 (inst->opcode >= INSTR_STORE_F &&
552 inst->opcode <= INSTR_STORE_FNC))
560 oper = block->instr[i-1];
561 if (!instr_is_operation(oper->opcode))
564 value = oper->_ops[0];
566 /* only do it for SSA values */
567 if (value->store != store_value)
570 /* don't optimize out the temp if it's used later again */
571 if (vec_size(value->reads) != 1)
574 /* The very next store must use this value */
575 if (value->reads[0] != store)
578 /* And of course the store must _read_ from it, so it's in
580 if (store->_ops[1] != value)
583 ++opts_optimizationcount[OPTIM_PEEPHOLE];
584 (void)!ir_instr_op(oper, 0, store->_ops[0], true);
586 vec_remove(block->instr, i, 1);
587 ir_instr_delete(store);
589 else if (inst->opcode == VINSTR_COND)
591 /* COND on a value resulting from a NOT could
592 * remove the NOT and swap its operands
599 value = inst->_ops[0];
601 if (value->store != store_value ||
602 vec_size(value->reads) != 1 ||
603 value->reads[0] != inst)
608 inot = value->writes[0];
609 if (inot->_ops[0] != value ||
610 inot->opcode < INSTR_NOT_F ||
611 inot->opcode > INSTR_NOT_FNC ||
612 inot->opcode == INSTR_NOT_V) /* can't do this one */
618 ++opts_optimizationcount[OPTIM_PEEPHOLE];
620 (void)!ir_instr_op(inst, 0, inot->_ops[1], false);
623 for (inotid = 0; inotid < vec_size(tmp->instr); ++inotid) {
624 if (tmp->instr[inotid] == inot)
627 if (inotid >= vec_size(tmp->instr)) {
628 compile_error(inst->context, "sanity-check failed: failed to find instruction to optimize out");
631 vec_remove(tmp->instr, inotid, 1);
632 ir_instr_delete(inot);
633 /* swap ontrue/onfalse */
635 inst->bops[0] = inst->bops[1];
646 bool ir_function_pass_tailrecursion(ir_function *self)
650 for (b = 0; b < vec_size(self->blocks); ++b) {
652 ir_instr *ret, *call, *store = NULL;
653 ir_block *block = self->blocks[b];
655 if (!block->final || vec_size(block->instr) < 2)
658 ret = block->instr[vec_size(block->instr)-1];
659 if (ret->opcode != INSTR_DONE && ret->opcode != INSTR_RETURN)
662 call = block->instr[vec_size(block->instr)-2];
663 if (call->opcode >= INSTR_STORE_F && call->opcode <= INSTR_STORE_FNC) {
664 /* account for the unoptimized
666 * STORE %return, %tmp
670 if (vec_size(block->instr) < 3)
674 call = block->instr[vec_size(block->instr)-3];
677 if (call->opcode < INSTR_CALL0 || call->opcode > INSTR_CALL8)
681 /* optimize out the STORE */
683 ret->_ops[0] == store->_ops[0] &&
684 store->_ops[1] == call->_ops[0])
686 ++opts_optimizationcount[OPTIM_PEEPHOLE];
687 call->_ops[0] = store->_ops[0];
688 vec_remove(block->instr, vec_size(block->instr) - 2, 1);
689 ir_instr_delete(store);
698 funcval = call->_ops[1];
701 if (funcval->vtype != TYPE_FUNCTION || funcval->constval.vfunc != self)
704 /* now we have a CALL and a RET, check if it's a tailcall */
705 if (ret->_ops[0] && call->_ops[0] != ret->_ops[0])
708 ++opts_optimizationcount[OPTIM_TAIL_RECURSION];
709 vec_shrinkby(block->instr, 2);
711 block->final = false; /* open it back up */
713 /* emite parameter-stores */
714 for (p = 0; p < vec_size(call->params); ++p) {
715 /* assert(call->params_count <= self->locals_count); */
716 if (!ir_block_create_store(block, call->context, self->locals[p], call->params[p])) {
717 irerror(call->context, "failed to create tailcall store instruction for parameter %i", (int)p);
721 if (!ir_block_create_jump(block, call->context, self->blocks[0])) {
722 irerror(call->context, "failed to create tailcall jump");
726 ir_instr_delete(call);
727 ir_instr_delete(ret);
733 bool ir_function_finalize(ir_function *self)
738 if (OPTS_OPTIMIZATION(OPTIM_PEEPHOLE)) {
739 if (!ir_function_pass_peephole(self)) {
740 irerror(self->context, "generic optimization pass broke something in `%s`", self->name);
745 if (OPTS_OPTIMIZATION(OPTIM_TAIL_RECURSION)) {
746 if (!ir_function_pass_tailrecursion(self)) {
747 irerror(self->context, "tail-recursion optimization pass broke something in `%s`", self->name);
752 if (!ir_function_naive_phi(self))
755 ir_function_enumerate(self);
757 if (!ir_function_calculate_liferanges(self))
759 if (!ir_function_allocate_locals(self))
764 ir_value* ir_function_create_local(ir_function *self, const char *name, int vtype, bool param)
769 vec_size(self->locals) &&
770 self->locals[vec_size(self->locals)-1]->store != store_param) {
771 irerror(self->context, "cannot add parameters after adding locals");
775 ve = ir_value_var(name, (param ? store_param : store_local), vtype);
776 vec_push(self->locals, ve);
780 /***********************************************************************
784 ir_block* ir_block_new(ir_function* owner, const char *name)
787 self = (ir_block*)mem_a(sizeof(*self));
791 memset(self, 0, sizeof(*self));
794 if (name && !ir_block_set_label(self, name)) {
799 self->context.file = "<@no context>";
800 self->context.line = 0;
804 self->entries = NULL;
808 self->is_return = false;
813 self->generated = false;
818 static void ir_block_delete_quick(ir_block* self)
821 if (self->label) mem_d(self->label);
822 for (i = 0; i != vec_size(self->instr); ++i)
823 ir_instr_delete_quick(self->instr[i]);
824 vec_free(self->instr);
825 vec_free(self->entries);
826 vec_free(self->exits);
827 vec_free(self->living);
831 void ir_block_delete(ir_block* self)
834 if (self->label) mem_d(self->label);
835 for (i = 0; i != vec_size(self->instr); ++i)
836 ir_instr_delete(self->instr[i]);
837 vec_free(self->instr);
838 vec_free(self->entries);
839 vec_free(self->exits);
840 vec_free(self->living);
844 bool ir_block_set_label(ir_block *self, const char *name)
847 mem_d((void*)self->label);
848 self->label = util_strdup(name);
849 return !!self->label;
852 /***********************************************************************
856 ir_instr* ir_instr_new(lex_ctx ctx, ir_block* owner, int op)
859 self = (ir_instr*)mem_a(sizeof(*self));
866 self->_ops[0] = NULL;
867 self->_ops[1] = NULL;
868 self->_ops[2] = NULL;
869 self->bops[0] = NULL;
870 self->bops[1] = NULL;
881 static void ir_instr_delete_quick(ir_instr *self)
884 vec_free(self->params);
888 void ir_instr_delete(ir_instr *self)
891 /* The following calls can only delete from
892 * vectors, we still want to delete this instruction
893 * so ignore the return value. Since with the warn_unused_result attribute
894 * gcc doesn't care about an explicit: (void)foo(); to ignore the result,
895 * I have to improvise here and use if(foo());
897 for (i = 0; i < vec_size(self->phi); ++i) {
899 if (vec_ir_instr_find(self->phi[i].value->writes, self, &idx))
900 vec_remove(self->phi[i].value->writes, idx, 1);
901 if (vec_ir_instr_find(self->phi[i].value->reads, self, &idx))
902 vec_remove(self->phi[i].value->reads, idx, 1);
905 for (i = 0; i < vec_size(self->params); ++i) {
907 if (vec_ir_instr_find(self->params[i]->writes, self, &idx))
908 vec_remove(self->params[i]->writes, idx, 1);
909 if (vec_ir_instr_find(self->params[i]->reads, self, &idx))
910 vec_remove(self->params[i]->reads, idx, 1);
912 vec_free(self->params);
913 (void)!ir_instr_op(self, 0, NULL, false);
914 (void)!ir_instr_op(self, 1, NULL, false);
915 (void)!ir_instr_op(self, 2, NULL, false);
919 bool ir_instr_op(ir_instr *self, int op, ir_value *v, bool writing)
921 if (self->_ops[op]) {
923 if (writing && vec_ir_instr_find(self->_ops[op]->writes, self, &idx))
924 vec_remove(self->_ops[op]->writes, idx, 1);
925 else if (vec_ir_instr_find(self->_ops[op]->reads, self, &idx))
926 vec_remove(self->_ops[op]->reads, idx, 1);
930 vec_push(v->writes, self);
932 vec_push(v->reads, self);
938 /***********************************************************************
942 void ir_value_code_setaddr(ir_value *self, int32_t gaddr)
944 self->code.globaladdr = gaddr;
945 if (self->members[0]) self->members[0]->code.globaladdr = gaddr;
946 if (self->members[1]) self->members[1]->code.globaladdr = gaddr;
947 if (self->members[2]) self->members[2]->code.globaladdr = gaddr;
950 int32_t ir_value_code_addr(const ir_value *self)
952 if (self->store == store_return)
953 return OFS_RETURN + self->code.addroffset;
954 return self->code.globaladdr + self->code.addroffset;
957 ir_value* ir_value_var(const char *name, int storetype, int vtype)
960 self = (ir_value*)mem_a(sizeof(*self));
962 self->fieldtype = TYPE_VOID;
963 self->outtype = TYPE_VOID;
964 self->store = storetype;
970 self->hasvalue = false;
971 self->context.file = "<@no context>";
972 self->context.line = 0;
974 if (name && !ir_value_set_name(self, name)) {
975 irerror(self->context, "out of memory");
980 memset(&self->constval, 0, sizeof(self->constval));
981 memset(&self->code, 0, sizeof(self->code));
983 self->members[0] = NULL;
984 self->members[1] = NULL;
985 self->members[2] = NULL;
986 self->memberof = NULL;
988 self->unique_life = false;
994 ir_value* ir_value_vector_member(ir_value *self, unsigned int member)
1002 if (self->members[member])
1003 return self->members[member];
1006 len = strlen(self->name);
1007 name = (char*)mem_a(len + 3);
1008 memcpy(name, self->name, len);
1010 name[len+1] = 'x' + member;
1016 if (self->vtype == TYPE_VECTOR)
1018 m = ir_value_var(name, self->store, TYPE_FLOAT);
1023 m->context = self->context;
1025 self->members[member] = m;
1026 m->code.addroffset = member;
1028 else if (self->vtype == TYPE_FIELD)
1030 if (self->fieldtype != TYPE_VECTOR)
1032 m = ir_value_var(name, self->store, TYPE_FIELD);
1037 m->fieldtype = TYPE_FLOAT;
1038 m->context = self->context;
1040 self->members[member] = m;
1041 m->code.addroffset = member;
1045 irerror(self->context, "invalid member access on %s", self->name);
1053 static GMQCC_INLINE size_t ir_value_sizeof(const ir_value *self)
1055 if (self->vtype == TYPE_FIELD && self->fieldtype == TYPE_VECTOR)
1056 return type_sizeof_[TYPE_VECTOR];
1057 return type_sizeof_[self->vtype];
1060 ir_value* ir_value_out(ir_function *owner, const char *name, int storetype, int vtype)
1062 ir_value *v = ir_value_var(name, storetype, vtype);
1065 ir_function_collect_value(owner, v);
1069 void ir_value_delete(ir_value* self)
1073 mem_d((void*)self->name);
1076 if (self->vtype == TYPE_STRING)
1077 mem_d((void*)self->constval.vstring);
1079 for (i = 0; i < 3; ++i) {
1080 if (self->members[i])
1081 ir_value_delete(self->members[i]);
1083 vec_free(self->reads);
1084 vec_free(self->writes);
1085 vec_free(self->life);
1089 bool ir_value_set_name(ir_value *self, const char *name)
1092 mem_d((void*)self->name);
1093 self->name = util_strdup(name);
1094 return !!self->name;
1097 bool ir_value_set_float(ir_value *self, float f)
1099 if (self->vtype != TYPE_FLOAT)
1101 self->constval.vfloat = f;
1102 self->hasvalue = true;
1106 bool ir_value_set_func(ir_value *self, int f)
1108 if (self->vtype != TYPE_FUNCTION)
1110 self->constval.vint = f;
1111 self->hasvalue = true;
1115 bool ir_value_set_vector(ir_value *self, vector v)
1117 if (self->vtype != TYPE_VECTOR)
1119 self->constval.vvec = v;
1120 self->hasvalue = true;
1124 bool ir_value_set_field(ir_value *self, ir_value *fld)
1126 if (self->vtype != TYPE_FIELD)
1128 self->constval.vpointer = fld;
1129 self->hasvalue = true;
1133 static char *ir_strdup(const char *str)
1136 /* actually dup empty strings */
1137 char *out = (char*)mem_a(1);
1141 return util_strdup(str);
1144 bool ir_value_set_string(ir_value *self, const char *str)
1146 if (self->vtype != TYPE_STRING)
1148 self->constval.vstring = ir_strdup(str);
1149 self->hasvalue = true;
1154 bool ir_value_set_int(ir_value *self, int i)
1156 if (self->vtype != TYPE_INTEGER)
1158 self->constval.vint = i;
1159 self->hasvalue = true;
1164 bool ir_value_lives(ir_value *self, size_t at)
1167 for (i = 0; i < vec_size(self->life); ++i)
1169 ir_life_entry_t *life = &self->life[i];
1170 if (life->start <= at && at <= life->end)
1172 if (life->start > at) /* since it's ordered */
1178 bool ir_value_life_insert(ir_value *self, size_t idx, ir_life_entry_t e)
1181 vec_push(self->life, e);
1182 for (k = vec_size(self->life)-1; k > idx; --k)
1183 self->life[k] = self->life[k-1];
1184 self->life[idx] = e;
1188 bool ir_value_life_merge(ir_value *self, size_t s)
1191 ir_life_entry_t *life = NULL;
1192 ir_life_entry_t *before = NULL;
1193 ir_life_entry_t new_entry;
1195 /* Find the first range >= s */
1196 for (i = 0; i < vec_size(self->life); ++i)
1199 life = &self->life[i];
1200 if (life->start > s)
1203 /* nothing found? append */
1204 if (i == vec_size(self->life)) {
1206 if (life && life->end+1 == s)
1208 /* previous life range can be merged in */
1212 if (life && life->end >= s)
1214 e.start = e.end = s;
1215 vec_push(self->life, e);
1221 if (before->end + 1 == s &&
1222 life->start - 1 == s)
1225 before->end = life->end;
1226 vec_remove(self->life, i, 1);
1229 if (before->end + 1 == s)
1235 /* already contained */
1236 if (before->end >= s)
1240 if (life->start - 1 == s)
1245 /* insert a new entry */
1246 new_entry.start = new_entry.end = s;
1247 return ir_value_life_insert(self, i, new_entry);
1250 bool ir_value_life_merge_into(ir_value *self, const ir_value *other)
1254 if (!vec_size(other->life))
1257 if (!vec_size(self->life)) {
1258 size_t count = vec_size(other->life);
1259 ir_life_entry_t *life = vec_add(self->life, count);
1260 memcpy(life, other->life, count * sizeof(*life));
1265 for (i = 0; i < vec_size(other->life); ++i)
1267 const ir_life_entry_t *life = &other->life[i];
1270 ir_life_entry_t *entry = &self->life[myi];
1272 if (life->end+1 < entry->start)
1274 /* adding an interval before entry */
1275 if (!ir_value_life_insert(self, myi, *life))
1281 if (life->start < entry->start &&
1282 life->end+1 >= entry->start)
1284 /* starts earlier and overlaps */
1285 entry->start = life->start;
1288 if (life->end > entry->end &&
1289 life->start <= entry->end+1)
1291 /* ends later and overlaps */
1292 entry->end = life->end;
1295 /* see if our change combines it with the next ranges */
1296 while (myi+1 < vec_size(self->life) &&
1297 entry->end+1 >= self->life[1+myi].start)
1299 /* overlaps with (myi+1) */
1300 if (entry->end < self->life[1+myi].end)
1301 entry->end = self->life[1+myi].end;
1302 vec_remove(self->life, myi+1, 1);
1303 entry = &self->life[myi];
1306 /* see if we're after the entry */
1307 if (life->start > entry->end)
1310 /* append if we're at the end */
1311 if (myi >= vec_size(self->life)) {
1312 vec_push(self->life, *life);
1315 /* otherweise check the next range */
1324 bool ir_values_overlap(const ir_value *a, const ir_value *b)
1326 /* For any life entry in A see if it overlaps with
1327 * any life entry in B.
1328 * Note that the life entries are orderes, so we can make a
1329 * more efficient algorithm there than naively translating the
1333 ir_life_entry_t *la, *lb, *enda, *endb;
1335 /* first of all, if either has no life range, they cannot clash */
1336 if (!vec_size(a->life) || !vec_size(b->life))
1341 enda = la + vec_size(a->life);
1342 endb = lb + vec_size(b->life);
1345 /* check if the entries overlap, for that,
1346 * both must start before the other one ends.
1348 if (la->start < lb->end &&
1349 lb->start < la->end)
1354 /* entries are ordered
1355 * one entry is earlier than the other
1356 * that earlier entry will be moved forward
1358 if (la->start < lb->start)
1360 /* order: A B, move A forward
1361 * check if we hit the end with A
1366 else /* if (lb->start < la->start) actually <= */
1368 /* order: B A, move B forward
1369 * check if we hit the end with B
1378 /***********************************************************************
1382 static bool ir_check_unreachable(ir_block *self)
1384 /* The IR should never have to deal with unreachable code */
1385 if (!self->final/* || OPTS_FLAG(ALLOW_UNREACHABLE_CODE)*/)
1387 irerror(self->context, "unreachable statement (%s)", self->label);
1391 bool ir_block_create_store_op(ir_block *self, lex_ctx ctx, int op, ir_value *target, ir_value *what)
1394 if (!ir_check_unreachable(self))
1397 if (target->store == store_value &&
1398 (op < INSTR_STOREP_F || op > INSTR_STOREP_FNC))
1400 irerror(self->context, "cannot store to an SSA value");
1401 irerror(self->context, "trying to store: %s <- %s", target->name, what->name);
1402 irerror(self->context, "instruction: %s", asm_instr[op].m);
1406 in = ir_instr_new(ctx, self, op);
1410 if (!ir_instr_op(in, 0, target, true) ||
1411 !ir_instr_op(in, 1, what, false))
1413 ir_instr_delete(in);
1416 vec_push(self->instr, in);
1420 bool ir_block_create_store(ir_block *self, lex_ctx ctx, ir_value *target, ir_value *what)
1424 if (target->vtype == TYPE_VARIANT)
1425 vtype = what->vtype;
1427 vtype = target->vtype;
1430 if (vtype == TYPE_FLOAT && what->vtype == TYPE_INTEGER)
1431 op = INSTR_CONV_ITOF;
1432 else if (vtype == TYPE_INTEGER && what->vtype == TYPE_FLOAT)
1433 op = INSTR_CONV_FTOI;
1435 op = type_store_instr[vtype];
1437 if (OPTS_FLAG(ADJUST_VECTOR_FIELDS)) {
1438 if (op == INSTR_STORE_FLD && what->fieldtype == TYPE_VECTOR)
1442 return ir_block_create_store_op(self, ctx, op, target, what);
1445 bool ir_block_create_storep(ir_block *self, lex_ctx ctx, ir_value *target, ir_value *what)
1450 if (target->vtype != TYPE_POINTER)
1453 /* storing using pointer - target is a pointer, type must be
1454 * inferred from source
1456 vtype = what->vtype;
1458 op = type_storep_instr[vtype];
1459 if (OPTS_FLAG(ADJUST_VECTOR_FIELDS)) {
1460 if (op == INSTR_STOREP_FLD && what->fieldtype == TYPE_VECTOR)
1461 op = INSTR_STOREP_V;
1464 return ir_block_create_store_op(self, ctx, op, target, what);
1467 bool ir_block_create_return(ir_block *self, lex_ctx ctx, ir_value *v)
1470 if (!ir_check_unreachable(self))
1473 self->is_return = true;
1474 in = ir_instr_new(ctx, self, INSTR_RETURN);
1478 if (v && !ir_instr_op(in, 0, v, false)) {
1479 ir_instr_delete(in);
1483 vec_push(self->instr, in);
1487 bool ir_block_create_if(ir_block *self, lex_ctx ctx, ir_value *v,
1488 ir_block *ontrue, ir_block *onfalse)
1491 if (!ir_check_unreachable(self))
1494 /*in = ir_instr_new(ctx, self, (v->vtype == TYPE_STRING ? INSTR_IF_S : INSTR_IF_F));*/
1495 in = ir_instr_new(ctx, self, VINSTR_COND);
1499 if (!ir_instr_op(in, 0, v, false)) {
1500 ir_instr_delete(in);
1504 in->bops[0] = ontrue;
1505 in->bops[1] = onfalse;
1507 vec_push(self->instr, in);
1509 vec_push(self->exits, ontrue);
1510 vec_push(self->exits, onfalse);
1511 vec_push(ontrue->entries, self);
1512 vec_push(onfalse->entries, self);
1516 bool ir_block_create_jump(ir_block *self, lex_ctx ctx, ir_block *to)
1519 if (!ir_check_unreachable(self))
1522 in = ir_instr_new(ctx, self, VINSTR_JUMP);
1527 vec_push(self->instr, in);
1529 vec_push(self->exits, to);
1530 vec_push(to->entries, self);
1534 bool ir_block_create_goto(ir_block *self, lex_ctx ctx, ir_block *to)
1536 self->owner->flags |= IR_FLAG_HAS_GOTO;
1537 return ir_block_create_jump(self, ctx, to);
1540 ir_instr* ir_block_create_phi(ir_block *self, lex_ctx ctx, const char *label, int ot)
1544 if (!ir_check_unreachable(self))
1546 in = ir_instr_new(ctx, self, VINSTR_PHI);
1549 out = ir_value_out(self->owner, label, store_value, ot);
1551 ir_instr_delete(in);
1554 if (!ir_instr_op(in, 0, out, true)) {
1555 ir_instr_delete(in);
1556 ir_value_delete(out);
1559 vec_push(self->instr, in);
1563 ir_value* ir_phi_value(ir_instr *self)
1565 return self->_ops[0];
1568 void ir_phi_add(ir_instr* self, ir_block *b, ir_value *v)
1572 if (!vec_ir_block_find(self->owner->entries, b, NULL)) {
1573 /* Must not be possible to cause this, otherwise the AST
1574 * is doing something wrong.
1576 irerror(self->context, "Invalid entry block for PHI");
1582 vec_push(v->reads, self);
1583 vec_push(self->phi, pe);
1586 /* call related code */
1587 ir_instr* ir_block_create_call(ir_block *self, lex_ctx ctx, const char *label, ir_value *func, bool noreturn)
1591 if (!ir_check_unreachable(self))
1593 in = ir_instr_new(ctx, self, (noreturn ? VINSTR_NRCALL : INSTR_CALL0));
1598 self->is_return = true;
1600 out = ir_value_out(self->owner, label, (func->outtype == TYPE_VOID) ? store_return : store_value, func->outtype);
1602 ir_instr_delete(in);
1605 if (!ir_instr_op(in, 0, out, true) ||
1606 !ir_instr_op(in, 1, func, false))
1608 ir_instr_delete(in);
1609 ir_value_delete(out);
1612 vec_push(self->instr, in);
1615 if (!ir_block_create_return(self, ctx, NULL)) {
1616 compile_error(ctx, "internal error: failed to generate dummy-return instruction");
1617 ir_instr_delete(in);
1625 ir_value* ir_call_value(ir_instr *self)
1627 return self->_ops[0];
1630 void ir_call_param(ir_instr* self, ir_value *v)
1632 vec_push(self->params, v);
1633 vec_push(v->reads, self);
1636 /* binary op related code */
1638 ir_value* ir_block_create_binop(ir_block *self, lex_ctx ctx,
1639 const char *label, int opcode,
1640 ir_value *left, ir_value *right)
1662 case INSTR_SUB_S: /* -- offset of string as float */
1667 case INSTR_BITOR_IF:
1668 case INSTR_BITOR_FI:
1669 case INSTR_BITAND_FI:
1670 case INSTR_BITAND_IF:
1685 case INSTR_BITAND_I:
1688 case INSTR_RSHIFT_I:
1689 case INSTR_LSHIFT_I:
1711 /* boolean operations result in floats */
1712 if (opcode >= INSTR_EQ_F && opcode <= INSTR_GT)
1714 else if (opcode >= INSTR_LE && opcode <= INSTR_GT)
1717 else if (opcode >= INSTR_LE_I && opcode <= INSTR_EQ_FI)
1722 if (ot == TYPE_VOID) {
1723 /* The AST or parser were supposed to check this! */
1727 return ir_block_create_general_instr(self, ctx, label, opcode, left, right, ot);
1730 ir_value* ir_block_create_unary(ir_block *self, lex_ctx ctx,
1731 const char *label, int opcode,
1734 int ot = TYPE_FLOAT;
1746 /* QC doesn't have other unary operations. We expect extensions to fill
1747 * the above list, otherwise we assume out-type = in-type, eg for an
1751 ot = operand->vtype;
1754 if (ot == TYPE_VOID) {
1755 /* The AST or parser were supposed to check this! */
1759 /* let's use the general instruction creator and pass NULL for OPB */
1760 return ir_block_create_general_instr(self, ctx, label, opcode, operand, NULL, ot);
1763 ir_value* ir_block_create_general_instr(ir_block *self, lex_ctx ctx, const char *label,
1764 int op, ir_value *a, ir_value *b, int outype)
1769 out = ir_value_out(self->owner, label, store_value, outype);
1773 instr = ir_instr_new(ctx, self, op);
1775 ir_value_delete(out);
1779 if (!ir_instr_op(instr, 0, out, true) ||
1780 !ir_instr_op(instr, 1, a, false) ||
1781 !ir_instr_op(instr, 2, b, false) )
1786 vec_push(self->instr, instr);
1790 ir_instr_delete(instr);
1791 ir_value_delete(out);
1795 ir_value* ir_block_create_fieldaddress(ir_block *self, lex_ctx ctx, const char *label, ir_value *ent, ir_value *field)
1799 /* Support for various pointer types todo if so desired */
1800 if (ent->vtype != TYPE_ENTITY)
1803 if (field->vtype != TYPE_FIELD)
1806 v = ir_block_create_general_instr(self, ctx, label, INSTR_ADDRESS, ent, field, TYPE_POINTER);
1807 v->fieldtype = field->fieldtype;
1811 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)
1814 if (ent->vtype != TYPE_ENTITY)
1817 /* at some point we could redirect for TYPE_POINTER... but that could lead to carelessness */
1818 if (field->vtype != TYPE_FIELD)
1823 case TYPE_FLOAT: op = INSTR_LOAD_F; break;
1824 case TYPE_VECTOR: op = INSTR_LOAD_V; break;
1825 case TYPE_STRING: op = INSTR_LOAD_S; break;
1826 case TYPE_FIELD: op = INSTR_LOAD_FLD; break;
1827 case TYPE_ENTITY: op = INSTR_LOAD_ENT; break;
1828 case TYPE_FUNCTION: op = INSTR_LOAD_FNC; break;
1830 case TYPE_POINTER: op = INSTR_LOAD_I; break;
1831 case TYPE_INTEGER: op = INSTR_LOAD_I; break;
1834 irerror(self->context, "invalid type for ir_block_create_load_from_ent: %s", type_name[outype]);
1838 return ir_block_create_general_instr(self, ctx, label, op, ent, field, outype);
1841 ir_value* ir_block_create_add(ir_block *self, lex_ctx ctx,
1843 ir_value *left, ir_value *right)
1846 int l = left->vtype;
1847 int r = right->vtype;
1851 irerror(self->context, "invalid type for ir_block_create_add: %s", type_name[l]);
1867 if ( (l == TYPE_FLOAT && r == TYPE_INTEGER) )
1869 else if ( (l == TYPE_INTEGER && r == TYPE_FLOAT) )
1874 irerror(self->context, "invalid type for ir_block_create_add: %s", type_name[l]);
1878 return ir_block_create_binop(self, ctx, label, op, left, right);
1881 ir_value* ir_block_create_sub(ir_block *self, lex_ctx ctx,
1883 ir_value *left, ir_value *right)
1886 int l = left->vtype;
1887 int r = right->vtype;
1892 irerror(self->context, "invalid type for ir_block_create_sub: %s", type_name[l]);
1908 if ( (l == TYPE_FLOAT && r == TYPE_INTEGER) )
1910 else if ( (l == TYPE_INTEGER && r == TYPE_FLOAT) )
1915 irerror(self->context, "invalid type for ir_block_create_sub: %s", type_name[l]);
1919 return ir_block_create_binop(self, ctx, label, op, left, right);
1922 ir_value* ir_block_create_mul(ir_block *self, lex_ctx ctx,
1924 ir_value *left, ir_value *right)
1927 int l = left->vtype;
1928 int r = right->vtype;
1933 irerror(self->context, "invalid type for ir_block_create_mul: %s", type_name[l]);
1948 if ( (l == TYPE_VECTOR && r == TYPE_FLOAT) )
1950 else if ( (l == TYPE_FLOAT && r == TYPE_VECTOR) )
1953 else if ( (l == TYPE_VECTOR && r == TYPE_INTEGER) )
1955 else if ( (l == TYPE_INTEGER && r == TYPE_VECTOR) )
1957 else if ( (l == TYPE_FLOAT && r == TYPE_INTEGER) )
1959 else if ( (l == TYPE_INTEGER && r == TYPE_FLOAT) )
1963 irerror(self->context, "invalid type for ir_block_create_mul: %s", type_name[l]);
1967 return ir_block_create_binop(self, ctx, label, op, left, right);
1970 ir_value* ir_block_create_div(ir_block *self, lex_ctx ctx,
1972 ir_value *left, ir_value *right)
1975 int l = left->vtype;
1976 int r = right->vtype;
1981 irerror(self->context, "invalid type for ir_block_create_div: %s", type_name[l]);
1994 if ( (l == TYPE_VECTOR && r == TYPE_FLOAT) )
1996 else if ( (l == TYPE_FLOAT && r == TYPE_INTEGER) )
1998 else if ( (l == TYPE_INTEGER && r == TYPE_FLOAT) )
2003 irerror(self->context, "invalid type for ir_block_create_div: %s", type_name[l]);
2007 return ir_block_create_binop(self, ctx, label, op, left, right);
2010 /* PHI resolving breaks the SSA, and must thus be the last
2011 * step before life-range calculation.
2014 static bool ir_block_naive_phi(ir_block *self);
2015 bool ir_function_naive_phi(ir_function *self)
2019 for (i = 0; i < vec_size(self->blocks); ++i)
2021 if (!ir_block_naive_phi(self->blocks[i]))
2028 static bool ir_naive_phi_emit_store(ir_block *block, size_t iid, ir_value *old, ir_value *what)
2033 /* create a store */
2034 if (!ir_block_create_store(block, old, what))
2037 /* we now move it up */
2038 instr = vec_last(block->instr);
2039 for (i = vec_size(block->instr)-1; i > iid; --i)
2040 block->instr[i] = block->instr[i-1];
2041 block->instr[i] = instr;
2047 static bool ir_block_naive_phi(ir_block *self)
2049 size_t i, p; /*, w;*/
2050 /* FIXME: optionally, create_phi can add the phis
2051 * to a list so we don't need to loop through blocks
2052 * - anyway: "don't optimize YET"
2054 for (i = 0; i < vec_size(self->instr); ++i)
2056 ir_instr *instr = self->instr[i];
2057 if (instr->opcode != VINSTR_PHI)
2060 vec_remove(self->instr, i, 1);
2061 --i; /* NOTE: i+1 below */
2063 for (p = 0; p < vec_size(instr->phi); ++p)
2065 ir_value *v = instr->phi[p].value;
2066 ir_block *b = instr->phi[p].from;
2068 if (v->store == store_value &&
2069 vec_size(v->reads) == 1 &&
2070 vec_size(v->writes) == 1)
2072 /* replace the value */
2073 if (!ir_instr_op(v->writes[0], 0, instr->_ops[0], true))
2078 /* force a move instruction */
2079 ir_instr *prevjump = vec_last(b->instr);
2082 instr->_ops[0]->store = store_global;
2083 if (!ir_block_create_store(b, instr->context, instr->_ops[0], v))
2085 instr->_ops[0]->store = store_value;
2086 vec_push(b->instr, prevjump);
2091 ir_value *v = instr->phi[p].value;
2092 for (w = 0; w < vec_size(v->writes); ++w) {
2095 if (!v->writes[w]->_ops[0])
2098 /* When the write was to a global, we have to emit a mov */
2099 old = v->writes[w]->_ops[0];
2101 /* The original instruction now writes to the PHI target local */
2102 if (v->writes[w]->_ops[0] == v)
2103 v->writes[w]->_ops[0] = instr->_ops[0];
2105 if (old->store != store_value && old->store != store_local && old->store != store_param)
2107 /* If it originally wrote to a global we need to store the value
2110 if (!ir_naive_phi_emit_store(self, i+1, old, v))
2112 if (i+1 < vec_size(self->instr))
2113 instr = self->instr[i+1];
2116 /* In case I forget and access instr later, it'll be NULL
2117 * when it's a problem, to make sure we crash, rather than accessing
2123 /* If it didn't, we can replace all reads by the phi target now. */
2125 for (r = 0; r < vec_size(old->reads); ++r)
2128 ir_instr *ri = old->reads[r];
2129 for (op = 0; op < vec_size(ri->phi); ++op) {
2130 if (ri->phi[op].value == old)
2131 ri->phi[op].value = v;
2133 for (op = 0; op < 3; ++op) {
2134 if (ri->_ops[op] == old)
2142 ir_instr_delete(instr);
2147 /***********************************************************************
2148 *IR Temp allocation code
2149 * Propagating value life ranges by walking through the function backwards
2150 * until no more changes are made.
2151 * In theory this should happen once more than once for every nested loop
2153 * Though this implementation might run an additional time for if nests.
2156 /* Enumerate instructions used by value's life-ranges
2158 static void ir_block_enumerate(ir_block *self, size_t *_eid)
2162 for (i = 0; i < vec_size(self->instr); ++i)
2164 self->instr[i]->eid = eid++;
2169 /* Enumerate blocks and instructions.
2170 * The block-enumeration is unordered!
2171 * We do not really use the block enumreation, however
2172 * the instruction enumeration is important for life-ranges.
2174 void ir_function_enumerate(ir_function *self)
2177 size_t instruction_id = 0;
2178 for (i = 0; i < vec_size(self->blocks); ++i)
2180 self->blocks[i]->eid = i;
2181 self->blocks[i]->run_id = 0;
2182 ir_block_enumerate(self->blocks[i], &instruction_id);
2186 static bool ir_block_life_propagate(ir_block *b, ir_block *prev, bool *changed);
2187 bool ir_function_calculate_liferanges(ir_function *self)
2195 for (i = 0; i != vec_size(self->blocks); ++i)
2197 if (self->blocks[i]->is_return)
2199 vec_free(self->blocks[i]->living);
2200 if (!ir_block_life_propagate(self->blocks[i], NULL, &changed))
2205 if (vec_size(self->blocks)) {
2206 ir_block *block = self->blocks[0];
2207 for (i = 0; i < vec_size(block->living); ++i) {
2208 ir_value *v = block->living[i];
2209 if (v->store != store_local)
2211 if ((v->members[0] && v->members[1] && v->members[2])) {
2212 /* all vector members have been accessed - only treat this as uninitialized
2213 * if any of them is also uninitialized.
2215 if (!vec_ir_value_find(block->living, v->members[0], NULL) &&
2216 !vec_ir_value_find(block->living, v->members[1], NULL) &&
2217 !vec_ir_value_find(block->living, v->members[2], NULL))
2223 /* A member is only uninitialized if the whole vector is also uninitialized */
2224 if (!vec_ir_value_find(block->living, v->memberof, NULL))
2227 self->flags |= IR_FLAG_HAS_UNINITIALIZED;
2228 if (irwarning(v->context, WARN_USED_UNINITIALIZED,
2229 "variable `%s` may be used uninitialized in this function", v->name))
2238 /* Local-value allocator
2239 * After finishing creating the liferange of all values used in a function
2240 * we can allocate their global-positions.
2241 * This is the counterpart to register-allocation in register machines.
2248 } function_allocator;
2250 static bool function_allocator_alloc(function_allocator *alloc, const ir_value *var)
2253 size_t vsize = ir_value_sizeof(var);
2255 slot = ir_value_var("reg", store_global, var->vtype);
2259 if (!ir_value_life_merge_into(slot, var))
2262 vec_push(alloc->locals, slot);
2263 vec_push(alloc->sizes, vsize);
2264 vec_push(alloc->unique, var->unique_life);
2269 ir_value_delete(slot);
2273 bool ir_function_allocate_locals(ir_function *self)
2282 function_allocator alloc;
2284 if (!vec_size(self->locals) && !vec_size(self->values))
2287 alloc.locals = NULL;
2289 alloc.positions = NULL;
2290 alloc.unique = NULL;
2292 for (i = 0; i < vec_size(self->locals); ++i)
2295 if (!OPTS_OPTIMIZATION(OPTIM_LOCALTEMPS))
2297 self->locals[i]->unique_life = true;
2298 if (!function_allocator_alloc(&alloc, self->locals[i]))
2302 /* Allocate a slot for any value that still exists */
2303 for (i = 0; i < vec_size(self->values); ++i)
2305 v = self->values[i];
2307 if (!vec_size(v->life))
2310 for (a = 0; a < vec_size(alloc.locals); ++a)
2312 /* if it's reserved for a unique liferange: skip */
2313 if (alloc.unique[a])
2316 slot = alloc.locals[a];
2318 /* never resize parameters
2319 * will be required later when overlapping temps + locals
2321 if (a < vec_size(self->params) &&
2322 alloc.sizes[a] < ir_value_sizeof(v))
2327 if (ir_values_overlap(v, slot))
2330 if (!ir_value_life_merge_into(slot, v))
2333 /* adjust size for this slot */
2334 if (alloc.sizes[a] < ir_value_sizeof(v))
2335 alloc.sizes[a] = ir_value_sizeof(v);
2337 self->values[i]->code.local = a;
2340 if (a >= vec_size(alloc.locals)) {
2341 self->values[i]->code.local = vec_size(alloc.locals);
2342 if (!function_allocator_alloc(&alloc, v))
2351 /* Adjust slot positions based on sizes */
2352 vec_push(alloc.positions, 0);
2354 if (vec_size(alloc.sizes))
2355 pos = alloc.positions[0] + alloc.sizes[0];
2358 for (i = 1; i < vec_size(alloc.sizes); ++i)
2360 pos = alloc.positions[i-1] + alloc.sizes[i-1];
2361 vec_push(alloc.positions, pos);
2364 self->allocated_locals = pos + vec_last(alloc.sizes);
2366 /* Locals need to know their new position */
2367 for (i = 0; i < vec_size(self->locals); ++i) {
2368 self->locals[i]->code.local = alloc.positions[i];
2370 /* Take over the actual slot positions on values */
2371 for (i = 0; i < vec_size(self->values); ++i) {
2372 self->values[i]->code.local = alloc.positions[self->values[i]->code.local];
2380 for (i = 0; i < vec_size(alloc.locals); ++i)
2381 ir_value_delete(alloc.locals[i]);
2382 vec_free(alloc.unique);
2383 vec_free(alloc.locals);
2384 vec_free(alloc.sizes);
2385 vec_free(alloc.positions);
2389 /* Get information about which operand
2390 * is read from, or written to.
2392 static void ir_op_read_write(int op, size_t *read, size_t *write)
2412 case INSTR_STOREP_F:
2413 case INSTR_STOREP_V:
2414 case INSTR_STOREP_S:
2415 case INSTR_STOREP_ENT:
2416 case INSTR_STOREP_FLD:
2417 case INSTR_STOREP_FNC:
2428 static bool ir_block_living_add_instr(ir_block *self, size_t eid)
2431 bool changed = false;
2433 for (i = 0; i != vec_size(self->living); ++i)
2435 tempbool = ir_value_life_merge(self->living[i], eid);
2438 irerror(self->context, "block_living_add_instr() value instruction added %s: %i", self->living[i]->_name, (int)eid);
2440 changed = changed || tempbool;
2445 static bool ir_block_life_prop_previous(ir_block* self, ir_block *prev, bool *changed)
2451 /* values which have been read in a previous iteration are now
2452 * in the "living" array even if the previous block doesn't use them.
2453 * So we have to remove whatever does not exist in the previous block.
2454 * They will be re-added on-read, but the liferange merge won't cause
2456 for (i = 0; i < vec_size(self->living); ++i)
2458 if (!vec_ir_value_find(prev->living, self->living[i], NULL)) {
2459 vec_remove(self->living, i, 1);
2465 /* Whatever the previous block still has in its living set
2466 * must now be added to ours as well.
2468 for (i = 0; i < vec_size(prev->living); ++i)
2470 if (vec_ir_value_find(self->living, prev->living[i], NULL))
2472 vec_push(self->living, prev->living[i]);
2474 irerror(self->contextt from prev: %s", self->label, prev->living[i]->_name);
2480 static bool ir_block_life_propagate(ir_block *self, ir_block *prev, bool *changed)
2486 /* bitmasks which operands are read from or written to */
2488 char dbg_ind[16] = { '#', '0' };
2493 if (!ir_block_life_prop_previous(self, prev, changed))
2497 i = vec_size(self->instr);
2500 instr = self->instr[i];
2502 /* PHI operands are always read operands */
2503 for (p = 0; p < vec_size(instr->phi); ++p)
2505 value = instr->phi[p].value;
2506 if (!vec_ir_value_find(self->living, value, NULL))
2507 vec_push(self->living, value);
2510 /* call params are read operands too */
2511 for (p = 0; p < vec_size(instr->params); ++p)
2513 value = instr->params[p];
2514 if (!vec_ir_value_find(self->living, value, NULL))
2515 vec_push(self->living, value);
2518 /* See which operands are read and write operands */
2519 ir_op_read_write(instr->opcode, &read, &write);
2521 if (instr->opcode == INSTR_MUL_VF)
2523 /* the float source will get an additional lifetime */
2524 tempbool = ir_value_life_merge(instr->_ops[2], instr->eid+1);
2525 *changed = *changed || tempbool;
2527 else if (instr->opcode == INSTR_MUL_FV)
2529 /* the float source will get an additional lifetime */
2530 tempbool = ir_value_life_merge(instr->_ops[1], instr->eid+1);
2531 *changed = *changed || tempbool;
2534 /* Go through the 3 main operands */
2535 for (o = 0; o < 3; ++o)
2537 if (!instr->_ops[o]) /* no such operand */
2540 value = instr->_ops[o];
2542 /* We only care about locals */
2543 /* we also calculate parameter liferanges so that locals
2544 * can take up parameter slots */
2545 if (value->store != store_value &&
2546 value->store != store_local &&
2547 value->store != store_param)
2553 if (!vec_ir_value_find(self->living, value, NULL))
2554 vec_push(self->living, value);
2557 /* write operands */
2558 /* When we write to a local, we consider it "dead" for the
2559 * remaining upper part of the function, since in SSA a value
2560 * can only be written once (== created)
2565 bool in_living = vec_ir_value_find(self->living, value, &idx);
2568 /* If the value isn't alive it hasn't been read before... */
2569 /* TODO: See if the warning can be emitted during parsing or AST processing
2570 * otherwise have warning printed here.
2571 * IF printing a warning here: include filecontext_t,
2572 * and make sure it's only printed once
2573 * since this function is run multiple times.
2575 /* For now: debug info: */
2576 /* con_err( "Value only written %s\n", value->name); */
2577 tempbool = ir_value_life_merge(value, instr->eid);
2578 *changed = *changed || tempbool;
2580 ir_instr_dump(instr, dbg_ind, printf);
2584 /* since 'living' won't contain it
2585 * anymore, merge the value, since
2588 tempbool = ir_value_life_merge(value, instr->eid);
2591 con_err( "value added id %s %i\n", value->name, (int)instr->eid);
2593 *changed = *changed || tempbool;
2595 vec_remove(self->living, idx, 1);
2600 tempbool = ir_block_living_add_instr(self, instr->eid);
2601 /*con_err( "living added values\n");*/
2602 *changed = *changed || tempbool;
2606 if (self->run_id == self->owner->run_id)
2609 self->run_id = self->owner->run_id;
2611 for (i = 0; i < vec_size(self->entries); ++i)
2613 ir_block *entry = self->entries[i];
2614 ir_block_life_propagate(entry, self, changed);
2620 /***********************************************************************
2623 * Since the IR has the convention of putting 'write' operands
2624 * at the beginning, we have to rotate the operands of instructions
2625 * properly in order to generate valid QCVM code.
2627 * Having destinations at a fixed position is more convenient. In QC
2628 * this is *mostly* OPC, but FTE adds at least 2 instructions which
2629 * read from from OPA, and store to OPB rather than OPC. Which is
2630 * partially the reason why the implementation of these instructions
2631 * in darkplaces has been delayed for so long.
2633 * Breaking conventions is annoying...
2635 static bool ir_builder_gen_global(ir_builder *self, ir_value *global, bool islocal, bool defs_only);
2637 static bool gen_global_field(ir_value *global)
2639 if (global->hasvalue)
2641 ir_value *fld = global->constval.vpointer;
2643 irerror(global->context, "Invalid field constant with no field: %s", global->name);
2647 /* copy the field's value */
2648 ir_value_code_setaddr(global, vec_size(code_globals));
2649 vec_push(code_globals, fld->code.fieldaddr);
2650 if (global->fieldtype == TYPE_VECTOR) {
2651 vec_push(code_globals, fld->code.fieldaddr+1);
2652 vec_push(code_globals, fld->code.fieldaddr+2);
2657 ir_value_code_setaddr(global, vec_size(code_globals));
2658 vec_push(code_globals, 0);
2659 if (global->fieldtype == TYPE_VECTOR) {
2660 vec_push(code_globals, 0);
2661 vec_push(code_globals, 0);
2664 if (global->code.globaladdr < 0)
2669 static bool gen_global_pointer(ir_value *global)
2671 if (global->hasvalue)
2673 ir_value *target = global->constval.vpointer;
2675 irerror(global->context, "Invalid pointer constant: %s", global->name);
2676 /* NULL pointers are pointing to the NULL constant, which also
2677 * sits at address 0, but still has an ir_value for itself.
2682 /* Here, relocations ARE possible - in fteqcc-enhanced-qc:
2683 * void() foo; <- proto
2684 * void() *fooptr = &foo;
2685 * void() foo = { code }
2687 if (!target->code.globaladdr) {
2688 /* FIXME: Check for the constant nullptr ir_value!
2689 * because then code.globaladdr being 0 is valid.
2691 irerror(global->context, "FIXME: Relocation support");
2695 ir_value_code_setaddr(global, vec_size(code_globals));
2696 vec_push(code_globals, target->code.globaladdr);
2700 ir_value_code_setaddr(global, vec_size(code_globals));
2701 vec_push(code_globals, 0);
2703 if (global->code.globaladdr < 0)
2708 static bool gen_blocks_recursive(ir_function *func, ir_block *block)
2710 prog_section_statement stmt;
2719 block->generated = true;
2720 block->code_start = vec_size(code_statements);
2721 for (i = 0; i < vec_size(block->instr); ++i)
2723 instr = block->instr[i];
2725 if (instr->opcode == VINSTR_PHI) {
2726 irerror(block->context, "cannot generate virtual instruction (phi)");
2730 if (instr->opcode == VINSTR_JUMP) {
2731 target = instr->bops[0];
2732 /* for uncoditional jumps, if the target hasn't been generated
2733 * yet, we generate them right here.
2735 if (!target->generated) {
2740 /* otherwise we generate a jump instruction */
2741 stmt.opcode = INSTR_GOTO;
2742 stmt.o1.s1 = (target->code_start) - vec_size(code_statements);
2745 if (stmt.o1.s1 != 1)
2746 code_push_statement(&stmt, instr->context.line);
2748 /* no further instructions can be in this block */
2752 if (instr->opcode == VINSTR_COND) {
2753 ontrue = instr->bops[0];
2754 onfalse = instr->bops[1];
2755 /* TODO: have the AST signal which block should
2756 * come first: eg. optimize IFs without ELSE...
2759 stmt.o1.u1 = ir_value_code_addr(instr->_ops[0]);
2763 if (ontrue->generated) {
2764 stmt.opcode = INSTR_IF;
2765 stmt.o2.s1 = (ontrue->code_start) - vec_size(code_statements);
2766 if (stmt.o2.s1 != 1)
2767 code_push_statement(&stmt, instr->context.line);
2769 if (onfalse->generated) {
2770 stmt.opcode = INSTR_IFNOT;
2771 stmt.o2.s1 = (onfalse->code_start) - vec_size(code_statements);
2772 if (stmt.o2.s1 != 1)
2773 code_push_statement(&stmt, instr->context.line);
2775 if (!ontrue->generated) {
2776 if (onfalse->generated) {
2781 if (!onfalse->generated) {
2782 if (ontrue->generated) {
2787 /* neither ontrue nor onfalse exist */
2788 stmt.opcode = INSTR_IFNOT;
2789 if (!instr->likely) {
2790 /* Honor the likelyhood hint */
2791 ir_block *tmp = onfalse;
2792 stmt.opcode = INSTR_IF;
2796 stidx = vec_size(code_statements);
2797 code_push_statement(&stmt, instr->context.line);
2798 /* on false we jump, so add ontrue-path */
2799 if (!gen_blocks_recursive(func, ontrue))
2801 /* fixup the jump address */
2802 code_statements[stidx].o2.s1 = vec_size(code_statements) - stidx;
2803 /* generate onfalse path */
2804 if (onfalse->generated) {
2805 /* fixup the jump address */
2806 code_statements[stidx].o2.s1 = (onfalse->code_start) - (stidx);
2807 if (code_statements[stidx].o2.s1 == 1) {
2808 code_statements[stidx] = code_statements[stidx+1];
2809 if (code_statements[stidx].o1.s1 < 0)
2810 code_statements[stidx].o1.s1++;
2811 code_pop_statement();
2813 stmt.opcode = vec_last(code_statements).opcode;
2814 if (stmt.opcode == INSTR_GOTO ||
2815 stmt.opcode == INSTR_IF ||
2816 stmt.opcode == INSTR_IFNOT ||
2817 stmt.opcode == INSTR_RETURN ||
2818 stmt.opcode == INSTR_DONE)
2820 /* no use jumping from here */
2823 /* may have been generated in the previous recursive call */
2824 stmt.opcode = INSTR_GOTO;
2825 stmt.o1.s1 = (onfalse->code_start) - vec_size(code_statements);
2828 if (stmt.o1.s1 != 1)
2829 code_push_statement(&stmt, instr->context.line);
2832 else if (code_statements[stidx].o2.s1 == 1) {
2833 code_statements[stidx] = code_statements[stidx+1];
2834 if (code_statements[stidx].o1.s1 < 0)
2835 code_statements[stidx].o1.s1++;
2836 code_pop_statement();
2838 /* if not, generate now */
2843 if ( (instr->opcode >= INSTR_CALL0 && instr->opcode <= INSTR_CALL8)
2844 || instr->opcode == VINSTR_NRCALL)
2846 /* Trivial call translation:
2847 * copy all params to OFS_PARM*
2848 * if the output's storetype is not store_return,
2849 * add append a STORE instruction!
2851 * NOTES on how to do it better without much trouble:
2852 * -) The liferanges!
2853 * Simply check the liferange of all parameters for
2854 * other CALLs. For each param with no CALL in its
2855 * liferange, we can store it in an OFS_PARM at
2856 * generation already. This would even include later
2857 * reuse.... probably... :)
2862 first = vec_size(instr->params);
2865 for (p = 0; p < first; ++p)
2867 ir_value *param = instr->params[p];
2869 stmt.opcode = INSTR_STORE_F;
2872 if (param->vtype == TYPE_FIELD)
2873 stmt.opcode = field_store_instr[param->fieldtype];
2875 stmt.opcode = type_store_instr[param->vtype];
2876 stmt.o1.u1 = ir_value_code_addr(param);
2877 stmt.o2.u1 = OFS_PARM0 + 3 * p;
2878 code_push_statement(&stmt, instr->context.line);
2880 /* Now handle extparams */
2881 first = vec_size(instr->params);
2882 for (; p < first; ++p)
2884 ir_builder *ir = func->owner;
2885 ir_value *param = instr->params[p];
2886 ir_value *targetparam;
2888 if (p-8 >= vec_size(ir->extparams))
2889 ir_gen_extparam(ir);
2891 targetparam = ir->extparams[p-8];
2893 stmt.opcode = INSTR_STORE_F;
2896 if (param->vtype == TYPE_FIELD)
2897 stmt.opcode = field_store_instr[param->fieldtype];
2899 stmt.opcode = type_store_instr[param->vtype];
2900 stmt.o1.u1 = ir_value_code_addr(param);
2901 stmt.o2.u1 = ir_value_code_addr(targetparam);
2902 code_push_statement(&stmt, instr->context.line);
2905 stmt.opcode = INSTR_CALL0 + vec_size(instr->params);
2906 if (stmt.opcode > INSTR_CALL8)
2907 stmt.opcode = INSTR_CALL8;
2908 stmt.o1.u1 = ir_value_code_addr(instr->_ops[1]);
2911 code_push_statement(&stmt, instr->context.line);
2913 retvalue = instr->_ops[0];
2914 if (retvalue && retvalue->store != store_return && (vec_size(retvalue->life) || retvalue->store == store_global))
2916 /* not to be kept in OFS_RETURN */
2917 if (retvalue->vtype == TYPE_FIELD && OPTS_FLAG(ADJUST_VECTOR_FIELDS))
2918 stmt.opcode = field_store_instr[retvalue->fieldtype];
2920 stmt.opcode = type_store_instr[retvalue->vtype];
2921 stmt.o1.u1 = OFS_RETURN;
2922 stmt.o2.u1 = ir_value_code_addr(retvalue);
2924 code_push_statement(&stmt, instr->context.line);
2929 if (instr->opcode == INSTR_STATE) {
2930 irerror(block->context, "TODO: state instruction");
2934 stmt.opcode = instr->opcode;
2939 /* This is the general order of operands */
2941 stmt.o3.u1 = ir_value_code_addr(instr->_ops[0]);
2944 stmt.o1.u1 = ir_value_code_addr(instr->_ops[1]);
2947 stmt.o2.u1 = ir_value_code_addr(instr->_ops[2]);
2949 if (stmt.opcode == INSTR_RETURN || stmt.opcode == INSTR_DONE)
2951 stmt.o1.u1 = stmt.o3.u1;
2954 else if ((stmt.opcode >= INSTR_STORE_F &&
2955 stmt.opcode <= INSTR_STORE_FNC) ||
2956 (stmt.opcode >= INSTR_STOREP_F &&
2957 stmt.opcode <= INSTR_STOREP_FNC))
2959 /* 2-operand instructions with A -> B */
2960 stmt.o2.u1 = stmt.o3.u1;
2963 /* tiny optimization, don't output
2966 if (stmt.o2.u1 == stmt.o1.u1 &&
2967 OPTS_OPTIMIZATION(OPTIM_PEEPHOLE))
2969 ++opts_optimizationcount[OPTIM_PEEPHOLE];
2974 code_push_statement(&stmt, instr->context.line);
2979 static bool gen_function_code(ir_function *self)
2982 prog_section_statement stmt;
2984 /* Starting from entry point, we generate blocks "as they come"
2985 * for now. Dead blocks will not be translated obviously.
2987 if (!vec_size(self->blocks)) {
2988 irerror(self->context, "Function '%s' declared without body.", self->name);
2992 block = self->blocks[0];
2993 if (block->generated)
2996 if (!gen_blocks_recursive(self, block)) {
2997 irerror(self->context, "failed to generate blocks for '%s'", self->name);
3001 /* code_write and qcvm -disasm need to know that the function ends here */
3002 stmt.opcode = INSTR_DONE;
3006 code_push_statement(&stmt, vec_last(code_linenums));
3010 static qcint ir_builder_filestring(ir_builder *ir, const char *filename)
3012 /* NOTE: filename pointers are copied, we never strdup them,
3013 * thus we can use pointer-comparison to find the string.
3018 for (i = 0; i < vec_size(ir->filenames); ++i) {
3019 if (ir->filenames[i] == filename)
3020 return ir->filestrings[i];
3023 str = code_genstring(filename);
3024 vec_push(ir->filenames, filename);
3025 vec_push(ir->filestrings, str);
3029 static bool gen_global_function(ir_builder *ir, ir_value *global)
3031 prog_section_function fun;
3036 if (!global->hasvalue || (!global->constval.vfunc))
3038 irerror(global->context, "Invalid state of function-global: not constant: %s", global->name);
3042 irfun = global->constval.vfunc;
3044 fun.name = global->code.name;
3045 fun.file = ir_builder_filestring(ir, global->context.file);
3046 fun.profile = 0; /* always 0 */
3047 fun.nargs = vec_size(irfun->params);
3051 for (i = 0;i < 8; ++i) {
3052 if ((int32_t)i >= fun.nargs)
3055 fun.argsize[i] = type_sizeof_[irfun->params[i]];
3059 fun.locals = irfun->allocated_locals;
3062 fun.entry = irfun->builtin+1;
3064 irfun->code_function_def = vec_size(code_functions);
3065 fun.entry = vec_size(code_statements);
3068 vec_push(code_functions, fun);
3072 static void ir_gen_extparam(ir_builder *ir)
3074 prog_section_def def;
3078 snprintf(name, sizeof(name), "EXTPARM#%i", (int)(vec_size(ir->extparams)+8));
3079 global = ir_value_var(name, store_global, TYPE_VECTOR);
3081 def.name = code_genstring(name);
3082 def.type = TYPE_VECTOR;
3083 def.offset = vec_size(code_globals);
3085 vec_push(code_defs, def);
3086 ir_value_code_setaddr(global, def.offset);
3087 vec_push(code_globals, 0);
3088 vec_push(code_globals, 0);
3089 vec_push(code_globals, 0);
3091 vec_push(ir->extparams, global);
3094 static bool gen_function_extparam_copy(ir_function *self)
3096 size_t i, ext, numparams;
3098 ir_builder *ir = self->owner;
3100 prog_section_statement stmt;
3102 numparams = vec_size(self->params);
3106 stmt.opcode = INSTR_STORE_F;
3108 for (i = 8; i < numparams; ++i) {
3110 if (ext >= vec_size(ir->extparams))
3111 ir_gen_extparam(ir);
3113 ep = ir->extparams[ext];
3115 stmt.opcode = type_store_instr[self->locals[i]->vtype];
3116 if (self->locals[i]->vtype == TYPE_FIELD &&
3117 self->locals[i]->fieldtype == TYPE_VECTOR)
3119 stmt.opcode = INSTR_STORE_V;
3121 stmt.o1.u1 = ir_value_code_addr(ep);
3122 stmt.o2.u1 = ir_value_code_addr(self->locals[i]);
3123 code_push_statement(&stmt, self->context.line);
3129 static bool gen_function_locals(ir_builder *ir, ir_value *global)
3131 prog_section_function *def;
3134 uint32_t firstlocal;
3136 irfun = global->constval.vfunc;
3137 def = code_functions + irfun->code_function_def;
3139 if (opts.g || (irfun->flags & IR_FLAG_MASK_NO_OVERLAP))
3140 firstlocal = def->firstlocal = vec_size(code_globals);
3142 firstlocal = def->firstlocal = ir->first_common_local;
3144 for (i = vec_size(code_globals); i < firstlocal + irfun->allocated_locals; ++i)
3145 vec_push(code_globals, 0);
3146 for (i = 0; i < vec_size(irfun->locals); ++i) {
3147 ir_value_code_setaddr(irfun->locals[i], firstlocal + irfun->locals[i]->code.local);
3148 if (!ir_builder_gen_global(ir, irfun->locals[i], true, true)) {
3149 irerror(irfun->locals[i]->context, "failed to generate local %s", irfun->locals[i]->name);
3153 for (i = 0; i < vec_size(irfun->values); ++i)
3155 ir_value *v = irfun->values[i];
3156 ir_value_code_setaddr(v, firstlocal + v->code.local);
3161 static bool gen_global_function_code(ir_builder *ir, ir_value *global)
3163 prog_section_function *fundef;
3168 irfun = global->constval.vfunc;
3170 if (global->cvq == CV_NONE) {
3171 irwarning(global->context, WARN_IMPLICIT_FUNCTION_POINTER,
3172 "function `%s` has no body and in QC implicitly becomes a function-pointer", global->name);
3174 /* this was a function pointer, don't generate code for those */
3181 if (irfun->code_function_def < 0) {
3182 irerror(irfun->context, "`%s`: IR global wasn't generated, failed to access function-def", irfun->name);
3185 fundef = &code_functions[irfun->code_function_def];
3187 fundef->entry = vec_size(code_statements);
3188 if (!gen_function_locals(ir, global)) {
3189 irerror(irfun->context, "Failed to generate locals for function %s", irfun->name);
3192 if (!gen_function_extparam_copy(irfun)) {
3193 irerror(irfun->context, "Failed to generate extparam-copy code for function %s", irfun->name);
3196 if (!gen_function_code(irfun)) {
3197 irerror(irfun->context, "Failed to generate code for function %s", irfun->name);
3203 static void gen_vector_defs(prog_section_def def, const char *name)
3208 if (!name || name[0] == '#' || OPTS_FLAG(SINGLE_VECTOR_DEFS))
3211 def.type = TYPE_FLOAT;
3215 component = (char*)mem_a(len+3);
3216 memcpy(component, name, len);
3218 component[len-0] = 0;
3219 component[len-2] = '_';
3221 component[len-1] = 'x';
3223 for (i = 0; i < 3; ++i) {
3224 def.name = code_genstring(component);
3225 vec_push(code_defs, def);
3231 static void gen_vector_fields(prog_section_field fld, const char *name)
3236 if (!name || OPTS_FLAG(SINGLE_VECTOR_DEFS))
3239 fld.type = TYPE_FLOAT;
3243 component = (char*)mem_a(len+3);
3244 memcpy(component, name, len);
3246 component[len-0] = 0;
3247 component[len-2] = '_';
3249 component[len-1] = 'x';
3251 for (i = 0; i < 3; ++i) {
3252 fld.name = code_genstring(component);
3253 vec_push(code_fields, fld);
3259 static bool ir_builder_gen_global(ir_builder *self, ir_value *global, bool islocal, bool defs_only)
3263 prog_section_def def;
3264 bool pushdef = false;
3266 if (opts.g || !islocal)
3269 def.type = global->vtype;
3270 def.offset = vec_size(code_globals);
3273 if (global->name[0] == '#') {
3274 if (!self->str_immediate)
3275 self->str_immediate = code_genstring("IMMEDIATE");
3276 def.name = global->code.name = self->str_immediate;
3279 def.name = global->code.name = code_genstring(global->name);
3284 def.offset = ir_value_code_addr(global);
3285 vec_push(code_defs, def);
3286 if (global->vtype == TYPE_VECTOR)
3287 gen_vector_defs(def, global->name);
3288 else if (global->vtype == TYPE_FIELD && global->fieldtype == TYPE_VECTOR)
3289 gen_vector_defs(def, global->name);
3296 switch (global->vtype)
3299 if (!strcmp(global->name, "end_sys_globals")) {
3300 /* TODO: remember this point... all the defs before this one
3301 * should be checksummed and added to progdefs.h when we generate it.
3304 else if (!strcmp(global->name, "end_sys_fields")) {
3305 /* TODO: same as above but for entity-fields rather than globsl
3309 irwarning(global->context, WARN_VOID_VARIABLES, "unrecognized variable of type void `%s`",
3311 /* I'd argue setting it to 0 is sufficient, but maybe some depend on knowing how far
3312 * the system fields actually go? Though the engine knows this anyway...
3313 * Maybe this could be an -foption
3314 * fteqcc creates data for end_sys_* - of size 1, so let's do the same
3316 ir_value_code_setaddr(global, vec_size(code_globals));
3317 vec_push(code_globals, 0);
3319 if (pushdef) vec_push(code_defs, def);
3322 if (pushdef) vec_push(code_defs, def);
3323 return gen_global_pointer(global);
3326 vec_push(code_defs, def);
3327 if (global->fieldtype == TYPE_VECTOR)
3328 gen_vector_defs(def, global->name);
3330 return gen_global_field(global);
3335 ir_value_code_setaddr(global, vec_size(code_globals));
3336 if (global->hasvalue) {
3337 iptr = (int32_t*)&global->constval.ivec[0];
3338 vec_push(code_globals, *iptr);
3340 vec_push(code_globals, 0);
3342 if (!islocal && global->cvq != CV_CONST)
3343 def.type |= DEF_SAVEGLOBAL;
3344 if (pushdef) vec_push(code_defs, def);
3346 return global->code.globaladdr >= 0;
3350 ir_value_code_setaddr(global, vec_size(code_globals));
3351 if (global->hasvalue) {
3352 vec_push(code_globals, code_genstring(global->constval.vstring));
3354 vec_push(code_globals, 0);
3356 if (!islocal && global->cvq != CV_CONST)
3357 def.type |= DEF_SAVEGLOBAL;
3358 if (pushdef) vec_push(code_defs, def);
3359 return global->code.globaladdr >= 0;
3364 ir_value_code_setaddr(global, vec_size(code_globals));
3365 if (global->hasvalue) {
3366 iptr = (int32_t*)&global->constval.ivec[0];
3367 vec_push(code_globals, iptr[0]);
3368 if (global->code.globaladdr < 0)
3370 for (d = 1; d < type_sizeof_[global->vtype]; ++d) {
3371 vec_push(code_globals, iptr[d]);
3374 vec_push(code_globals, 0);
3375 if (global->code.globaladdr < 0)
3377 for (d = 1; d < type_sizeof_[global->vtype]; ++d) {
3378 vec_push(code_globals, 0);
3381 if (!islocal && global->cvq != CV_CONST)
3382 def.type |= DEF_SAVEGLOBAL;
3385 vec_push(code_defs, def);
3386 def.type &= ~DEF_SAVEGLOBAL;
3387 gen_vector_defs(def, global->name);
3389 return global->code.globaladdr >= 0;
3392 ir_value_code_setaddr(global, vec_size(code_globals));
3393 if (!global->hasvalue) {
3394 vec_push(code_globals, 0);
3395 if (global->code.globaladdr < 0)
3398 vec_push(code_globals, vec_size(code_functions));
3399 if (!gen_global_function(self, global))
3402 if (!islocal && global->cvq != CV_CONST)
3403 def.type |= DEF_SAVEGLOBAL;
3404 if (pushdef) vec_push(code_defs, def);
3407 /* assume biggest type */
3408 ir_value_code_setaddr(global, vec_size(code_globals));
3409 vec_push(code_globals, 0);
3410 for (i = 1; i < type_sizeof_[TYPE_VARIANT]; ++i)
3411 vec_push(code_globals, 0);
3414 /* refuse to create 'void' type or any other fancy business. */
3415 irerror(global->context, "Invalid type for global variable `%s`: %s",
3416 global->name, type_name[global->vtype]);
3421 static void ir_builder_prepare_field(ir_value *field)
3423 field->code.fieldaddr = code_alloc_field(type_sizeof_[field->fieldtype]);
3426 static bool ir_builder_gen_field(ir_builder *self, ir_value *field)
3428 prog_section_def def;
3429 prog_section_field fld;
3433 def.type = (uint16_t)field->vtype;
3434 def.offset = (uint16_t)vec_size(code_globals);
3436 /* create a global named the same as the field */
3437 if (opts.standard == COMPILER_GMQCC) {
3438 /* in our standard, the global gets a dot prefix */
3439 size_t len = strlen(field->name);
3442 /* we really don't want to have to allocate this, and 1024
3443 * bytes is more than enough for a variable/field name
3445 if (len+2 >= sizeof(name)) {
3446 irerror(field->context, "invalid field name size: %u", (unsigned int)len);
3451 memcpy(name+1, field->name, len); /* no strncpy - we used strlen above */
3454 def.name = code_genstring(name);
3455 fld.name = def.name + 1; /* we reuse that string table entry */
3457 /* in plain QC, there cannot be a global with the same name,
3458 * and so we also name the global the same.
3459 * FIXME: fteqcc should create a global as well
3460 * check if it actually uses the same name. Probably does
3462 def.name = code_genstring(field->name);
3463 fld.name = def.name;
3466 field->code.name = def.name;
3468 vec_push(code_defs, def);
3470 fld.type = field->fieldtype;
3472 if (fld.type == TYPE_VOID) {
3473 irerror(field->context, "field is missing a type: %s - don't know its size", field->name);
3477 fld.offset = field->code.fieldaddr;
3479 vec_push(code_fields, fld);
3481 ir_value_code_setaddr(field, vec_size(code_globals));
3482 vec_push(code_globals, fld.offset);
3483 if (fld.type == TYPE_VECTOR) {
3484 vec_push(code_globals, fld.offset+1);
3485 vec_push(code_globals, fld.offset+2);
3488 if (field->fieldtype == TYPE_VECTOR) {
3489 gen_vector_defs(def, field->name);
3490 gen_vector_fields(fld, field->name);
3493 return field->code.globaladdr >= 0;
3496 bool ir_builder_generate(ir_builder *self, const char *filename)
3498 prog_section_statement stmt;
3500 char *lnofile = NULL;
3504 for (i = 0; i < vec_size(self->fields); ++i)
3506 ir_builder_prepare_field(self->fields[i]);
3509 for (i = 0; i < vec_size(self->globals); ++i)
3511 if (!ir_builder_gen_global(self, self->globals[i], false, false)) {
3514 if (self->globals[i]->vtype == TYPE_FUNCTION) {
3515 ir_function *func = self->globals[i]->constval.vfunc;
3516 if (func && self->max_locals < func->allocated_locals &&
3517 !(func->flags & IR_FLAG_MASK_NO_OVERLAP))
3519 self->max_locals = func->allocated_locals;
3524 for (i = 0; i < vec_size(self->fields); ++i)
3526 if (!ir_builder_gen_field(self, self->fields[i])) {
3531 /* generate common locals */
3532 self->first_common_local = vec_size(code_globals);
3533 for (i = 0; i < self->max_locals; ++i) {
3534 vec_push(code_globals, 0);
3537 /* generate function code */
3538 for (i = 0; i < vec_size(self->globals); ++i)
3540 if (self->globals[i]->vtype == TYPE_FUNCTION) {
3541 if (!gen_global_function_code(self, self->globals[i])) {
3547 if (vec_size(code_globals) >= 65536) {
3548 irerror(vec_last(self->globals)->context, "This progs file would require more globals than the metadata can handle. Bailing out.");
3552 /* DP errors if the last instruction is not an INSTR_DONE. */
3553 if (vec_last(code_statements).opcode != INSTR_DONE)
3555 stmt.opcode = INSTR_DONE;
3559 code_push_statement(&stmt, vec_last(code_linenums));
3565 if (vec_size(code_statements) != vec_size(code_linenums)) {
3566 con_err("Linecounter wrong: %lu != %lu\n",
3567 (unsigned long)vec_size(code_statements),
3568 (unsigned long)vec_size(code_linenums));
3569 } else if (OPTS_FLAG(LNO)) {
3571 size_t filelen = strlen(filename);
3573 memcpy(vec_add(lnofile, filelen+1), filename, filelen+1);
3574 dot = strrchr(lnofile, '.');
3578 vec_shrinkto(lnofile, dot - lnofile);
3580 memcpy(vec_add(lnofile, 5), ".lno", 5);
3584 con_out("writing '%s' and '%s'...\n", filename, lnofile);
3586 con_out("writing '%s'\n", filename);
3587 if (!code_write(filename, lnofile)) {
3595 /***********************************************************************
3596 *IR DEBUG Dump functions...
3599 #define IND_BUFSZ 1024
3602 # define strncat(dst, src, sz) strncat_s(dst, sz, src, _TRUNCATE)
3605 const char *qc_opname(int op)
3607 if (op < 0) return "<INVALID>";
3608 if (op < (int)( sizeof(asm_instr) / sizeof(asm_instr[0]) ))
3609 return asm_instr[op].m;
3611 case VINSTR_PHI: return "PHI";
3612 case VINSTR_JUMP: return "JUMP";
3613 case VINSTR_COND: return "COND";
3614 default: return "<UNK>";
3618 void ir_builder_dump(ir_builder *b, int (*oprintf)(const char*, ...))
3621 char indent[IND_BUFSZ];
3625 oprintf("module %s\n", b->name);
3626 for (i = 0; i < vec_size(b->globals); ++i)
3629 if (b->globals[i]->hasvalue)
3630 oprintf("%s = ", b->globals[i]->name);
3631 ir_value_dump(b->globals[i], oprintf);
3634 for (i = 0; i < vec_size(b->functions); ++i)
3635 ir_function_dump(b->functions[i], indent, oprintf);
3636 oprintf("endmodule %s\n", b->name);
3639 void ir_function_dump(ir_function *f, char *ind,
3640 int (*oprintf)(const char*, ...))
3643 if (f->builtin != 0) {
3644 oprintf("%sfunction %s = builtin %i\n", ind, f->name, -f->builtin);
3647 oprintf("%sfunction %s\n", ind, f->name);
3648 strncat(ind, "\t", IND_BUFSZ);
3649 if (vec_size(f->locals))
3651 oprintf("%s%i locals:\n", ind, (int)vec_size(f->locals));
3652 for (i = 0; i < vec_size(f->locals); ++i) {
3653 oprintf("%s\t", ind);
3654 ir_value_dump(f->locals[i], oprintf);
3658 oprintf("%sliferanges:\n", ind);
3659 for (i = 0; i < vec_size(f->locals); ++i) {
3661 ir_value *v = f->locals[i];
3662 oprintf("%s\t%s: %s@%i ", ind, v->name, (v->unique_life ? "unique " : ""), (int)v->code.local);
3663 for (l = 0; l < vec_size(v->life); ++l) {
3664 oprintf("[%i,%i] ", v->life[l].start, v->life[l].end);
3668 for (i = 0; i < vec_size(f->values); ++i) {
3670 ir_value *v = f->values[i];
3671 oprintf("%s\t%s: @%i ", ind, v->name, (int)v->code.local);
3672 for (l = 0; l < vec_size(v->life); ++l) {
3673 oprintf("[%i,%i] ", v->life[l].start, v->life[l].end);
3677 if (vec_size(f->blocks))
3679 oprintf("%slife passes (check): %i\n", ind, (int)f->run_id);
3680 for (i = 0; i < vec_size(f->blocks); ++i) {
3681 if (f->blocks[i]->run_id != f->run_id) {
3682 oprintf("%slife pass check fail! %i != %i\n", ind, (int)f->blocks[i]->run_id, (int)f->run_id);
3684 ir_block_dump(f->blocks[i], ind, oprintf);
3688 ind[strlen(ind)-1] = 0;
3689 oprintf("%sendfunction %s\n", ind, f->name);
3692 void ir_block_dump(ir_block* b, char *ind,
3693 int (*oprintf)(const char*, ...))
3696 oprintf("%s:%s\n", ind, b->label);
3697 strncat(ind, "\t", IND_BUFSZ);
3699 for (i = 0; i < vec_size(b->instr); ++i)
3700 ir_instr_dump(b->instr[i], ind, oprintf);
3701 ind[strlen(ind)-1] = 0;
3704 void dump_phi(ir_instr *in, int (*oprintf)(const char*, ...))
3707 oprintf("%s <- phi ", in->_ops[0]->name);
3708 for (i = 0; i < vec_size(in->phi); ++i)
3710 oprintf("([%s] : %s) ", in->phi[i].from->label,
3711 in->phi[i].value->name);
3716 void ir_instr_dump(ir_instr *in, char *ind,
3717 int (*oprintf)(const char*, ...))
3720 const char *comma = NULL;
3722 oprintf("%s (%i) ", ind, (int)in->eid);
3724 if (in->opcode == VINSTR_PHI) {
3725 dump_phi(in, oprintf);
3729 strncat(ind, "\t", IND_BUFSZ);
3731 if (in->_ops[0] && (in->_ops[1] || in->_ops[2])) {
3732 ir_value_dump(in->_ops[0], oprintf);
3733 if (in->_ops[1] || in->_ops[2])
3736 if (in->opcode == INSTR_CALL0 || in->opcode == VINSTR_NRCALL) {
3737 oprintf("CALL%i\t", vec_size(in->params));
3739 oprintf("%s\t", qc_opname(in->opcode));
3741 if (in->_ops[0] && !(in->_ops[1] || in->_ops[2])) {
3742 ir_value_dump(in->_ops[0], oprintf);
3747 for (i = 1; i != 3; ++i) {
3751 ir_value_dump(in->_ops[i], oprintf);
3759 oprintf("[%s]", in->bops[0]->label);
3763 oprintf("%s[%s]", comma, in->bops[1]->label);
3764 if (vec_size(in->params)) {
3765 oprintf("\tparams: ");
3766 for (i = 0; i != vec_size(in->params); ++i) {
3767 oprintf("%s, ", in->params[i]->name);
3771 ind[strlen(ind)-1] = 0;
3774 void ir_value_dump_string(const char *str, int (*oprintf)(const char*, ...))
3777 for (; *str; ++str) {
3779 case '\n': oprintf("\\n"); break;
3780 case '\r': oprintf("\\r"); break;
3781 case '\t': oprintf("\\t"); break;
3782 case '\v': oprintf("\\v"); break;
3783 case '\f': oprintf("\\f"); break;
3784 case '\b': oprintf("\\b"); break;
3785 case '\a': oprintf("\\a"); break;
3786 case '\\': oprintf("\\\\"); break;
3787 case '"': oprintf("\\\""); break;
3788 default: oprintf("%c", *str); break;
3794 void ir_value_dump(ir_value* v, int (*oprintf)(const char*, ...))
3803 oprintf("fn:%s", v->name);
3806 oprintf("%g", v->constval.vfloat);
3809 oprintf("'%g %g %g'",
3812 v->constval.vvec.z);
3815 oprintf("(entity)");
3818 ir_value_dump_string(v->constval.vstring, oprintf);
3822 oprintf("%i", v->constval.vint);
3827 v->constval.vpointer->name);
3831 oprintf("%s", v->name);
3835 void ir_value_dump_life(const ir_value *self, int (*oprintf)(const char*,...))
3838 oprintf("Life of %12s:", self->name);
3839 for (i = 0; i < vec_size(self->life); ++i)
3841 oprintf(" + [%i, %i]\n", self->life[i].start, self->life[i].end);