5 * Permission is hereby granted, free of charge, to any person obtaining a copy of
6 * this software and associated documentation files (the "Software"), to deal in
7 * the Software without restriction, including without limitation the rights to
8 * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
9 * of the Software, and to permit persons to whom the Software is furnished to do
10 * so, subject to the following conditions:
12 * The above copyright notice and this permission notice shall be included in all
13 * copies or substantial portions of the Software.
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
28 /***********************************************************************
29 * Type sizes used at multiple points in the IR codegen
32 const char *type_name[TYPE_COUNT] = {
48 size_t type_sizeof_[TYPE_COUNT] = {
55 1, /* TYPE_FUNCTION */
64 uint16_t type_store_instr[TYPE_COUNT] = {
65 INSTR_STORE_F, /* should use I when having integer support */
72 INSTR_STORE_ENT, /* should use I */
74 INSTR_STORE_I, /* integer type */
79 INSTR_STORE_V, /* variant, should never be accessed */
81 AINSTR_END, /* struct */
82 AINSTR_END, /* union */
83 AINSTR_END, /* array */
86 uint16_t field_store_instr[TYPE_COUNT] = {
96 INSTR_STORE_FLD, /* integer type */
101 INSTR_STORE_V, /* variant, should never be accessed */
103 AINSTR_END, /* struct */
104 AINSTR_END, /* union */
105 AINSTR_END, /* array */
108 uint16_t type_storep_instr[TYPE_COUNT] = {
109 INSTR_STOREP_F, /* should use I when having integer support */
116 INSTR_STOREP_ENT, /* should use I */
118 INSTR_STOREP_ENT, /* integer type */
123 INSTR_STOREP_V, /* variant, should never be accessed */
125 AINSTR_END, /* struct */
126 AINSTR_END, /* union */
127 AINSTR_END, /* array */
130 uint16_t type_eq_instr[TYPE_COUNT] = {
131 INSTR_EQ_F, /* should use I when having integer support */
136 INSTR_EQ_E, /* FLD has no comparison */
138 INSTR_EQ_E, /* should use I */
145 INSTR_EQ_V, /* variant, should never be accessed */
147 AINSTR_END, /* struct */
148 AINSTR_END, /* union */
149 AINSTR_END, /* array */
152 uint16_t type_ne_instr[TYPE_COUNT] = {
153 INSTR_NE_F, /* should use I when having integer support */
158 INSTR_NE_E, /* FLD has no comparison */
160 INSTR_NE_E, /* should use I */
167 INSTR_NE_V, /* variant, should never be accessed */
169 AINSTR_END, /* struct */
170 AINSTR_END, /* union */
171 AINSTR_END, /* array */
174 uint16_t type_not_instr[TYPE_COUNT] = {
175 INSTR_NOT_F, /* should use I when having integer support */
182 INSTR_NOT_ENT, /* should use I */
184 INSTR_NOT_I, /* integer type */
189 INSTR_NOT_V, /* variant, should never be accessed */
191 AINSTR_END, /* struct */
192 AINSTR_END, /* union */
193 AINSTR_END, /* array */
197 static void ir_gen_extparam(ir_builder *ir);
199 /* error functions */
201 static void irerror(lex_ctx ctx, const char *msg, ...)
205 con_cvprintmsg((void*)&ctx, LVL_ERROR, "internal error", msg, ap);
209 static bool irwarning(lex_ctx ctx, int warntype, const char *fmt, ...)
214 r = vcompile_warning(ctx, warntype, fmt, ap);
219 /***********************************************************************
220 * Vector utility functions
223 bool GMQCC_WARN vec_ir_value_find(ir_value **vec, ir_value *what, size_t *idx)
226 size_t len = vec_size(vec);
227 for (i = 0; i < len; ++i) {
228 if (vec[i] == what) {
236 bool GMQCC_WARN vec_ir_block_find(ir_block **vec, ir_block *what, size_t *idx)
239 size_t len = vec_size(vec);
240 for (i = 0; i < len; ++i) {
241 if (vec[i] == what) {
249 bool GMQCC_WARN vec_ir_instr_find(ir_instr **vec, ir_instr *what, size_t *idx)
252 size_t len = vec_size(vec);
253 for (i = 0; i < len; ++i) {
254 if (vec[i] == what) {
262 /***********************************************************************
266 static void ir_block_delete_quick(ir_block* self);
267 static void ir_instr_delete_quick(ir_instr *self);
268 static void ir_function_delete_quick(ir_function *self);
270 ir_builder* ir_builder_new(const char *modulename)
274 self = (ir_builder*)mem_a(sizeof(*self));
278 self->functions = NULL;
279 self->globals = NULL;
281 self->extparams = NULL;
282 self->filenames = NULL;
283 self->filestrings = NULL;
284 self->htglobals = util_htnew(IR_HT_SIZE);
285 self->htfields = util_htnew(IR_HT_SIZE);
286 self->htfunctions = util_htnew(IR_HT_SIZE);
288 self->str_immediate = 0;
290 if (!ir_builder_set_name(self, modulename)) {
298 void ir_builder_delete(ir_builder* self)
301 util_htdel(self->htglobals);
302 util_htdel(self->htfields);
303 util_htdel(self->htfunctions);
304 mem_d((void*)self->name);
305 for (i = 0; i != vec_size(self->functions); ++i) {
306 ir_function_delete_quick(self->functions[i]);
308 vec_free(self->functions);
309 for (i = 0; i != vec_size(self->extparams); ++i) {
310 ir_value_delete(self->extparams[i]);
312 vec_free(self->extparams);
313 for (i = 0; i != vec_size(self->globals); ++i) {
314 ir_value_delete(self->globals[i]);
316 vec_free(self->globals);
317 for (i = 0; i != vec_size(self->fields); ++i) {
318 ir_value_delete(self->fields[i]);
320 vec_free(self->fields);
321 vec_free(self->filenames);
322 vec_free(self->filestrings);
326 bool ir_builder_set_name(ir_builder *self, const char *name)
329 mem_d((void*)self->name);
330 self->name = util_strdup(name);
334 ir_function* ir_builder_get_function(ir_builder *self, const char *name)
336 return (ir_function*)util_htget(self->htfunctions, name);
339 ir_function* ir_builder_create_function(ir_builder *self, const char *name, int outtype)
341 ir_function *fn = ir_builder_get_function(self, name);
346 fn = ir_function_new(self, outtype);
347 if (!ir_function_set_name(fn, name))
349 ir_function_delete(fn);
352 vec_push(self->functions, fn);
353 util_htset(self->htfunctions, name, fn);
355 fn->value = ir_builder_create_global(self, fn->name, TYPE_FUNCTION);
357 ir_function_delete(fn);
361 fn->value->hasvalue = true;
362 fn->value->outtype = outtype;
363 fn->value->constval.vfunc = fn;
364 fn->value->context = fn->context;
369 ir_value* ir_builder_get_global(ir_builder *self, const char *name)
371 return (ir_value*)util_htget(self->htglobals, name);
374 ir_value* ir_builder_create_global(ir_builder *self, const char *name, int vtype)
378 if (name && name[0] != '#')
380 ve = ir_builder_get_global(self, name);
386 ve = ir_value_var(name, store_global, vtype);
387 vec_push(self->globals, ve);
388 util_htset(self->htglobals, name, ve);
392 ir_value* ir_builder_get_field(ir_builder *self, const char *name)
394 return (ir_value*)util_htget(self->htfields, name);
398 ir_value* ir_builder_create_field(ir_builder *self, const char *name, int vtype)
400 ir_value *ve = ir_builder_get_field(self, name);
405 ve = ir_value_var(name, store_global, TYPE_FIELD);
406 ve->fieldtype = vtype;
407 vec_push(self->fields, ve);
408 util_htset(self->htfields, name, ve);
412 /***********************************************************************
416 bool ir_function_naive_phi(ir_function*);
417 void ir_function_enumerate(ir_function*);
418 bool ir_function_calculate_liferanges(ir_function*);
419 bool ir_function_allocate_locals(ir_function*);
421 ir_function* ir_function_new(ir_builder* owner, int outtype)
424 self = (ir_function*)mem_a(sizeof(*self));
429 memset(self, 0, sizeof(*self));
432 if (!ir_function_set_name(self, "<@unnamed>")) {
439 self->context.file = "<@no context>";
440 self->context.line = 0;
441 self->outtype = outtype;
450 self->code_function_def = -1;
451 self->allocated_locals = 0;
457 bool ir_function_set_name(ir_function *self, const char *name)
460 mem_d((void*)self->name);
461 self->name = util_strdup(name);
465 static void ir_function_delete_quick(ir_function *self)
468 mem_d((void*)self->name);
470 for (i = 0; i != vec_size(self->blocks); ++i)
471 ir_block_delete_quick(self->blocks[i]);
472 vec_free(self->blocks);
474 vec_free(self->params);
476 for (i = 0; i != vec_size(self->values); ++i)
477 ir_value_delete(self->values[i]);
478 vec_free(self->values);
480 for (i = 0; i != vec_size(self->locals); ++i)
481 ir_value_delete(self->locals[i]);
482 vec_free(self->locals);
484 /* self->value is deleted by the builder */
489 void ir_function_delete(ir_function *self)
492 mem_d((void*)self->name);
494 for (i = 0; i != vec_size(self->blocks); ++i)
495 ir_block_delete(self->blocks[i]);
496 vec_free(self->blocks);
498 vec_free(self->params);
500 for (i = 0; i != vec_size(self->values); ++i)
501 ir_value_delete(self->values[i]);
502 vec_free(self->values);
504 for (i = 0; i != vec_size(self->locals); ++i)
505 ir_value_delete(self->locals[i]);
506 vec_free(self->locals);
508 /* self->value is deleted by the builder */
513 void ir_function_collect_value(ir_function *self, ir_value *v)
515 vec_push(self->values, v);
518 ir_block* ir_function_create_block(lex_ctx ctx, ir_function *self, const char *label)
520 ir_block* bn = ir_block_new(self, label);
522 vec_push(self->blocks, bn);
526 static bool instr_is_operation(uint16_t op)
528 return ( (op >= INSTR_MUL_F && op <= INSTR_GT) ||
529 (op >= INSTR_LOAD_F && op <= INSTR_LOAD_FNC) ||
530 (op == INSTR_ADDRESS) ||
531 (op >= INSTR_NOT_F && op <= INSTR_NOT_FNC) ||
532 (op >= INSTR_AND && op <= INSTR_BITOR) ||
533 (op >= INSTR_CALL0 && op <= INSTR_CALL8) );
536 bool ir_function_pass_peephole(ir_function *self)
540 for (b = 0; b < vec_size(self->blocks); ++b) {
542 ir_block *block = self->blocks[b];
544 for (i = 0; i < vec_size(block->instr); ++i) {
546 inst = block->instr[i];
549 (inst->opcode >= INSTR_STORE_F &&
550 inst->opcode <= INSTR_STORE_FNC))
558 oper = block->instr[i-1];
559 if (!instr_is_operation(oper->opcode))
562 value = oper->_ops[0];
564 /* only do it for SSA values */
565 if (value->store != store_value)
568 /* don't optimize out the temp if it's used later again */
569 if (vec_size(value->reads) != 1)
572 /* The very next store must use this value */
573 if (value->reads[0] != store)
576 /* And of course the store must _read_ from it, so it's in
578 if (store->_ops[1] != value)
581 ++opts_optimizationcount[OPTIM_PEEPHOLE];
582 (void)!ir_instr_op(oper, 0, store->_ops[0], true);
584 vec_remove(block->instr, i, 1);
585 ir_instr_delete(store);
587 else if (inst->opcode == VINSTR_COND)
589 /* COND on a value resulting from a NOT could
590 * remove the NOT and swap its operands
597 value = inst->_ops[0];
599 if (value->store != store_value ||
600 vec_size(value->reads) != 1 ||
601 value->reads[0] != inst)
606 inot = value->writes[0];
607 if (inot->_ops[0] != value ||
608 inot->opcode < INSTR_NOT_F ||
609 inot->opcode > INSTR_NOT_FNC ||
610 inot->opcode == INSTR_NOT_V) /* can't do this one */
616 ++opts_optimizationcount[OPTIM_PEEPHOLE];
618 (void)!ir_instr_op(inst, 0, inot->_ops[1], false);
621 for (inotid = 0; inotid < vec_size(tmp->instr); ++inotid) {
622 if (tmp->instr[inotid] == inot)
625 if (inotid >= vec_size(tmp->instr)) {
626 compile_error(inst->context, "sanity-check failed: failed to find instruction to optimize out");
629 vec_remove(tmp->instr, inotid, 1);
630 ir_instr_delete(inot);
631 /* swap ontrue/onfalse */
633 inst->bops[0] = inst->bops[1];
644 bool ir_function_pass_tailrecursion(ir_function *self)
648 for (b = 0; b < vec_size(self->blocks); ++b) {
650 ir_instr *ret, *call, *store = NULL;
651 ir_block *block = self->blocks[b];
653 if (!block->final || vec_size(block->instr) < 2)
656 ret = block->instr[vec_size(block->instr)-1];
657 if (ret->opcode != INSTR_DONE && ret->opcode != INSTR_RETURN)
660 call = block->instr[vec_size(block->instr)-2];
661 if (call->opcode >= INSTR_STORE_F && call->opcode <= INSTR_STORE_FNC) {
662 /* account for the unoptimized
664 * STORE %return, %tmp
668 if (vec_size(block->instr) < 3)
672 call = block->instr[vec_size(block->instr)-3];
675 if (call->opcode < INSTR_CALL0 || call->opcode > INSTR_CALL8)
679 /* optimize out the STORE */
681 ret->_ops[0] == store->_ops[0] &&
682 store->_ops[1] == call->_ops[0])
684 ++opts_optimizationcount[OPTIM_PEEPHOLE];
685 call->_ops[0] = store->_ops[0];
686 vec_remove(block->instr, vec_size(block->instr) - 2, 1);
687 ir_instr_delete(store);
696 funcval = call->_ops[1];
699 if (funcval->vtype != TYPE_FUNCTION || funcval->constval.vfunc != self)
702 /* now we have a CALL and a RET, check if it's a tailcall */
703 if (ret->_ops[0] && call->_ops[0] != ret->_ops[0])
706 ++opts_optimizationcount[OPTIM_TAIL_RECURSION];
707 vec_shrinkby(block->instr, 2);
709 block->final = false; /* open it back up */
711 /* emite parameter-stores */
712 for (p = 0; p < vec_size(call->params); ++p) {
713 /* assert(call->params_count <= self->locals_count); */
714 if (!ir_block_create_store(block, call->context, self->locals[p], call->params[p])) {
715 irerror(call->context, "failed to create tailcall store instruction for parameter %i", (int)p);
719 if (!ir_block_create_jump(block, call->context, self->blocks[0])) {
720 irerror(call->context, "failed to create tailcall jump");
724 ir_instr_delete(call);
725 ir_instr_delete(ret);
731 bool ir_function_finalize(ir_function *self)
736 if (OPTS_OPTIMIZATION(OPTIM_PEEPHOLE)) {
737 if (!ir_function_pass_peephole(self)) {
738 irerror(self->context, "generic optimization pass broke something in `%s`", self->name);
743 if (OPTS_OPTIMIZATION(OPTIM_TAIL_RECURSION)) {
744 if (!ir_function_pass_tailrecursion(self)) {
745 irerror(self->context, "tail-recursion optimization pass broke something in `%s`", self->name);
750 if (!ir_function_naive_phi(self))
753 ir_function_enumerate(self);
755 if (!ir_function_calculate_liferanges(self))
757 if (!ir_function_allocate_locals(self))
762 ir_value* ir_function_create_local(ir_function *self, const char *name, int vtype, bool param)
767 vec_size(self->locals) &&
768 self->locals[vec_size(self->locals)-1]->store != store_param) {
769 irerror(self->context, "cannot add parameters after adding locals");
773 ve = ir_value_var(name, (param ? store_param : store_local), vtype);
774 vec_push(self->locals, ve);
778 /***********************************************************************
782 ir_block* ir_block_new(ir_function* owner, const char *name)
785 self = (ir_block*)mem_a(sizeof(*self));
789 memset(self, 0, sizeof(*self));
792 if (name && !ir_block_set_label(self, name)) {
797 self->context.file = "<@no context>";
798 self->context.line = 0;
802 self->entries = NULL;
806 self->is_return = false;
811 self->generated = false;
816 static void ir_block_delete_quick(ir_block* self)
819 if (self->label) mem_d(self->label);
820 for (i = 0; i != vec_size(self->instr); ++i)
821 ir_instr_delete_quick(self->instr[i]);
822 vec_free(self->instr);
823 vec_free(self->entries);
824 vec_free(self->exits);
825 vec_free(self->living);
829 void ir_block_delete(ir_block* self)
832 if (self->label) mem_d(self->label);
833 for (i = 0; i != vec_size(self->instr); ++i)
834 ir_instr_delete(self->instr[i]);
835 vec_free(self->instr);
836 vec_free(self->entries);
837 vec_free(self->exits);
838 vec_free(self->living);
842 bool ir_block_set_label(ir_block *self, const char *name)
845 mem_d((void*)self->label);
846 self->label = util_strdup(name);
847 return !!self->label;
850 /***********************************************************************
854 ir_instr* ir_instr_new(lex_ctx ctx, ir_block* owner, int op)
857 self = (ir_instr*)mem_a(sizeof(*self));
864 self->_ops[0] = NULL;
865 self->_ops[1] = NULL;
866 self->_ops[2] = NULL;
867 self->bops[0] = NULL;
868 self->bops[1] = NULL;
879 static void ir_instr_delete_quick(ir_instr *self)
882 vec_free(self->params);
886 void ir_instr_delete(ir_instr *self)
889 /* The following calls can only delete from
890 * vectors, we still want to delete this instruction
891 * so ignore the return value. Since with the warn_unused_result attribute
892 * gcc doesn't care about an explicit: (void)foo(); to ignore the result,
893 * I have to improvise here and use if(foo());
895 for (i = 0; i < vec_size(self->phi); ++i) {
897 if (vec_ir_instr_find(self->phi[i].value->writes, self, &idx))
898 vec_remove(self->phi[i].value->writes, idx, 1);
899 if (vec_ir_instr_find(self->phi[i].value->reads, self, &idx))
900 vec_remove(self->phi[i].value->reads, idx, 1);
903 for (i = 0; i < vec_size(self->params); ++i) {
905 if (vec_ir_instr_find(self->params[i]->writes, self, &idx))
906 vec_remove(self->params[i]->writes, idx, 1);
907 if (vec_ir_instr_find(self->params[i]->reads, self, &idx))
908 vec_remove(self->params[i]->reads, idx, 1);
910 vec_free(self->params);
911 (void)!ir_instr_op(self, 0, NULL, false);
912 (void)!ir_instr_op(self, 1, NULL, false);
913 (void)!ir_instr_op(self, 2, NULL, false);
917 bool ir_instr_op(ir_instr *self, int op, ir_value *v, bool writing)
919 if (self->_ops[op]) {
921 if (writing && vec_ir_instr_find(self->_ops[op]->writes, self, &idx))
922 vec_remove(self->_ops[op]->writes, idx, 1);
923 else if (vec_ir_instr_find(self->_ops[op]->reads, self, &idx))
924 vec_remove(self->_ops[op]->reads, idx, 1);
928 vec_push(v->writes, self);
930 vec_push(v->reads, self);
936 /***********************************************************************
940 void ir_value_code_setaddr(ir_value *self, int32_t gaddr)
942 self->code.globaladdr = gaddr;
943 if (self->members[0]) self->members[0]->code.globaladdr = gaddr;
944 if (self->members[1]) self->members[1]->code.globaladdr = gaddr;
945 if (self->members[2]) self->members[2]->code.globaladdr = gaddr;
948 int32_t ir_value_code_addr(const ir_value *self)
950 if (self->store == store_return)
951 return OFS_RETURN + self->code.addroffset;
952 return self->code.globaladdr + self->code.addroffset;
955 ir_value* ir_value_var(const char *name, int storetype, int vtype)
958 self = (ir_value*)mem_a(sizeof(*self));
960 self->fieldtype = TYPE_VOID;
961 self->outtype = TYPE_VOID;
962 self->store = storetype;
968 self->hasvalue = false;
969 self->context.file = "<@no context>";
970 self->context.line = 0;
972 if (name && !ir_value_set_name(self, name)) {
973 irerror(self->context, "out of memory");
978 memset(&self->constval, 0, sizeof(self->constval));
979 memset(&self->code, 0, sizeof(self->code));
981 self->members[0] = NULL;
982 self->members[1] = NULL;
983 self->members[2] = NULL;
984 self->memberof = NULL;
986 self->unique_life = false;
992 ir_value* ir_value_vector_member(ir_value *self, unsigned int member)
1000 if (self->members[member])
1001 return self->members[member];
1004 len = strlen(self->name);
1005 name = (char*)mem_a(len + 3);
1006 memcpy(name, self->name, len);
1008 name[len+1] = 'x' + member;
1014 if (self->vtype == TYPE_VECTOR)
1016 m = ir_value_var(name, self->store, TYPE_FLOAT);
1021 m->context = self->context;
1023 self->members[member] = m;
1024 m->code.addroffset = member;
1026 else if (self->vtype == TYPE_FIELD)
1028 if (self->fieldtype != TYPE_VECTOR)
1030 m = ir_value_var(name, self->store, TYPE_FIELD);
1035 m->fieldtype = TYPE_FLOAT;
1036 m->context = self->context;
1038 self->members[member] = m;
1039 m->code.addroffset = member;
1043 irerror(self->context, "invalid member access on %s", self->name);
1051 static GMQCC_INLINE size_t ir_value_sizeof(const ir_value *self)
1053 if (self->vtype == TYPE_FIELD && self->fieldtype == TYPE_VECTOR)
1054 return type_sizeof_[TYPE_VECTOR];
1055 return type_sizeof_[self->vtype];
1058 ir_value* ir_value_out(ir_function *owner, const char *name, int storetype, int vtype)
1060 ir_value *v = ir_value_var(name, storetype, vtype);
1063 ir_function_collect_value(owner, v);
1067 void ir_value_delete(ir_value* self)
1071 mem_d((void*)self->name);
1074 if (self->vtype == TYPE_STRING)
1075 mem_d((void*)self->constval.vstring);
1077 for (i = 0; i < 3; ++i) {
1078 if (self->members[i])
1079 ir_value_delete(self->members[i]);
1081 vec_free(self->reads);
1082 vec_free(self->writes);
1083 vec_free(self->life);
1087 bool ir_value_set_name(ir_value *self, const char *name)
1090 mem_d((void*)self->name);
1091 self->name = util_strdup(name);
1092 return !!self->name;
1095 bool ir_value_set_float(ir_value *self, float f)
1097 if (self->vtype != TYPE_FLOAT)
1099 self->constval.vfloat = f;
1100 self->hasvalue = true;
1104 bool ir_value_set_func(ir_value *self, int f)
1106 if (self->vtype != TYPE_FUNCTION)
1108 self->constval.vint = f;
1109 self->hasvalue = true;
1113 bool ir_value_set_vector(ir_value *self, vector v)
1115 if (self->vtype != TYPE_VECTOR)
1117 self->constval.vvec = v;
1118 self->hasvalue = true;
1122 bool ir_value_set_field(ir_value *self, ir_value *fld)
1124 if (self->vtype != TYPE_FIELD)
1126 self->constval.vpointer = fld;
1127 self->hasvalue = true;
1131 static char *ir_strdup(const char *str)
1134 /* actually dup empty strings */
1135 char *out = (char*)mem_a(1);
1139 return util_strdup(str);
1142 bool ir_value_set_string(ir_value *self, const char *str)
1144 if (self->vtype != TYPE_STRING)
1146 self->constval.vstring = ir_strdup(str);
1147 self->hasvalue = true;
1152 bool ir_value_set_int(ir_value *self, int i)
1154 if (self->vtype != TYPE_INTEGER)
1156 self->constval.vint = i;
1157 self->hasvalue = true;
1162 bool ir_value_lives(ir_value *self, size_t at)
1165 for (i = 0; i < vec_size(self->life); ++i)
1167 ir_life_entry_t *life = &self->life[i];
1168 if (life->start <= at && at <= life->end)
1170 if (life->start > at) /* since it's ordered */
1176 bool ir_value_life_insert(ir_value *self, size_t idx, ir_life_entry_t e)
1179 vec_push(self->life, e);
1180 for (k = vec_size(self->life)-1; k > idx; --k)
1181 self->life[k] = self->life[k-1];
1182 self->life[idx] = e;
1186 bool ir_value_life_merge(ir_value *self, size_t s)
1189 ir_life_entry_t *life = NULL;
1190 ir_life_entry_t *before = NULL;
1191 ir_life_entry_t new_entry;
1193 /* Find the first range >= s */
1194 for (i = 0; i < vec_size(self->life); ++i)
1197 life = &self->life[i];
1198 if (life->start > s)
1201 /* nothing found? append */
1202 if (i == vec_size(self->life)) {
1204 if (life && life->end+1 == s)
1206 /* previous life range can be merged in */
1210 if (life && life->end >= s)
1212 e.start = e.end = s;
1213 vec_push(self->life, e);
1219 if (before->end + 1 == s &&
1220 life->start - 1 == s)
1223 before->end = life->end;
1224 vec_remove(self->life, i, 1);
1227 if (before->end + 1 == s)
1233 /* already contained */
1234 if (before->end >= s)
1238 if (life->start - 1 == s)
1243 /* insert a new entry */
1244 new_entry.start = new_entry.end = s;
1245 return ir_value_life_insert(self, i, new_entry);
1248 bool ir_value_life_merge_into(ir_value *self, const ir_value *other)
1252 if (!vec_size(other->life))
1255 if (!vec_size(self->life)) {
1256 size_t count = vec_size(other->life);
1257 ir_life_entry_t *life = vec_add(self->life, count);
1258 memcpy(life, other->life, count * sizeof(*life));
1263 for (i = 0; i < vec_size(other->life); ++i)
1265 const ir_life_entry_t *life = &other->life[i];
1268 ir_life_entry_t *entry = &self->life[myi];
1270 if (life->end+1 < entry->start)
1272 /* adding an interval before entry */
1273 if (!ir_value_life_insert(self, myi, *life))
1279 if (life->start < entry->start &&
1280 life->end+1 >= entry->start)
1282 /* starts earlier and overlaps */
1283 entry->start = life->start;
1286 if (life->end > entry->end &&
1287 life->start <= entry->end+1)
1289 /* ends later and overlaps */
1290 entry->end = life->end;
1293 /* see if our change combines it with the next ranges */
1294 while (myi+1 < vec_size(self->life) &&
1295 entry->end+1 >= self->life[1+myi].start)
1297 /* overlaps with (myi+1) */
1298 if (entry->end < self->life[1+myi].end)
1299 entry->end = self->life[1+myi].end;
1300 vec_remove(self->life, myi+1, 1);
1301 entry = &self->life[myi];
1304 /* see if we're after the entry */
1305 if (life->start > entry->end)
1308 /* append if we're at the end */
1309 if (myi >= vec_size(self->life)) {
1310 vec_push(self->life, *life);
1313 /* otherweise check the next range */
1322 bool ir_values_overlap(const ir_value *a, const ir_value *b)
1324 /* For any life entry in A see if it overlaps with
1325 * any life entry in B.
1326 * Note that the life entries are orderes, so we can make a
1327 * more efficient algorithm there than naively translating the
1331 ir_life_entry_t *la, *lb, *enda, *endb;
1333 /* first of all, if either has no life range, they cannot clash */
1334 if (!vec_size(a->life) || !vec_size(b->life))
1339 enda = la + vec_size(a->life);
1340 endb = lb + vec_size(b->life);
1343 /* check if the entries overlap, for that,
1344 * both must start before the other one ends.
1346 if (la->start < lb->end &&
1347 lb->start < la->end)
1352 /* entries are ordered
1353 * one entry is earlier than the other
1354 * that earlier entry will be moved forward
1356 if (la->start < lb->start)
1358 /* order: A B, move A forward
1359 * check if we hit the end with A
1364 else /* if (lb->start < la->start) actually <= */
1366 /* order: B A, move B forward
1367 * check if we hit the end with B
1376 /***********************************************************************
1380 static bool ir_check_unreachable(ir_block *self)
1382 /* The IR should never have to deal with unreachable code */
1383 if (!self->final/* || OPTS_FLAG(ALLOW_UNREACHABLE_CODE)*/)
1385 irerror(self->context, "unreachable statement (%s)", self->label);
1389 bool ir_block_create_store_op(ir_block *self, lex_ctx ctx, int op, ir_value *target, ir_value *what)
1392 if (!ir_check_unreachable(self))
1395 if (target->store == store_value &&
1396 (op < INSTR_STOREP_F || op > INSTR_STOREP_FNC))
1398 irerror(self->context, "cannot store to an SSA value");
1399 irerror(self->context, "trying to store: %s <- %s", target->name, what->name);
1400 irerror(self->context, "instruction: %s", asm_instr[op].m);
1404 in = ir_instr_new(ctx, self, op);
1408 if (!ir_instr_op(in, 0, target, true) ||
1409 !ir_instr_op(in, 1, what, false))
1411 ir_instr_delete(in);
1414 vec_push(self->instr, in);
1418 bool ir_block_create_store(ir_block *self, lex_ctx ctx, ir_value *target, ir_value *what)
1422 if (target->vtype == TYPE_VARIANT)
1423 vtype = what->vtype;
1425 vtype = target->vtype;
1428 if (vtype == TYPE_FLOAT && what->vtype == TYPE_INTEGER)
1429 op = INSTR_CONV_ITOF;
1430 else if (vtype == TYPE_INTEGER && what->vtype == TYPE_FLOAT)
1431 op = INSTR_CONV_FTOI;
1433 op = type_store_instr[vtype];
1435 if (OPTS_FLAG(ADJUST_VECTOR_FIELDS)) {
1436 if (op == INSTR_STORE_FLD && what->fieldtype == TYPE_VECTOR)
1440 return ir_block_create_store_op(self, ctx, op, target, what);
1443 bool ir_block_create_storep(ir_block *self, lex_ctx ctx, ir_value *target, ir_value *what)
1448 if (target->vtype != TYPE_POINTER)
1451 /* storing using pointer - target is a pointer, type must be
1452 * inferred from source
1454 vtype = what->vtype;
1456 op = type_storep_instr[vtype];
1457 if (OPTS_FLAG(ADJUST_VECTOR_FIELDS)) {
1458 if (op == INSTR_STOREP_FLD && what->fieldtype == TYPE_VECTOR)
1459 op = INSTR_STOREP_V;
1462 return ir_block_create_store_op(self, ctx, op, target, what);
1465 bool ir_block_create_return(ir_block *self, lex_ctx ctx, ir_value *v)
1468 if (!ir_check_unreachable(self))
1471 self->is_return = true;
1472 in = ir_instr_new(ctx, self, INSTR_RETURN);
1476 if (v && !ir_instr_op(in, 0, v, false)) {
1477 ir_instr_delete(in);
1481 vec_push(self->instr, in);
1485 bool ir_block_create_if(ir_block *self, lex_ctx ctx, ir_value *v,
1486 ir_block *ontrue, ir_block *onfalse)
1489 if (!ir_check_unreachable(self))
1492 /*in = ir_instr_new(ctx, self, (v->vtype == TYPE_STRING ? INSTR_IF_S : INSTR_IF_F));*/
1493 in = ir_instr_new(ctx, self, VINSTR_COND);
1497 if (!ir_instr_op(in, 0, v, false)) {
1498 ir_instr_delete(in);
1502 in->bops[0] = ontrue;
1503 in->bops[1] = onfalse;
1505 vec_push(self->instr, in);
1507 vec_push(self->exits, ontrue);
1508 vec_push(self->exits, onfalse);
1509 vec_push(ontrue->entries, self);
1510 vec_push(onfalse->entries, self);
1514 bool ir_block_create_jump(ir_block *self, lex_ctx ctx, ir_block *to)
1517 if (!ir_check_unreachable(self))
1520 in = ir_instr_new(ctx, self, VINSTR_JUMP);
1525 vec_push(self->instr, in);
1527 vec_push(self->exits, to);
1528 vec_push(to->entries, self);
1532 bool ir_block_create_goto(ir_block *self, lex_ctx ctx, ir_block *to)
1534 self->owner->flags |= IR_FLAG_HAS_GOTO;
1535 return ir_block_create_jump(self, ctx, to);
1538 ir_instr* ir_block_create_phi(ir_block *self, lex_ctx ctx, const char *label, int ot)
1542 if (!ir_check_unreachable(self))
1544 in = ir_instr_new(ctx, self, VINSTR_PHI);
1547 out = ir_value_out(self->owner, label, store_value, ot);
1549 ir_instr_delete(in);
1552 if (!ir_instr_op(in, 0, out, true)) {
1553 ir_instr_delete(in);
1554 ir_value_delete(out);
1557 vec_push(self->instr, in);
1561 ir_value* ir_phi_value(ir_instr *self)
1563 return self->_ops[0];
1566 void ir_phi_add(ir_instr* self, ir_block *b, ir_value *v)
1570 if (!vec_ir_block_find(self->owner->entries, b, NULL)) {
1571 /* Must not be possible to cause this, otherwise the AST
1572 * is doing something wrong.
1574 irerror(self->context, "Invalid entry block for PHI");
1580 vec_push(v->reads, self);
1581 vec_push(self->phi, pe);
1584 /* call related code */
1585 ir_instr* ir_block_create_call(ir_block *self, lex_ctx ctx, const char *label, ir_value *func, bool noreturn)
1589 if (!ir_check_unreachable(self))
1591 in = ir_instr_new(ctx, self, (noreturn ? VINSTR_NRCALL : INSTR_CALL0));
1596 self->is_return = true;
1598 out = ir_value_out(self->owner, label, (func->outtype == TYPE_VOID) ? store_return : store_value, func->outtype);
1600 ir_instr_delete(in);
1603 if (!ir_instr_op(in, 0, out, true) ||
1604 !ir_instr_op(in, 1, func, false))
1606 ir_instr_delete(in);
1607 ir_value_delete(out);
1610 vec_push(self->instr, in);
1613 if (!ir_block_create_return(self, ctx, NULL)) {
1614 compile_error(ctx, "internal error: failed to generate dummy-return instruction");
1615 ir_instr_delete(in);
1623 ir_value* ir_call_value(ir_instr *self)
1625 return self->_ops[0];
1628 void ir_call_param(ir_instr* self, ir_value *v)
1630 vec_push(self->params, v);
1631 vec_push(v->reads, self);
1634 /* binary op related code */
1636 ir_value* ir_block_create_binop(ir_block *self, lex_ctx ctx,
1637 const char *label, int opcode,
1638 ir_value *left, ir_value *right)
1660 case INSTR_SUB_S: /* -- offset of string as float */
1665 case INSTR_BITOR_IF:
1666 case INSTR_BITOR_FI:
1667 case INSTR_BITAND_FI:
1668 case INSTR_BITAND_IF:
1683 case INSTR_BITAND_I:
1686 case INSTR_RSHIFT_I:
1687 case INSTR_LSHIFT_I:
1709 /* boolean operations result in floats */
1710 if (opcode >= INSTR_EQ_F && opcode <= INSTR_GT)
1712 else if (opcode >= INSTR_LE && opcode <= INSTR_GT)
1715 else if (opcode >= INSTR_LE_I && opcode <= INSTR_EQ_FI)
1720 if (ot == TYPE_VOID) {
1721 /* The AST or parser were supposed to check this! */
1725 return ir_block_create_general_instr(self, ctx, label, opcode, left, right, ot);
1728 ir_value* ir_block_create_unary(ir_block *self, lex_ctx ctx,
1729 const char *label, int opcode,
1732 int ot = TYPE_FLOAT;
1744 /* QC doesn't have other unary operations. We expect extensions to fill
1745 * the above list, otherwise we assume out-type = in-type, eg for an
1749 ot = operand->vtype;
1752 if (ot == TYPE_VOID) {
1753 /* The AST or parser were supposed to check this! */
1757 /* let's use the general instruction creator and pass NULL for OPB */
1758 return ir_block_create_general_instr(self, ctx, label, opcode, operand, NULL, ot);
1761 ir_value* ir_block_create_general_instr(ir_block *self, lex_ctx ctx, const char *label,
1762 int op, ir_value *a, ir_value *b, int outype)
1767 out = ir_value_out(self->owner, label, store_value, outype);
1771 instr = ir_instr_new(ctx, self, op);
1773 ir_value_delete(out);
1777 if (!ir_instr_op(instr, 0, out, true) ||
1778 !ir_instr_op(instr, 1, a, false) ||
1779 !ir_instr_op(instr, 2, b, false) )
1784 vec_push(self->instr, instr);
1788 ir_instr_delete(instr);
1789 ir_value_delete(out);
1793 ir_value* ir_block_create_fieldaddress(ir_block *self, lex_ctx ctx, const char *label, ir_value *ent, ir_value *field)
1797 /* Support for various pointer types todo if so desired */
1798 if (ent->vtype != TYPE_ENTITY)
1801 if (field->vtype != TYPE_FIELD)
1804 v = ir_block_create_general_instr(self, ctx, label, INSTR_ADDRESS, ent, field, TYPE_POINTER);
1805 v->fieldtype = field->fieldtype;
1809 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)
1812 if (ent->vtype != TYPE_ENTITY)
1815 /* at some point we could redirect for TYPE_POINTER... but that could lead to carelessness */
1816 if (field->vtype != TYPE_FIELD)
1821 case TYPE_FLOAT: op = INSTR_LOAD_F; break;
1822 case TYPE_VECTOR: op = INSTR_LOAD_V; break;
1823 case TYPE_STRING: op = INSTR_LOAD_S; break;
1824 case TYPE_FIELD: op = INSTR_LOAD_FLD; break;
1825 case TYPE_ENTITY: op = INSTR_LOAD_ENT; break;
1826 case TYPE_FUNCTION: op = INSTR_LOAD_FNC; break;
1828 case TYPE_POINTER: op = INSTR_LOAD_I; break;
1829 case TYPE_INTEGER: op = INSTR_LOAD_I; break;
1832 irerror(self->context, "invalid type for ir_block_create_load_from_ent: %s", type_name[outype]);
1836 return ir_block_create_general_instr(self, ctx, label, op, ent, field, outype);
1839 ir_value* ir_block_create_add(ir_block *self, lex_ctx ctx,
1841 ir_value *left, ir_value *right)
1844 int l = left->vtype;
1845 int r = right->vtype;
1849 irerror(self->context, "invalid type for ir_block_create_add: %s", type_name[l]);
1865 if ( (l == TYPE_FLOAT && r == TYPE_INTEGER) )
1867 else if ( (l == TYPE_INTEGER && r == TYPE_FLOAT) )
1872 irerror(self->context, "invalid type for ir_block_create_add: %s", type_name[l]);
1876 return ir_block_create_binop(self, ctx, label, op, left, right);
1879 ir_value* ir_block_create_sub(ir_block *self, lex_ctx ctx,
1881 ir_value *left, ir_value *right)
1884 int l = left->vtype;
1885 int r = right->vtype;
1890 irerror(self->context, "invalid type for ir_block_create_sub: %s", type_name[l]);
1906 if ( (l == TYPE_FLOAT && r == TYPE_INTEGER) )
1908 else if ( (l == TYPE_INTEGER && r == TYPE_FLOAT) )
1913 irerror(self->context, "invalid type for ir_block_create_sub: %s", type_name[l]);
1917 return ir_block_create_binop(self, ctx, label, op, left, right);
1920 ir_value* ir_block_create_mul(ir_block *self, lex_ctx ctx,
1922 ir_value *left, ir_value *right)
1925 int l = left->vtype;
1926 int r = right->vtype;
1931 irerror(self->context, "invalid type for ir_block_create_mul: %s", type_name[l]);
1946 if ( (l == TYPE_VECTOR && r == TYPE_FLOAT) )
1948 else if ( (l == TYPE_FLOAT && r == TYPE_VECTOR) )
1951 else if ( (l == TYPE_VECTOR && r == TYPE_INTEGER) )
1953 else if ( (l == TYPE_INTEGER && r == TYPE_VECTOR) )
1955 else if ( (l == TYPE_FLOAT && r == TYPE_INTEGER) )
1957 else if ( (l == TYPE_INTEGER && r == TYPE_FLOAT) )
1961 irerror(self->context, "invalid type for ir_block_create_mul: %s", type_name[l]);
1965 return ir_block_create_binop(self, ctx, label, op, left, right);
1968 ir_value* ir_block_create_div(ir_block *self, lex_ctx ctx,
1970 ir_value *left, ir_value *right)
1973 int l = left->vtype;
1974 int r = right->vtype;
1979 irerror(self->context, "invalid type for ir_block_create_div: %s", type_name[l]);
1992 if ( (l == TYPE_VECTOR && r == TYPE_FLOAT) )
1994 else if ( (l == TYPE_FLOAT && r == TYPE_INTEGER) )
1996 else if ( (l == TYPE_INTEGER && r == TYPE_FLOAT) )
2001 irerror(self->context, "invalid type for ir_block_create_div: %s", type_name[l]);
2005 return ir_block_create_binop(self, ctx, label, op, left, right);
2008 /* PHI resolving breaks the SSA, and must thus be the last
2009 * step before life-range calculation.
2012 static bool ir_block_naive_phi(ir_block *self);
2013 bool ir_function_naive_phi(ir_function *self)
2017 for (i = 0; i < vec_size(self->blocks); ++i)
2019 if (!ir_block_naive_phi(self->blocks[i]))
2026 static bool ir_naive_phi_emit_store(ir_block *block, size_t iid, ir_value *old, ir_value *what)
2031 /* create a store */
2032 if (!ir_block_create_store(block, old, what))
2035 /* we now move it up */
2036 instr = vec_last(block->instr);
2037 for (i = vec_size(block->instr)-1; i > iid; --i)
2038 block->instr[i] = block->instr[i-1];
2039 block->instr[i] = instr;
2045 static bool ir_block_naive_phi(ir_block *self)
2047 size_t i, p; /*, w;*/
2048 /* FIXME: optionally, create_phi can add the phis
2049 * to a list so we don't need to loop through blocks
2050 * - anyway: "don't optimize YET"
2052 for (i = 0; i < vec_size(self->instr); ++i)
2054 ir_instr *instr = self->instr[i];
2055 if (instr->opcode != VINSTR_PHI)
2058 vec_remove(self->instr, i, 1);
2059 --i; /* NOTE: i+1 below */
2061 for (p = 0; p < vec_size(instr->phi); ++p)
2063 ir_value *v = instr->phi[p].value;
2064 ir_block *b = instr->phi[p].from;
2066 if (v->store == store_value &&
2067 vec_size(v->reads) == 1 &&
2068 vec_size(v->writes) == 1)
2070 /* replace the value */
2071 if (!ir_instr_op(v->writes[0], 0, instr->_ops[0], true))
2076 /* force a move instruction */
2077 ir_instr *prevjump = vec_last(b->instr);
2080 instr->_ops[0]->store = store_global;
2081 if (!ir_block_create_store(b, instr->context, instr->_ops[0], v))
2083 instr->_ops[0]->store = store_value;
2084 vec_push(b->instr, prevjump);
2089 ir_value *v = instr->phi[p].value;
2090 for (w = 0; w < vec_size(v->writes); ++w) {
2093 if (!v->writes[w]->_ops[0])
2096 /* When the write was to a global, we have to emit a mov */
2097 old = v->writes[w]->_ops[0];
2099 /* The original instruction now writes to the PHI target local */
2100 if (v->writes[w]->_ops[0] == v)
2101 v->writes[w]->_ops[0] = instr->_ops[0];
2103 if (old->store != store_value && old->store != store_local && old->store != store_param)
2105 /* If it originally wrote to a global we need to store the value
2108 if (!ir_naive_phi_emit_store(self, i+1, old, v))
2110 if (i+1 < vec_size(self->instr))
2111 instr = self->instr[i+1];
2114 /* In case I forget and access instr later, it'll be NULL
2115 * when it's a problem, to make sure we crash, rather than accessing
2121 /* If it didn't, we can replace all reads by the phi target now. */
2123 for (r = 0; r < vec_size(old->reads); ++r)
2126 ir_instr *ri = old->reads[r];
2127 for (op = 0; op < vec_size(ri->phi); ++op) {
2128 if (ri->phi[op].value == old)
2129 ri->phi[op].value = v;
2131 for (op = 0; op < 3; ++op) {
2132 if (ri->_ops[op] == old)
2140 ir_instr_delete(instr);
2145 /***********************************************************************
2146 *IR Temp allocation code
2147 * Propagating value life ranges by walking through the function backwards
2148 * until no more changes are made.
2149 * In theory this should happen once more than once for every nested loop
2151 * Though this implementation might run an additional time for if nests.
2154 /* Enumerate instructions used by value's life-ranges
2156 static void ir_block_enumerate(ir_block *self, size_t *_eid)
2160 for (i = 0; i < vec_size(self->instr); ++i)
2162 self->instr[i]->eid = eid++;
2167 /* Enumerate blocks and instructions.
2168 * The block-enumeration is unordered!
2169 * We do not really use the block enumreation, however
2170 * the instruction enumeration is important for life-ranges.
2172 void ir_function_enumerate(ir_function *self)
2175 size_t instruction_id = 0;
2176 for (i = 0; i < vec_size(self->blocks); ++i)
2178 self->blocks[i]->eid = i;
2179 self->blocks[i]->run_id = 0;
2180 ir_block_enumerate(self->blocks[i], &instruction_id);
2184 static bool ir_block_life_propagate(ir_block *b, ir_block *prev, bool *changed);
2185 bool ir_function_calculate_liferanges(ir_function *self)
2193 for (i = 0; i != vec_size(self->blocks); ++i)
2195 if (self->blocks[i]->is_return)
2197 vec_free(self->blocks[i]->living);
2198 if (!ir_block_life_propagate(self->blocks[i], NULL, &changed))
2203 if (vec_size(self->blocks)) {
2204 ir_block *block = self->blocks[0];
2205 for (i = 0; i < vec_size(block->living); ++i) {
2206 ir_value *v = block->living[i];
2207 if (v->store != store_local)
2209 if ((v->members[0] && v->members[1] && v->members[2])) {
2210 /* all vector members have been accessed - only treat this as uninitialized
2211 * if any of them is also uninitialized.
2213 if (!vec_ir_value_find(block->living, v->members[0], NULL) &&
2214 !vec_ir_value_find(block->living, v->members[1], NULL) &&
2215 !vec_ir_value_find(block->living, v->members[2], NULL))
2221 /* A member is only uninitialized if the whole vector is also uninitialized */
2222 if (!vec_ir_value_find(block->living, v->memberof, NULL))
2225 self->flags |= IR_FLAG_HAS_UNINITIALIZED;
2226 if (irwarning(v->context, WARN_USED_UNINITIALIZED,
2227 "variable `%s` may be used uninitialized in this function", v->name))
2236 /* Local-value allocator
2237 * After finishing creating the liferange of all values used in a function
2238 * we can allocate their global-positions.
2239 * This is the counterpart to register-allocation in register machines.
2246 } function_allocator;
2248 static bool function_allocator_alloc(function_allocator *alloc, const ir_value *var)
2251 size_t vsize = ir_value_sizeof(var);
2253 slot = ir_value_var("reg", store_global, var->vtype);
2257 if (!ir_value_life_merge_into(slot, var))
2260 vec_push(alloc->locals, slot);
2261 vec_push(alloc->sizes, vsize);
2262 vec_push(alloc->unique, var->unique_life);
2267 ir_value_delete(slot);
2271 bool ir_function_allocate_locals(ir_function *self)
2280 function_allocator alloc;
2282 if (!vec_size(self->locals) && !vec_size(self->values))
2285 alloc.locals = NULL;
2287 alloc.positions = NULL;
2288 alloc.unique = NULL;
2290 for (i = 0; i < vec_size(self->locals); ++i)
2293 if (!OPTS_OPTIMIZATION(OPTIM_LOCALTEMPS))
2295 self->locals[i]->unique_life = true;
2296 if (!function_allocator_alloc(&alloc, self->locals[i]))
2300 /* Allocate a slot for any value that still exists */
2301 for (i = 0; i < vec_size(self->values); ++i)
2303 v = self->values[i];
2305 if (!vec_size(v->life))
2308 for (a = 0; a < vec_size(alloc.locals); ++a)
2310 /* if it's reserved for a unique liferange: skip */
2311 if (alloc.unique[a])
2314 slot = alloc.locals[a];
2316 /* never resize parameters
2317 * will be required later when overlapping temps + locals
2319 if (a < vec_size(self->params) &&
2320 alloc.sizes[a] < ir_value_sizeof(v))
2325 if (ir_values_overlap(v, slot))
2328 if (!ir_value_life_merge_into(slot, v))
2331 /* adjust size for this slot */
2332 if (alloc.sizes[a] < ir_value_sizeof(v))
2333 alloc.sizes[a] = ir_value_sizeof(v);
2335 self->values[i]->code.local = a;
2338 if (a >= vec_size(alloc.locals)) {
2339 self->values[i]->code.local = vec_size(alloc.locals);
2340 if (!function_allocator_alloc(&alloc, v))
2349 /* Adjust slot positions based on sizes */
2350 vec_push(alloc.positions, 0);
2352 if (vec_size(alloc.sizes))
2353 pos = alloc.positions[0] + alloc.sizes[0];
2356 for (i = 1; i < vec_size(alloc.sizes); ++i)
2358 pos = alloc.positions[i-1] + alloc.sizes[i-1];
2359 vec_push(alloc.positions, pos);
2362 self->allocated_locals = pos + vec_last(alloc.sizes);
2364 /* Locals need to know their new position */
2365 for (i = 0; i < vec_size(self->locals); ++i) {
2366 self->locals[i]->code.local = alloc.positions[i];
2368 /* Take over the actual slot positions on values */
2369 for (i = 0; i < vec_size(self->values); ++i) {
2370 self->values[i]->code.local = alloc.positions[self->values[i]->code.local];
2378 for (i = 0; i < vec_size(alloc.locals); ++i)
2379 ir_value_delete(alloc.locals[i]);
2380 vec_free(alloc.unique);
2381 vec_free(alloc.locals);
2382 vec_free(alloc.sizes);
2383 vec_free(alloc.positions);
2387 /* Get information about which operand
2388 * is read from, or written to.
2390 static void ir_op_read_write(int op, size_t *read, size_t *write)
2410 case INSTR_STOREP_F:
2411 case INSTR_STOREP_V:
2412 case INSTR_STOREP_S:
2413 case INSTR_STOREP_ENT:
2414 case INSTR_STOREP_FLD:
2415 case INSTR_STOREP_FNC:
2426 static bool ir_block_living_add_instr(ir_block *self, size_t eid)
2429 bool changed = false;
2431 for (i = 0; i != vec_size(self->living); ++i)
2433 tempbool = ir_value_life_merge(self->living[i], eid);
2436 irerror(self->context, "block_living_add_instr() value instruction added %s: %i", self->living[i]->_name, (int)eid);
2438 changed = changed || tempbool;
2443 static bool ir_block_life_prop_previous(ir_block* self, ir_block *prev, bool *changed)
2449 /* values which have been read in a previous iteration are now
2450 * in the "living" array even if the previous block doesn't use them.
2451 * So we have to remove whatever does not exist in the previous block.
2452 * They will be re-added on-read, but the liferange merge won't cause
2454 for (i = 0; i < vec_size(self->living); ++i)
2456 if (!vec_ir_value_find(prev->living, self->living[i], NULL)) {
2457 vec_remove(self->living, i, 1);
2463 /* Whatever the previous block still has in its living set
2464 * must now be added to ours as well.
2466 for (i = 0; i < vec_size(prev->living); ++i)
2468 if (vec_ir_value_find(self->living, prev->living[i], NULL))
2470 vec_push(self->living, prev->living[i]);
2472 irerror(self->contextt from prev: %s", self->label, prev->living[i]->_name);
2478 static bool ir_block_life_propagate(ir_block *self, ir_block *prev, bool *changed)
2484 /* bitmasks which operands are read from or written to */
2486 char dbg_ind[16] = { '#', '0' };
2491 if (!ir_block_life_prop_previous(self, prev, changed))
2495 i = vec_size(self->instr);
2498 instr = self->instr[i];
2500 /* PHI operands are always read operands */
2501 for (p = 0; p < vec_size(instr->phi); ++p)
2503 value = instr->phi[p].value;
2504 if (!vec_ir_value_find(self->living, value, NULL))
2505 vec_push(self->living, value);
2508 /* call params are read operands too */
2509 for (p = 0; p < vec_size(instr->params); ++p)
2511 value = instr->params[p];
2512 if (!vec_ir_value_find(self->living, value, NULL))
2513 vec_push(self->living, value);
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 for (o = 0; o < 3; ++o)
2535 if (!instr->_ops[o]) /* no such operand */
2538 value = instr->_ops[o];
2540 /* We only care about locals */
2541 /* we also calculate parameter liferanges so that locals
2542 * can take up parameter slots */
2543 if (value->store != store_value &&
2544 value->store != store_local &&
2545 value->store != store_param)
2551 if (!vec_ir_value_find(self->living, value, NULL))
2552 vec_push(self->living, value);
2555 /* write operands */
2556 /* When we write to a local, we consider it "dead" for the
2557 * remaining upper part of the function, since in SSA a value
2558 * can only be written once (== created)
2563 bool in_living = vec_ir_value_find(self->living, value, &idx);
2566 /* If the value isn't alive it hasn't been read before... */
2567 /* TODO: See if the warning can be emitted during parsing or AST processing
2568 * otherwise have warning printed here.
2569 * IF printing a warning here: include filecontext_t,
2570 * and make sure it's only printed once
2571 * since this function is run multiple times.
2573 /* For now: debug info: */
2574 /* con_err( "Value only written %s\n", value->name); */
2575 tempbool = ir_value_life_merge(value, instr->eid);
2576 *changed = *changed || tempbool;
2578 ir_instr_dump(instr, dbg_ind, printf);
2582 /* since 'living' won't contain it
2583 * anymore, merge the value, since
2586 tempbool = ir_value_life_merge(value, instr->eid);
2589 con_err( "value added id %s %i\n", value->name, (int)instr->eid);
2591 *changed = *changed || tempbool;
2593 vec_remove(self->living, idx, 1);
2598 tempbool = ir_block_living_add_instr(self, instr->eid);
2599 /*con_err( "living added values\n");*/
2600 *changed = *changed || tempbool;
2604 if (self->run_id == self->owner->run_id)
2607 self->run_id = self->owner->run_id;
2609 for (i = 0; i < vec_size(self->entries); ++i)
2611 ir_block *entry = self->entries[i];
2612 ir_block_life_propagate(entry, self, changed);
2618 /***********************************************************************
2621 * Since the IR has the convention of putting 'write' operands
2622 * at the beginning, we have to rotate the operands of instructions
2623 * properly in order to generate valid QCVM code.
2625 * Having destinations at a fixed position is more convenient. In QC
2626 * this is *mostly* OPC, but FTE adds at least 2 instructions which
2627 * read from from OPA, and store to OPB rather than OPC. Which is
2628 * partially the reason why the implementation of these instructions
2629 * in darkplaces has been delayed for so long.
2631 * Breaking conventions is annoying...
2633 static bool ir_builder_gen_global(ir_builder *self, ir_value *global, bool islocal);
2635 static bool gen_global_field(ir_value *global)
2637 if (global->hasvalue)
2639 ir_value *fld = global->constval.vpointer;
2641 irerror(global->context, "Invalid field constant with no field: %s", global->name);
2645 /* copy the field's value */
2646 ir_value_code_setaddr(global, vec_size(code_globals));
2647 vec_push(code_globals, fld->code.fieldaddr);
2648 if (global->fieldtype == TYPE_VECTOR) {
2649 vec_push(code_globals, fld->code.fieldaddr+1);
2650 vec_push(code_globals, fld->code.fieldaddr+2);
2655 ir_value_code_setaddr(global, vec_size(code_globals));
2656 vec_push(code_globals, 0);
2657 if (global->fieldtype == TYPE_VECTOR) {
2658 vec_push(code_globals, 0);
2659 vec_push(code_globals, 0);
2662 if (global->code.globaladdr < 0)
2667 static bool gen_global_pointer(ir_value *global)
2669 if (global->hasvalue)
2671 ir_value *target = global->constval.vpointer;
2673 irerror(global->context, "Invalid pointer constant: %s", global->name);
2674 /* NULL pointers are pointing to the NULL constant, which also
2675 * sits at address 0, but still has an ir_value for itself.
2680 /* Here, relocations ARE possible - in fteqcc-enhanced-qc:
2681 * void() foo; <- proto
2682 * void() *fooptr = &foo;
2683 * void() foo = { code }
2685 if (!target->code.globaladdr) {
2686 /* FIXME: Check for the constant nullptr ir_value!
2687 * because then code.globaladdr being 0 is valid.
2689 irerror(global->context, "FIXME: Relocation support");
2693 ir_value_code_setaddr(global, vec_size(code_globals));
2694 vec_push(code_globals, target->code.globaladdr);
2698 ir_value_code_setaddr(global, vec_size(code_globals));
2699 vec_push(code_globals, 0);
2701 if (global->code.globaladdr < 0)
2706 static bool gen_blocks_recursive(ir_function *func, ir_block *block)
2708 prog_section_statement stmt;
2717 block->generated = true;
2718 block->code_start = vec_size(code_statements);
2719 for (i = 0; i < vec_size(block->instr); ++i)
2721 instr = block->instr[i];
2723 if (instr->opcode == VINSTR_PHI) {
2724 irerror(block->context, "cannot generate virtual instruction (phi)");
2728 if (instr->opcode == VINSTR_JUMP) {
2729 target = instr->bops[0];
2730 /* for uncoditional jumps, if the target hasn't been generated
2731 * yet, we generate them right here.
2733 if (!target->generated) {
2738 /* otherwise we generate a jump instruction */
2739 stmt.opcode = INSTR_GOTO;
2740 stmt.o1.s1 = (target->code_start) - vec_size(code_statements);
2743 if (stmt.o1.s1 != 1)
2744 code_push_statement(&stmt, instr->context.line);
2746 /* no further instructions can be in this block */
2750 if (instr->opcode == VINSTR_COND) {
2751 ontrue = instr->bops[0];
2752 onfalse = instr->bops[1];
2753 /* TODO: have the AST signal which block should
2754 * come first: eg. optimize IFs without ELSE...
2757 stmt.o1.u1 = ir_value_code_addr(instr->_ops[0]);
2761 if (ontrue->generated) {
2762 stmt.opcode = INSTR_IF;
2763 stmt.o2.s1 = (ontrue->code_start) - vec_size(code_statements);
2764 if (stmt.o2.s1 != 1)
2765 code_push_statement(&stmt, instr->context.line);
2767 if (onfalse->generated) {
2768 stmt.opcode = INSTR_IFNOT;
2769 stmt.o2.s1 = (onfalse->code_start) - vec_size(code_statements);
2770 if (stmt.o2.s1 != 1)
2771 code_push_statement(&stmt, instr->context.line);
2773 if (!ontrue->generated) {
2774 if (onfalse->generated) {
2779 if (!onfalse->generated) {
2780 if (ontrue->generated) {
2785 /* neither ontrue nor onfalse exist */
2786 stmt.opcode = INSTR_IFNOT;
2787 if (!instr->likely) {
2788 /* Honor the likelyhood hint */
2789 ir_block *tmp = onfalse;
2790 stmt.opcode = INSTR_IF;
2794 stidx = vec_size(code_statements);
2795 code_push_statement(&stmt, instr->context.line);
2796 /* on false we jump, so add ontrue-path */
2797 if (!gen_blocks_recursive(func, ontrue))
2799 /* fixup the jump address */
2800 code_statements[stidx].o2.s1 = vec_size(code_statements) - stidx;
2801 /* generate onfalse path */
2802 if (onfalse->generated) {
2803 /* fixup the jump address */
2804 code_statements[stidx].o2.s1 = (onfalse->code_start) - (stidx);
2805 if (code_statements[stidx].o2.s1 == 1) {
2806 code_statements[stidx] = code_statements[stidx+1];
2807 if (code_statements[stidx].o1.s1 < 0)
2808 code_statements[stidx].o1.s1++;
2809 code_pop_statement();
2811 stmt.opcode = vec_last(code_statements).opcode;
2812 if (stmt.opcode == INSTR_GOTO ||
2813 stmt.opcode == INSTR_IF ||
2814 stmt.opcode == INSTR_IFNOT ||
2815 stmt.opcode == INSTR_RETURN ||
2816 stmt.opcode == INSTR_DONE)
2818 /* no use jumping from here */
2821 /* may have been generated in the previous recursive call */
2822 stmt.opcode = INSTR_GOTO;
2823 stmt.o1.s1 = (onfalse->code_start) - vec_size(code_statements);
2826 if (stmt.o1.s1 != 1)
2827 code_push_statement(&stmt, instr->context.line);
2830 else if (code_statements[stidx].o2.s1 == 1) {
2831 code_statements[stidx] = code_statements[stidx+1];
2832 if (code_statements[stidx].o1.s1 < 0)
2833 code_statements[stidx].o1.s1++;
2834 code_pop_statement();
2836 /* if not, generate now */
2841 if ( (instr->opcode >= INSTR_CALL0 && instr->opcode <= INSTR_CALL8)
2842 || instr->opcode == VINSTR_NRCALL)
2844 /* Trivial call translation:
2845 * copy all params to OFS_PARM*
2846 * if the output's storetype is not store_return,
2847 * add append a STORE instruction!
2849 * NOTES on how to do it better without much trouble:
2850 * -) The liferanges!
2851 * Simply check the liferange of all parameters for
2852 * other CALLs. For each param with no CALL in its
2853 * liferange, we can store it in an OFS_PARM at
2854 * generation already. This would even include later
2855 * reuse.... probably... :)
2860 first = vec_size(instr->params);
2863 for (p = 0; p < first; ++p)
2865 ir_value *param = instr->params[p];
2867 stmt.opcode = INSTR_STORE_F;
2870 if (param->vtype == TYPE_FIELD)
2871 stmt.opcode = field_store_instr[param->fieldtype];
2873 stmt.opcode = type_store_instr[param->vtype];
2874 stmt.o1.u1 = ir_value_code_addr(param);
2875 stmt.o2.u1 = OFS_PARM0 + 3 * p;
2876 code_push_statement(&stmt, instr->context.line);
2878 /* Now handle extparams */
2879 first = vec_size(instr->params);
2880 for (; p < first; ++p)
2882 ir_builder *ir = func->owner;
2883 ir_value *param = instr->params[p];
2884 ir_value *targetparam;
2886 if (p-8 >= vec_size(ir->extparams))
2887 ir_gen_extparam(ir);
2889 targetparam = ir->extparams[p-8];
2891 stmt.opcode = INSTR_STORE_F;
2894 if (param->vtype == TYPE_FIELD)
2895 stmt.opcode = field_store_instr[param->fieldtype];
2897 stmt.opcode = type_store_instr[param->vtype];
2898 stmt.o1.u1 = ir_value_code_addr(param);
2899 stmt.o2.u1 = ir_value_code_addr(targetparam);
2900 code_push_statement(&stmt, instr->context.line);
2903 stmt.opcode = INSTR_CALL0 + vec_size(instr->params);
2904 if (stmt.opcode > INSTR_CALL8)
2905 stmt.opcode = INSTR_CALL8;
2906 stmt.o1.u1 = ir_value_code_addr(instr->_ops[1]);
2909 code_push_statement(&stmt, instr->context.line);
2911 retvalue = instr->_ops[0];
2912 if (retvalue && retvalue->store != store_return && (vec_size(retvalue->life) || retvalue->store == store_global))
2914 /* not to be kept in OFS_RETURN */
2915 if (retvalue->vtype == TYPE_FIELD && OPTS_FLAG(ADJUST_VECTOR_FIELDS))
2916 stmt.opcode = field_store_instr[retvalue->fieldtype];
2918 stmt.opcode = type_store_instr[retvalue->vtype];
2919 stmt.o1.u1 = OFS_RETURN;
2920 stmt.o2.u1 = ir_value_code_addr(retvalue);
2922 code_push_statement(&stmt, instr->context.line);
2927 if (instr->opcode == INSTR_STATE) {
2928 irerror(block->context, "TODO: state instruction");
2932 stmt.opcode = instr->opcode;
2937 /* This is the general order of operands */
2939 stmt.o3.u1 = ir_value_code_addr(instr->_ops[0]);
2942 stmt.o1.u1 = ir_value_code_addr(instr->_ops[1]);
2945 stmt.o2.u1 = ir_value_code_addr(instr->_ops[2]);
2947 if (stmt.opcode == INSTR_RETURN || stmt.opcode == INSTR_DONE)
2949 stmt.o1.u1 = stmt.o3.u1;
2952 else if ((stmt.opcode >= INSTR_STORE_F &&
2953 stmt.opcode <= INSTR_STORE_FNC) ||
2954 (stmt.opcode >= INSTR_STOREP_F &&
2955 stmt.opcode <= INSTR_STOREP_FNC))
2957 /* 2-operand instructions with A -> B */
2958 stmt.o2.u1 = stmt.o3.u1;
2961 /* tiny optimization, don't output
2964 if (stmt.o2.u1 == stmt.o1.u1 &&
2965 OPTS_OPTIMIZATION(OPTIM_PEEPHOLE))
2967 ++opts_optimizationcount[OPTIM_PEEPHOLE];
2972 code_push_statement(&stmt, instr->context.line);
2977 static bool gen_function_code(ir_function *self)
2980 prog_section_statement stmt;
2982 /* Starting from entry point, we generate blocks "as they come"
2983 * for now. Dead blocks will not be translated obviously.
2985 if (!vec_size(self->blocks)) {
2986 irerror(self->context, "Function '%s' declared without body.", self->name);
2990 block = self->blocks[0];
2991 if (block->generated)
2994 if (!gen_blocks_recursive(self, block)) {
2995 irerror(self->context, "failed to generate blocks for '%s'", self->name);
2999 /* code_write and qcvm -disasm need to know that the function ends here */
3000 stmt.opcode = INSTR_DONE;
3004 code_push_statement(&stmt, vec_last(code_linenums));
3008 static qcint ir_builder_filestring(ir_builder *ir, const char *filename)
3010 /* NOTE: filename pointers are copied, we never strdup them,
3011 * thus we can use pointer-comparison to find the string.
3016 for (i = 0; i < vec_size(ir->filenames); ++i) {
3017 if (ir->filenames[i] == filename)
3018 return ir->filestrings[i];
3021 str = code_genstring(filename);
3022 vec_push(ir->filenames, filename);
3023 vec_push(ir->filestrings, str);
3027 static bool gen_global_function(ir_builder *ir, ir_value *global)
3029 prog_section_function fun;
3034 if (!global->hasvalue || (!global->constval.vfunc))
3036 irerror(global->context, "Invalid state of function-global: not constant: %s", global->name);
3040 irfun = global->constval.vfunc;
3042 fun.name = global->code.name;
3043 fun.file = ir_builder_filestring(ir, global->context.file);
3044 fun.profile = 0; /* always 0 */
3045 fun.nargs = vec_size(irfun->params);
3049 for (i = 0;i < 8; ++i) {
3050 if ((int32_t)i >= fun.nargs)
3053 fun.argsize[i] = type_sizeof_[irfun->params[i]];
3056 fun.firstlocal = vec_size(code_globals);
3058 fun.locals = irfun->allocated_locals;
3059 for (i = 0; i < vec_size(irfun->locals); ++i) {
3060 if (!ir_builder_gen_global(ir, irfun->locals[i], true)) {
3061 irerror(irfun->locals[i]->context, "Failed to generate local %s", irfun->locals[i]->name);
3064 ir_value_code_setaddr(irfun->locals[i], fun.firstlocal + irfun->locals[i]->code.local);
3066 for (i = 0; i < vec_size(irfun->values); ++i)
3068 /* generate code.globaladdr for ssa values */
3069 ir_value *v = irfun->values[i];
3070 ir_value_code_setaddr(v, fun.firstlocal + v->code.local);
3072 for (i = vec_size(code_globals); i < fun.firstlocal + irfun->allocated_locals; ++i)
3073 vec_push(code_globals, 0);
3076 fun.entry = irfun->builtin+1;
3078 irfun->code_function_def = vec_size(code_functions);
3079 fun.entry = vec_size(code_statements);
3082 vec_push(code_functions, fun);
3086 static void ir_gen_extparam(ir_builder *ir)
3088 prog_section_def def;
3092 snprintf(name, sizeof(name), "EXTPARM#%i", (int)(vec_size(ir->extparams)+8));
3093 global = ir_value_var(name, store_global, TYPE_VECTOR);
3095 def.name = code_genstring(name);
3096 def.type = TYPE_VECTOR;
3097 def.offset = vec_size(code_globals);
3099 vec_push(code_defs, def);
3100 ir_value_code_setaddr(global, def.offset);
3101 vec_push(code_globals, 0);
3102 vec_push(code_globals, 0);
3103 vec_push(code_globals, 0);
3105 vec_push(ir->extparams, global);
3108 static bool gen_function_extparam_copy(ir_function *self)
3110 size_t i, ext, numparams;
3112 ir_builder *ir = self->owner;
3114 prog_section_statement stmt;
3116 numparams = vec_size(self->params);
3120 stmt.opcode = INSTR_STORE_F;
3122 for (i = 8; i < numparams; ++i) {
3124 if (ext >= vec_size(ir->extparams))
3125 ir_gen_extparam(ir);
3127 ep = ir->extparams[ext];
3129 stmt.opcode = type_store_instr[self->locals[i]->vtype];
3130 if (self->locals[i]->vtype == TYPE_FIELD &&
3131 self->locals[i]->fieldtype == TYPE_VECTOR)
3133 stmt.opcode = INSTR_STORE_V;
3135 stmt.o1.u1 = ir_value_code_addr(ep);
3136 stmt.o2.u1 = ir_value_code_addr(self->locals[i]);
3137 code_push_statement(&stmt, self->context.line);
3143 static bool gen_global_function_code(ir_builder *ir, ir_value *global)
3145 prog_section_function *fundef;
3150 irfun = global->constval.vfunc;
3152 if (global->cvq == CV_NONE) {
3153 irwarning(global->context, WARN_IMPLICIT_FUNCTION_POINTER,
3154 "function `%s` has no body and in QC implicitly becomes a function-pointer", global->name);
3156 /* this was a function pointer, don't generate code for those */
3163 if (irfun->code_function_def < 0) {
3164 irerror(irfun->context, "`%s`: IR global wasn't generated, failed to access function-def", irfun->name);
3167 fundef = &code_functions[irfun->code_function_def];
3169 fundef->entry = vec_size(code_statements);
3170 if (!gen_function_extparam_copy(irfun)) {
3171 irerror(irfun->context, "Failed to generate extparam-copy code for function %s", irfun->name);
3174 if (!gen_function_code(irfun)) {
3175 irerror(irfun->context, "Failed to generate code for function %s", irfun->name);
3181 static void gen_vector_defs(prog_section_def def, const char *name)
3186 if (!name || name[0] == '#' || OPTS_FLAG(SINGLE_VECTOR_DEFS))
3189 def.type = TYPE_FLOAT;
3193 component = (char*)mem_a(len+3);
3194 memcpy(component, name, len);
3196 component[len-0] = 0;
3197 component[len-2] = '_';
3199 component[len-1] = 'x';
3201 for (i = 0; i < 3; ++i) {
3202 def.name = code_genstring(component);
3203 vec_push(code_defs, def);
3209 static void gen_vector_fields(prog_section_field fld, const char *name)
3214 if (!name || OPTS_FLAG(SINGLE_VECTOR_DEFS))
3217 fld.type = TYPE_FLOAT;
3221 component = (char*)mem_a(len+3);
3222 memcpy(component, name, len);
3224 component[len-0] = 0;
3225 component[len-2] = '_';
3227 component[len-1] = 'x';
3229 for (i = 0; i < 3; ++i) {
3230 fld.name = code_genstring(component);
3231 vec_push(code_fields, fld);
3237 static bool ir_builder_gen_global(ir_builder *self, ir_value *global, bool islocal)
3241 prog_section_def def;
3242 bool pushdef = false;
3244 if (opts.g || !islocal)
3247 def.type = global->vtype;
3248 def.offset = vec_size(code_globals);
3251 if (global->name[0] == '#') {
3252 if (!self->str_immediate)
3253 self->str_immediate = code_genstring("IMMEDIATE");
3254 def.name = global->code.name = self->str_immediate;
3257 def.name = global->code.name = code_genstring(global->name);
3263 switch (global->vtype)
3266 if (!strcmp(global->name, "end_sys_globals")) {
3267 /* TODO: remember this point... all the defs before this one
3268 * should be checksummed and added to progdefs.h when we generate it.
3271 else if (!strcmp(global->name, "end_sys_fields")) {
3272 /* TODO: same as above but for entity-fields rather than globsl
3276 irwarning(global->context, WARN_VOID_VARIABLES, "unrecognized variable of type void `%s`",
3278 /* I'd argue setting it to 0 is sufficient, but maybe some depend on knowing how far
3279 * the system fields actually go? Though the engine knows this anyway...
3280 * Maybe this could be an -foption
3281 * fteqcc creates data for end_sys_* - of size 1, so let's do the same
3283 ir_value_code_setaddr(global, vec_size(code_globals));
3284 vec_push(code_globals, 0);
3286 if (pushdef) vec_push(code_defs, def);
3289 if (pushdef) vec_push(code_defs, def);
3290 return gen_global_pointer(global);
3293 vec_push(code_defs, def);
3294 gen_vector_defs(def, global->name);
3296 return gen_global_field(global);
3301 ir_value_code_setaddr(global, vec_size(code_globals));
3302 if (global->hasvalue) {
3303 iptr = (int32_t*)&global->constval.ivec[0];
3304 vec_push(code_globals, *iptr);
3306 vec_push(code_globals, 0);
3308 if (!islocal && global->cvq != CV_CONST)
3309 def.type |= DEF_SAVEGLOBAL;
3310 if (pushdef) vec_push(code_defs, def);
3312 return global->code.globaladdr >= 0;
3316 ir_value_code_setaddr(global, vec_size(code_globals));
3317 if (global->hasvalue) {
3318 vec_push(code_globals, code_genstring(global->constval.vstring));
3320 vec_push(code_globals, 0);
3322 if (!islocal && global->cvq != CV_CONST)
3323 def.type |= DEF_SAVEGLOBAL;
3324 if (pushdef) vec_push(code_defs, def);
3325 return global->code.globaladdr >= 0;
3330 ir_value_code_setaddr(global, vec_size(code_globals));
3331 if (global->hasvalue) {
3332 iptr = (int32_t*)&global->constval.ivec[0];
3333 vec_push(code_globals, iptr[0]);
3334 if (global->code.globaladdr < 0)
3336 for (d = 1; d < type_sizeof_[global->vtype]; ++d) {
3337 vec_push(code_globals, iptr[d]);
3340 vec_push(code_globals, 0);
3341 if (global->code.globaladdr < 0)
3343 for (d = 1; d < type_sizeof_[global->vtype]; ++d) {
3344 vec_push(code_globals, 0);
3347 if (!islocal && global->cvq != CV_CONST)
3348 def.type |= DEF_SAVEGLOBAL;
3351 vec_push(code_defs, def);
3352 def.type &= ~DEF_SAVEGLOBAL;
3353 gen_vector_defs(def, global->name);
3355 return global->code.globaladdr >= 0;
3358 ir_value_code_setaddr(global, vec_size(code_globals));
3359 if (!global->hasvalue) {
3360 vec_push(code_globals, 0);
3361 if (global->code.globaladdr < 0)
3364 vec_push(code_globals, vec_size(code_functions));
3365 if (!gen_global_function(self, global))
3368 if (!islocal && global->cvq != CV_CONST)
3369 def.type |= DEF_SAVEGLOBAL;
3370 if (pushdef) vec_push(code_defs, def);
3373 /* assume biggest type */
3374 ir_value_code_setaddr(global, vec_size(code_globals));
3375 vec_push(code_globals, 0);
3376 for (i = 1; i < type_sizeof_[TYPE_VARIANT]; ++i)
3377 vec_push(code_globals, 0);
3380 /* refuse to create 'void' type or any other fancy business. */
3381 irerror(global->context, "Invalid type for global variable `%s`: %s",
3382 global->name, type_name[global->vtype]);
3387 static void ir_builder_prepare_field(ir_value *field)
3389 field->code.fieldaddr = code_alloc_field(type_sizeof_[field->fieldtype]);
3392 static bool ir_builder_gen_field(ir_builder *self, ir_value *field)
3394 prog_section_def def;
3395 prog_section_field fld;
3399 def.type = (uint16_t)field->vtype;
3400 def.offset = (uint16_t)vec_size(code_globals);
3402 /* create a global named the same as the field */
3403 if (opts.standard == COMPILER_GMQCC) {
3404 /* in our standard, the global gets a dot prefix */
3405 size_t len = strlen(field->name);
3408 /* we really don't want to have to allocate this, and 1024
3409 * bytes is more than enough for a variable/field name
3411 if (len+2 >= sizeof(name)) {
3412 irerror(field->context, "invalid field name size: %u", (unsigned int)len);
3417 memcpy(name+1, field->name, len); /* no strncpy - we used strlen above */
3420 def.name = code_genstring(name);
3421 fld.name = def.name + 1; /* we reuse that string table entry */
3423 /* in plain QC, there cannot be a global with the same name,
3424 * and so we also name the global the same.
3425 * FIXME: fteqcc should create a global as well
3426 * check if it actually uses the same name. Probably does
3428 def.name = code_genstring(field->name);
3429 fld.name = def.name;
3432 field->code.name = def.name;
3434 vec_push(code_defs, def);
3436 fld.type = field->fieldtype;
3438 if (fld.type == TYPE_VOID) {
3439 irerror(field->context, "field is missing a type: %s - don't know its size", field->name);
3443 fld.offset = field->code.fieldaddr;
3445 vec_push(code_fields, fld);
3447 ir_value_code_setaddr(field, vec_size(code_globals));
3448 vec_push(code_globals, fld.offset);
3449 if (fld.type == TYPE_VECTOR) {
3450 vec_push(code_globals, fld.offset+1);
3451 vec_push(code_globals, fld.offset+2);
3454 if (field->fieldtype == TYPE_VECTOR) {
3455 gen_vector_defs(def, field->name);
3456 gen_vector_fields(fld, field->name);
3459 return field->code.globaladdr >= 0;
3462 bool ir_builder_generate(ir_builder *self, const char *filename)
3464 prog_section_statement stmt;
3466 char *lnofile = NULL;
3470 for (i = 0; i < vec_size(self->fields); ++i)
3472 ir_builder_prepare_field(self->fields[i]);
3475 for (i = 0; i < vec_size(self->globals); ++i)
3477 if (!ir_builder_gen_global(self, self->globals[i], false)) {
3482 for (i = 0; i < vec_size(self->fields); ++i)
3484 if (!ir_builder_gen_field(self, self->fields[i])) {
3489 /* generate function code */
3490 for (i = 0; i < vec_size(self->globals); ++i)
3492 if (self->globals[i]->vtype == TYPE_FUNCTION) {
3493 if (!gen_global_function_code(self, self->globals[i])) {
3499 if (vec_size(code_globals) >= 65536) {
3500 irerror(vec_last(self->globals)->context, "This progs file would require more globals than the metadata can handle. Bailing out.");
3504 /* DP errors if the last instruction is not an INSTR_DONE. */
3505 if (vec_last(code_statements).opcode != INSTR_DONE)
3507 stmt.opcode = INSTR_DONE;
3511 code_push_statement(&stmt, vec_last(code_linenums));
3517 if (vec_size(code_statements) != vec_size(code_linenums)) {
3518 con_err("Linecounter wrong: %lu != %lu\n",
3519 (unsigned long)vec_size(code_statements),
3520 (unsigned long)vec_size(code_linenums));
3521 } else if (OPTS_FLAG(LNO)) {
3523 size_t filelen = strlen(filename);
3525 memcpy(vec_add(lnofile, filelen+1), filename, filelen+1);
3526 dot = strrchr(lnofile, '.');
3530 vec_shrinkto(lnofile, dot - lnofile);
3532 memcpy(vec_add(lnofile, 5), ".lno", 5);
3536 con_out("writing '%s' and '%s'...\n", filename, lnofile);
3538 con_out("writing '%s'\n", filename);
3539 if (!code_write(filename, lnofile)) {
3547 /***********************************************************************
3548 *IR DEBUG Dump functions...
3551 #define IND_BUFSZ 1024
3554 # define strncat(dst, src, sz) strncat_s(dst, sz, src, _TRUNCATE)
3557 const char *qc_opname(int op)
3559 if (op < 0) return "<INVALID>";
3560 if (op < (int)( sizeof(asm_instr) / sizeof(asm_instr[0]) ))
3561 return asm_instr[op].m;
3563 case VINSTR_PHI: return "PHI";
3564 case VINSTR_JUMP: return "JUMP";
3565 case VINSTR_COND: return "COND";
3566 default: return "<UNK>";
3570 void ir_builder_dump(ir_builder *b, int (*oprintf)(const char*, ...))
3573 char indent[IND_BUFSZ];
3577 oprintf("module %s\n", b->name);
3578 for (i = 0; i < vec_size(b->globals); ++i)
3581 if (b->globals[i]->hasvalue)
3582 oprintf("%s = ", b->globals[i]->name);
3583 ir_value_dump(b->globals[i], oprintf);
3586 for (i = 0; i < vec_size(b->functions); ++i)
3587 ir_function_dump(b->functions[i], indent, oprintf);
3588 oprintf("endmodule %s\n", b->name);
3591 void ir_function_dump(ir_function *f, char *ind,
3592 int (*oprintf)(const char*, ...))
3595 if (f->builtin != 0) {
3596 oprintf("%sfunction %s = builtin %i\n", ind, f->name, -f->builtin);
3599 oprintf("%sfunction %s\n", ind, f->name);
3600 strncat(ind, "\t", IND_BUFSZ);
3601 if (vec_size(f->locals))
3603 oprintf("%s%i locals:\n", ind, (int)vec_size(f->locals));
3604 for (i = 0; i < vec_size(f->locals); ++i) {
3605 oprintf("%s\t", ind);
3606 ir_value_dump(f->locals[i], oprintf);
3610 oprintf("%sliferanges:\n", ind);
3611 for (i = 0; i < vec_size(f->locals); ++i) {
3613 ir_value *v = f->locals[i];
3614 oprintf("%s\t%s: %s@%i ", ind, v->name, (v->unique_life ? "unique " : ""), (int)v->code.local);
3615 for (l = 0; l < vec_size(v->life); ++l) {
3616 oprintf("[%i,%i] ", v->life[l].start, v->life[l].end);
3620 for (i = 0; i < vec_size(f->values); ++i) {
3622 ir_value *v = f->values[i];
3623 oprintf("%s\t%s: @%i ", ind, v->name, (int)v->code.local);
3624 for (l = 0; l < vec_size(v->life); ++l) {
3625 oprintf("[%i,%i] ", v->life[l].start, v->life[l].end);
3629 if (vec_size(f->blocks))
3631 oprintf("%slife passes (check): %i\n", ind, (int)f->run_id);
3632 for (i = 0; i < vec_size(f->blocks); ++i) {
3633 if (f->blocks[i]->run_id != f->run_id) {
3634 oprintf("%slife pass check fail! %i != %i\n", ind, (int)f->blocks[i]->run_id, (int)f->run_id);
3636 ir_block_dump(f->blocks[i], ind, oprintf);
3640 ind[strlen(ind)-1] = 0;
3641 oprintf("%sendfunction %s\n", ind, f->name);
3644 void ir_block_dump(ir_block* b, char *ind,
3645 int (*oprintf)(const char*, ...))
3648 oprintf("%s:%s\n", ind, b->label);
3649 strncat(ind, "\t", IND_BUFSZ);
3651 for (i = 0; i < vec_size(b->instr); ++i)
3652 ir_instr_dump(b->instr[i], ind, oprintf);
3653 ind[strlen(ind)-1] = 0;
3656 void dump_phi(ir_instr *in, int (*oprintf)(const char*, ...))
3659 oprintf("%s <- phi ", in->_ops[0]->name);
3660 for (i = 0; i < vec_size(in->phi); ++i)
3662 oprintf("([%s] : %s) ", in->phi[i].from->label,
3663 in->phi[i].value->name);
3668 void ir_instr_dump(ir_instr *in, char *ind,
3669 int (*oprintf)(const char*, ...))
3672 const char *comma = NULL;
3674 oprintf("%s (%i) ", ind, (int)in->eid);
3676 if (in->opcode == VINSTR_PHI) {
3677 dump_phi(in, oprintf);
3681 strncat(ind, "\t", IND_BUFSZ);
3683 if (in->_ops[0] && (in->_ops[1] || in->_ops[2])) {
3684 ir_value_dump(in->_ops[0], oprintf);
3685 if (in->_ops[1] || in->_ops[2])
3688 if (in->opcode == INSTR_CALL0 || in->opcode == VINSTR_NRCALL) {
3689 oprintf("CALL%i\t", vec_size(in->params));
3691 oprintf("%s\t", qc_opname(in->opcode));
3693 if (in->_ops[0] && !(in->_ops[1] || in->_ops[2])) {
3694 ir_value_dump(in->_ops[0], oprintf);
3699 for (i = 1; i != 3; ++i) {
3703 ir_value_dump(in->_ops[i], oprintf);
3711 oprintf("[%s]", in->bops[0]->label);
3715 oprintf("%s[%s]", comma, in->bops[1]->label);
3716 if (vec_size(in->params)) {
3717 oprintf("\tparams: ");
3718 for (i = 0; i != vec_size(in->params); ++i) {
3719 oprintf("%s, ", in->params[i]->name);
3723 ind[strlen(ind)-1] = 0;
3726 void ir_value_dump_string(const char *str, int (*oprintf)(const char*, ...))
3729 for (; *str; ++str) {
3731 case '\n': oprintf("\\n"); break;
3732 case '\r': oprintf("\\r"); break;
3733 case '\t': oprintf("\\t"); break;
3734 case '\v': oprintf("\\v"); break;
3735 case '\f': oprintf("\\f"); break;
3736 case '\b': oprintf("\\b"); break;
3737 case '\a': oprintf("\\a"); break;
3738 case '\\': oprintf("\\\\"); break;
3739 case '"': oprintf("\\\""); break;
3740 default: oprintf("%c", *str); break;
3746 void ir_value_dump(ir_value* v, int (*oprintf)(const char*, ...))
3755 oprintf("fn:%s", v->name);
3758 oprintf("%g", v->constval.vfloat);
3761 oprintf("'%g %g %g'",
3764 v->constval.vvec.z);
3767 oprintf("(entity)");
3770 ir_value_dump_string(v->constval.vstring, oprintf);
3774 oprintf("%i", v->constval.vint);
3779 v->constval.vpointer->name);
3783 oprintf("%s", v->name);
3787 void ir_value_dump_life(const ir_value *self, int (*oprintf)(const char*,...))
3790 oprintf("Life of %12s:", self->name);
3791 for (i = 0; i < vec_size(self->life); ++i)
3793 oprintf(" + [%i, %i]\n", self->life[i].start, self->life[i].end);