5 * Permission is hereby granted, free of charge, to any person obtaining a copy of
6 * this software and associated documentation files (the "Software"), to deal in
7 * the Software without restriction, including without limitation the rights to
8 * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
9 * of the Software, and to permit persons to whom the Software is furnished to do
10 * so, subject to the following conditions:
12 * The above copyright notice and this permission notice shall be included in all
13 * copies or substantial portions of the Software.
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
28 /***********************************************************************
29 * Type sizes used at multiple points in the IR codegen
32 const char *type_name[TYPE_COUNT] = {
48 size_t type_sizeof[TYPE_COUNT] = {
55 1, /* TYPE_FUNCTION */
64 uint16_t type_store_instr[TYPE_COUNT] = {
65 INSTR_STORE_F, /* should use I when having integer support */
72 INSTR_STORE_ENT, /* should use I */
74 INSTR_STORE_I, /* integer type */
79 INSTR_STORE_V, /* variant, should never be accessed */
81 AINSTR_END, /* struct */
82 AINSTR_END, /* union */
83 AINSTR_END, /* array */
86 uint16_t field_store_instr[TYPE_COUNT] = {
96 INSTR_STORE_FLD, /* integer type */
101 INSTR_STORE_V, /* variant, should never be accessed */
103 AINSTR_END, /* struct */
104 AINSTR_END, /* union */
105 AINSTR_END, /* array */
108 uint16_t type_storep_instr[TYPE_COUNT] = {
109 INSTR_STOREP_F, /* should use I when having integer support */
116 INSTR_STOREP_ENT, /* should use I */
118 INSTR_STOREP_ENT, /* integer type */
123 INSTR_STOREP_V, /* variant, should never be accessed */
125 AINSTR_END, /* struct */
126 AINSTR_END, /* union */
127 AINSTR_END, /* array */
130 uint16_t type_eq_instr[TYPE_COUNT] = {
131 INSTR_EQ_F, /* should use I when having integer support */
136 INSTR_EQ_E, /* FLD has no comparison */
138 INSTR_EQ_E, /* should use I */
145 INSTR_EQ_V, /* variant, should never be accessed */
147 AINSTR_END, /* struct */
148 AINSTR_END, /* union */
149 AINSTR_END, /* array */
152 uint16_t type_ne_instr[TYPE_COUNT] = {
153 INSTR_NE_F, /* should use I when having integer support */
158 INSTR_NE_E, /* FLD has no comparison */
160 INSTR_NE_E, /* should use I */
167 INSTR_NE_V, /* variant, should never be accessed */
169 AINSTR_END, /* struct */
170 AINSTR_END, /* union */
171 AINSTR_END, /* array */
174 uint16_t type_not_instr[TYPE_COUNT] = {
175 INSTR_NOT_F, /* should use I when having integer support */
182 INSTR_NOT_ENT, /* should use I */
184 INSTR_NOT_I, /* integer type */
189 INSTR_NOT_V, /* variant, should never be accessed */
191 AINSTR_END, /* struct */
192 AINSTR_END, /* union */
193 AINSTR_END, /* array */
197 static void ir_gen_extparam(ir_builder *ir);
199 /* error functions */
201 static void irerror(lex_ctx ctx, const char *msg, ...)
205 con_cvprintmsg((void*)&ctx, LVL_ERROR, "internal error", msg, ap);
209 static bool irwarning(lex_ctx ctx, int warntype, const char *fmt, ...)
214 r = vcompile_warning(ctx, warntype, fmt, ap);
219 /***********************************************************************
220 * Vector utility functions
223 bool GMQCC_WARN vec_ir_value_find(ir_value **vec, ir_value *what, size_t *idx)
226 size_t len = vec_size(vec);
227 for (i = 0; i < len; ++i) {
228 if (vec[i] == what) {
236 bool GMQCC_WARN vec_ir_block_find(ir_block **vec, ir_block *what, size_t *idx)
239 size_t len = vec_size(vec);
240 for (i = 0; i < len; ++i) {
241 if (vec[i] == what) {
249 bool GMQCC_WARN vec_ir_instr_find(ir_instr **vec, ir_instr *what, size_t *idx)
252 size_t len = vec_size(vec);
253 for (i = 0; i < len; ++i) {
254 if (vec[i] == what) {
262 /***********************************************************************
266 static void ir_block_delete_quick(ir_block* self);
267 static void ir_instr_delete_quick(ir_instr *self);
268 static void ir_function_delete_quick(ir_function *self);
270 ir_builder* ir_builder_new(const char *modulename)
274 self = (ir_builder*)mem_a(sizeof(*self));
278 self->functions = NULL;
279 self->globals = NULL;
281 self->extparams = NULL;
282 self->filenames = NULL;
283 self->filestrings = NULL;
284 self->htglobals = util_htnew(IR_HT_SIZE);
285 self->htfields = util_htnew(IR_HT_SIZE);
286 self->htfunctions = util_htnew(IR_HT_SIZE);
288 self->str_immediate = 0;
290 if (!ir_builder_set_name(self, modulename)) {
298 void ir_builder_delete(ir_builder* self)
301 util_htdel(self->htglobals);
302 util_htdel(self->htfields);
303 util_htdel(self->htfunctions);
304 mem_d((void*)self->name);
305 for (i = 0; i != vec_size(self->functions); ++i) {
306 ir_function_delete_quick(self->functions[i]);
308 vec_free(self->functions);
309 for (i = 0; i != vec_size(self->extparams); ++i) {
310 ir_value_delete(self->extparams[i]);
312 vec_free(self->extparams);
313 for (i = 0; i != vec_size(self->globals); ++i) {
314 ir_value_delete(self->globals[i]);
316 vec_free(self->globals);
317 for (i = 0; i != vec_size(self->fields); ++i) {
318 ir_value_delete(self->fields[i]);
320 vec_free(self->fields);
321 vec_free(self->filenames);
322 vec_free(self->filestrings);
326 bool ir_builder_set_name(ir_builder *self, const char *name)
329 mem_d((void*)self->name);
330 self->name = util_strdup(name);
334 ir_function* ir_builder_get_function(ir_builder *self, const char *name)
336 return (ir_function*)util_htget(self->htfunctions, name);
339 ir_function* ir_builder_create_function(ir_builder *self, const char *name, int outtype)
341 ir_function *fn = ir_builder_get_function(self, name);
346 fn = ir_function_new(self, outtype);
347 if (!ir_function_set_name(fn, name))
349 ir_function_delete(fn);
352 vec_push(self->functions, fn);
353 util_htset(self->htfunctions, name, fn);
355 fn->value = ir_builder_create_global(self, fn->name, TYPE_FUNCTION);
357 ir_function_delete(fn);
361 fn->value->hasvalue = true;
362 fn->value->outtype = outtype;
363 fn->value->constval.vfunc = fn;
364 fn->value->context = fn->context;
369 ir_value* ir_builder_get_global(ir_builder *self, const char *name)
371 return (ir_value*)util_htget(self->htglobals, name);
374 ir_value* ir_builder_create_global(ir_builder *self, const char *name, int vtype)
378 if (name && name[0] != '#')
380 ve = ir_builder_get_global(self, name);
386 ve = ir_value_var(name, store_global, vtype);
387 vec_push(self->globals, ve);
388 util_htset(self->htglobals, name, ve);
392 ir_value* ir_builder_get_field(ir_builder *self, const char *name)
394 return (ir_value*)util_htget(self->htfields, name);
398 ir_value* ir_builder_create_field(ir_builder *self, const char *name, int vtype)
400 ir_value *ve = ir_builder_get_field(self, name);
405 ve = ir_value_var(name, store_global, TYPE_FIELD);
406 ve->fieldtype = vtype;
407 vec_push(self->fields, ve);
408 util_htset(self->htfields, name, ve);
412 /***********************************************************************
416 bool ir_function_naive_phi(ir_function*);
417 void ir_function_enumerate(ir_function*);
418 bool ir_function_calculate_liferanges(ir_function*);
419 bool ir_function_allocate_locals(ir_function*);
421 ir_function* ir_function_new(ir_builder* owner, int outtype)
424 self = (ir_function*)mem_a(sizeof(*self));
429 memset(self, 0, sizeof(*self));
432 if (!ir_function_set_name(self, "<@unnamed>")) {
437 self->context.file = "<@no context>";
438 self->context.line = 0;
439 self->outtype = outtype;
448 self->code_function_def = -1;
449 self->allocated_locals = 0;
455 bool ir_function_set_name(ir_function *self, const char *name)
458 mem_d((void*)self->name);
459 self->name = util_strdup(name);
463 static void ir_function_delete_quick(ir_function *self)
466 mem_d((void*)self->name);
468 for (i = 0; i != vec_size(self->blocks); ++i)
469 ir_block_delete_quick(self->blocks[i]);
470 vec_free(self->blocks);
472 vec_free(self->params);
474 for (i = 0; i != vec_size(self->values); ++i)
475 ir_value_delete(self->values[i]);
476 vec_free(self->values);
478 for (i = 0; i != vec_size(self->locals); ++i)
479 ir_value_delete(self->locals[i]);
480 vec_free(self->locals);
482 /* self->value is deleted by the builder */
487 void ir_function_delete(ir_function *self)
490 mem_d((void*)self->name);
492 for (i = 0; i != vec_size(self->blocks); ++i)
493 ir_block_delete(self->blocks[i]);
494 vec_free(self->blocks);
496 vec_free(self->params);
498 for (i = 0; i != vec_size(self->values); ++i)
499 ir_value_delete(self->values[i]);
500 vec_free(self->values);
502 for (i = 0; i != vec_size(self->locals); ++i)
503 ir_value_delete(self->locals[i]);
504 vec_free(self->locals);
506 /* self->value is deleted by the builder */
511 void ir_function_collect_value(ir_function *self, ir_value *v)
513 vec_push(self->values, v);
516 ir_block* ir_function_create_block(lex_ctx ctx, ir_function *self, const char *label)
518 ir_block* bn = ir_block_new(self, label);
520 vec_push(self->blocks, bn);
524 static bool instr_is_operation(uint16_t op)
526 return ( (op >= INSTR_MUL_F && op <= INSTR_GT) ||
527 (op >= INSTR_LOAD_F && op <= INSTR_LOAD_FNC) ||
528 (op == INSTR_ADDRESS) ||
529 (op >= INSTR_NOT_F && op <= INSTR_NOT_FNC) ||
530 (op >= INSTR_AND && op <= INSTR_BITOR) );
533 bool ir_function_pass_peephole(ir_function *self)
537 for (b = 0; b < vec_size(self->blocks); ++b) {
539 ir_block *block = self->blocks[b];
541 for (i = 0; i < vec_size(block->instr); ++i) {
543 inst = block->instr[i];
546 (inst->opcode >= INSTR_STORE_F &&
547 inst->opcode <= INSTR_STORE_FNC))
555 oper = block->instr[i-1];
556 if (!instr_is_operation(oper->opcode))
559 value = oper->_ops[0];
561 /* only do it for SSA values */
562 if (value->store != store_value)
565 /* don't optimize out the temp if it's used later again */
566 if (vec_size(value->reads) != 1)
569 /* The very next store must use this value */
570 if (value->reads[0] != store)
573 /* And of course the store must _read_ from it, so it's in
575 if (store->_ops[1] != value)
578 ++opts_optimizationcount[OPTIM_PEEPHOLE];
579 (void)!ir_instr_op(oper, 0, store->_ops[0], true);
581 vec_remove(block->instr, i, 1);
582 ir_instr_delete(store);
584 else if (inst->opcode == VINSTR_COND)
586 /* COND on a value resulting from a NOT could
587 * remove the NOT and swap its operands
594 value = inst->_ops[0];
596 if (value->store != store_value ||
597 vec_size(value->reads) != 1 ||
598 value->reads[0] != inst)
603 inot = value->writes[0];
604 if (inot->_ops[0] != value ||
605 inot->opcode < INSTR_NOT_F ||
606 inot->opcode > INSTR_NOT_FNC ||
607 inot->opcode == INSTR_NOT_V) /* can't do this one */
613 ++opts_optimizationcount[OPTIM_PEEPHOLE];
615 (void)!ir_instr_op(inst, 0, inot->_ops[1], false);
618 for (inotid = 0; inotid < vec_size(tmp->instr); ++inotid) {
619 if (tmp->instr[inotid] == inot)
622 if (inotid >= vec_size(tmp->instr)) {
623 compile_error(inst->context, "sanity-check failed: failed to find instruction to optimize out");
626 vec_remove(tmp->instr, inotid, 1);
627 ir_instr_delete(inot);
628 /* swap ontrue/onfalse */
630 inst->bops[0] = inst->bops[1];
641 bool ir_function_pass_tailcall(ir_function *self)
645 for (b = 0; b < vec_size(self->blocks); ++b) {
647 ir_instr *ret, *call, *store = NULL;
648 ir_block *block = self->blocks[b];
650 if (!block->final || vec_size(block->instr) < 2)
653 ret = block->instr[vec_size(block->instr)-1];
654 if (ret->opcode != INSTR_DONE && ret->opcode != INSTR_RETURN)
657 call = block->instr[vec_size(block->instr)-2];
658 if (call->opcode >= INSTR_STORE_F && call->opcode <= INSTR_STORE_FNC) {
659 /* account for the unoptimized
661 * STORE %return, %tmp
665 if (vec_size(block->instr) < 3)
669 call = block->instr[vec_size(block->instr)-3];
672 if (call->opcode < INSTR_CALL0 || call->opcode > INSTR_CALL8)
676 /* optimize out the STORE */
678 ret->_ops[0] == store->_ops[0] &&
679 store->_ops[1] == call->_ops[0])
681 ++opts_optimizationcount[OPTIM_PEEPHOLE];
682 call->_ops[0] = store->_ops[0];
683 vec_remove(block->instr, vec_size(block->instr) - 2, 1);
684 ir_instr_delete(store);
693 funcval = call->_ops[1];
696 if (funcval->vtype != TYPE_FUNCTION || funcval->constval.vfunc != self)
699 /* now we have a CALL and a RET, check if it's a tailcall */
700 if (ret->_ops[0] && call->_ops[0] != ret->_ops[0])
703 ++opts_optimizationcount[OPTIM_TAIL_RECURSION];
704 vec_shrinkby(block->instr, 2);
706 block->final = false; /* open it back up */
708 /* emite parameter-stores */
709 for (p = 0; p < vec_size(call->params); ++p) {
710 /* assert(call->params_count <= self->locals_count); */
711 if (!ir_block_create_store(block, call->context, self->locals[p], call->params[p])) {
712 irerror(call->context, "failed to create tailcall store instruction for parameter %i", (int)p);
716 if (!ir_block_create_jump(block, call->context, self->blocks[0])) {
717 irerror(call->context, "failed to create tailcall jump");
721 ir_instr_delete(call);
722 ir_instr_delete(ret);
728 bool ir_function_finalize(ir_function *self)
733 if (OPTS_OPTIMIZATION(OPTIM_PEEPHOLE)) {
734 if (!ir_function_pass_peephole(self)) {
735 irerror(self->context, "generic optimization pass broke something in `%s`", self->name);
740 if (OPTS_OPTIMIZATION(OPTIM_TAIL_RECURSION)) {
741 if (!ir_function_pass_tailcall(self)) {
742 irerror(self->context, "tailcall optimization pass broke something in `%s`", self->name);
747 if (!ir_function_naive_phi(self))
750 ir_function_enumerate(self);
752 if (!ir_function_calculate_liferanges(self))
754 if (!ir_function_allocate_locals(self))
759 ir_value* ir_function_create_local(ir_function *self, const char *name, int vtype, bool param)
764 vec_size(self->locals) &&
765 self->locals[vec_size(self->locals)-1]->store != store_param) {
766 irerror(self->context, "cannot add parameters after adding locals");
770 ve = ir_value_var(name, (param ? store_param : store_local), vtype);
771 vec_push(self->locals, ve);
775 /***********************************************************************
779 ir_block* ir_block_new(ir_function* owner, const char *name)
782 self = (ir_block*)mem_a(sizeof(*self));
786 memset(self, 0, sizeof(*self));
789 if (name && !ir_block_set_label(self, name)) {
794 self->context.file = "<@no context>";
795 self->context.line = 0;
799 self->entries = NULL;
803 self->is_return = false;
808 self->generated = false;
813 static void ir_block_delete_quick(ir_block* self)
816 if (self->label) mem_d(self->label);
817 for (i = 0; i != vec_size(self->instr); ++i)
818 ir_instr_delete_quick(self->instr[i]);
819 vec_free(self->instr);
820 vec_free(self->entries);
821 vec_free(self->exits);
822 vec_free(self->living);
826 void ir_block_delete(ir_block* self)
829 if (self->label) mem_d(self->label);
830 for (i = 0; i != vec_size(self->instr); ++i)
831 ir_instr_delete(self->instr[i]);
832 vec_free(self->instr);
833 vec_free(self->entries);
834 vec_free(self->exits);
835 vec_free(self->living);
839 bool ir_block_set_label(ir_block *self, const char *name)
842 mem_d((void*)self->label);
843 self->label = util_strdup(name);
844 return !!self->label;
847 /***********************************************************************
851 ir_instr* ir_instr_new(lex_ctx ctx, ir_block* owner, int op)
854 self = (ir_instr*)mem_a(sizeof(*self));
861 self->_ops[0] = NULL;
862 self->_ops[1] = NULL;
863 self->_ops[2] = NULL;
864 self->bops[0] = NULL;
865 self->bops[1] = NULL;
876 static void ir_instr_delete_quick(ir_instr *self)
879 vec_free(self->params);
883 void ir_instr_delete(ir_instr *self)
886 /* The following calls can only delete from
887 * vectors, we still want to delete this instruction
888 * so ignore the return value. Since with the warn_unused_result attribute
889 * gcc doesn't care about an explicit: (void)foo(); to ignore the result,
890 * I have to improvise here and use if(foo());
892 for (i = 0; i < vec_size(self->phi); ++i) {
894 if (vec_ir_instr_find(self->phi[i].value->writes, self, &idx))
895 vec_remove(self->phi[i].value->writes, idx, 1);
896 if (vec_ir_instr_find(self->phi[i].value->reads, self, &idx))
897 vec_remove(self->phi[i].value->reads, idx, 1);
900 for (i = 0; i < vec_size(self->params); ++i) {
902 if (vec_ir_instr_find(self->params[i]->writes, self, &idx))
903 vec_remove(self->params[i]->writes, idx, 1);
904 if (vec_ir_instr_find(self->params[i]->reads, self, &idx))
905 vec_remove(self->params[i]->reads, idx, 1);
907 vec_free(self->params);
908 (void)!ir_instr_op(self, 0, NULL, false);
909 (void)!ir_instr_op(self, 1, NULL, false);
910 (void)!ir_instr_op(self, 2, NULL, false);
914 bool ir_instr_op(ir_instr *self, int op, ir_value *v, bool writing)
916 if (self->_ops[op]) {
918 if (writing && vec_ir_instr_find(self->_ops[op]->writes, self, &idx))
919 vec_remove(self->_ops[op]->writes, idx, 1);
920 else if (vec_ir_instr_find(self->_ops[op]->reads, self, &idx))
921 vec_remove(self->_ops[op]->reads, idx, 1);
925 vec_push(v->writes, self);
927 vec_push(v->reads, self);
933 /***********************************************************************
937 void ir_value_code_setaddr(ir_value *self, int32_t gaddr)
939 self->code.globaladdr = gaddr;
940 if (self->members[0]) self->members[0]->code.globaladdr = gaddr;
941 if (self->members[1]) self->members[1]->code.globaladdr = gaddr;
942 if (self->members[2]) self->members[2]->code.globaladdr = gaddr;
945 int32_t ir_value_code_addr(const ir_value *self)
947 if (self->store == store_return)
948 return OFS_RETURN + self->code.addroffset;
949 return self->code.globaladdr + self->code.addroffset;
952 ir_value* ir_value_var(const char *name, int storetype, int vtype)
955 self = (ir_value*)mem_a(sizeof(*self));
957 self->fieldtype = TYPE_VOID;
958 self->outtype = TYPE_VOID;
959 self->store = storetype;
965 self->hasvalue = false;
966 self->context.file = "<@no context>";
967 self->context.line = 0;
969 if (name && !ir_value_set_name(self, name)) {
970 irerror(self->context, "out of memory");
975 memset(&self->constval, 0, sizeof(self->constval));
976 memset(&self->code, 0, sizeof(self->code));
978 self->members[0] = NULL;
979 self->members[1] = NULL;
980 self->members[2] = NULL;
981 self->memberof = NULL;
983 self->unique_life = false;
989 ir_value* ir_value_vector_member(ir_value *self, unsigned int member)
995 if (self->members[member])
996 return self->members[member];
998 if (self->vtype == TYPE_VECTOR)
1000 m = ir_value_var(self->name, self->store, TYPE_FLOAT);
1003 m->context = self->context;
1005 self->members[member] = m;
1006 m->code.addroffset = member;
1008 else if (self->vtype == TYPE_FIELD)
1010 if (self->fieldtype != TYPE_VECTOR)
1012 m = ir_value_var(self->name, self->store, TYPE_FIELD);
1015 m->fieldtype = TYPE_FLOAT;
1016 m->context = self->context;
1018 self->members[member] = m;
1019 m->code.addroffset = member;
1023 irerror(self->context, "invalid member access on %s", self->name);
1031 ir_value* ir_value_out(ir_function *owner, const char *name, int storetype, int vtype)
1033 ir_value *v = ir_value_var(name, storetype, vtype);
1036 ir_function_collect_value(owner, v);
1040 void ir_value_delete(ir_value* self)
1044 mem_d((void*)self->name);
1047 if (self->vtype == TYPE_STRING)
1048 mem_d((void*)self->constval.vstring);
1050 for (i = 0; i < 3; ++i) {
1051 if (self->members[i])
1052 ir_value_delete(self->members[i]);
1054 vec_free(self->reads);
1055 vec_free(self->writes);
1056 vec_free(self->life);
1060 bool ir_value_set_name(ir_value *self, const char *name)
1063 mem_d((void*)self->name);
1064 self->name = util_strdup(name);
1065 return !!self->name;
1068 bool ir_value_set_float(ir_value *self, float f)
1070 if (self->vtype != TYPE_FLOAT)
1072 self->constval.vfloat = f;
1073 self->hasvalue = true;
1077 bool ir_value_set_func(ir_value *self, int f)
1079 if (self->vtype != TYPE_FUNCTION)
1081 self->constval.vint = f;
1082 self->hasvalue = true;
1086 bool ir_value_set_vector(ir_value *self, vector v)
1088 if (self->vtype != TYPE_VECTOR)
1090 self->constval.vvec = v;
1091 self->hasvalue = true;
1095 bool ir_value_set_field(ir_value *self, ir_value *fld)
1097 if (self->vtype != TYPE_FIELD)
1099 self->constval.vpointer = fld;
1100 self->hasvalue = true;
1104 static char *ir_strdup(const char *str)
1107 /* actually dup empty strings */
1108 char *out = mem_a(1);
1112 return util_strdup(str);
1115 bool ir_value_set_string(ir_value *self, const char *str)
1117 if (self->vtype != TYPE_STRING)
1119 self->constval.vstring = ir_strdup(str);
1120 self->hasvalue = true;
1125 bool ir_value_set_int(ir_value *self, int i)
1127 if (self->vtype != TYPE_INTEGER)
1129 self->constval.vint = i;
1130 self->hasvalue = true;
1135 bool ir_value_lives(ir_value *self, size_t at)
1138 for (i = 0; i < vec_size(self->life); ++i)
1140 ir_life_entry_t *life = &self->life[i];
1141 if (life->start <= at && at <= life->end)
1143 if (life->start > at) /* since it's ordered */
1149 bool ir_value_life_insert(ir_value *self, size_t idx, ir_life_entry_t e)
1152 vec_push(self->life, e);
1153 for (k = vec_size(self->life)-1; k > idx; --k)
1154 self->life[k] = self->life[k-1];
1155 self->life[idx] = e;
1159 bool ir_value_life_merge(ir_value *self, size_t s)
1162 ir_life_entry_t *life = NULL;
1163 ir_life_entry_t *before = NULL;
1164 ir_life_entry_t new_entry;
1166 /* Find the first range >= s */
1167 for (i = 0; i < vec_size(self->life); ++i)
1170 life = &self->life[i];
1171 if (life->start > s)
1174 /* nothing found? append */
1175 if (i == vec_size(self->life)) {
1177 if (life && life->end+1 == s)
1179 /* previous life range can be merged in */
1183 if (life && life->end >= s)
1185 e.start = e.end = s;
1186 vec_push(self->life, e);
1192 if (before->end + 1 == s &&
1193 life->start - 1 == s)
1196 before->end = life->end;
1197 vec_remove(self->life, i, 1);
1200 if (before->end + 1 == s)
1206 /* already contained */
1207 if (before->end >= s)
1211 if (life->start - 1 == s)
1216 /* insert a new entry */
1217 new_entry.start = new_entry.end = s;
1218 return ir_value_life_insert(self, i, new_entry);
1221 bool ir_value_life_merge_into(ir_value *self, const ir_value *other)
1225 if (!vec_size(other->life))
1228 if (!vec_size(self->life)) {
1229 size_t count = vec_size(other->life);
1230 ir_life_entry_t *life = vec_add(self->life, count);
1231 memcpy(life, other->life, count * sizeof(*life));
1236 for (i = 0; i < vec_size(other->life); ++i)
1238 const ir_life_entry_t *life = &other->life[i];
1241 ir_life_entry_t *entry = &self->life[myi];
1243 if (life->end+1 < entry->start)
1245 /* adding an interval before entry */
1246 if (!ir_value_life_insert(self, myi, *life))
1252 if (life->start < entry->start &&
1253 life->end+1 >= entry->start)
1255 /* starts earlier and overlaps */
1256 entry->start = life->start;
1259 if (life->end > entry->end &&
1260 life->start <= entry->end+1)
1262 /* ends later and overlaps */
1263 entry->end = life->end;
1266 /* see if our change combines it with the next ranges */
1267 while (myi+1 < vec_size(self->life) &&
1268 entry->end+1 >= self->life[1+myi].start)
1270 /* overlaps with (myi+1) */
1271 if (entry->end < self->life[1+myi].end)
1272 entry->end = self->life[1+myi].end;
1273 vec_remove(self->life, myi+1, 1);
1274 entry = &self->life[myi];
1277 /* see if we're after the entry */
1278 if (life->start > entry->end)
1281 /* append if we're at the end */
1282 if (myi >= vec_size(self->life)) {
1283 vec_push(self->life, *life);
1286 /* otherweise check the next range */
1295 bool ir_values_overlap(const ir_value *a, const ir_value *b)
1297 /* For any life entry in A see if it overlaps with
1298 * any life entry in B.
1299 * Note that the life entries are orderes, so we can make a
1300 * more efficient algorithm there than naively translating the
1304 ir_life_entry_t *la, *lb, *enda, *endb;
1306 /* first of all, if either has no life range, they cannot clash */
1307 if (!vec_size(a->life) || !vec_size(b->life))
1312 enda = la + vec_size(a->life);
1313 endb = lb + vec_size(b->life);
1316 /* check if the entries overlap, for that,
1317 * both must start before the other one ends.
1319 if (la->start < lb->end &&
1320 lb->start < la->end)
1325 /* entries are ordered
1326 * one entry is earlier than the other
1327 * that earlier entry will be moved forward
1329 if (la->start < lb->start)
1331 /* order: A B, move A forward
1332 * check if we hit the end with A
1337 else /* if (lb->start < la->start) actually <= */
1339 /* order: B A, move B forward
1340 * check if we hit the end with B
1349 /***********************************************************************
1353 bool ir_block_create_store_op(ir_block *self, lex_ctx ctx, int op, ir_value *target, ir_value *what)
1357 irerror(self->context, "unreachable statement (%s)", self->label);
1361 if (target->store == store_value &&
1362 (op < INSTR_STOREP_F || op > INSTR_STOREP_FNC))
1364 irerror(self->context, "cannot store to an SSA value");
1365 irerror(self->context, "trying to store: %s <- %s", target->name, what->name);
1366 irerror(self->context, "instruction: %s", asm_instr[op].m);
1370 in = ir_instr_new(ctx, self, op);
1374 if (!ir_instr_op(in, 0, target, true) ||
1375 !ir_instr_op(in, 1, what, false))
1377 ir_instr_delete(in);
1380 vec_push(self->instr, in);
1384 bool ir_block_create_store(ir_block *self, lex_ctx ctx, ir_value *target, ir_value *what)
1388 if (target->vtype == TYPE_VARIANT)
1389 vtype = what->vtype;
1391 vtype = target->vtype;
1394 if (vtype == TYPE_FLOAT && what->vtype == TYPE_INTEGER)
1395 op = INSTR_CONV_ITOF;
1396 else if (vtype == TYPE_INTEGER && what->vtype == TYPE_FLOAT)
1397 op = INSTR_CONV_FTOI;
1399 op = type_store_instr[vtype];
1401 if (OPTS_FLAG(ADJUST_VECTOR_FIELDS)) {
1402 if (op == INSTR_STORE_FLD && what->fieldtype == TYPE_VECTOR)
1406 return ir_block_create_store_op(self, ctx, op, target, what);
1409 bool ir_block_create_storep(ir_block *self, lex_ctx ctx, ir_value *target, ir_value *what)
1414 if (target->vtype != TYPE_POINTER)
1417 /* storing using pointer - target is a pointer, type must be
1418 * inferred from source
1420 vtype = what->vtype;
1422 op = type_storep_instr[vtype];
1423 if (OPTS_FLAG(ADJUST_VECTOR_FIELDS)) {
1424 if (op == INSTR_STOREP_FLD && what->fieldtype == TYPE_VECTOR)
1425 op = INSTR_STOREP_V;
1428 return ir_block_create_store_op(self, ctx, op, target, what);
1431 bool ir_block_create_return(ir_block *self, lex_ctx ctx, ir_value *v)
1435 irerror(self->context, "unreachable statement (%s)", self->label);
1439 self->is_return = true;
1440 in = ir_instr_new(ctx, self, INSTR_RETURN);
1444 if (v && !ir_instr_op(in, 0, v, false)) {
1445 ir_instr_delete(in);
1449 vec_push(self->instr, in);
1453 bool ir_block_create_if(ir_block *self, lex_ctx ctx, ir_value *v,
1454 ir_block *ontrue, ir_block *onfalse)
1458 irerror(self->context, "unreachable statement (%s)", self->label);
1462 /*in = ir_instr_new(ctx, self, (v->vtype == TYPE_STRING ? INSTR_IF_S : INSTR_IF_F));*/
1463 in = ir_instr_new(ctx, self, VINSTR_COND);
1467 if (!ir_instr_op(in, 0, v, false)) {
1468 ir_instr_delete(in);
1472 in->bops[0] = ontrue;
1473 in->bops[1] = onfalse;
1475 vec_push(self->instr, in);
1477 vec_push(self->exits, ontrue);
1478 vec_push(self->exits, onfalse);
1479 vec_push(ontrue->entries, self);
1480 vec_push(onfalse->entries, self);
1484 bool ir_block_create_jump(ir_block *self, lex_ctx ctx, ir_block *to)
1488 irerror(self->context, "unreachable statement (%s)", self->label);
1492 in = ir_instr_new(ctx, self, VINSTR_JUMP);
1497 vec_push(self->instr, in);
1499 vec_push(self->exits, to);
1500 vec_push(to->entries, self);
1504 bool ir_block_create_goto(ir_block *self, lex_ctx ctx, ir_block *to)
1508 irerror(self->context, "unreachable statement (%s)", self->label);
1512 in = ir_instr_new(ctx, self, INSTR_GOTO);
1517 vec_push(self->instr, in);
1519 vec_push(self->exits, to);
1520 vec_push(to->entries, self);
1524 ir_instr* ir_block_create_phi(ir_block *self, lex_ctx ctx, const char *label, int ot)
1528 in = ir_instr_new(ctx, self, VINSTR_PHI);
1531 out = ir_value_out(self->owner, label, store_value, ot);
1533 ir_instr_delete(in);
1536 if (!ir_instr_op(in, 0, out, true)) {
1537 ir_instr_delete(in);
1538 ir_value_delete(out);
1541 vec_push(self->instr, in);
1545 ir_value* ir_phi_value(ir_instr *self)
1547 return self->_ops[0];
1550 void ir_phi_add(ir_instr* self, ir_block *b, ir_value *v)
1554 if (!vec_ir_block_find(self->owner->entries, b, NULL)) {
1555 /* Must not be possible to cause this, otherwise the AST
1556 * is doing something wrong.
1558 irerror(self->context, "Invalid entry block for PHI");
1564 vec_push(v->reads, self);
1565 vec_push(self->phi, pe);
1568 /* call related code */
1569 ir_instr* ir_block_create_call(ir_block *self, lex_ctx ctx, const char *label, ir_value *func)
1573 in = ir_instr_new(ctx, self, INSTR_CALL0);
1576 out = ir_value_out(self->owner, label, (func->outtype == TYPE_VOID) ? store_return : store_value, func->outtype);
1578 ir_instr_delete(in);
1581 if (!ir_instr_op(in, 0, out, true) ||
1582 !ir_instr_op(in, 1, func, false))
1584 ir_instr_delete(in);
1585 ir_value_delete(out);
1588 vec_push(self->instr, in);
1592 ir_value* ir_call_value(ir_instr *self)
1594 return self->_ops[0];
1597 void ir_call_param(ir_instr* self, ir_value *v)
1599 vec_push(self->params, v);
1600 vec_push(v->reads, self);
1603 /* binary op related code */
1605 ir_value* ir_block_create_binop(ir_block *self, lex_ctx ctx,
1606 const char *label, int opcode,
1607 ir_value *left, ir_value *right)
1629 case INSTR_SUB_S: /* -- offset of string as float */
1634 case INSTR_BITOR_IF:
1635 case INSTR_BITOR_FI:
1636 case INSTR_BITAND_FI:
1637 case INSTR_BITAND_IF:
1652 case INSTR_BITAND_I:
1655 case INSTR_RSHIFT_I:
1656 case INSTR_LSHIFT_I:
1678 /* boolean operations result in floats */
1679 if (opcode >= INSTR_EQ_F && opcode <= INSTR_GT)
1681 else if (opcode >= INSTR_LE && opcode <= INSTR_GT)
1684 else if (opcode >= INSTR_LE_I && opcode <= INSTR_EQ_FI)
1689 if (ot == TYPE_VOID) {
1690 /* The AST or parser were supposed to check this! */
1694 return ir_block_create_general_instr(self, ctx, label, opcode, left, right, ot);
1697 ir_value* ir_block_create_unary(ir_block *self, lex_ctx ctx,
1698 const char *label, int opcode,
1701 int ot = TYPE_FLOAT;
1713 /* QC doesn't have other unary operations. We expect extensions to fill
1714 * the above list, otherwise we assume out-type = in-type, eg for an
1718 ot = operand->vtype;
1721 if (ot == TYPE_VOID) {
1722 /* The AST or parser were supposed to check this! */
1726 /* let's use the general instruction creator and pass NULL for OPB */
1727 return ir_block_create_general_instr(self, ctx, label, opcode, operand, NULL, ot);
1730 ir_value* ir_block_create_general_instr(ir_block *self, lex_ctx ctx, const char *label,
1731 int op, ir_value *a, ir_value *b, int outype)
1736 out = ir_value_out(self->owner, label, store_value, outype);
1740 instr = ir_instr_new(ctx, self, op);
1742 ir_value_delete(out);
1746 if (!ir_instr_op(instr, 0, out, true) ||
1747 !ir_instr_op(instr, 1, a, false) ||
1748 !ir_instr_op(instr, 2, b, false) )
1753 vec_push(self->instr, instr);
1757 ir_instr_delete(instr);
1758 ir_value_delete(out);
1762 ir_value* ir_block_create_fieldaddress(ir_block *self, lex_ctx ctx, const char *label, ir_value *ent, ir_value *field)
1766 /* Support for various pointer types todo if so desired */
1767 if (ent->vtype != TYPE_ENTITY)
1770 if (field->vtype != TYPE_FIELD)
1773 v = ir_block_create_general_instr(self, ctx, label, INSTR_ADDRESS, ent, field, TYPE_POINTER);
1774 v->fieldtype = field->fieldtype;
1778 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)
1781 if (ent->vtype != TYPE_ENTITY)
1784 /* at some point we could redirect for TYPE_POINTER... but that could lead to carelessness */
1785 if (field->vtype != TYPE_FIELD)
1790 case TYPE_FLOAT: op = INSTR_LOAD_F; break;
1791 case TYPE_VECTOR: op = INSTR_LOAD_V; break;
1792 case TYPE_STRING: op = INSTR_LOAD_S; break;
1793 case TYPE_FIELD: op = INSTR_LOAD_FLD; break;
1794 case TYPE_ENTITY: op = INSTR_LOAD_ENT; break;
1795 case TYPE_FUNCTION: op = INSTR_LOAD_FNC; break;
1797 case TYPE_POINTER: op = INSTR_LOAD_I; break;
1798 case TYPE_INTEGER: op = INSTR_LOAD_I; break;
1801 irerror(self->context, "invalid type for ir_block_create_load_from_ent: %s", type_name[outype]);
1805 return ir_block_create_general_instr(self, ctx, label, op, ent, field, outype);
1808 ir_value* ir_block_create_add(ir_block *self, lex_ctx ctx,
1810 ir_value *left, ir_value *right)
1813 int l = left->vtype;
1814 int r = right->vtype;
1818 irerror(self->context, "invalid type for ir_block_create_add: %s", type_name[l]);
1834 if ( (l == TYPE_FLOAT && r == TYPE_INTEGER) )
1836 else if ( (l == TYPE_INTEGER && r == TYPE_FLOAT) )
1841 irerror(self->context, "invalid type for ir_block_create_add: %s", type_name[l]);
1845 return ir_block_create_binop(self, ctx, label, op, left, right);
1848 ir_value* ir_block_create_sub(ir_block *self, lex_ctx ctx,
1850 ir_value *left, ir_value *right)
1853 int l = left->vtype;
1854 int r = right->vtype;
1859 irerror(self->context, "invalid type for ir_block_create_sub: %s", type_name[l]);
1875 if ( (l == TYPE_FLOAT && r == TYPE_INTEGER) )
1877 else if ( (l == TYPE_INTEGER && r == TYPE_FLOAT) )
1882 irerror(self->context, "invalid type for ir_block_create_sub: %s", type_name[l]);
1886 return ir_block_create_binop(self, ctx, label, op, left, right);
1889 ir_value* ir_block_create_mul(ir_block *self, lex_ctx ctx,
1891 ir_value *left, ir_value *right)
1894 int l = left->vtype;
1895 int r = right->vtype;
1900 irerror(self->context, "invalid type for ir_block_create_mul: %s", type_name[l]);
1915 if ( (l == TYPE_VECTOR && r == TYPE_FLOAT) )
1917 else if ( (l == TYPE_FLOAT && r == TYPE_VECTOR) )
1920 else if ( (l == TYPE_VECTOR && r == TYPE_INTEGER) )
1922 else if ( (l == TYPE_INTEGER && r == TYPE_VECTOR) )
1924 else if ( (l == TYPE_FLOAT && r == TYPE_INTEGER) )
1926 else if ( (l == TYPE_INTEGER && r == TYPE_FLOAT) )
1930 irerror(self->context, "invalid type for ir_block_create_mul: %s", type_name[l]);
1934 return ir_block_create_binop(self, ctx, label, op, left, right);
1937 ir_value* ir_block_create_div(ir_block *self, lex_ctx ctx,
1939 ir_value *left, ir_value *right)
1942 int l = left->vtype;
1943 int r = right->vtype;
1948 irerror(self->context, "invalid type for ir_block_create_div: %s", type_name[l]);
1961 if ( (l == TYPE_VECTOR && r == TYPE_FLOAT) )
1963 else if ( (l == TYPE_FLOAT && r == TYPE_INTEGER) )
1965 else if ( (l == TYPE_INTEGER && r == TYPE_FLOAT) )
1970 irerror(self->context, "invalid type for ir_block_create_div: %s", type_name[l]);
1974 return ir_block_create_binop(self, ctx, label, op, left, right);
1977 /* PHI resolving breaks the SSA, and must thus be the last
1978 * step before life-range calculation.
1981 static bool ir_block_naive_phi(ir_block *self);
1982 bool ir_function_naive_phi(ir_function *self)
1986 for (i = 0; i < vec_size(self->blocks); ++i)
1988 if (!ir_block_naive_phi(self->blocks[i]))
1995 static bool ir_naive_phi_emit_store(ir_block *block, size_t iid, ir_value *old, ir_value *what)
2000 /* create a store */
2001 if (!ir_block_create_store(block, old, what))
2004 /* we now move it up */
2005 instr = vec_last(block->instr);
2006 for (i = vec_size(block->instr)-1; i > iid; --i)
2007 block->instr[i] = block->instr[i-1];
2008 block->instr[i] = instr;
2014 static bool ir_block_naive_phi(ir_block *self)
2016 size_t i, p; /*, w;*/
2017 /* FIXME: optionally, create_phi can add the phis
2018 * to a list so we don't need to loop through blocks
2019 * - anyway: "don't optimize YET"
2021 for (i = 0; i < vec_size(self->instr); ++i)
2023 ir_instr *instr = self->instr[i];
2024 if (instr->opcode != VINSTR_PHI)
2027 vec_remove(self->instr, i, 1);
2028 --i; /* NOTE: i+1 below */
2030 for (p = 0; p < vec_size(instr->phi); ++p)
2032 ir_value *v = instr->phi[p].value;
2033 ir_block *b = instr->phi[p].from;
2035 if (v->store == store_value &&
2036 vec_size(v->reads) == 1 &&
2037 vec_size(v->writes) == 1)
2039 /* replace the value */
2040 if (!ir_instr_op(v->writes[0], 0, instr->_ops[0], true))
2045 /* force a move instruction */
2046 ir_instr *prevjump = vec_last(b->instr);
2049 instr->_ops[0]->store = store_global;
2050 if (!ir_block_create_store(b, instr->context, instr->_ops[0], v))
2052 instr->_ops[0]->store = store_value;
2053 vec_push(b->instr, prevjump);
2058 ir_value *v = instr->phi[p].value;
2059 for (w = 0; w < vec_size(v->writes); ++w) {
2062 if (!v->writes[w]->_ops[0])
2065 /* When the write was to a global, we have to emit a mov */
2066 old = v->writes[w]->_ops[0];
2068 /* The original instruction now writes to the PHI target local */
2069 if (v->writes[w]->_ops[0] == v)
2070 v->writes[w]->_ops[0] = instr->_ops[0];
2072 if (old->store != store_value && old->store != store_local && old->store != store_param)
2074 /* If it originally wrote to a global we need to store the value
2077 if (!ir_naive_phi_emit_store(self, i+1, old, v))
2079 if (i+1 < vec_size(self->instr))
2080 instr = self->instr[i+1];
2083 /* In case I forget and access instr later, it'll be NULL
2084 * when it's a problem, to make sure we crash, rather than accessing
2090 /* If it didn't, we can replace all reads by the phi target now. */
2092 for (r = 0; r < vec_size(old->reads); ++r)
2095 ir_instr *ri = old->reads[r];
2096 for (op = 0; op < vec_size(ri->phi); ++op) {
2097 if (ri->phi[op].value == old)
2098 ri->phi[op].value = v;
2100 for (op = 0; op < 3; ++op) {
2101 if (ri->_ops[op] == old)
2109 ir_instr_delete(instr);
2114 /***********************************************************************
2115 *IR Temp allocation code
2116 * Propagating value life ranges by walking through the function backwards
2117 * until no more changes are made.
2118 * In theory this should happen once more than once for every nested loop
2120 * Though this implementation might run an additional time for if nests.
2123 /* Enumerate instructions used by value's life-ranges
2125 static void ir_block_enumerate(ir_block *self, size_t *_eid)
2129 for (i = 0; i < vec_size(self->instr); ++i)
2131 self->instr[i]->eid = eid++;
2136 /* Enumerate blocks and instructions.
2137 * The block-enumeration is unordered!
2138 * We do not really use the block enumreation, however
2139 * the instruction enumeration is important for life-ranges.
2141 void ir_function_enumerate(ir_function *self)
2144 size_t instruction_id = 0;
2145 for (i = 0; i < vec_size(self->blocks); ++i)
2147 self->blocks[i]->eid = i;
2148 self->blocks[i]->run_id = 0;
2149 ir_block_enumerate(self->blocks[i], &instruction_id);
2153 static bool ir_block_life_propagate(ir_block *b, ir_block *prev, bool *changed);
2154 bool ir_function_calculate_liferanges(ir_function *self)
2162 for (i = 0; i != vec_size(self->blocks); ++i)
2164 if (self->blocks[i]->is_return)
2166 vec_free(self->blocks[i]->living);
2167 if (!ir_block_life_propagate(self->blocks[i], NULL, &changed))
2172 if (vec_size(self->blocks)) {
2173 ir_block *block = self->blocks[0];
2174 for (i = 0; i < vec_size(block->living); ++i) {
2175 ir_value *v = block->living[i];
2176 if (v->memberof || v->store != store_local)
2178 if (irwarning(v->context, WARN_USED_UNINITIALIZED,
2179 "variable `%s` may be used uninitialized in this function", v->name))
2188 /* Local-value allocator
2189 * After finishing creating the liferange of all values used in a function
2190 * we can allocate their global-positions.
2191 * This is the counterpart to register-allocation in register machines.
2198 } function_allocator;
2200 static bool function_allocator_alloc(function_allocator *alloc, const ir_value *var)
2203 size_t vsize = type_sizeof[var->vtype];
2205 slot = ir_value_var("reg", store_global, var->vtype);
2209 if (!ir_value_life_merge_into(slot, var))
2212 vec_push(alloc->locals, slot);
2213 vec_push(alloc->sizes, vsize);
2214 vec_push(alloc->unique, var->unique_life);
2219 ir_value_delete(slot);
2223 bool ir_function_allocate_locals(ir_function *self)
2232 function_allocator alloc;
2234 if (!vec_size(self->locals) && !vec_size(self->values))
2237 alloc.locals = NULL;
2239 alloc.positions = NULL;
2240 alloc.unique = NULL;
2242 for (i = 0; i < vec_size(self->locals); ++i)
2244 if (!OPTS_OPTIMIZATION(OPTIM_LOCALTEMPS))
2245 self->locals[i]->unique_life = true;
2246 if (!function_allocator_alloc(&alloc, self->locals[i]))
2250 /* Allocate a slot for any value that still exists */
2251 for (i = 0; i < vec_size(self->values); ++i)
2253 v = self->values[i];
2255 if (!vec_size(v->life))
2258 for (a = 0; a < vec_size(alloc.locals); ++a)
2260 /* if it's reserved for a unique liferange: skip */
2261 if (alloc.unique[a])
2264 slot = alloc.locals[a];
2266 /* never resize parameters
2267 * will be required later when overlapping temps + locals
2269 if (a < vec_size(self->params) &&
2270 alloc.sizes[a] < type_sizeof[v->vtype])
2275 if (ir_values_overlap(v, slot))
2278 if (!ir_value_life_merge_into(slot, v))
2281 /* adjust size for this slot */
2282 if (alloc.sizes[a] < type_sizeof[v->vtype])
2283 alloc.sizes[a] = type_sizeof[v->vtype];
2285 self->values[i]->code.local = a;
2288 if (a >= vec_size(alloc.locals)) {
2289 self->values[i]->code.local = vec_size(alloc.locals);
2290 if (!function_allocator_alloc(&alloc, v))
2299 /* Adjust slot positions based on sizes */
2300 vec_push(alloc.positions, 0);
2302 if (vec_size(alloc.sizes))
2303 pos = alloc.positions[0] + alloc.sizes[0];
2306 for (i = 1; i < vec_size(alloc.sizes); ++i)
2308 pos = alloc.positions[i-1] + alloc.sizes[i-1];
2309 vec_push(alloc.positions, pos);
2312 self->allocated_locals = pos + vec_last(alloc.sizes);
2314 /* Locals need to know their new position */
2315 for (i = 0; i < vec_size(self->locals); ++i) {
2316 self->locals[i]->code.local = alloc.positions[i];
2318 /* Take over the actual slot positions on values */
2319 for (i = 0; i < vec_size(self->values); ++i) {
2320 self->values[i]->code.local = alloc.positions[self->values[i]->code.local];
2328 for (i = 0; i < vec_size(alloc.locals); ++i)
2329 ir_value_delete(alloc.locals[i]);
2330 vec_free(alloc.locals);
2331 vec_free(alloc.sizes);
2332 vec_free(alloc.positions);
2336 /* Get information about which operand
2337 * is read from, or written to.
2339 static void ir_op_read_write(int op, size_t *read, size_t *write)
2359 case INSTR_STOREP_F:
2360 case INSTR_STOREP_V:
2361 case INSTR_STOREP_S:
2362 case INSTR_STOREP_ENT:
2363 case INSTR_STOREP_FLD:
2364 case INSTR_STOREP_FNC:
2375 static bool ir_block_living_add_instr(ir_block *self, size_t eid)
2378 bool changed = false;
2380 for (i = 0; i != vec_size(self->living); ++i)
2382 tempbool = ir_value_life_merge(self->living[i], eid);
2385 irerror(self->context, "block_living_add_instr() value instruction added %s: %i", self->living[i]->_name, (int)eid);
2387 changed = changed || tempbool;
2392 static bool ir_block_life_prop_previous(ir_block* self, ir_block *prev, bool *changed)
2398 /* values which have been read in a previous iteration are now
2399 * in the "living" array even if the previous block doesn't use them.
2400 * So we have to remove whatever does not exist in the previous block.
2401 * They will be re-added on-read, but the liferange merge won't cause
2403 for (i = 0; i < vec_size(self->living); ++i)
2405 if (!vec_ir_value_find(prev->living, self->living[i], NULL)) {
2406 vec_remove(self->living, i, 1);
2412 /* Whatever the previous block still has in its living set
2413 * must now be added to ours as well.
2415 for (i = 0; i < vec_size(prev->living); ++i)
2417 if (vec_ir_value_find(self->living, prev->living[i], NULL))
2419 vec_push(self->living, prev->living[i]);
2421 irerror(self->contextt from prev: %s", self->label, prev->living[i]->_name);
2427 static bool ir_block_life_propagate(ir_block *self, ir_block *prev, bool *changed)
2433 /* bitmasks which operands are read from or written to */
2435 char dbg_ind[16] = { '#', '0' };
2440 if (!ir_block_life_prop_previous(self, prev, changed))
2444 i = vec_size(self->instr);
2447 instr = self->instr[i];
2449 /* PHI operands are always read operands */
2450 for (p = 0; p < vec_size(instr->phi); ++p)
2452 value = instr->phi[p].value;
2453 if (value->memberof)
2454 value = value->memberof;
2455 if (!vec_ir_value_find(self->living, value, NULL))
2456 vec_push(self->living, value);
2459 /* call params are read operands too */
2460 for (p = 0; p < vec_size(instr->params); ++p)
2462 value = instr->params[p];
2463 if (value->memberof)
2464 value = value->memberof;
2465 if (!vec_ir_value_find(self->living, value, NULL))
2466 vec_push(self->living, value);
2469 /* See which operands are read and write operands */
2470 ir_op_read_write(instr->opcode, &read, &write);
2472 if (instr->opcode == INSTR_MUL_VF)
2474 /* the float source will get an additional lifetime */
2475 tempbool = ir_value_life_merge(instr->_ops[2], instr->eid+1);
2476 *changed = *changed || tempbool;
2478 else if (instr->opcode == INSTR_MUL_FV)
2480 /* the float source will get an additional lifetime */
2481 tempbool = ir_value_life_merge(instr->_ops[1], instr->eid+1);
2482 *changed = *changed || tempbool;
2485 /* Go through the 3 main operands */
2486 for (o = 0; o < 3; ++o)
2488 if (!instr->_ops[o]) /* no such operand */
2491 value = instr->_ops[o];
2492 if (value->memberof)
2493 value = value->memberof;
2495 /* We only care about locals */
2496 /* we also calculate parameter liferanges so that locals
2497 * can take up parameter slots */
2498 if (value->store != store_value &&
2499 value->store != store_local &&
2500 value->store != store_param)
2506 if (!vec_ir_value_find(self->living, value, NULL))
2507 vec_push(self->living, value);
2510 /* write operands */
2511 /* When we write to a local, we consider it "dead" for the
2512 * remaining upper part of the function, since in SSA a value
2513 * can only be written once (== created)
2518 bool in_living = vec_ir_value_find(self->living, value, &idx);
2521 /* If the value isn't alive it hasn't been read before... */
2522 /* TODO: See if the warning can be emitted during parsing or AST processing
2523 * otherwise have warning printed here.
2524 * IF printing a warning here: include filecontext_t,
2525 * and make sure it's only printed once
2526 * since this function is run multiple times.
2528 /* For now: debug info: */
2529 /* con_err( "Value only written %s\n", value->name); */
2530 tempbool = ir_value_life_merge(value, instr->eid);
2531 *changed = *changed || tempbool;
2533 ir_instr_dump(instr, dbg_ind, printf);
2537 /* since 'living' won't contain it
2538 * anymore, merge the value, since
2541 tempbool = ir_value_life_merge(value, instr->eid);
2544 con_err( "value added id %s %i\n", value->name, (int)instr->eid);
2546 *changed = *changed || tempbool;
2548 vec_remove(self->living, idx, 1);
2553 tempbool = ir_block_living_add_instr(self, instr->eid);
2554 /*con_err( "living added values\n");*/
2555 *changed = *changed || tempbool;
2559 if (self->run_id == self->owner->run_id)
2562 self->run_id = self->owner->run_id;
2564 for (i = 0; i < vec_size(self->entries); ++i)
2566 ir_block *entry = self->entries[i];
2567 ir_block_life_propagate(entry, self, changed);
2573 /***********************************************************************
2576 * Since the IR has the convention of putting 'write' operands
2577 * at the beginning, we have to rotate the operands of instructions
2578 * properly in order to generate valid QCVM code.
2580 * Having destinations at a fixed position is more convenient. In QC
2581 * this is *mostly* OPC, but FTE adds at least 2 instructions which
2582 * read from from OPA, and store to OPB rather than OPC. Which is
2583 * partially the reason why the implementation of these instructions
2584 * in darkplaces has been delayed for so long.
2586 * Breaking conventions is annoying...
2588 static bool ir_builder_gen_global(ir_builder *self, ir_value *global, bool islocal);
2590 static bool gen_global_field(ir_value *global)
2592 if (global->hasvalue)
2594 ir_value *fld = global->constval.vpointer;
2596 irerror(global->context, "Invalid field constant with no field: %s", global->name);
2600 /* copy the field's value */
2601 ir_value_code_setaddr(global, vec_size(code_globals));
2602 vec_push(code_globals, fld->code.fieldaddr);
2603 if (global->fieldtype == TYPE_VECTOR) {
2604 vec_push(code_globals, fld->code.fieldaddr+1);
2605 vec_push(code_globals, fld->code.fieldaddr+2);
2610 ir_value_code_setaddr(global, vec_size(code_globals));
2611 vec_push(code_globals, 0);
2612 if (global->fieldtype == TYPE_VECTOR) {
2613 vec_push(code_globals, 0);
2614 vec_push(code_globals, 0);
2617 if (global->code.globaladdr < 0)
2622 static bool gen_global_pointer(ir_value *global)
2624 if (global->hasvalue)
2626 ir_value *target = global->constval.vpointer;
2628 irerror(global->context, "Invalid pointer constant: %s", global->name);
2629 /* NULL pointers are pointing to the NULL constant, which also
2630 * sits at address 0, but still has an ir_value for itself.
2635 /* Here, relocations ARE possible - in fteqcc-enhanced-qc:
2636 * void() foo; <- proto
2637 * void() *fooptr = &foo;
2638 * void() foo = { code }
2640 if (!target->code.globaladdr) {
2641 /* FIXME: Check for the constant nullptr ir_value!
2642 * because then code.globaladdr being 0 is valid.
2644 irerror(global->context, "FIXME: Relocation support");
2648 ir_value_code_setaddr(global, vec_size(code_globals));
2649 vec_push(code_globals, target->code.globaladdr);
2653 ir_value_code_setaddr(global, vec_size(code_globals));
2654 vec_push(code_globals, 0);
2656 if (global->code.globaladdr < 0)
2661 static bool gen_blocks_recursive(ir_function *func, ir_block *block)
2663 prog_section_statement stmt;
2672 block->generated = true;
2673 block->code_start = vec_size(code_statements);
2674 for (i = 0; i < vec_size(block->instr); ++i)
2676 instr = block->instr[i];
2678 if (instr->opcode == VINSTR_PHI) {
2679 irerror(block->context, "cannot generate virtual instruction (phi)");
2683 if (instr->opcode == VINSTR_JUMP) {
2684 target = instr->bops[0];
2685 /* for uncoditional jumps, if the target hasn't been generated
2686 * yet, we generate them right here.
2688 if (!target->generated) {
2693 /* otherwise we generate a jump instruction */
2694 stmt.opcode = INSTR_GOTO;
2695 stmt.o1.s1 = (target->code_start) - vec_size(code_statements);
2698 if (stmt.o1.s1 != 1)
2699 code_push_statement(&stmt, instr->context.line);
2701 /* no further instructions can be in this block */
2705 if (instr->opcode == VINSTR_COND) {
2706 ontrue = instr->bops[0];
2707 onfalse = instr->bops[1];
2708 /* TODO: have the AST signal which block should
2709 * come first: eg. optimize IFs without ELSE...
2712 stmt.o1.u1 = ir_value_code_addr(instr->_ops[0]);
2716 if (ontrue->generated) {
2717 stmt.opcode = INSTR_IF;
2718 stmt.o2.s1 = (ontrue->code_start) - vec_size(code_statements);
2719 if (stmt.o2.s1 != 1)
2720 code_push_statement(&stmt, instr->context.line);
2722 if (onfalse->generated) {
2723 stmt.opcode = INSTR_IFNOT;
2724 stmt.o2.s1 = (onfalse->code_start) - vec_size(code_statements);
2725 if (stmt.o2.s1 != 1)
2726 code_push_statement(&stmt, instr->context.line);
2728 if (!ontrue->generated) {
2729 if (onfalse->generated) {
2734 if (!onfalse->generated) {
2735 if (ontrue->generated) {
2740 /* neither ontrue nor onfalse exist */
2741 stmt.opcode = INSTR_IFNOT;
2742 if (!instr->likely) {
2743 /* Honor the likelyhood hint */
2744 ir_block *tmp = onfalse;
2745 stmt.opcode = INSTR_IF;
2749 stidx = vec_size(code_statements);
2750 code_push_statement(&stmt, instr->context.line);
2751 /* on false we jump, so add ontrue-path */
2752 if (!gen_blocks_recursive(func, ontrue))
2754 /* fixup the jump address */
2755 code_statements[stidx].o2.s1 = vec_size(code_statements) - stidx;
2756 /* generate onfalse path */
2757 if (onfalse->generated) {
2758 /* fixup the jump address */
2759 code_statements[stidx].o2.s1 = (onfalse->code_start) - (stidx);
2760 if (code_statements[stidx].o2.s1 == 1) {
2761 code_statements[stidx] = code_statements[stidx+1];
2762 if (code_statements[stidx].o1.s1 < 0)
2763 code_statements[stidx].o1.s1++;
2764 code_pop_statement();
2766 stmt.opcode = vec_last(code_statements).opcode;
2767 if (stmt.opcode == INSTR_GOTO ||
2768 stmt.opcode == INSTR_IF ||
2769 stmt.opcode == INSTR_IFNOT ||
2770 stmt.opcode == INSTR_RETURN ||
2771 stmt.opcode == INSTR_DONE)
2773 /* no use jumping from here */
2776 /* may have been generated in the previous recursive call */
2777 stmt.opcode = INSTR_GOTO;
2778 stmt.o1.s1 = (onfalse->code_start) - vec_size(code_statements);
2781 if (stmt.o1.s1 != 1)
2782 code_push_statement(&stmt, instr->context.line);
2785 else if (code_statements[stidx].o2.s1 == 1) {
2786 code_statements[stidx] = code_statements[stidx+1];
2787 if (code_statements[stidx].o1.s1 < 0)
2788 code_statements[stidx].o1.s1++;
2789 code_pop_statement();
2791 /* if not, generate now */
2796 if (instr->opcode >= INSTR_CALL0 && instr->opcode <= INSTR_CALL8) {
2797 /* Trivial call translation:
2798 * copy all params to OFS_PARM*
2799 * if the output's storetype is not store_return,
2800 * add append a STORE instruction!
2802 * NOTES on how to do it better without much trouble:
2803 * -) The liferanges!
2804 * Simply check the liferange of all parameters for
2805 * other CALLs. For each param with no CALL in its
2806 * liferange, we can store it in an OFS_PARM at
2807 * generation already. This would even include later
2808 * reuse.... probably... :)
2813 first = vec_size(instr->params);
2816 for (p = 0; p < first; ++p)
2818 ir_value *param = instr->params[p];
2820 stmt.opcode = INSTR_STORE_F;
2823 if (param->vtype == TYPE_FIELD)
2824 stmt.opcode = field_store_instr[param->fieldtype];
2826 stmt.opcode = type_store_instr[param->vtype];
2827 stmt.o1.u1 = ir_value_code_addr(param);
2828 stmt.o2.u1 = OFS_PARM0 + 3 * p;
2829 code_push_statement(&stmt, instr->context.line);
2831 /* Now handle extparams */
2832 first = vec_size(instr->params);
2833 for (; p < first; ++p)
2835 ir_builder *ir = func->owner;
2836 ir_value *param = instr->params[p];
2837 ir_value *targetparam;
2839 if (p-8 >= vec_size(ir->extparams))
2840 ir_gen_extparam(ir);
2842 targetparam = ir->extparams[p-8];
2844 stmt.opcode = INSTR_STORE_F;
2847 if (param->vtype == TYPE_FIELD)
2848 stmt.opcode = field_store_instr[param->fieldtype];
2850 stmt.opcode = type_store_instr[param->vtype];
2851 stmt.o1.u1 = ir_value_code_addr(param);
2852 stmt.o2.u1 = ir_value_code_addr(targetparam);
2853 code_push_statement(&stmt, instr->context.line);
2856 stmt.opcode = INSTR_CALL0 + vec_size(instr->params);
2857 if (stmt.opcode > INSTR_CALL8)
2858 stmt.opcode = INSTR_CALL8;
2859 stmt.o1.u1 = ir_value_code_addr(instr->_ops[1]);
2862 code_push_statement(&stmt, instr->context.line);
2864 retvalue = instr->_ops[0];
2865 if (retvalue && retvalue->store != store_return && vec_size(retvalue->life))
2867 /* not to be kept in OFS_RETURN */
2868 if (retvalue->vtype == TYPE_FIELD)
2869 stmt.opcode = field_store_instr[retvalue->vtype];
2871 stmt.opcode = type_store_instr[retvalue->vtype];
2872 stmt.o1.u1 = OFS_RETURN;
2873 stmt.o2.u1 = ir_value_code_addr(retvalue);
2875 code_push_statement(&stmt, instr->context.line);
2880 if (instr->opcode == INSTR_STATE) {
2881 irerror(block->context, "TODO: state instruction");
2885 stmt.opcode = instr->opcode;
2890 /* This is the general order of operands */
2892 stmt.o3.u1 = ir_value_code_addr(instr->_ops[0]);
2895 stmt.o1.u1 = ir_value_code_addr(instr->_ops[1]);
2898 stmt.o2.u1 = ir_value_code_addr(instr->_ops[2]);
2900 if (stmt.opcode == INSTR_RETURN || stmt.opcode == INSTR_DONE)
2902 stmt.o1.u1 = stmt.o3.u1;
2905 else if ((stmt.opcode >= INSTR_STORE_F &&
2906 stmt.opcode <= INSTR_STORE_FNC) ||
2907 (stmt.opcode >= INSTR_STOREP_F &&
2908 stmt.opcode <= INSTR_STOREP_FNC))
2910 /* 2-operand instructions with A -> B */
2911 stmt.o2.u1 = stmt.o3.u1;
2914 /* tiny optimization, don't output
2917 if (stmt.o2.u1 == stmt.o1.u1 &&
2918 OPTS_OPTIMIZATION(OPTIM_PEEPHOLE))
2920 ++opts_optimizationcount[OPTIM_PEEPHOLE];
2925 code_push_statement(&stmt, instr->context.line);
2930 static bool gen_function_code(ir_function *self)
2933 prog_section_statement stmt;
2935 /* Starting from entry point, we generate blocks "as they come"
2936 * for now. Dead blocks will not be translated obviously.
2938 if (!vec_size(self->blocks)) {
2939 irerror(self->context, "Function '%s' declared without body.", self->name);
2943 block = self->blocks[0];
2944 if (block->generated)
2947 if (!gen_blocks_recursive(self, block)) {
2948 irerror(self->context, "failed to generate blocks for '%s'", self->name);
2952 /* code_write and qcvm -disasm need to know that the function ends here */
2953 stmt.opcode = INSTR_DONE;
2957 code_push_statement(&stmt, vec_last(code_linenums));
2961 static qcint ir_builder_filestring(ir_builder *ir, const char *filename)
2963 /* NOTE: filename pointers are copied, we never strdup them,
2964 * thus we can use pointer-comparison to find the string.
2969 for (i = 0; i < vec_size(ir->filenames); ++i) {
2970 if (ir->filenames[i] == filename)
2971 return ir->filestrings[i];
2974 str = code_genstring(filename);
2975 vec_push(ir->filenames, filename);
2976 vec_push(ir->filestrings, str);
2980 static bool gen_global_function(ir_builder *ir, ir_value *global)
2982 prog_section_function fun;
2986 #ifndef NEW_ALLOC_STRAT
2987 size_t local_var_end;
2990 if (!global->hasvalue || (!global->constval.vfunc))
2992 irerror(global->context, "Invalid state of function-global: not constant: %s", global->name);
2996 irfun = global->constval.vfunc;
2998 fun.name = global->code.name;
2999 fun.file = ir_builder_filestring(ir, global->context.file);
3000 fun.profile = 0; /* always 0 */
3001 fun.nargs = vec_size(irfun->params);
3005 for (i = 0;i < 8; ++i) {
3006 if ((int32_t)i >= fun.nargs)
3009 fun.argsize[i] = type_sizeof[irfun->params[i]];
3012 fun.firstlocal = vec_size(code_globals);
3014 #ifndef NEW_ALLOC_STRAT
3015 local_var_end = fun.firstlocal;
3016 for (i = 0; i < vec_size(irfun->locals); ++i) {
3017 if (!ir_builder_gen_global(ir, irfun->locals[i], true)) {
3018 irerror(irfun->locals[i]->context, "Failed to generate local %s", irfun->locals[i]->name);
3022 if (vec_size(irfun->locals)) {
3023 ir_value *last = vec_last(irfun->locals);
3024 local_var_end = last->code.globaladdr;
3025 if (last->vtype == TYPE_FIELD && last->fieldtype == TYPE_VECTOR)
3026 local_var_end += type_sizeof[TYPE_VECTOR];
3028 local_var_end += type_sizeof[last->vtype];
3030 for (i = 0; i < vec_size(irfun->values); ++i)
3032 /* generate code.globaladdr for ssa values */
3033 ir_value *v = irfun->values[i];
3034 ir_value_code_setaddr(v, local_var_end + v->code.local);
3036 for (i = 0; i < irfun->allocated_locals; ++i) {
3037 /* fill the locals with zeros */
3038 vec_push(code_globals, 0);
3041 fun.locals = vec_size(code_globals) - fun.firstlocal;
3043 fun.locals = irfun->allocated_locals;
3044 for (i = 0; i < vec_size(irfun->locals); ++i) {
3045 if (!ir_builder_gen_global(ir, irfun->locals[i], true)) {
3046 irerror(irfun->locals[i]->context, "Failed to generate local %s", irfun->locals[i]->name);
3049 ir_value_code_setaddr(irfun->locals[i], fun.firstlocal + irfun->locals[i]->code.local);
3051 for (i = vec_size(code_globals) - fun.firstlocal; i < fun.locals; ++i) {
3052 vec_push(code_globals, 0);
3054 for (i = 0; i < vec_size(irfun->values); ++i)
3056 /* generate code.globaladdr for ssa values */
3057 ir_value *v = irfun->values[i];
3058 ir_value_code_setaddr(v, fun.firstlocal + v->code.local);
3063 fun.entry = irfun->builtin+1;
3065 irfun->code_function_def = vec_size(code_functions);
3066 fun.entry = vec_size(code_statements);
3069 vec_push(code_functions, fun);
3073 static void ir_gen_extparam(ir_builder *ir)
3075 prog_section_def def;
3079 snprintf(name, sizeof(name), "EXTPARM#%i", (int)(vec_size(ir->extparams)+8));
3080 global = ir_value_var(name, store_global, TYPE_VECTOR);
3082 def.name = code_genstring(name);
3083 def.type = TYPE_VECTOR;
3084 def.offset = vec_size(code_globals);
3086 vec_push(code_defs, def);
3087 ir_value_code_setaddr(global, def.offset);
3088 vec_push(code_globals, 0);
3089 vec_push(code_globals, 0);
3090 vec_push(code_globals, 0);
3092 vec_push(ir->extparams, global);
3095 static bool gen_function_extparam_copy(ir_function *self)
3097 size_t i, ext, numparams;
3099 ir_builder *ir = self->owner;
3101 prog_section_statement stmt;
3103 numparams = vec_size(self->params);
3107 stmt.opcode = INSTR_STORE_F;
3109 for (i = 8; i < numparams; ++i) {
3111 if (ext >= vec_size(ir->extparams))
3112 ir_gen_extparam(ir);
3114 ep = ir->extparams[ext];
3116 stmt.opcode = type_store_instr[self->locals[i]->vtype];
3117 if (self->locals[i]->vtype == TYPE_FIELD &&
3118 self->locals[i]->fieldtype == TYPE_VECTOR)
3120 stmt.opcode = INSTR_STORE_V;
3122 stmt.o1.u1 = ir_value_code_addr(ep);
3123 stmt.o2.u1 = ir_value_code_addr(self->locals[i]);
3124 code_push_statement(&stmt, self->context.line);
3130 static bool gen_global_function_code(ir_builder *ir, ir_value *global)
3132 prog_section_function *fundef;
3137 irfun = global->constval.vfunc;
3139 if (global->cvq == CV_NONE) {
3140 irwarning(global->context, WARN_IMPLICIT_FUNCTION_POINTER,
3141 "function `%s` has no body and in QC implicitly becomes a function-pointer", global->name);
3143 /* this was a function pointer, don't generate code for those */
3150 if (irfun->code_function_def < 0) {
3151 irerror(irfun->context, "`%s`: IR global wasn't generated, failed to access function-def", irfun->name);
3154 fundef = &code_functions[irfun->code_function_def];
3156 fundef->entry = vec_size(code_statements);
3157 if (!gen_function_extparam_copy(irfun)) {
3158 irerror(irfun->context, "Failed to generate extparam-copy code for function %s", irfun->name);
3161 if (!gen_function_code(irfun)) {
3162 irerror(irfun->context, "Failed to generate code for function %s", irfun->name);
3168 static void gen_vector_defs(prog_section_def def, const char *name)
3173 if (!name || OPTS_FLAG(SINGLE_VECTOR_DEFS))
3176 def.type = TYPE_FLOAT;
3180 component = (char*)mem_a(len+3);
3181 memcpy(component, name, len);
3183 component[len-0] = 0;
3184 component[len-2] = '_';
3186 component[len-1] = 'x';
3188 for (i = 0; i < 3; ++i) {
3189 def.name = code_genstring(component);
3190 vec_push(code_defs, def);
3196 static void gen_vector_fields(prog_section_field fld, const char *name)
3201 if (!name || OPTS_FLAG(SINGLE_VECTOR_DEFS))
3204 fld.type = TYPE_FLOAT;
3208 component = (char*)mem_a(len+3);
3209 memcpy(component, name, len);
3211 component[len-0] = 0;
3212 component[len-2] = '_';
3214 component[len-1] = 'x';
3216 for (i = 0; i < 3; ++i) {
3217 fld.name = code_genstring(component);
3218 vec_push(code_fields, fld);
3224 static bool ir_builder_gen_global(ir_builder *self, ir_value *global, bool islocal)
3228 prog_section_def def;
3230 def.type = global->vtype;
3231 def.offset = vec_size(code_globals);
3234 if (global->name[0] == '#') {
3235 if (!self->str_immediate)
3236 self->str_immediate = code_genstring("IMMEDIATE");
3237 def.name = global->code.name = self->str_immediate;
3240 def.name = global->code.name = code_genstring(global->name);
3245 switch (global->vtype)
3248 if (!strcmp(global->name, "end_sys_globals")) {
3249 /* TODO: remember this point... all the defs before this one
3250 * should be checksummed and added to progdefs.h when we generate it.
3253 else if (!strcmp(global->name, "end_sys_fields")) {
3254 /* TODO: same as above but for entity-fields rather than globsl
3258 irwarning(global->context, WARN_VOID_VARIABLES, "unrecognized variable of type void `%s`",
3260 /* I'd argue setting it to 0 is sufficient, but maybe some depend on knowing how far
3261 * the system fields actually go? Though the engine knows this anyway...
3262 * Maybe this could be an -foption
3263 * fteqcc creates data for end_sys_* - of size 1, so let's do the same
3265 ir_value_code_setaddr(global, vec_size(code_globals));
3266 vec_push(code_globals, 0);
3268 vec_push(code_defs, def);
3271 vec_push(code_defs, def);
3272 return gen_global_pointer(global);
3274 vec_push(code_defs, def);
3275 gen_vector_defs(def, global->name);
3276 return gen_global_field(global);
3281 ir_value_code_setaddr(global, vec_size(code_globals));
3282 if (global->hasvalue) {
3283 iptr = (int32_t*)&global->constval.ivec[0];
3284 vec_push(code_globals, *iptr);
3286 vec_push(code_globals, 0);
3288 if (!islocal && global->cvq != CV_CONST)
3289 def.type |= DEF_SAVEGLOBAL;
3290 vec_push(code_defs, def);
3292 return global->code.globaladdr >= 0;
3296 ir_value_code_setaddr(global, vec_size(code_globals));
3297 if (global->hasvalue) {
3298 vec_push(code_globals, code_genstring(global->constval.vstring));
3300 vec_push(code_globals, 0);
3302 if (!islocal && global->cvq != CV_CONST)
3303 def.type |= DEF_SAVEGLOBAL;
3304 vec_push(code_defs, def);
3305 return global->code.globaladdr >= 0;
3310 ir_value_code_setaddr(global, vec_size(code_globals));
3311 if (global->hasvalue) {
3312 iptr = (int32_t*)&global->constval.ivec[0];
3313 vec_push(code_globals, iptr[0]);
3314 if (global->code.globaladdr < 0)
3316 for (d = 1; d < type_sizeof[global->vtype]; ++d) {
3317 vec_push(code_globals, iptr[d]);
3320 vec_push(code_globals, 0);
3321 if (global->code.globaladdr < 0)
3323 for (d = 1; d < type_sizeof[global->vtype]; ++d) {
3324 vec_push(code_globals, 0);
3327 if (!islocal && global->cvq != CV_CONST)
3328 def.type |= DEF_SAVEGLOBAL;
3330 vec_push(code_defs, def);
3331 def.type &= ~DEF_SAVEGLOBAL;
3332 gen_vector_defs(def, global->name);
3333 return global->code.globaladdr >= 0;
3336 ir_value_code_setaddr(global, vec_size(code_globals));
3337 if (!global->hasvalue) {
3338 vec_push(code_globals, 0);
3339 if (global->code.globaladdr < 0)
3342 vec_push(code_globals, vec_size(code_functions));
3343 if (!gen_global_function(self, global))
3346 if (!islocal && global->cvq != CV_CONST)
3347 def.type |= DEF_SAVEGLOBAL;
3348 vec_push(code_defs, def);
3351 /* assume biggest type */
3352 ir_value_code_setaddr(global, vec_size(code_globals));
3353 vec_push(code_globals, 0);
3354 for (i = 1; i < type_sizeof[TYPE_VARIANT]; ++i)
3355 vec_push(code_globals, 0);
3358 /* refuse to create 'void' type or any other fancy business. */
3359 irerror(global->context, "Invalid type for global variable `%s`: %s",
3360 global->name, type_name[global->vtype]);
3365 static void ir_builder_prepare_field(ir_value *field)
3367 field->code.fieldaddr = code_alloc_field(type_sizeof[field->fieldtype]);
3370 static bool ir_builder_gen_field(ir_builder *self, ir_value *field)
3372 prog_section_def def;
3373 prog_section_field fld;
3377 def.type = (uint16_t)field->vtype;
3378 def.offset = (uint16_t)vec_size(code_globals);
3380 /* create a global named the same as the field */
3381 if (opts.standard == COMPILER_GMQCC) {
3382 /* in our standard, the global gets a dot prefix */
3383 size_t len = strlen(field->name);
3386 /* we really don't want to have to allocate this, and 1024
3387 * bytes is more than enough for a variable/field name
3389 if (len+2 >= sizeof(name)) {
3390 irerror(field->context, "invalid field name size: %u", (unsigned int)len);
3395 memcpy(name+1, field->name, len); /* no strncpy - we used strlen above */
3398 def.name = code_genstring(name);
3399 fld.name = def.name + 1; /* we reuse that string table entry */
3401 /* in plain QC, there cannot be a global with the same name,
3402 * and so we also name the global the same.
3403 * FIXME: fteqcc should create a global as well
3404 * check if it actually uses the same name. Probably does
3406 def.name = code_genstring(field->name);
3407 fld.name = def.name;
3410 field->code.name = def.name;
3412 vec_push(code_defs, def);
3414 fld.type = field->fieldtype;
3416 if (fld.type == TYPE_VOID) {
3417 irerror(field->context, "field is missing a type: %s - don't know its size", field->name);
3421 fld.offset = field->code.fieldaddr;
3423 vec_push(code_fields, fld);
3425 ir_value_code_setaddr(field, vec_size(code_globals));
3426 vec_push(code_globals, fld.offset);
3427 if (fld.type == TYPE_VECTOR) {
3428 vec_push(code_globals, fld.offset+1);
3429 vec_push(code_globals, fld.offset+2);
3432 if (field->fieldtype == TYPE_VECTOR) {
3433 gen_vector_defs(def, field->name);
3434 gen_vector_fields(fld, field->name);
3437 return field->code.globaladdr >= 0;
3440 bool ir_builder_generate(ir_builder *self, const char *filename)
3442 prog_section_statement stmt;
3444 char *lnofile = NULL;
3448 for (i = 0; i < vec_size(self->fields); ++i)
3450 ir_builder_prepare_field(self->fields[i]);
3453 for (i = 0; i < vec_size(self->globals); ++i)
3455 if (!ir_builder_gen_global(self, self->globals[i], false)) {
3460 for (i = 0; i < vec_size(self->fields); ++i)
3462 if (!ir_builder_gen_field(self, self->fields[i])) {
3467 /* generate function code */
3468 for (i = 0; i < vec_size(self->globals); ++i)
3470 if (self->globals[i]->vtype == TYPE_FUNCTION) {
3471 if (!gen_global_function_code(self, self->globals[i])) {
3477 if (vec_size(code_globals) >= 65536) {
3478 irerror(vec_last(self->globals)->context, "This progs file would require more globals than the metadata can handle. Bailing out.");
3482 /* DP errors if the last instruction is not an INSTR_DONE. */
3483 if (vec_last(code_statements).opcode != INSTR_DONE)
3485 stmt.opcode = INSTR_DONE;
3489 code_push_statement(&stmt, vec_last(code_linenums));
3495 if (vec_size(code_statements) != vec_size(code_linenums)) {
3496 con_err("Linecounter wrong: %lu != %lu\n",
3497 (unsigned long)vec_size(code_statements),
3498 (unsigned long)vec_size(code_linenums));
3499 } else if (OPTS_FLAG(LNO)) {
3501 size_t filelen = strlen(filename);
3503 memcpy(vec_add(lnofile, filelen+1), filename, filelen+1);
3504 dot = strrchr(lnofile, '.');
3508 vec_shrinkto(lnofile, dot - lnofile);
3510 memcpy(vec_add(lnofile, 5), ".lno", 5);
3514 con_out("writing '%s' and '%s'...\n", filename, lnofile);
3516 con_out("writing '%s'\n", filename);
3517 if (!code_write(filename, lnofile)) {
3525 /***********************************************************************
3526 *IR DEBUG Dump functions...
3529 #define IND_BUFSZ 1024
3532 # define strncat(dst, src, sz) strncat_s(dst, sz, src, _TRUNCATE)
3535 const char *qc_opname(int op)
3537 if (op < 0) return "<INVALID>";
3538 if (op < (int)( sizeof(asm_instr) / sizeof(asm_instr[0]) ))
3539 return asm_instr[op].m;
3541 case VINSTR_PHI: return "PHI";
3542 case VINSTR_JUMP: return "JUMP";
3543 case VINSTR_COND: return "COND";
3544 default: return "<UNK>";
3548 void ir_builder_dump(ir_builder *b, int (*oprintf)(const char*, ...))
3551 char indent[IND_BUFSZ];
3555 oprintf("module %s\n", b->name);
3556 for (i = 0; i < vec_size(b->globals); ++i)
3559 if (b->globals[i]->hasvalue)
3560 oprintf("%s = ", b->globals[i]->name);
3561 ir_value_dump(b->globals[i], oprintf);
3564 for (i = 0; i < vec_size(b->functions); ++i)
3565 ir_function_dump(b->functions[i], indent, oprintf);
3566 oprintf("endmodule %s\n", b->name);
3569 void ir_function_dump(ir_function *f, char *ind,
3570 int (*oprintf)(const char*, ...))
3573 if (f->builtin != 0) {
3574 oprintf("%sfunction %s = builtin %i\n", ind, f->name, -f->builtin);
3577 oprintf("%sfunction %s\n", ind, f->name);
3578 strncat(ind, "\t", IND_BUFSZ);
3579 if (vec_size(f->locals))
3581 oprintf("%s%i locals:\n", ind, (int)vec_size(f->locals));
3582 for (i = 0; i < vec_size(f->locals); ++i) {
3583 oprintf("%s\t", ind);
3584 ir_value_dump(f->locals[i], oprintf);
3588 oprintf("%sliferanges:\n", ind);
3589 for (i = 0; i < vec_size(f->locals); ++i) {
3591 ir_value *v = f->locals[i];
3592 oprintf("%s\t%s: %s@%i ", ind, v->name, (v->unique_life ? "unique " : ""), (int)v->code.local);
3593 for (l = 0; l < vec_size(v->life); ++l) {
3594 oprintf("[%i,%i] ", v->life[l].start, v->life[l].end);
3598 for (i = 0; i < vec_size(f->values); ++i) {
3600 ir_value *v = f->values[i];
3601 oprintf("%s\t%s: @%i ", ind, v->name, (int)v->code.local);
3602 for (l = 0; l < vec_size(v->life); ++l) {
3603 oprintf("[%i,%i] ", v->life[l].start, v->life[l].end);
3607 if (vec_size(f->blocks))
3609 oprintf("%slife passes (check): %i\n", ind, (int)f->run_id);
3610 for (i = 0; i < vec_size(f->blocks); ++i) {
3611 if (f->blocks[i]->run_id != f->run_id) {
3612 oprintf("%slife pass check fail! %i != %i\n", ind, (int)f->blocks[i]->run_id, (int)f->run_id);
3614 ir_block_dump(f->blocks[i], ind, oprintf);
3618 ind[strlen(ind)-1] = 0;
3619 oprintf("%sendfunction %s\n", ind, f->name);
3622 void ir_block_dump(ir_block* b, char *ind,
3623 int (*oprintf)(const char*, ...))
3626 oprintf("%s:%s\n", ind, b->label);
3627 strncat(ind, "\t", IND_BUFSZ);
3629 for (i = 0; i < vec_size(b->instr); ++i)
3630 ir_instr_dump(b->instr[i], ind, oprintf);
3631 ind[strlen(ind)-1] = 0;
3634 void dump_phi(ir_instr *in, int (*oprintf)(const char*, ...))
3637 oprintf("%s <- phi ", in->_ops[0]->name);
3638 for (i = 0; i < vec_size(in->phi); ++i)
3640 oprintf("([%s] : %s) ", in->phi[i].from->label,
3641 in->phi[i].value->name);
3646 void ir_instr_dump(ir_instr *in, char *ind,
3647 int (*oprintf)(const char*, ...))
3650 const char *comma = NULL;
3652 oprintf("%s (%i) ", ind, (int)in->eid);
3654 if (in->opcode == VINSTR_PHI) {
3655 dump_phi(in, oprintf);
3659 strncat(ind, "\t", IND_BUFSZ);
3661 if (in->_ops[0] && (in->_ops[1] || in->_ops[2])) {
3662 ir_value_dump(in->_ops[0], oprintf);
3663 if (in->_ops[1] || in->_ops[2])
3666 if (in->opcode == INSTR_CALL0) {
3667 oprintf("CALL%i\t", vec_size(in->params));
3669 oprintf("%s\t", qc_opname(in->opcode));
3671 if (in->_ops[0] && !(in->_ops[1] || in->_ops[2])) {
3672 ir_value_dump(in->_ops[0], oprintf);
3677 for (i = 1; i != 3; ++i) {
3681 ir_value_dump(in->_ops[i], oprintf);
3689 oprintf("[%s]", in->bops[0]->label);
3693 oprintf("%s[%s]", comma, in->bops[1]->label);
3694 if (vec_size(in->params)) {
3695 oprintf("\tparams: ");
3696 for (i = 0; i != vec_size(in->params); ++i) {
3697 oprintf("%s, ", in->params[i]->name);
3701 ind[strlen(ind)-1] = 0;
3704 void ir_value_dump_string(const char *str, int (*oprintf)(const char*, ...))
3707 for (; *str; ++str) {
3709 case '\n': oprintf("\\n"); break;
3710 case '\r': oprintf("\\r"); break;
3711 case '\t': oprintf("\\t"); break;
3712 case '\v': oprintf("\\v"); break;
3713 case '\f': oprintf("\\f"); break;
3714 case '\b': oprintf("\\b"); break;
3715 case '\a': oprintf("\\a"); break;
3716 case '\\': oprintf("\\\\"); break;
3717 case '"': oprintf("\\\""); break;
3718 default: oprintf("%c", *str); break;
3724 void ir_value_dump(ir_value* v, int (*oprintf)(const char*, ...))
3733 oprintf("fn:%s", v->name);
3736 oprintf("%g", v->constval.vfloat);
3739 oprintf("'%g %g %g'",
3742 v->constval.vvec.z);
3745 oprintf("(entity)");
3748 ir_value_dump_string(v->constval.vstring, oprintf);
3752 oprintf("%i", v->constval.vint);
3757 v->constval.vpointer->name);
3761 oprintf("%s", v->name);
3765 void ir_value_dump_life(const ir_value *self, int (*oprintf)(const char*,...))
3768 oprintf("Life of %12s:", self->name);
3769 for (i = 0; i < vec_size(self->life); ++i)
3771 oprintf(" + [%i, %i]\n", self->life[i].start, self->life[i].end);