2 * Copyright (C) 2012, 2013
5 * Permission is hereby granted, free of charge, to any person obtaining a copy of
6 * this software and associated documentation files (the "Software"), to deal in
7 * the Software without restriction, including without limitation the rights to
8 * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
9 * of the Software, and to permit persons to whom the Software is furnished to do
10 * so, subject to the following conditions:
12 * The above copyright notice and this permission notice shall be included in all
13 * copies or substantial portions of the Software.
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
28 /***********************************************************************
29 * Type sizes used at multiple points in the IR codegen
32 const char *type_name[TYPE_COUNT] = {
51 size_t type_sizeof_[TYPE_COUNT] = {
58 1, /* TYPE_FUNCTION */
69 uint16_t type_store_instr[TYPE_COUNT] = {
70 INSTR_STORE_F, /* should use I when having integer support */
77 INSTR_STORE_ENT, /* should use I */
79 INSTR_STORE_I, /* integer type */
84 INSTR_STORE_V, /* variant, should never be accessed */
86 AINSTR_END, /* struct */
87 AINSTR_END, /* union */
88 AINSTR_END, /* array */
90 AINSTR_END, /* noexpr */
93 uint16_t field_store_instr[TYPE_COUNT] = {
103 INSTR_STORE_FLD, /* integer type */
108 INSTR_STORE_V, /* variant, should never be accessed */
110 AINSTR_END, /* struct */
111 AINSTR_END, /* union */
112 AINSTR_END, /* array */
113 AINSTR_END, /* nil */
114 AINSTR_END, /* noexpr */
117 uint16_t type_storep_instr[TYPE_COUNT] = {
118 INSTR_STOREP_F, /* should use I when having integer support */
125 INSTR_STOREP_ENT, /* should use I */
127 INSTR_STOREP_ENT, /* integer type */
132 INSTR_STOREP_V, /* variant, should never be accessed */
134 AINSTR_END, /* struct */
135 AINSTR_END, /* union */
136 AINSTR_END, /* array */
137 AINSTR_END, /* nil */
138 AINSTR_END, /* noexpr */
141 uint16_t type_eq_instr[TYPE_COUNT] = {
142 INSTR_EQ_F, /* should use I when having integer support */
147 INSTR_EQ_E, /* FLD has no comparison */
149 INSTR_EQ_E, /* should use I */
156 INSTR_EQ_V, /* variant, should never be accessed */
158 AINSTR_END, /* struct */
159 AINSTR_END, /* union */
160 AINSTR_END, /* array */
161 AINSTR_END, /* nil */
162 AINSTR_END, /* noexpr */
165 uint16_t type_ne_instr[TYPE_COUNT] = {
166 INSTR_NE_F, /* should use I when having integer support */
171 INSTR_NE_E, /* FLD has no comparison */
173 INSTR_NE_E, /* should use I */
180 INSTR_NE_V, /* variant, should never be accessed */
182 AINSTR_END, /* struct */
183 AINSTR_END, /* union */
184 AINSTR_END, /* array */
185 AINSTR_END, /* nil */
186 AINSTR_END, /* noexpr */
189 uint16_t type_not_instr[TYPE_COUNT] = {
190 INSTR_NOT_F, /* should use I when having integer support */
197 INSTR_NOT_ENT, /* should use I */
199 INSTR_NOT_I, /* integer type */
204 INSTR_NOT_V, /* variant, should never be accessed */
206 AINSTR_END, /* struct */
207 AINSTR_END, /* union */
208 AINSTR_END, /* array */
209 AINSTR_END, /* nil */
210 AINSTR_END, /* noexpr */
214 static ir_value* ir_gen_extparam_proto(ir_builder *ir);
215 static void ir_gen_extparam (ir_builder *ir);
217 /* error functions */
219 static void irerror(lex_ctx ctx, const char *msg, ...)
223 con_cvprintmsg((void*)&ctx, LVL_ERROR, "internal error", msg, ap);
227 static bool irwarning(lex_ctx ctx, int warntype, const char *fmt, ...)
232 r = vcompile_warning(ctx, warntype, fmt, ap);
237 /***********************************************************************
238 * Vector utility functions
241 bool GMQCC_WARN vec_ir_value_find(ir_value **vec, const ir_value *what, size_t *idx)
244 size_t len = vec_size(vec);
245 for (i = 0; i < len; ++i) {
246 if (vec[i] == what) {
254 bool GMQCC_WARN vec_ir_block_find(ir_block **vec, ir_block *what, size_t *idx)
257 size_t len = vec_size(vec);
258 for (i = 0; i < len; ++i) {
259 if (vec[i] == what) {
267 bool GMQCC_WARN vec_ir_instr_find(ir_instr **vec, ir_instr *what, size_t *idx)
270 size_t len = vec_size(vec);
271 for (i = 0; i < len; ++i) {
272 if (vec[i] == what) {
280 /***********************************************************************
284 static void ir_block_delete_quick(ir_block* self);
285 static void ir_instr_delete_quick(ir_instr *self);
286 static void ir_function_delete_quick(ir_function *self);
288 ir_builder* ir_builder_new(const char *modulename)
292 self = (ir_builder*)mem_a(sizeof(*self));
296 self->functions = NULL;
297 self->globals = NULL;
299 self->filenames = NULL;
300 self->filestrings = NULL;
301 self->htglobals = util_htnew(IR_HT_SIZE);
302 self->htfields = util_htnew(IR_HT_SIZE);
303 self->htfunctions = util_htnew(IR_HT_SIZE);
305 self->extparams = NULL;
306 self->extparam_protos = NULL;
308 self->first_common_globaltemp = 0;
309 self->max_globaltemps = 0;
310 self->first_common_local = 0;
311 self->max_locals = 0;
313 self->str_immediate = 0;
315 if (!ir_builder_set_name(self, modulename)) {
320 self->nil = ir_value_var("nil", store_value, TYPE_NIL);
321 self->nil->cvq = CV_CONST;
326 void ir_builder_delete(ir_builder* self)
329 util_htdel(self->htglobals);
330 util_htdel(self->htfields);
331 util_htdel(self->htfunctions);
332 mem_d((void*)self->name);
333 for (i = 0; i != vec_size(self->functions); ++i) {
334 ir_function_delete_quick(self->functions[i]);
336 vec_free(self->functions);
337 for (i = 0; i != vec_size(self->extparams); ++i) {
338 ir_value_delete(self->extparams[i]);
340 vec_free(self->extparams);
341 for (i = 0; i != vec_size(self->globals); ++i) {
342 ir_value_delete(self->globals[i]);
344 vec_free(self->globals);
345 for (i = 0; i != vec_size(self->fields); ++i) {
346 ir_value_delete(self->fields[i]);
348 ir_value_delete(self->nil);
349 vec_free(self->fields);
350 vec_free(self->filenames);
351 vec_free(self->filestrings);
355 bool ir_builder_set_name(ir_builder *self, const char *name)
358 mem_d((void*)self->name);
359 self->name = util_strdup(name);
363 ir_function* ir_builder_get_function(ir_builder *self, const char *name)
365 return (ir_function*)util_htget(self->htfunctions, name);
368 ir_function* ir_builder_create_function(ir_builder *self, const char *name, int outtype)
370 ir_function *fn = ir_builder_get_function(self, name);
375 fn = ir_function_new(self, outtype);
376 if (!ir_function_set_name(fn, name))
378 ir_function_delete(fn);
381 vec_push(self->functions, fn);
382 util_htset(self->htfunctions, name, fn);
384 fn->value = ir_builder_create_global(self, fn->name, TYPE_FUNCTION);
386 ir_function_delete(fn);
390 fn->value->hasvalue = true;
391 fn->value->outtype = outtype;
392 fn->value->constval.vfunc = fn;
393 fn->value->context = fn->context;
398 ir_value* ir_builder_get_global(ir_builder *self, const char *name)
400 return (ir_value*)util_htget(self->htglobals, name);
403 ir_value* ir_builder_create_global(ir_builder *self, const char *name, int vtype)
407 if (name && name[0] != '#')
409 ve = ir_builder_get_global(self, name);
415 ve = ir_value_var(name, store_global, vtype);
416 vec_push(self->globals, ve);
417 util_htset(self->htglobals, name, ve);
421 ir_value* ir_builder_get_field(ir_builder *self, const char *name)
423 return (ir_value*)util_htget(self->htfields, name);
427 ir_value* ir_builder_create_field(ir_builder *self, const char *name, int vtype)
429 ir_value *ve = ir_builder_get_field(self, name);
434 ve = ir_value_var(name, store_global, TYPE_FIELD);
435 ve->fieldtype = vtype;
436 vec_push(self->fields, ve);
437 util_htset(self->htfields, name, ve);
441 /***********************************************************************
445 bool ir_function_naive_phi(ir_function*);
446 void ir_function_enumerate(ir_function*);
447 bool ir_function_calculate_liferanges(ir_function*);
448 bool ir_function_allocate_locals(ir_function*);
450 ir_function* ir_function_new(ir_builder* owner, int outtype)
453 self = (ir_function*)mem_a(sizeof(*self));
458 memset(self, 0, sizeof(*self));
461 if (!ir_function_set_name(self, "<@unnamed>")) {
468 self->context.file = "<@no context>";
469 self->context.line = 0;
470 self->outtype = outtype;
479 self->code_function_def = -1;
480 self->allocated_locals = 0;
481 self->globaltemps = 0;
487 bool ir_function_set_name(ir_function *self, const char *name)
490 mem_d((void*)self->name);
491 self->name = util_strdup(name);
495 static void ir_function_delete_quick(ir_function *self)
498 mem_d((void*)self->name);
500 for (i = 0; i != vec_size(self->blocks); ++i)
501 ir_block_delete_quick(self->blocks[i]);
502 vec_free(self->blocks);
504 vec_free(self->params);
506 for (i = 0; i != vec_size(self->values); ++i)
507 ir_value_delete(self->values[i]);
508 vec_free(self->values);
510 for (i = 0; i != vec_size(self->locals); ++i)
511 ir_value_delete(self->locals[i]);
512 vec_free(self->locals);
514 /* self->value is deleted by the builder */
519 void ir_function_delete(ir_function *self)
522 mem_d((void*)self->name);
524 for (i = 0; i != vec_size(self->blocks); ++i)
525 ir_block_delete(self->blocks[i]);
526 vec_free(self->blocks);
528 vec_free(self->params);
530 for (i = 0; i != vec_size(self->values); ++i)
531 ir_value_delete(self->values[i]);
532 vec_free(self->values);
534 for (i = 0; i != vec_size(self->locals); ++i)
535 ir_value_delete(self->locals[i]);
536 vec_free(self->locals);
538 /* self->value is deleted by the builder */
543 void ir_function_collect_value(ir_function *self, ir_value *v)
545 vec_push(self->values, v);
548 ir_block* ir_function_create_block(lex_ctx ctx, ir_function *self, const char *label)
550 ir_block* bn = ir_block_new(self, label);
552 vec_push(self->blocks, bn);
556 static bool instr_is_operation(uint16_t op)
558 return ( (op >= INSTR_MUL_F && op <= INSTR_GT) ||
559 (op >= INSTR_LOAD_F && op <= INSTR_LOAD_FNC) ||
560 (op == INSTR_ADDRESS) ||
561 (op >= INSTR_NOT_F && op <= INSTR_NOT_FNC) ||
562 (op >= INSTR_AND && op <= INSTR_BITOR) ||
563 (op >= INSTR_CALL0 && op <= INSTR_CALL8) );
566 bool ir_function_pass_peephole(ir_function *self)
570 for (b = 0; b < vec_size(self->blocks); ++b) {
572 ir_block *block = self->blocks[b];
574 for (i = 0; i < vec_size(block->instr); ++i) {
576 inst = block->instr[i];
579 (inst->opcode >= INSTR_STORE_F &&
580 inst->opcode <= INSTR_STORE_FNC))
588 oper = block->instr[i-1];
589 if (!instr_is_operation(oper->opcode))
592 value = oper->_ops[0];
594 /* only do it for SSA values */
595 if (value->store != store_value)
598 /* don't optimize out the temp if it's used later again */
599 if (vec_size(value->reads) != 1)
602 /* The very next store must use this value */
603 if (value->reads[0] != store)
606 /* And of course the store must _read_ from it, so it's in
608 if (store->_ops[1] != value)
611 ++opts_optimizationcount[OPTIM_PEEPHOLE];
612 (void)!ir_instr_op(oper, 0, store->_ops[0], true);
614 vec_remove(block->instr, i, 1);
615 ir_instr_delete(store);
617 else if (inst->opcode == VINSTR_COND)
619 /* COND on a value resulting from a NOT could
620 * remove the NOT and swap its operands
627 value = inst->_ops[0];
629 if (value->store != store_value ||
630 vec_size(value->reads) != 1 ||
631 value->reads[0] != inst)
636 inot = value->writes[0];
637 if (inot->_ops[0] != value ||
638 inot->opcode < INSTR_NOT_F ||
639 inot->opcode > INSTR_NOT_FNC ||
640 inot->opcode == INSTR_NOT_V || /* can't do these */
641 inot->opcode == INSTR_NOT_S)
647 ++opts_optimizationcount[OPTIM_PEEPHOLE];
649 (void)!ir_instr_op(inst, 0, inot->_ops[1], false);
652 for (inotid = 0; inotid < vec_size(tmp->instr); ++inotid) {
653 if (tmp->instr[inotid] == inot)
656 if (inotid >= vec_size(tmp->instr)) {
657 compile_error(inst->context, "sanity-check failed: failed to find instruction to optimize out");
660 vec_remove(tmp->instr, inotid, 1);
661 ir_instr_delete(inot);
662 /* swap ontrue/onfalse */
664 inst->bops[0] = inst->bops[1];
675 bool ir_function_pass_tailrecursion(ir_function *self)
679 for (b = 0; b < vec_size(self->blocks); ++b) {
681 ir_instr *ret, *call, *store = NULL;
682 ir_block *block = self->blocks[b];
684 if (!block->final || vec_size(block->instr) < 2)
687 ret = block->instr[vec_size(block->instr)-1];
688 if (ret->opcode != INSTR_DONE && ret->opcode != INSTR_RETURN)
691 call = block->instr[vec_size(block->instr)-2];
692 if (call->opcode >= INSTR_STORE_F && call->opcode <= INSTR_STORE_FNC) {
693 /* account for the unoptimized
695 * STORE %return, %tmp
699 if (vec_size(block->instr) < 3)
703 call = block->instr[vec_size(block->instr)-3];
706 if (call->opcode < INSTR_CALL0 || call->opcode > INSTR_CALL8)
710 /* optimize out the STORE */
712 ret->_ops[0] == store->_ops[0] &&
713 store->_ops[1] == call->_ops[0])
715 ++opts_optimizationcount[OPTIM_PEEPHOLE];
716 call->_ops[0] = store->_ops[0];
717 vec_remove(block->instr, vec_size(block->instr) - 2, 1);
718 ir_instr_delete(store);
727 funcval = call->_ops[1];
730 if (funcval->vtype != TYPE_FUNCTION || funcval->constval.vfunc != self)
733 /* now we have a CALL and a RET, check if it's a tailcall */
734 if (ret->_ops[0] && call->_ops[0] != ret->_ops[0])
737 ++opts_optimizationcount[OPTIM_TAIL_RECURSION];
738 vec_shrinkby(block->instr, 2);
740 block->final = false; /* open it back up */
742 /* emite parameter-stores */
743 for (p = 0; p < vec_size(call->params); ++p) {
744 /* assert(call->params_count <= self->locals_count); */
745 if (!ir_block_create_store(block, call->context, self->locals[p], call->params[p])) {
746 irerror(call->context, "failed to create tailcall store instruction for parameter %i", (int)p);
750 if (!ir_block_create_jump(block, call->context, self->blocks[0])) {
751 irerror(call->context, "failed to create tailcall jump");
755 ir_instr_delete(call);
756 ir_instr_delete(ret);
762 bool ir_function_finalize(ir_function *self)
769 if (OPTS_OPTIMIZATION(OPTIM_PEEPHOLE)) {
770 if (!ir_function_pass_peephole(self)) {
771 irerror(self->context, "generic optimization pass broke something in `%s`", self->name);
776 if (OPTS_OPTIMIZATION(OPTIM_TAIL_RECURSION)) {
777 if (!ir_function_pass_tailrecursion(self)) {
778 irerror(self->context, "tail-recursion optimization pass broke something in `%s`", self->name);
783 if (!ir_function_naive_phi(self)) {
784 irerror(self->context, "internal error: ir_function_naive_phi failed");
788 for (i = 0; i < vec_size(self->locals); ++i) {
789 ir_value *v = self->locals[i];
790 if (v->vtype == TYPE_VECTOR ||
791 (v->vtype == TYPE_FIELD && v->outtype == TYPE_VECTOR))
793 ir_value_vector_member(v, 0);
794 ir_value_vector_member(v, 1);
795 ir_value_vector_member(v, 2);
798 for (i = 0; i < vec_size(self->values); ++i) {
799 ir_value *v = self->values[i];
800 if (v->vtype == TYPE_VECTOR ||
801 (v->vtype == TYPE_FIELD && v->outtype == TYPE_VECTOR))
803 ir_value_vector_member(v, 0);
804 ir_value_vector_member(v, 1);
805 ir_value_vector_member(v, 2);
809 ir_function_enumerate(self);
811 if (!ir_function_calculate_liferanges(self))
813 if (!ir_function_allocate_locals(self))
818 ir_value* ir_function_create_local(ir_function *self, const char *name, int vtype, bool param)
823 vec_size(self->locals) &&
824 self->locals[vec_size(self->locals)-1]->store != store_param) {
825 irerror(self->context, "cannot add parameters after adding locals");
829 ve = ir_value_var(name, (param ? store_param : store_local), vtype);
832 vec_push(self->locals, ve);
836 /***********************************************************************
840 ir_block* ir_block_new(ir_function* owner, const char *name)
843 self = (ir_block*)mem_a(sizeof(*self));
847 memset(self, 0, sizeof(*self));
850 if (name && !ir_block_set_label(self, name)) {
855 self->context.file = "<@no context>";
856 self->context.line = 0;
860 self->entries = NULL;
864 self->is_return = false;
869 self->generated = false;
874 static void ir_block_delete_quick(ir_block* self)
877 if (self->label) mem_d(self->label);
878 for (i = 0; i != vec_size(self->instr); ++i)
879 ir_instr_delete_quick(self->instr[i]);
880 vec_free(self->instr);
881 vec_free(self->entries);
882 vec_free(self->exits);
883 vec_free(self->living);
887 void ir_block_delete(ir_block* self)
890 if (self->label) mem_d(self->label);
891 for (i = 0; i != vec_size(self->instr); ++i)
892 ir_instr_delete(self->instr[i]);
893 vec_free(self->instr);
894 vec_free(self->entries);
895 vec_free(self->exits);
896 vec_free(self->living);
900 bool ir_block_set_label(ir_block *self, const char *name)
903 mem_d((void*)self->label);
904 self->label = util_strdup(name);
905 return !!self->label;
908 /***********************************************************************
912 ir_instr* ir_instr_new(lex_ctx ctx, ir_block* owner, int op)
915 self = (ir_instr*)mem_a(sizeof(*self));
922 self->_ops[0] = NULL;
923 self->_ops[1] = NULL;
924 self->_ops[2] = NULL;
925 self->bops[0] = NULL;
926 self->bops[1] = NULL;
937 static void ir_instr_delete_quick(ir_instr *self)
940 vec_free(self->params);
944 void ir_instr_delete(ir_instr *self)
947 /* The following calls can only delete from
948 * vectors, we still want to delete this instruction
949 * so ignore the return value. Since with the warn_unused_result attribute
950 * gcc doesn't care about an explicit: (void)foo(); to ignore the result,
951 * I have to improvise here and use if(foo());
953 for (i = 0; i < vec_size(self->phi); ++i) {
955 if (vec_ir_instr_find(self->phi[i].value->writes, self, &idx))
956 vec_remove(self->phi[i].value->writes, idx, 1);
957 if (vec_ir_instr_find(self->phi[i].value->reads, self, &idx))
958 vec_remove(self->phi[i].value->reads, idx, 1);
961 for (i = 0; i < vec_size(self->params); ++i) {
963 if (vec_ir_instr_find(self->params[i]->writes, self, &idx))
964 vec_remove(self->params[i]->writes, idx, 1);
965 if (vec_ir_instr_find(self->params[i]->reads, self, &idx))
966 vec_remove(self->params[i]->reads, idx, 1);
968 vec_free(self->params);
969 (void)!ir_instr_op(self, 0, NULL, false);
970 (void)!ir_instr_op(self, 1, NULL, false);
971 (void)!ir_instr_op(self, 2, NULL, false);
975 bool ir_instr_op(ir_instr *self, int op, ir_value *v, bool writing)
977 if (self->_ops[op]) {
979 if (writing && vec_ir_instr_find(self->_ops[op]->writes, self, &idx))
980 vec_remove(self->_ops[op]->writes, idx, 1);
981 else if (vec_ir_instr_find(self->_ops[op]->reads, self, &idx))
982 vec_remove(self->_ops[op]->reads, idx, 1);
986 vec_push(v->writes, self);
988 vec_push(v->reads, self);
994 /***********************************************************************
998 void ir_value_code_setaddr(ir_value *self, int32_t gaddr)
1000 self->code.globaladdr = gaddr;
1001 if (self->members[0]) self->members[0]->code.globaladdr = gaddr;
1002 if (self->members[1]) self->members[1]->code.globaladdr = gaddr;
1003 if (self->members[2]) self->members[2]->code.globaladdr = gaddr;
1006 int32_t ir_value_code_addr(const ir_value *self)
1008 if (self->store == store_return)
1009 return OFS_RETURN + self->code.addroffset;
1010 return self->code.globaladdr + self->code.addroffset;
1013 ir_value* ir_value_var(const char *name, int storetype, int vtype)
1016 self = (ir_value*)mem_a(sizeof(*self));
1017 self->vtype = vtype;
1018 self->fieldtype = TYPE_VOID;
1019 self->outtype = TYPE_VOID;
1020 self->store = storetype;
1023 self->writes = NULL;
1025 self->cvq = CV_NONE;
1026 self->hasvalue = false;
1027 self->context.file = "<@no context>";
1028 self->context.line = 0;
1030 if (name && !ir_value_set_name(self, name)) {
1031 irerror(self->context, "out of memory");
1036 memset(&self->constval, 0, sizeof(self->constval));
1037 memset(&self->code, 0, sizeof(self->code));
1039 self->members[0] = NULL;
1040 self->members[1] = NULL;
1041 self->members[2] = NULL;
1042 self->memberof = NULL;
1044 self->unique_life = false;
1045 self->locked = false;
1046 self->callparam = false;
1052 ir_value* ir_value_vector_member(ir_value *self, unsigned int member)
1060 if (self->members[member])
1061 return self->members[member];
1064 len = strlen(self->name);
1065 name = (char*)mem_a(len + 3);
1066 memcpy(name, self->name, len);
1068 name[len+1] = 'x' + member;
1074 if (self->vtype == TYPE_VECTOR)
1076 m = ir_value_var(name, self->store, TYPE_FLOAT);
1081 m->context = self->context;
1083 self->members[member] = m;
1084 m->code.addroffset = member;
1086 else if (self->vtype == TYPE_FIELD)
1088 if (self->fieldtype != TYPE_VECTOR)
1090 m = ir_value_var(name, self->store, TYPE_FIELD);
1095 m->fieldtype = TYPE_FLOAT;
1096 m->context = self->context;
1098 self->members[member] = m;
1099 m->code.addroffset = member;
1103 irerror(self->context, "invalid member access on %s", self->name);
1111 static GMQCC_INLINE size_t ir_value_sizeof(const ir_value *self)
1113 if (self->vtype == TYPE_FIELD && self->fieldtype == TYPE_VECTOR)
1114 return type_sizeof_[TYPE_VECTOR];
1115 return type_sizeof_[self->vtype];
1118 ir_value* ir_value_out(ir_function *owner, const char *name, int storetype, int vtype)
1120 ir_value *v = ir_value_var(name, storetype, vtype);
1123 ir_function_collect_value(owner, v);
1127 void ir_value_delete(ir_value* self)
1131 mem_d((void*)self->name);
1134 if (self->vtype == TYPE_STRING)
1135 mem_d((void*)self->constval.vstring);
1137 for (i = 0; i < 3; ++i) {
1138 if (self->members[i])
1139 ir_value_delete(self->members[i]);
1141 vec_free(self->reads);
1142 vec_free(self->writes);
1143 vec_free(self->life);
1147 bool ir_value_set_name(ir_value *self, const char *name)
1150 mem_d((void*)self->name);
1151 self->name = util_strdup(name);
1152 return !!self->name;
1155 bool ir_value_set_float(ir_value *self, float f)
1157 if (self->vtype != TYPE_FLOAT)
1159 self->constval.vfloat = f;
1160 self->hasvalue = true;
1164 bool ir_value_set_func(ir_value *self, int f)
1166 if (self->vtype != TYPE_FUNCTION)
1168 self->constval.vint = f;
1169 self->hasvalue = true;
1173 bool ir_value_set_vector(ir_value *self, vector v)
1175 if (self->vtype != TYPE_VECTOR)
1177 self->constval.vvec = v;
1178 self->hasvalue = true;
1182 bool ir_value_set_field(ir_value *self, ir_value *fld)
1184 if (self->vtype != TYPE_FIELD)
1186 self->constval.vpointer = fld;
1187 self->hasvalue = true;
1191 static char *ir_strdup(const char *str)
1194 /* actually dup empty strings */
1195 char *out = (char*)mem_a(1);
1199 return util_strdup(str);
1202 bool ir_value_set_string(ir_value *self, const char *str)
1204 if (self->vtype != TYPE_STRING)
1206 self->constval.vstring = ir_strdup(str);
1207 self->hasvalue = true;
1212 bool ir_value_set_int(ir_value *self, int i)
1214 if (self->vtype != TYPE_INTEGER)
1216 self->constval.vint = i;
1217 self->hasvalue = true;
1222 bool ir_value_lives(ir_value *self, size_t at)
1225 for (i = 0; i < vec_size(self->life); ++i)
1227 ir_life_entry_t *life = &self->life[i];
1228 if (life->start <= at && at <= life->end)
1230 if (life->start > at) /* since it's ordered */
1236 bool ir_value_life_insert(ir_value *self, size_t idx, ir_life_entry_t e)
1239 vec_push(self->life, e);
1240 for (k = vec_size(self->life)-1; k > idx; --k)
1241 self->life[k] = self->life[k-1];
1242 self->life[idx] = e;
1246 bool ir_value_life_merge(ir_value *self, size_t s)
1249 ir_life_entry_t *life = NULL;
1250 ir_life_entry_t *before = NULL;
1251 ir_life_entry_t new_entry;
1253 /* Find the first range >= s */
1254 for (i = 0; i < vec_size(self->life); ++i)
1257 life = &self->life[i];
1258 if (life->start > s)
1261 /* nothing found? append */
1262 if (i == vec_size(self->life)) {
1264 if (life && life->end+1 == s)
1266 /* previous life range can be merged in */
1270 if (life && life->end >= s)
1272 e.start = e.end = s;
1273 vec_push(self->life, e);
1279 if (before->end + 1 == s &&
1280 life->start - 1 == s)
1283 before->end = life->end;
1284 vec_remove(self->life, i, 1);
1287 if (before->end + 1 == s)
1293 /* already contained */
1294 if (before->end >= s)
1298 if (life->start - 1 == s)
1303 /* insert a new entry */
1304 new_entry.start = new_entry.end = s;
1305 return ir_value_life_insert(self, i, new_entry);
1308 bool ir_value_life_merge_into(ir_value *self, const ir_value *other)
1312 if (!vec_size(other->life))
1315 if (!vec_size(self->life)) {
1316 size_t count = vec_size(other->life);
1317 ir_life_entry_t *life = vec_add(self->life, count);
1318 memcpy(life, other->life, count * sizeof(*life));
1323 for (i = 0; i < vec_size(other->life); ++i)
1325 const ir_life_entry_t *life = &other->life[i];
1328 ir_life_entry_t *entry = &self->life[myi];
1330 if (life->end+1 < entry->start)
1332 /* adding an interval before entry */
1333 if (!ir_value_life_insert(self, myi, *life))
1339 if (life->start < entry->start &&
1340 life->end+1 >= entry->start)
1342 /* starts earlier and overlaps */
1343 entry->start = life->start;
1346 if (life->end > entry->end &&
1347 life->start <= entry->end+1)
1349 /* ends later and overlaps */
1350 entry->end = life->end;
1353 /* see if our change combines it with the next ranges */
1354 while (myi+1 < vec_size(self->life) &&
1355 entry->end+1 >= self->life[1+myi].start)
1357 /* overlaps with (myi+1) */
1358 if (entry->end < self->life[1+myi].end)
1359 entry->end = self->life[1+myi].end;
1360 vec_remove(self->life, myi+1, 1);
1361 entry = &self->life[myi];
1364 /* see if we're after the entry */
1365 if (life->start > entry->end)
1368 /* append if we're at the end */
1369 if (myi >= vec_size(self->life)) {
1370 vec_push(self->life, *life);
1373 /* otherweise check the next range */
1382 bool ir_values_overlap(const ir_value *a, const ir_value *b)
1384 /* For any life entry in A see if it overlaps with
1385 * any life entry in B.
1386 * Note that the life entries are orderes, so we can make a
1387 * more efficient algorithm there than naively translating the
1391 ir_life_entry_t *la, *lb, *enda, *endb;
1393 /* first of all, if either has no life range, they cannot clash */
1394 if (!vec_size(a->life) || !vec_size(b->life))
1399 enda = la + vec_size(a->life);
1400 endb = lb + vec_size(b->life);
1403 /* check if the entries overlap, for that,
1404 * both must start before the other one ends.
1406 if (la->start < lb->end &&
1407 lb->start < la->end)
1412 /* entries are ordered
1413 * one entry is earlier than the other
1414 * that earlier entry will be moved forward
1416 if (la->start < lb->start)
1418 /* order: A B, move A forward
1419 * check if we hit the end with A
1424 else /* if (lb->start < la->start) actually <= */
1426 /* order: B A, move B forward
1427 * check if we hit the end with B
1436 /***********************************************************************
1440 static bool ir_check_unreachable(ir_block *self)
1442 /* The IR should never have to deal with unreachable code */
1443 if (!self->final/* || OPTS_FLAG(ALLOW_UNREACHABLE_CODE)*/)
1445 irerror(self->context, "unreachable statement (%s)", self->label);
1449 bool ir_block_create_store_op(ir_block *self, lex_ctx ctx, int op, ir_value *target, ir_value *what)
1452 if (!ir_check_unreachable(self))
1455 if (target->store == store_value &&
1456 (op < INSTR_STOREP_F || op > INSTR_STOREP_FNC))
1458 irerror(self->context, "cannot store to an SSA value");
1459 irerror(self->context, "trying to store: %s <- %s", target->name, what->name);
1460 irerror(self->context, "instruction: %s", asm_instr[op].m);
1464 in = ir_instr_new(ctx, self, op);
1468 if (!ir_instr_op(in, 0, target, (op < INSTR_STOREP_F || op > INSTR_STOREP_FNC)) ||
1469 !ir_instr_op(in, 1, what, false))
1471 ir_instr_delete(in);
1474 vec_push(self->instr, in);
1478 bool ir_block_create_store(ir_block *self, lex_ctx ctx, ir_value *target, ir_value *what)
1482 if (target->vtype == TYPE_VARIANT)
1483 vtype = what->vtype;
1485 vtype = target->vtype;
1488 if (vtype == TYPE_FLOAT && what->vtype == TYPE_INTEGER)
1489 op = INSTR_CONV_ITOF;
1490 else if (vtype == TYPE_INTEGER && what->vtype == TYPE_FLOAT)
1491 op = INSTR_CONV_FTOI;
1493 op = type_store_instr[vtype];
1495 if (OPTS_FLAG(ADJUST_VECTOR_FIELDS)) {
1496 if (op == INSTR_STORE_FLD && what->fieldtype == TYPE_VECTOR)
1500 return ir_block_create_store_op(self, ctx, op, target, what);
1503 bool ir_block_create_storep(ir_block *self, lex_ctx ctx, ir_value *target, ir_value *what)
1508 if (target->vtype != TYPE_POINTER)
1511 /* storing using pointer - target is a pointer, type must be
1512 * inferred from source
1514 vtype = what->vtype;
1516 op = type_storep_instr[vtype];
1517 if (OPTS_FLAG(ADJUST_VECTOR_FIELDS)) {
1518 if (op == INSTR_STOREP_FLD && what->fieldtype == TYPE_VECTOR)
1519 op = INSTR_STOREP_V;
1522 return ir_block_create_store_op(self, ctx, op, target, what);
1525 bool ir_block_create_return(ir_block *self, lex_ctx ctx, ir_value *v)
1528 if (!ir_check_unreachable(self))
1531 self->is_return = true;
1532 in = ir_instr_new(ctx, self, INSTR_RETURN);
1536 if (v && !ir_instr_op(in, 0, v, false)) {
1537 ir_instr_delete(in);
1541 vec_push(self->instr, in);
1545 bool ir_block_create_if(ir_block *self, lex_ctx ctx, ir_value *v,
1546 ir_block *ontrue, ir_block *onfalse)
1549 if (!ir_check_unreachable(self))
1552 /*in = ir_instr_new(ctx, self, (v->vtype == TYPE_STRING ? INSTR_IF_S : INSTR_IF_F));*/
1553 in = ir_instr_new(ctx, self, VINSTR_COND);
1557 if (!ir_instr_op(in, 0, v, false)) {
1558 ir_instr_delete(in);
1562 in->bops[0] = ontrue;
1563 in->bops[1] = onfalse;
1565 vec_push(self->instr, in);
1567 vec_push(self->exits, ontrue);
1568 vec_push(self->exits, onfalse);
1569 vec_push(ontrue->entries, self);
1570 vec_push(onfalse->entries, self);
1574 bool ir_block_create_jump(ir_block *self, lex_ctx ctx, ir_block *to)
1577 if (!ir_check_unreachable(self))
1580 in = ir_instr_new(ctx, self, VINSTR_JUMP);
1585 vec_push(self->instr, in);
1587 vec_push(self->exits, to);
1588 vec_push(to->entries, self);
1592 bool ir_block_create_goto(ir_block *self, lex_ctx ctx, ir_block *to)
1594 self->owner->flags |= IR_FLAG_HAS_GOTO;
1595 return ir_block_create_jump(self, ctx, to);
1598 ir_instr* ir_block_create_phi(ir_block *self, lex_ctx ctx, const char *label, int ot)
1602 if (!ir_check_unreachable(self))
1604 in = ir_instr_new(ctx, self, VINSTR_PHI);
1607 out = ir_value_out(self->owner, label, store_value, ot);
1609 ir_instr_delete(in);
1612 if (!ir_instr_op(in, 0, out, true)) {
1613 ir_instr_delete(in);
1614 ir_value_delete(out);
1617 vec_push(self->instr, in);
1621 ir_value* ir_phi_value(ir_instr *self)
1623 return self->_ops[0];
1626 void ir_phi_add(ir_instr* self, ir_block *b, ir_value *v)
1630 if (!vec_ir_block_find(self->owner->entries, b, NULL)) {
1631 /* Must not be possible to cause this, otherwise the AST
1632 * is doing something wrong.
1634 irerror(self->context, "Invalid entry block for PHI");
1640 vec_push(v->reads, self);
1641 vec_push(self->phi, pe);
1644 /* call related code */
1645 ir_instr* ir_block_create_call(ir_block *self, lex_ctx ctx, const char *label, ir_value *func, bool noreturn)
1649 if (!ir_check_unreachable(self))
1651 in = ir_instr_new(ctx, self, (noreturn ? VINSTR_NRCALL : INSTR_CALL0));
1656 self->is_return = true;
1658 out = ir_value_out(self->owner, label, (func->outtype == TYPE_VOID) ? store_return : store_value, func->outtype);
1660 ir_instr_delete(in);
1663 if (!ir_instr_op(in, 0, out, true) ||
1664 !ir_instr_op(in, 1, func, false))
1666 ir_instr_delete(in);
1667 ir_value_delete(out);
1670 vec_push(self->instr, in);
1673 if (!ir_block_create_return(self, ctx, NULL)) {
1674 compile_error(ctx, "internal error: failed to generate dummy-return instruction");
1675 ir_instr_delete(in);
1683 ir_value* ir_call_value(ir_instr *self)
1685 return self->_ops[0];
1688 void ir_call_param(ir_instr* self, ir_value *v)
1690 vec_push(self->params, v);
1691 vec_push(v->reads, self);
1694 /* binary op related code */
1696 ir_value* ir_block_create_binop(ir_block *self, lex_ctx ctx,
1697 const char *label, int opcode,
1698 ir_value *left, ir_value *right)
1720 case INSTR_SUB_S: /* -- offset of string as float */
1725 case INSTR_BITOR_IF:
1726 case INSTR_BITOR_FI:
1727 case INSTR_BITAND_FI:
1728 case INSTR_BITAND_IF:
1743 case INSTR_BITAND_I:
1746 case INSTR_RSHIFT_I:
1747 case INSTR_LSHIFT_I:
1769 /* boolean operations result in floats */
1770 if (opcode >= INSTR_EQ_F && opcode <= INSTR_GT)
1772 else if (opcode >= INSTR_LE && opcode <= INSTR_GT)
1775 else if (opcode >= INSTR_LE_I && opcode <= INSTR_EQ_FI)
1780 if (ot == TYPE_VOID) {
1781 /* The AST or parser were supposed to check this! */
1785 return ir_block_create_general_instr(self, ctx, label, opcode, left, right, ot);
1788 ir_value* ir_block_create_unary(ir_block *self, lex_ctx ctx,
1789 const char *label, int opcode,
1792 int ot = TYPE_FLOAT;
1804 /* QC doesn't have other unary operations. We expect extensions to fill
1805 * the above list, otherwise we assume out-type = in-type, eg for an
1809 ot = operand->vtype;
1812 if (ot == TYPE_VOID) {
1813 /* The AST or parser were supposed to check this! */
1817 /* let's use the general instruction creator and pass NULL for OPB */
1818 return ir_block_create_general_instr(self, ctx, label, opcode, operand, NULL, ot);
1821 ir_value* ir_block_create_general_instr(ir_block *self, lex_ctx ctx, const char *label,
1822 int op, ir_value *a, ir_value *b, int outype)
1827 out = ir_value_out(self->owner, label, store_value, outype);
1831 instr = ir_instr_new(ctx, self, op);
1833 ir_value_delete(out);
1837 if (!ir_instr_op(instr, 0, out, true) ||
1838 !ir_instr_op(instr, 1, a, false) ||
1839 !ir_instr_op(instr, 2, b, false) )
1844 vec_push(self->instr, instr);
1848 ir_instr_delete(instr);
1849 ir_value_delete(out);
1853 ir_value* ir_block_create_fieldaddress(ir_block *self, lex_ctx ctx, const char *label, ir_value *ent, ir_value *field)
1857 /* Support for various pointer types todo if so desired */
1858 if (ent->vtype != TYPE_ENTITY)
1861 if (field->vtype != TYPE_FIELD)
1864 v = ir_block_create_general_instr(self, ctx, label, INSTR_ADDRESS, ent, field, TYPE_POINTER);
1865 v->fieldtype = field->fieldtype;
1869 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)
1872 if (ent->vtype != TYPE_ENTITY)
1875 /* at some point we could redirect for TYPE_POINTER... but that could lead to carelessness */
1876 if (field->vtype != TYPE_FIELD)
1881 case TYPE_FLOAT: op = INSTR_LOAD_F; break;
1882 case TYPE_VECTOR: op = INSTR_LOAD_V; break;
1883 case TYPE_STRING: op = INSTR_LOAD_S; break;
1884 case TYPE_FIELD: op = INSTR_LOAD_FLD; break;
1885 case TYPE_ENTITY: op = INSTR_LOAD_ENT; break;
1886 case TYPE_FUNCTION: op = INSTR_LOAD_FNC; break;
1888 case TYPE_POINTER: op = INSTR_LOAD_I; break;
1889 case TYPE_INTEGER: op = INSTR_LOAD_I; break;
1892 irerror(self->context, "invalid type for ir_block_create_load_from_ent: %s", type_name[outype]);
1896 return ir_block_create_general_instr(self, ctx, label, op, ent, field, outype);
1899 /* PHI resolving breaks the SSA, and must thus be the last
1900 * step before life-range calculation.
1903 static bool ir_block_naive_phi(ir_block *self);
1904 bool ir_function_naive_phi(ir_function *self)
1908 for (i = 0; i < vec_size(self->blocks); ++i)
1910 if (!ir_block_naive_phi(self->blocks[i]))
1916 static bool ir_block_naive_phi(ir_block *self)
1918 size_t i, p; /*, w;*/
1919 /* FIXME: optionally, create_phi can add the phis
1920 * to a list so we don't need to loop through blocks
1921 * - anyway: "don't optimize YET"
1923 for (i = 0; i < vec_size(self->instr); ++i)
1925 ir_instr *instr = self->instr[i];
1926 if (instr->opcode != VINSTR_PHI)
1929 vec_remove(self->instr, i, 1);
1930 --i; /* NOTE: i+1 below */
1932 for (p = 0; p < vec_size(instr->phi); ++p)
1934 ir_value *v = instr->phi[p].value;
1935 ir_block *b = instr->phi[p].from;
1937 if (v->store == store_value &&
1938 vec_size(v->reads) == 1 &&
1939 vec_size(v->writes) == 1)
1941 /* replace the value */
1942 if (!ir_instr_op(v->writes[0], 0, instr->_ops[0], true))
1947 /* force a move instruction */
1948 ir_instr *prevjump = vec_last(b->instr);
1951 instr->_ops[0]->store = store_global;
1952 if (!ir_block_create_store(b, instr->context, instr->_ops[0], v))
1954 instr->_ops[0]->store = store_value;
1955 vec_push(b->instr, prevjump);
1959 ir_instr_delete(instr);
1964 /***********************************************************************
1965 *IR Temp allocation code
1966 * Propagating value life ranges by walking through the function backwards
1967 * until no more changes are made.
1968 * In theory this should happen once more than once for every nested loop
1970 * Though this implementation might run an additional time for if nests.
1973 /* Enumerate instructions used by value's life-ranges
1975 static void ir_block_enumerate(ir_block *self, size_t *_eid)
1979 for (i = 0; i < vec_size(self->instr); ++i)
1981 self->instr[i]->eid = eid++;
1986 /* Enumerate blocks and instructions.
1987 * The block-enumeration is unordered!
1988 * We do not really use the block enumreation, however
1989 * the instruction enumeration is important for life-ranges.
1991 void ir_function_enumerate(ir_function *self)
1994 size_t instruction_id = 1;
1995 for (i = 0; i < vec_size(self->blocks); ++i)
1997 self->blocks[i]->eid = i;
1998 self->blocks[i]->run_id = 0;
1999 ir_block_enumerate(self->blocks[i], &instruction_id);
2003 static bool ir_block_life_propagate(ir_block *b, ir_block *prev, bool *changed);
2004 bool ir_function_calculate_liferanges(ir_function *self)
2009 /* parameters live at 0 */
2010 for (i = 0; i < vec_size(self->params); ++i)
2011 ir_value_life_merge(self->locals[i], 0);
2016 for (i = 0; i != vec_size(self->blocks); ++i)
2018 if (self->blocks[i]->is_return)
2020 vec_free(self->blocks[i]->living);
2021 if (!ir_block_life_propagate(self->blocks[i], NULL, &changed))
2026 if (vec_size(self->blocks)) {
2027 ir_block *block = self->blocks[0];
2028 for (i = 0; i < vec_size(block->living); ++i) {
2029 ir_value *v = block->living[i];
2030 if (v->store != store_local)
2032 if (v->vtype == TYPE_VECTOR)
2034 self->flags |= IR_FLAG_HAS_UNINITIALIZED;
2035 /* find the instruction reading from it */
2036 for (s = 0; s < vec_size(v->reads); ++s) {
2037 if (v->reads[s]->eid == v->life[0].end)
2040 if (s < vec_size(v->reads)) {
2041 if (irwarning(v->context, WARN_USED_UNINITIALIZED,
2042 "variable `%s` may be used uninitialized in this function\n"
2045 v->reads[s]->context.file, v->reads[s]->context.line)
2053 ir_value *vec = v->memberof;
2054 for (s = 0; s < vec_size(vec->reads); ++s) {
2055 if (vec->reads[s]->eid == v->life[0].end)
2058 if (s < vec_size(vec->reads)) {
2059 if (irwarning(v->context, WARN_USED_UNINITIALIZED,
2060 "variable `%s` may be used uninitialized in this function\n"
2063 vec->reads[s]->context.file, vec->reads[s]->context.line)
2071 if (irwarning(v->context, WARN_USED_UNINITIALIZED,
2072 "variable `%s` may be used uninitialized in this function", v->name))
2081 /* Local-value allocator
2082 * After finishing creating the liferange of all values used in a function
2083 * we can allocate their global-positions.
2084 * This is the counterpart to register-allocation in register machines.
2091 } function_allocator;
2093 static bool function_allocator_alloc(function_allocator *alloc, ir_value *var)
2096 size_t vsize = ir_value_sizeof(var);
2098 var->code.local = vec_size(alloc->locals);
2100 slot = ir_value_var("reg", store_global, var->vtype);
2104 if (!ir_value_life_merge_into(slot, var))
2107 vec_push(alloc->locals, slot);
2108 vec_push(alloc->sizes, vsize);
2109 vec_push(alloc->unique, var->unique_life);
2114 ir_value_delete(slot);
2118 static bool ir_function_allocator_assign(ir_function *self, function_allocator *alloc, ir_value *v)
2124 return function_allocator_alloc(alloc, v);
2126 for (a = 0; a < vec_size(alloc->locals); ++a)
2128 /* if it's reserved for a unique liferange: skip */
2129 if (alloc->unique[a])
2132 slot = alloc->locals[a];
2134 /* never resize parameters
2135 * will be required later when overlapping temps + locals
2137 if (a < vec_size(self->params) &&
2138 alloc->sizes[a] < ir_value_sizeof(v))
2143 if (ir_values_overlap(v, slot))
2146 if (!ir_value_life_merge_into(slot, v))
2149 /* adjust size for this slot */
2150 if (alloc->sizes[a] < ir_value_sizeof(v))
2151 alloc->sizes[a] = ir_value_sizeof(v);
2156 if (a >= vec_size(alloc->locals)) {
2157 if (!function_allocator_alloc(alloc, v))
2163 static bool ir_value_has_point_life(const ir_value *v)
2165 size_t i, vs = vec_size(v->life);
2166 for (i = 0; i < vs; ++i) {
2167 if (v->life[i].start == v->life[i].end)
2173 bool ir_function_allocate_locals(ir_function *self)
2178 bool opt_gt = OPTS_OPTIMIZATION(OPTIM_GLOBAL_TEMPS);
2182 function_allocator lockalloc, globalloc;
2184 if (!vec_size(self->locals) && !vec_size(self->values))
2187 globalloc.locals = NULL;
2188 globalloc.sizes = NULL;
2189 globalloc.positions = NULL;
2190 globalloc.unique = NULL;
2191 lockalloc.locals = NULL;
2192 lockalloc.sizes = NULL;
2193 lockalloc.positions = NULL;
2194 lockalloc.unique = NULL;
2196 for (i = 0; i < vec_size(self->locals); ++i)
2198 v = self->locals[i];
2199 if (ir_value_has_point_life(v))
2200 v->unique_life = true;
2201 if (!OPTS_OPTIMIZATION(OPTIM_LOCAL_TEMPS)) {
2203 v->unique_life = true;
2205 else if (i >= vec_size(self->params))
2208 v->locked = true; /* lock parameters locals */
2209 if (!function_allocator_alloc((v->locked || !opt_gt ? &lockalloc : &globalloc), v))
2212 for (; i < vec_size(self->locals); ++i)
2214 v = self->locals[i];
2215 if (!vec_size(v->life))
2217 if (ir_value_has_point_life(v))
2218 v->unique_life = true;
2219 if (!ir_function_allocator_assign(self, (v->locked || !opt_gt ? &lockalloc : &globalloc), v))
2223 /* Allocate a slot for any value that still exists */
2224 for (i = 0; i < vec_size(self->values); ++i)
2226 v = self->values[i];
2228 if (!vec_size(v->life))
2230 if (ir_value_has_point_life(v)) {
2231 /* happens on free ternarys like:
2235 irerror(v->context, "internal error: point life SSA value leaked: %s", v->name);
2237 v->unique_life = true;
2240 /* CALL optimization:
2241 * If the value is a parameter-temp: 1 write, 1 read from a CALL
2242 * and it's not "locked", write it to the OFS_PARM directly.
2244 if (OPTS_OPTIMIZATION(OPTIM_CALL_STORES) && !v->locked && !v->unique_life) {
2245 if (vec_size(v->reads) == 1 && vec_size(v->writes) == 1 &&
2246 (v->reads[0]->opcode == VINSTR_NRCALL ||
2247 (v->reads[0]->opcode >= INSTR_CALL0 && v->reads[0]->opcode <= INSTR_CALL8)
2252 ir_instr *call = v->reads[0];
2253 if (!vec_ir_value_find(call->params, v, ¶m)) {
2254 irerror(call->context, "internal error: unlocked parameter %s not found", v->name);
2258 ++opts_optimizationcount[OPTIM_CALL_STORES];
2259 v->callparam = true;
2261 ir_value_code_setaddr(v, OFS_PARM0 + 3*param);
2265 if (vec_size(self->owner->extparam_protos) <= param)
2266 ep = ir_gen_extparam_proto(self->owner);
2268 ep = self->owner->extparam_protos[param];
2269 ir_instr_op(v->writes[0], 0, ep, true);
2270 call->params[param+8] = ep;
2274 if (vec_size(v->writes) == 1 && v->writes[0]->opcode == INSTR_CALL0)
2276 v->store = store_return;
2277 if (v->members[0]) v->members[0]->store = store_return;
2278 if (v->members[1]) v->members[1]->store = store_return;
2279 if (v->members[2]) v->members[2]->store = store_return;
2280 ++opts_optimizationcount[OPTIM_CALL_STORES];
2285 if (!ir_function_allocator_assign(self, (v->locked || !opt_gt ? &lockalloc : &globalloc), v))
2289 if (!lockalloc.sizes && !globalloc.sizes) {
2292 vec_push(lockalloc.positions, 0);
2293 vec_push(globalloc.positions, 0);
2295 /* Adjust slot positions based on sizes */
2296 if (lockalloc.sizes) {
2297 pos = (vec_size(lockalloc.sizes) ? lockalloc.positions[0] : 0);
2298 for (i = 1; i < vec_size(lockalloc.sizes); ++i)
2300 pos = lockalloc.positions[i-1] + lockalloc.sizes[i-1];
2301 vec_push(lockalloc.positions, pos);
2303 self->allocated_locals = pos + vec_last(lockalloc.sizes);
2305 if (globalloc.sizes) {
2306 pos = (vec_size(globalloc.sizes) ? globalloc.positions[0] : 0);
2307 for (i = 1; i < vec_size(globalloc.sizes); ++i)
2309 pos = globalloc.positions[i-1] + globalloc.sizes[i-1];
2310 vec_push(globalloc.positions, pos);
2312 self->globaltemps = pos + vec_last(globalloc.sizes);
2315 /* Locals need to know their new position */
2316 for (i = 0; i < vec_size(self->locals); ++i) {
2317 v = self->locals[i];
2318 if (i >= vec_size(self->params) && !vec_size(v->life))
2320 if (v->locked || !opt_gt)
2321 v->code.local = lockalloc.positions[v->code.local];
2323 v->code.local = globalloc.positions[v->code.local];
2325 /* Take over the actual slot positions on values */
2326 for (i = 0; i < vec_size(self->values); ++i) {
2327 v = self->values[i];
2328 if (!vec_size(v->life))
2330 if (v->locked || !opt_gt)
2331 v->code.local = lockalloc.positions[v->code.local];
2333 v->code.local = globalloc.positions[v->code.local];
2341 for (i = 0; i < vec_size(lockalloc.locals); ++i)
2342 ir_value_delete(lockalloc.locals[i]);
2343 for (i = 0; i < vec_size(globalloc.locals); ++i)
2344 ir_value_delete(globalloc.locals[i]);
2345 vec_free(globalloc.unique);
2346 vec_free(globalloc.locals);
2347 vec_free(globalloc.sizes);
2348 vec_free(globalloc.positions);
2349 vec_free(lockalloc.unique);
2350 vec_free(lockalloc.locals);
2351 vec_free(lockalloc.sizes);
2352 vec_free(lockalloc.positions);
2356 /* Get information about which operand
2357 * is read from, or written to.
2359 static void ir_op_read_write(int op, size_t *read, size_t *write)
2379 case INSTR_STOREP_F:
2380 case INSTR_STOREP_V:
2381 case INSTR_STOREP_S:
2382 case INSTR_STOREP_ENT:
2383 case INSTR_STOREP_FLD:
2384 case INSTR_STOREP_FNC:
2395 static bool ir_block_living_add_instr(ir_block *self, size_t eid)
2398 bool changed = false;
2400 for (i = 0; i != vec_size(self->living); ++i)
2402 tempbool = ir_value_life_merge(self->living[i], eid);
2403 changed = changed || tempbool;
2408 static bool ir_block_living_lock(ir_block *self)
2411 bool changed = false;
2412 for (i = 0; i != vec_size(self->living); ++i)
2414 if (!self->living[i]->locked) {
2415 self->living[i]->locked = true;
2422 static bool ir_block_life_prop_previous(ir_block* self, ir_block *prev, bool *changed)
2428 /* values which have been read in a previous iteration are now
2429 * in the "living" array even if the previous block doesn't use them.
2430 * So we have to remove whatever does not exist in the previous block.
2431 * They will be re-added on-read, but the liferange merge won't cause
2433 for (i = 0; i < vec_size(self->living); ++i)
2435 if (!vec_ir_value_find(prev->living, self->living[i], NULL)) {
2436 vec_remove(self->living, i, 1);
2442 /* Whatever the previous block still has in its living set
2443 * must now be added to ours as well.
2445 for (i = 0; i < vec_size(prev->living); ++i)
2447 if (vec_ir_value_find(self->living, prev->living[i], NULL))
2449 vec_push(self->living, prev->living[i]);
2451 irerror(self->contextt from prev: %s", self->label, prev->living[i]->_name);
2457 static bool ir_block_life_propagate(ir_block *self, ir_block *prev, bool *changed)
2462 size_t i, o, p, mem;
2463 /* bitmasks which operands are read from or written to */
2472 if (!ir_block_life_prop_previous(self, prev, changed))
2476 i = vec_size(self->instr);
2479 instr = self->instr[i];
2481 /* See which operands are read and write operands */
2482 ir_op_read_write(instr->opcode, &read, &write);
2484 if (instr->opcode == INSTR_MUL_VF)
2486 /* the float source will get an additional lifetime */
2487 tempbool = ir_value_life_merge(instr->_ops[2], instr->eid+1);
2488 *changed = *changed || tempbool;
2490 else if (instr->opcode == INSTR_MUL_FV)
2492 /* the float source will get an additional lifetime */
2493 tempbool = ir_value_life_merge(instr->_ops[1], instr->eid+1);
2494 *changed = *changed || tempbool;
2497 /* Go through the 3 main operands
2498 * writes first, then reads
2500 for (o = 0; o < 3; ++o)
2502 if (!instr->_ops[o]) /* no such operand */
2505 value = instr->_ops[o];
2507 /* We only care about locals */
2508 /* we also calculate parameter liferanges so that locals
2509 * can take up parameter slots */
2510 if (value->store != store_value &&
2511 value->store != store_local &&
2512 value->store != store_param)
2515 /* write operands */
2516 /* When we write to a local, we consider it "dead" for the
2517 * remaining upper part of the function, since in SSA a value
2518 * can only be written once (== created)
2523 bool in_living = vec_ir_value_find(self->living, value, &idx);
2526 /* If the value isn't alive it hasn't been read before... */
2527 /* TODO: See if the warning can be emitted during parsing or AST processing
2528 * otherwise have warning printed here.
2529 * IF printing a warning here: include filecontext_t,
2530 * and make sure it's only printed once
2531 * since this function is run multiple times.
2533 /* con_err( "Value only written %s\n", value->name); */
2534 tempbool = ir_value_life_merge(value, instr->eid);
2535 *changed = *changed || tempbool;
2537 /* since 'living' won't contain it
2538 * anymore, merge the value, since
2541 tempbool = ir_value_life_merge(value, instr->eid);
2542 *changed = *changed || tempbool;
2544 vec_remove(self->living, idx, 1);
2546 /* Removing a vector removes all members */
2547 for (mem = 0; mem < 3; ++mem) {
2548 if (value->members[mem] && vec_ir_value_find(self->living, value->members[mem], &idx)) {
2549 tempbool = ir_value_life_merge(value->members[mem], instr->eid);
2550 *changed = *changed || tempbool;
2551 vec_remove(self->living, idx, 1);
2554 /* Removing the last member removes the vector */
2555 if (value->memberof) {
2556 value = value->memberof;
2557 for (mem = 0; mem < 3; ++mem) {
2558 if (value->members[mem] && vec_ir_value_find(self->living, value->members[mem], NULL))
2561 if (mem == 3 && vec_ir_value_find(self->living, value, &idx)) {
2562 tempbool = ir_value_life_merge(value, instr->eid);
2563 *changed = *changed || tempbool;
2564 vec_remove(self->living, idx, 1);
2570 for (o = 0; o < 3; ++o)
2572 if (!instr->_ops[o]) /* no such operand */
2575 value = instr->_ops[o];
2577 /* We only care about locals */
2578 /* we also calculate parameter liferanges so that locals
2579 * can take up parameter slots */
2580 if (value->store != store_value &&
2581 value->store != store_local &&
2582 value->store != store_param)
2588 if (!vec_ir_value_find(self->living, value, NULL))
2589 vec_push(self->living, value);
2590 /* reading adds the full vector */
2591 if (value->memberof && !vec_ir_value_find(self->living, value->memberof, NULL))
2592 vec_push(self->living, value->memberof);
2593 for (mem = 0; mem < 3; ++mem) {
2594 if (value->members[mem] && !vec_ir_value_find(self->living, value->members[mem], NULL))
2595 vec_push(self->living, value->members[mem]);
2599 /* PHI operands are always read operands */
2600 for (p = 0; p < vec_size(instr->phi); ++p)
2602 value = instr->phi[p].value;
2603 if (!vec_ir_value_find(self->living, value, NULL))
2604 vec_push(self->living, value);
2605 /* reading adds the full vector */
2606 if (value->memberof && !vec_ir_value_find(self->living, value->memberof, NULL))
2607 vec_push(self->living, value->memberof);
2608 for (mem = 0; mem < 3; ++mem) {
2609 if (value->members[mem] && !vec_ir_value_find(self->living, value->members[mem], NULL))
2610 vec_push(self->living, value->members[mem]);
2614 /* on a call, all these values must be "locked" */
2615 if (instr->opcode >= INSTR_CALL0 && instr->opcode <= INSTR_CALL8) {
2616 if (ir_block_living_lock(self))
2619 /* call params are read operands too */
2620 for (p = 0; p < vec_size(instr->params); ++p)
2622 value = instr->params[p];
2623 if (!vec_ir_value_find(self->living, value, NULL))
2624 vec_push(self->living, value);
2625 /* reading adds the full vector */
2626 if (value->memberof && !vec_ir_value_find(self->living, value->memberof, NULL))
2627 vec_push(self->living, value->memberof);
2628 for (mem = 0; mem < 3; ++mem) {
2629 if (value->members[mem] && !vec_ir_value_find(self->living, value->members[mem], NULL))
2630 vec_push(self->living, value->members[mem]);
2635 tempbool = ir_block_living_add_instr(self, instr->eid);
2636 /*con_err( "living added values\n");*/
2637 *changed = *changed || tempbool;
2641 if (self->run_id == self->owner->run_id)
2644 self->run_id = self->owner->run_id;
2646 for (i = 0; i < vec_size(self->entries); ++i)
2648 ir_block *entry = self->entries[i];
2649 ir_block_life_propagate(entry, self, changed);
2655 /***********************************************************************
2658 * Since the IR has the convention of putting 'write' operands
2659 * at the beginning, we have to rotate the operands of instructions
2660 * properly in order to generate valid QCVM code.
2662 * Having destinations at a fixed position is more convenient. In QC
2663 * this is *mostly* OPC, but FTE adds at least 2 instructions which
2664 * read from from OPA, and store to OPB rather than OPC. Which is
2665 * partially the reason why the implementation of these instructions
2666 * in darkplaces has been delayed for so long.
2668 * Breaking conventions is annoying...
2670 static bool ir_builder_gen_global(ir_builder *self, ir_value *global, bool islocal);
2672 static bool gen_global_field(ir_value *global)
2674 if (global->hasvalue)
2676 ir_value *fld = global->constval.vpointer;
2678 irerror(global->context, "Invalid field constant with no field: %s", global->name);
2682 /* copy the field's value */
2683 ir_value_code_setaddr(global, vec_size(code_globals));
2684 vec_push(code_globals, fld->code.fieldaddr);
2685 if (global->fieldtype == TYPE_VECTOR) {
2686 vec_push(code_globals, fld->code.fieldaddr+1);
2687 vec_push(code_globals, fld->code.fieldaddr+2);
2692 ir_value_code_setaddr(global, vec_size(code_globals));
2693 vec_push(code_globals, 0);
2694 if (global->fieldtype == TYPE_VECTOR) {
2695 vec_push(code_globals, 0);
2696 vec_push(code_globals, 0);
2699 if (global->code.globaladdr < 0)
2704 static bool gen_global_pointer(ir_value *global)
2706 if (global->hasvalue)
2708 ir_value *target = global->constval.vpointer;
2710 irerror(global->context, "Invalid pointer constant: %s", global->name);
2711 /* NULL pointers are pointing to the NULL constant, which also
2712 * sits at address 0, but still has an ir_value for itself.
2717 /* Here, relocations ARE possible - in fteqcc-enhanced-qc:
2718 * void() foo; <- proto
2719 * void() *fooptr = &foo;
2720 * void() foo = { code }
2722 if (!target->code.globaladdr) {
2723 /* FIXME: Check for the constant nullptr ir_value!
2724 * because then code.globaladdr being 0 is valid.
2726 irerror(global->context, "FIXME: Relocation support");
2730 ir_value_code_setaddr(global, vec_size(code_globals));
2731 vec_push(code_globals, target->code.globaladdr);
2735 ir_value_code_setaddr(global, vec_size(code_globals));
2736 vec_push(code_globals, 0);
2738 if (global->code.globaladdr < 0)
2743 static bool gen_blocks_recursive(ir_function *func, ir_block *block)
2745 prog_section_statement stmt;
2754 block->generated = true;
2755 block->code_start = vec_size(code_statements);
2756 for (i = 0; i < vec_size(block->instr); ++i)
2758 instr = block->instr[i];
2760 if (instr->opcode == VINSTR_PHI) {
2761 irerror(block->context, "cannot generate virtual instruction (phi)");
2765 if (instr->opcode == VINSTR_JUMP) {
2766 target = instr->bops[0];
2767 /* for uncoditional jumps, if the target hasn't been generated
2768 * yet, we generate them right here.
2770 if (!target->generated) {
2775 /* otherwise we generate a jump instruction */
2776 stmt.opcode = INSTR_GOTO;
2777 stmt.o1.s1 = (target->code_start) - vec_size(code_statements);
2780 if (stmt.o1.s1 != 1)
2781 code_push_statement(&stmt, instr->context.line);
2783 /* no further instructions can be in this block */
2787 if (instr->opcode == VINSTR_COND) {
2788 ontrue = instr->bops[0];
2789 onfalse = instr->bops[1];
2790 /* TODO: have the AST signal which block should
2791 * come first: eg. optimize IFs without ELSE...
2794 stmt.o1.u1 = ir_value_code_addr(instr->_ops[0]);
2798 if (ontrue->generated) {
2799 stmt.opcode = INSTR_IF;
2800 stmt.o2.s1 = (ontrue->code_start) - vec_size(code_statements);
2801 if (stmt.o2.s1 != 1)
2802 code_push_statement(&stmt, instr->context.line);
2804 if (onfalse->generated) {
2805 stmt.opcode = INSTR_IFNOT;
2806 stmt.o2.s1 = (onfalse->code_start) - vec_size(code_statements);
2807 if (stmt.o2.s1 != 1)
2808 code_push_statement(&stmt, instr->context.line);
2810 if (!ontrue->generated) {
2811 if (onfalse->generated) {
2816 if (!onfalse->generated) {
2817 if (ontrue->generated) {
2822 /* neither ontrue nor onfalse exist */
2823 stmt.opcode = INSTR_IFNOT;
2824 if (!instr->likely) {
2825 /* Honor the likelyhood hint */
2826 ir_block *tmp = onfalse;
2827 stmt.opcode = INSTR_IF;
2831 stidx = vec_size(code_statements);
2832 code_push_statement(&stmt, instr->context.line);
2833 /* on false we jump, so add ontrue-path */
2834 if (!gen_blocks_recursive(func, ontrue))
2836 /* fixup the jump address */
2837 code_statements[stidx].o2.s1 = vec_size(code_statements) - stidx;
2838 /* generate onfalse path */
2839 if (onfalse->generated) {
2840 /* fixup the jump address */
2841 code_statements[stidx].o2.s1 = (onfalse->code_start) - (stidx);
2842 if (stidx+2 == vec_size(code_statements) && code_statements[stidx].o2.s1 == 1) {
2843 code_statements[stidx] = code_statements[stidx+1];
2844 if (code_statements[stidx].o1.s1 < 0)
2845 code_statements[stidx].o1.s1++;
2846 code_pop_statement();
2848 stmt.opcode = vec_last(code_statements).opcode;
2849 if (stmt.opcode == INSTR_GOTO ||
2850 stmt.opcode == INSTR_IF ||
2851 stmt.opcode == INSTR_IFNOT ||
2852 stmt.opcode == INSTR_RETURN ||
2853 stmt.opcode == INSTR_DONE)
2855 /* no use jumping from here */
2858 /* may have been generated in the previous recursive call */
2859 stmt.opcode = INSTR_GOTO;
2860 stmt.o1.s1 = (onfalse->code_start) - vec_size(code_statements);
2863 if (stmt.o1.s1 != 1)
2864 code_push_statement(&stmt, instr->context.line);
2867 else if (stidx+2 == vec_size(code_statements) && code_statements[stidx].o2.s1 == 1) {
2868 code_statements[stidx] = code_statements[stidx+1];
2869 if (code_statements[stidx].o1.s1 < 0)
2870 code_statements[stidx].o1.s1++;
2871 code_pop_statement();
2873 /* if not, generate now */
2878 if ( (instr->opcode >= INSTR_CALL0 && instr->opcode <= INSTR_CALL8)
2879 || instr->opcode == VINSTR_NRCALL)
2884 first = vec_size(instr->params);
2887 for (p = 0; p < first; ++p)
2889 ir_value *param = instr->params[p];
2890 if (param->callparam)
2893 stmt.opcode = INSTR_STORE_F;
2896 if (param->vtype == TYPE_FIELD)
2897 stmt.opcode = field_store_instr[param->fieldtype];
2898 else if (param->vtype == TYPE_NIL)
2899 stmt.opcode = INSTR_STORE_V;
2901 stmt.opcode = type_store_instr[param->vtype];
2902 stmt.o1.u1 = ir_value_code_addr(param);
2903 stmt.o2.u1 = OFS_PARM0 + 3 * p;
2904 code_push_statement(&stmt, instr->context.line);
2906 /* Now handle extparams */
2907 first = vec_size(instr->params);
2908 for (; p < first; ++p)
2910 ir_builder *ir = func->owner;
2911 ir_value *param = instr->params[p];
2912 ir_value *targetparam;
2914 if (param->callparam)
2917 if (p-8 >= vec_size(ir->extparams))
2918 ir_gen_extparam(ir);
2920 targetparam = ir->extparams[p-8];
2922 stmt.opcode = INSTR_STORE_F;
2925 if (param->vtype == TYPE_FIELD)
2926 stmt.opcode = field_store_instr[param->fieldtype];
2927 else if (param->vtype == TYPE_NIL)
2928 stmt.opcode = INSTR_STORE_V;
2930 stmt.opcode = type_store_instr[param->vtype];
2931 stmt.o1.u1 = ir_value_code_addr(param);
2932 stmt.o2.u1 = ir_value_code_addr(targetparam);
2933 code_push_statement(&stmt, instr->context.line);
2936 stmt.opcode = INSTR_CALL0 + vec_size(instr->params);
2937 if (stmt.opcode > INSTR_CALL8)
2938 stmt.opcode = INSTR_CALL8;
2939 stmt.o1.u1 = ir_value_code_addr(instr->_ops[1]);
2942 code_push_statement(&stmt, instr->context.line);
2944 retvalue = instr->_ops[0];
2945 if (retvalue && retvalue->store != store_return &&
2946 (retvalue->store == store_global || vec_size(retvalue->life)))
2948 /* not to be kept in OFS_RETURN */
2949 if (retvalue->vtype == TYPE_FIELD && OPTS_FLAG(ADJUST_VECTOR_FIELDS))
2950 stmt.opcode = field_store_instr[retvalue->fieldtype];
2952 stmt.opcode = type_store_instr[retvalue->vtype];
2953 stmt.o1.u1 = OFS_RETURN;
2954 stmt.o2.u1 = ir_value_code_addr(retvalue);
2956 code_push_statement(&stmt, instr->context.line);
2961 if (instr->opcode == INSTR_STATE) {
2962 irerror(block->context, "TODO: state instruction");
2966 stmt.opcode = instr->opcode;
2971 /* This is the general order of operands */
2973 stmt.o3.u1 = ir_value_code_addr(instr->_ops[0]);
2976 stmt.o1.u1 = ir_value_code_addr(instr->_ops[1]);
2979 stmt.o2.u1 = ir_value_code_addr(instr->_ops[2]);
2981 if (stmt.opcode == INSTR_RETURN || stmt.opcode == INSTR_DONE)
2983 stmt.o1.u1 = stmt.o3.u1;
2986 else if ((stmt.opcode >= INSTR_STORE_F &&
2987 stmt.opcode <= INSTR_STORE_FNC) ||
2988 (stmt.opcode >= INSTR_STOREP_F &&
2989 stmt.opcode <= INSTR_STOREP_FNC))
2991 /* 2-operand instructions with A -> B */
2992 stmt.o2.u1 = stmt.o3.u1;
2995 /* tiny optimization, don't output
2998 if (stmt.o2.u1 == stmt.o1.u1 &&
2999 OPTS_OPTIMIZATION(OPTIM_PEEPHOLE))
3001 ++opts_optimizationcount[OPTIM_PEEPHOLE];
3006 code_push_statement(&stmt, instr->context.line);
3011 static bool gen_function_code(ir_function *self)
3014 prog_section_statement stmt, *retst;
3016 /* Starting from entry point, we generate blocks "as they come"
3017 * for now. Dead blocks will not be translated obviously.
3019 if (!vec_size(self->blocks)) {
3020 irerror(self->context, "Function '%s' declared without body.", self->name);
3024 block = self->blocks[0];
3025 if (block->generated)
3028 if (!gen_blocks_recursive(self, block)) {
3029 irerror(self->context, "failed to generate blocks for '%s'", self->name);
3033 /* code_write and qcvm -disasm need to know that the function ends here */
3034 retst = &vec_last(code_statements);
3035 if (OPTS_OPTIMIZATION(OPTIM_VOID_RETURN) &&
3036 self->outtype == TYPE_VOID &&
3037 retst->opcode == INSTR_RETURN &&
3038 !retst->o1.u1 && !retst->o2.u1 && !retst->o3.u1)
3040 retst->opcode = INSTR_DONE;
3041 ++opts_optimizationcount[OPTIM_VOID_RETURN];
3043 stmt.opcode = INSTR_DONE;
3047 code_push_statement(&stmt, vec_last(code_linenums));
3052 static qcint ir_builder_filestring(ir_builder *ir, const char *filename)
3054 /* NOTE: filename pointers are copied, we never strdup them,
3055 * thus we can use pointer-comparison to find the string.
3060 for (i = 0; i < vec_size(ir->filenames); ++i) {
3061 if (ir->filenames[i] == filename)
3062 return ir->filestrings[i];
3065 str = code_genstring(filename);
3066 vec_push(ir->filenames, filename);
3067 vec_push(ir->filestrings, str);
3071 static bool gen_global_function(ir_builder *ir, ir_value *global)
3073 prog_section_function fun;
3078 if (!global->hasvalue || (!global->constval.vfunc))
3080 irerror(global->context, "Invalid state of function-global: not constant: %s", global->name);
3084 irfun = global->constval.vfunc;
3086 fun.name = global->code.name;
3087 fun.file = ir_builder_filestring(ir, global->context.file);
3088 fun.profile = 0; /* always 0 */
3089 fun.nargs = vec_size(irfun->params);
3093 for (i = 0;i < 8; ++i) {
3094 if ((int32_t)i >= fun.nargs)
3097 fun.argsize[i] = type_sizeof_[irfun->params[i]];
3101 fun.locals = irfun->allocated_locals;
3104 fun.entry = irfun->builtin+1;
3106 irfun->code_function_def = vec_size(code_functions);
3107 fun.entry = vec_size(code_statements);
3110 vec_push(code_functions, fun);
3114 static ir_value* ir_gen_extparam_proto(ir_builder *ir)
3119 snprintf(name, sizeof(name), "EXTPARM#%i", (int)(vec_size(ir->extparam_protos)+8));
3120 global = ir_value_var(name, store_global, TYPE_VECTOR);
3122 vec_push(ir->extparam_protos, global);
3126 static void ir_gen_extparam(ir_builder *ir)
3128 prog_section_def def;
3131 if (vec_size(ir->extparam_protos) < vec_size(ir->extparams)+1)
3132 global = ir_gen_extparam_proto(ir);
3134 global = ir->extparam_protos[vec_size(ir->extparams)];
3136 def.name = code_genstring(global->name);
3137 def.type = TYPE_VECTOR;
3138 def.offset = vec_size(code_globals);
3140 vec_push(code_defs, def);
3141 ir_value_code_setaddr(global, def.offset);
3142 vec_push(code_globals, 0);
3143 vec_push(code_globals, 0);
3144 vec_push(code_globals, 0);
3146 vec_push(ir->extparams, global);
3149 static bool gen_function_extparam_copy(ir_function *self)
3151 size_t i, ext, numparams;
3153 ir_builder *ir = self->owner;
3155 prog_section_statement stmt;
3157 numparams = vec_size(self->params);
3161 stmt.opcode = INSTR_STORE_F;
3163 for (i = 8; i < numparams; ++i) {
3165 if (ext >= vec_size(ir->extparams))
3166 ir_gen_extparam(ir);
3168 ep = ir->extparams[ext];
3170 stmt.opcode = type_store_instr[self->locals[i]->vtype];
3171 if (self->locals[i]->vtype == TYPE_FIELD &&
3172 self->locals[i]->fieldtype == TYPE_VECTOR)
3174 stmt.opcode = INSTR_STORE_V;
3176 stmt.o1.u1 = ir_value_code_addr(ep);
3177 stmt.o2.u1 = ir_value_code_addr(self->locals[i]);
3178 code_push_statement(&stmt, self->context.line);
3184 static bool gen_function_locals(ir_builder *ir, ir_value *global)
3186 prog_section_function *def;
3189 uint32_t firstlocal, firstglobal;
3191 irfun = global->constval.vfunc;
3192 def = code_functions + irfun->code_function_def;
3194 if (opts.g || !OPTS_OPTIMIZATION(OPTIM_OVERLAP_LOCALS) || (irfun->flags & IR_FLAG_MASK_NO_OVERLAP))
3195 firstlocal = def->firstlocal = vec_size(code_globals);
3197 firstlocal = def->firstlocal = ir->first_common_local;
3198 ++opts_optimizationcount[OPTIM_OVERLAP_LOCALS];
3201 firstglobal = (OPTS_OPTIMIZATION(OPTIM_GLOBAL_TEMPS) ? ir->first_common_globaltemp : firstlocal);
3203 for (i = vec_size(code_globals); i < firstlocal + irfun->allocated_locals; ++i)
3204 vec_push(code_globals, 0);
3205 for (i = 0; i < vec_size(irfun->locals); ++i) {
3206 ir_value *v = irfun->locals[i];
3207 if (v->locked || !OPTS_OPTIMIZATION(OPTIM_GLOBAL_TEMPS)) {
3208 ir_value_code_setaddr(v, firstlocal + v->code.local);
3209 if (!ir_builder_gen_global(ir, irfun->locals[i], true)) {
3210 irerror(irfun->locals[i]->context, "failed to generate local %s", irfun->locals[i]->name);
3215 ir_value_code_setaddr(v, firstglobal + v->code.local);
3217 for (i = 0; i < vec_size(irfun->values); ++i)
3219 ir_value *v = irfun->values[i];
3223 ir_value_code_setaddr(v, firstlocal + v->code.local);
3225 ir_value_code_setaddr(v, firstglobal + v->code.local);
3230 static bool gen_global_function_code(ir_builder *ir, ir_value *global)
3232 prog_section_function *fundef;
3237 irfun = global->constval.vfunc;
3239 if (global->cvq == CV_NONE) {
3240 irwarning(global->context, WARN_IMPLICIT_FUNCTION_POINTER,
3241 "function `%s` has no body and in QC implicitly becomes a function-pointer", global->name);
3243 /* this was a function pointer, don't generate code for those */
3250 if (irfun->code_function_def < 0) {
3251 irerror(irfun->context, "`%s`: IR global wasn't generated, failed to access function-def", irfun->name);
3254 fundef = &code_functions[irfun->code_function_def];
3256 fundef->entry = vec_size(code_statements);
3257 if (!gen_function_locals(ir, global)) {
3258 irerror(irfun->context, "Failed to generate locals for function %s", irfun->name);
3261 if (!gen_function_extparam_copy(irfun)) {
3262 irerror(irfun->context, "Failed to generate extparam-copy code for function %s", irfun->name);
3265 if (!gen_function_code(irfun)) {
3266 irerror(irfun->context, "Failed to generate code for function %s", irfun->name);
3272 static void gen_vector_defs(prog_section_def def, const char *name)
3277 if (!name || name[0] == '#' || OPTS_FLAG(SINGLE_VECTOR_DEFS))
3280 def.type = TYPE_FLOAT;
3284 component = (char*)mem_a(len+3);
3285 memcpy(component, name, len);
3287 component[len-0] = 0;
3288 component[len-2] = '_';
3290 component[len-1] = 'x';
3292 for (i = 0; i < 3; ++i) {
3293 def.name = code_genstring(component);
3294 vec_push(code_defs, def);
3300 static void gen_vector_fields(prog_section_field fld, const char *name)
3305 if (!name || OPTS_FLAG(SINGLE_VECTOR_DEFS))
3308 fld.type = TYPE_FLOAT;
3312 component = (char*)mem_a(len+3);
3313 memcpy(component, name, len);
3315 component[len-0] = 0;
3316 component[len-2] = '_';
3318 component[len-1] = 'x';
3320 for (i = 0; i < 3; ++i) {
3321 fld.name = code_genstring(component);
3322 vec_push(code_fields, fld);
3328 static bool ir_builder_gen_global(ir_builder *self, ir_value *global, bool islocal)
3332 prog_section_def def;
3333 bool pushdef = false;
3335 def.type = global->vtype;
3336 def.offset = vec_size(code_globals);
3338 if (opts.g || !islocal)
3342 if (OPTS_OPTIMIZATION(OPTIM_STRIP_CONSTANT_NAMES) &&
3343 (global->name[0] == '#' || global->cvq == CV_CONST))
3348 if (pushdef && global->name) {
3349 if (global->name[0] == '#') {
3350 if (!self->str_immediate)
3351 self->str_immediate = code_genstring("IMMEDIATE");
3352 def.name = global->code.name = self->str_immediate;
3355 def.name = global->code.name = code_genstring(global->name);
3360 def.offset = ir_value_code_addr(global);
3361 vec_push(code_defs, def);
3362 if (global->vtype == TYPE_VECTOR)
3363 gen_vector_defs(def, global->name);
3364 else if (global->vtype == TYPE_FIELD && global->fieldtype == TYPE_VECTOR)
3365 gen_vector_defs(def, global->name);
3372 switch (global->vtype)
3375 if (!strcmp(global->name, "end_sys_globals")) {
3376 /* TODO: remember this point... all the defs before this one
3377 * should be checksummed and added to progdefs.h when we generate it.
3380 else if (!strcmp(global->name, "end_sys_fields")) {
3381 /* TODO: same as above but for entity-fields rather than globsl
3385 irwarning(global->context, WARN_VOID_VARIABLES, "unrecognized variable of type void `%s`",
3387 /* I'd argue setting it to 0 is sufficient, but maybe some depend on knowing how far
3388 * the system fields actually go? Though the engine knows this anyway...
3389 * Maybe this could be an -foption
3390 * fteqcc creates data for end_sys_* - of size 1, so let's do the same
3392 ir_value_code_setaddr(global, vec_size(code_globals));
3393 vec_push(code_globals, 0);
3395 if (pushdef) vec_push(code_defs, def);
3398 if (pushdef) vec_push(code_defs, def);
3399 return gen_global_pointer(global);
3402 vec_push(code_defs, def);
3403 if (global->fieldtype == TYPE_VECTOR)
3404 gen_vector_defs(def, global->name);
3406 return gen_global_field(global);
3411 ir_value_code_setaddr(global, vec_size(code_globals));
3412 if (global->hasvalue) {
3413 iptr = (int32_t*)&global->constval.ivec[0];
3414 vec_push(code_globals, *iptr);
3416 vec_push(code_globals, 0);
3418 if (!islocal && global->cvq != CV_CONST)
3419 def.type |= DEF_SAVEGLOBAL;
3420 if (pushdef) vec_push(code_defs, def);
3422 return global->code.globaladdr >= 0;
3426 ir_value_code_setaddr(global, vec_size(code_globals));
3427 if (global->hasvalue) {
3428 vec_push(code_globals, code_genstring(global->constval.vstring));
3430 vec_push(code_globals, 0);
3432 if (!islocal && global->cvq != CV_CONST)
3433 def.type |= DEF_SAVEGLOBAL;
3434 if (pushdef) vec_push(code_defs, def);
3435 return global->code.globaladdr >= 0;
3440 ir_value_code_setaddr(global, vec_size(code_globals));
3441 if (global->hasvalue) {
3442 iptr = (int32_t*)&global->constval.ivec[0];
3443 vec_push(code_globals, iptr[0]);
3444 if (global->code.globaladdr < 0)
3446 for (d = 1; d < type_sizeof_[global->vtype]; ++d) {
3447 vec_push(code_globals, iptr[d]);
3450 vec_push(code_globals, 0);
3451 if (global->code.globaladdr < 0)
3453 for (d = 1; d < type_sizeof_[global->vtype]; ++d) {
3454 vec_push(code_globals, 0);
3457 if (!islocal && global->cvq != CV_CONST)
3458 def.type |= DEF_SAVEGLOBAL;
3461 vec_push(code_defs, def);
3462 def.type &= ~DEF_SAVEGLOBAL;
3463 gen_vector_defs(def, global->name);
3465 return global->code.globaladdr >= 0;
3468 ir_value_code_setaddr(global, vec_size(code_globals));
3469 if (!global->hasvalue) {
3470 vec_push(code_globals, 0);
3471 if (global->code.globaladdr < 0)
3474 vec_push(code_globals, vec_size(code_functions));
3475 if (!gen_global_function(self, global))
3478 if (!islocal && global->cvq != CV_CONST)
3479 def.type |= DEF_SAVEGLOBAL;
3480 if (pushdef) vec_push(code_defs, def);
3483 /* assume biggest type */
3484 ir_value_code_setaddr(global, vec_size(code_globals));
3485 vec_push(code_globals, 0);
3486 for (i = 1; i < type_sizeof_[TYPE_VARIANT]; ++i)
3487 vec_push(code_globals, 0);
3490 /* refuse to create 'void' type or any other fancy business. */
3491 irerror(global->context, "Invalid type for global variable `%s`: %s",
3492 global->name, type_name[global->vtype]);
3497 static void ir_builder_prepare_field(ir_value *field)
3499 field->code.fieldaddr = code_alloc_field(type_sizeof_[field->fieldtype]);
3502 static bool ir_builder_gen_field(ir_builder *self, ir_value *field)
3504 prog_section_def def;
3505 prog_section_field fld;
3509 def.type = (uint16_t)field->vtype;
3510 def.offset = (uint16_t)vec_size(code_globals);
3512 /* create a global named the same as the field */
3513 if (opts.standard == COMPILER_GMQCC) {
3514 /* in our standard, the global gets a dot prefix */
3515 size_t len = strlen(field->name);
3518 /* we really don't want to have to allocate this, and 1024
3519 * bytes is more than enough for a variable/field name
3521 if (len+2 >= sizeof(name)) {
3522 irerror(field->context, "invalid field name size: %u", (unsigned int)len);
3527 memcpy(name+1, field->name, len); /* no strncpy - we used strlen above */
3530 def.name = code_genstring(name);
3531 fld.name = def.name + 1; /* we reuse that string table entry */
3533 /* in plain QC, there cannot be a global with the same name,
3534 * and so we also name the global the same.
3535 * FIXME: fteqcc should create a global as well
3536 * check if it actually uses the same name. Probably does
3538 def.name = code_genstring(field->name);
3539 fld.name = def.name;
3542 field->code.name = def.name;
3544 vec_push(code_defs, def);
3546 fld.type = field->fieldtype;
3548 if (fld.type == TYPE_VOID) {
3549 irerror(field->context, "field is missing a type: %s - don't know its size", field->name);
3553 fld.offset = field->code.fieldaddr;
3555 vec_push(code_fields, fld);
3557 ir_value_code_setaddr(field, vec_size(code_globals));
3558 vec_push(code_globals, fld.offset);
3559 if (fld.type == TYPE_VECTOR) {
3560 vec_push(code_globals, fld.offset+1);
3561 vec_push(code_globals, fld.offset+2);
3564 if (field->fieldtype == TYPE_VECTOR) {
3565 gen_vector_defs(def, field->name);
3566 gen_vector_fields(fld, field->name);
3569 return field->code.globaladdr >= 0;
3572 bool ir_builder_generate(ir_builder *self, const char *filename)
3574 prog_section_statement stmt;
3576 char *lnofile = NULL;
3580 for (i = 0; i < vec_size(self->fields); ++i)
3582 ir_builder_prepare_field(self->fields[i]);
3585 for (i = 0; i < vec_size(self->globals); ++i)
3587 if (!ir_builder_gen_global(self, self->globals[i], false)) {
3590 if (self->globals[i]->vtype == TYPE_FUNCTION) {
3591 ir_function *func = self->globals[i]->constval.vfunc;
3592 if (func && self->max_locals < func->allocated_locals &&
3593 !(func->flags & IR_FLAG_MASK_NO_OVERLAP))
3595 self->max_locals = func->allocated_locals;
3597 if (func && self->max_globaltemps < func->globaltemps)
3598 self->max_globaltemps = func->globaltemps;
3602 for (i = 0; i < vec_size(self->fields); ++i)
3604 if (!ir_builder_gen_field(self, self->fields[i])) {
3610 ir_value_code_setaddr(self->nil, vec_size(code_globals));
3611 vec_push(code_globals, 0);
3612 vec_push(code_globals, 0);
3613 vec_push(code_globals, 0);
3615 /* generate global temps */
3616 self->first_common_globaltemp = vec_size(code_globals);
3617 for (i = 0; i < self->max_globaltemps; ++i) {
3618 vec_push(code_globals, 0);
3620 /* generate common locals */
3621 self->first_common_local = vec_size(code_globals);
3622 for (i = 0; i < self->max_locals; ++i) {
3623 vec_push(code_globals, 0);
3626 /* generate function code */
3627 for (i = 0; i < vec_size(self->globals); ++i)
3629 if (self->globals[i]->vtype == TYPE_FUNCTION) {
3630 if (!gen_global_function_code(self, self->globals[i])) {
3636 if (vec_size(code_globals) >= 65536) {
3637 irerror(vec_last(self->globals)->context, "This progs file would require more globals than the metadata can handle. Bailing out.");
3641 /* DP errors if the last instruction is not an INSTR_DONE. */
3642 if (vec_last(code_statements).opcode != INSTR_DONE)
3644 stmt.opcode = INSTR_DONE;
3648 code_push_statement(&stmt, vec_last(code_linenums));
3654 if (vec_size(code_statements) != vec_size(code_linenums)) {
3655 con_err("Linecounter wrong: %lu != %lu\n",
3656 (unsigned long)vec_size(code_statements),
3657 (unsigned long)vec_size(code_linenums));
3658 } else if (OPTS_FLAG(LNO)) {
3660 size_t filelen = strlen(filename);
3662 memcpy(vec_add(lnofile, filelen+1), filename, filelen+1);
3663 dot = strrchr(lnofile, '.');
3667 vec_shrinkto(lnofile, dot - lnofile);
3669 memcpy(vec_add(lnofile, 5), ".lno", 5);
3674 con_out("writing '%s' and '%s'...\n", filename, lnofile);
3676 con_out("writing '%s'\n", filename);
3678 if (!code_write(filename, lnofile)) {
3686 /***********************************************************************
3687 *IR DEBUG Dump functions...
3690 #define IND_BUFSZ 1024
3693 # define strncat(dst, src, sz) strncat_s(dst, sz, src, _TRUNCATE)
3696 const char *qc_opname(int op)
3698 if (op < 0) return "<INVALID>";
3699 if (op < (int)( sizeof(asm_instr) / sizeof(asm_instr[0]) ))
3700 return asm_instr[op].m;
3702 case VINSTR_PHI: return "PHI";
3703 case VINSTR_JUMP: return "JUMP";
3704 case VINSTR_COND: return "COND";
3705 default: return "<UNK>";
3709 void ir_builder_dump(ir_builder *b, int (*oprintf)(const char*, ...))
3712 char indent[IND_BUFSZ];
3716 oprintf("module %s\n", b->name);
3717 for (i = 0; i < vec_size(b->globals); ++i)
3720 if (b->globals[i]->hasvalue)
3721 oprintf("%s = ", b->globals[i]->name);
3722 ir_value_dump(b->globals[i], oprintf);
3725 for (i = 0; i < vec_size(b->functions); ++i)
3726 ir_function_dump(b->functions[i], indent, oprintf);
3727 oprintf("endmodule %s\n", b->name);
3730 void ir_function_dump(ir_function *f, char *ind,
3731 int (*oprintf)(const char*, ...))
3734 if (f->builtin != 0) {
3735 oprintf("%sfunction %s = builtin %i\n", ind, f->name, -f->builtin);
3738 oprintf("%sfunction %s\n", ind, f->name);
3739 strncat(ind, "\t", IND_BUFSZ);
3740 if (vec_size(f->locals))
3742 oprintf("%s%i locals:\n", ind, (int)vec_size(f->locals));
3743 for (i = 0; i < vec_size(f->locals); ++i) {
3744 oprintf("%s\t", ind);
3745 ir_value_dump(f->locals[i], oprintf);
3749 oprintf("%sliferanges:\n", ind);
3750 for (i = 0; i < vec_size(f->locals); ++i) {
3751 const char *attr = "";
3753 ir_value *v = f->locals[i];
3754 if (v->unique_life && v->locked)
3755 attr = "unique,locked ";
3756 else if (v->unique_life)
3760 oprintf("%s\t%s: %s %s%s@%i ", ind, v->name, type_name[v->vtype],
3761 attr, (v->callparam ? "callparam " : ""),
3762 (int)v->code.local);
3763 for (l = 0; l < vec_size(v->life); ++l) {
3764 oprintf("[%i,%i] ", v->life[l].start, v->life[l].end);
3767 for (m = 0; m < 3; ++m) {
3768 ir_value *vm = v->members[m];
3771 if (vm->unique_life && vm->locked)
3772 attr = "unique,locked ";
3773 else if (vm->unique_life)
3775 else if (vm->locked)
3777 oprintf("%s\t%s: %s@%i ", ind, vm->name, attr, (int)vm->code.local);
3778 for (l = 0; l < vec_size(vm->life); ++l) {
3779 oprintf("[%i,%i] ", vm->life[l].start, vm->life[l].end);
3784 for (i = 0; i < vec_size(f->values); ++i) {
3785 const char *attr = "";
3787 ir_value *v = f->values[i];
3788 if (v->unique_life && v->locked)
3789 attr = "unique,locked ";
3790 else if (v->unique_life)
3794 oprintf("%s\t%s: %s %s%s@%i ", ind, v->name, type_name[v->vtype],
3795 attr, (v->callparam ? "callparam " : ""),
3796 (int)v->code.local);
3797 for (l = 0; l < vec_size(v->life); ++l) {
3798 oprintf("[%i,%i] ", v->life[l].start, v->life[l].end);
3801 for (m = 0; m < 3; ++m) {
3802 ir_value *vm = v->members[m];
3805 if (vm->unique_life && vm->locked)
3806 attr = "unique,locked ";
3807 else if (vm->unique_life)
3809 else if (vm->locked)
3811 oprintf("%s\t%s: %s@%i ", ind, vm->name, attr, (int)vm->code.local);
3812 for (l = 0; l < vec_size(vm->life); ++l) {
3813 oprintf("[%i,%i] ", vm->life[l].start, vm->life[l].end);
3818 if (vec_size(f->blocks))
3820 oprintf("%slife passes (check): %i\n", ind, (int)f->run_id);
3821 for (i = 0; i < vec_size(f->blocks); ++i) {
3822 if (f->blocks[i]->run_id != f->run_id) {
3823 oprintf("%slife pass check fail! %i != %i\n", ind, (int)f->blocks[i]->run_id, (int)f->run_id);
3825 ir_block_dump(f->blocks[i], ind, oprintf);
3829 ind[strlen(ind)-1] = 0;
3830 oprintf("%sendfunction %s\n", ind, f->name);
3833 void ir_block_dump(ir_block* b, char *ind,
3834 int (*oprintf)(const char*, ...))
3837 oprintf("%s:%s\n", ind, b->label);
3838 strncat(ind, "\t", IND_BUFSZ);
3840 for (i = 0; i < vec_size(b->instr); ++i)
3841 ir_instr_dump(b->instr[i], ind, oprintf);
3842 ind[strlen(ind)-1] = 0;
3845 void dump_phi(ir_instr *in, int (*oprintf)(const char*, ...))
3848 oprintf("%s <- phi ", in->_ops[0]->name);
3849 for (i = 0; i < vec_size(in->phi); ++i)
3851 oprintf("([%s] : %s) ", in->phi[i].from->label,
3852 in->phi[i].value->name);
3857 void ir_instr_dump(ir_instr *in, char *ind,
3858 int (*oprintf)(const char*, ...))
3861 const char *comma = NULL;
3863 oprintf("%s (%i) ", ind, (int)in->eid);
3865 if (in->opcode == VINSTR_PHI) {
3866 dump_phi(in, oprintf);
3870 strncat(ind, "\t", IND_BUFSZ);
3872 if (in->_ops[0] && (in->_ops[1] || in->_ops[2])) {
3873 ir_value_dump(in->_ops[0], oprintf);
3874 if (in->_ops[1] || in->_ops[2])
3877 if (in->opcode == INSTR_CALL0 || in->opcode == VINSTR_NRCALL) {
3878 oprintf("CALL%i\t", vec_size(in->params));
3880 oprintf("%s\t", qc_opname(in->opcode));
3882 if (in->_ops[0] && !(in->_ops[1] || in->_ops[2])) {
3883 ir_value_dump(in->_ops[0], oprintf);
3888 for (i = 1; i != 3; ++i) {
3892 ir_value_dump(in->_ops[i], oprintf);
3900 oprintf("[%s]", in->bops[0]->label);
3904 oprintf("%s[%s]", comma, in->bops[1]->label);
3905 if (vec_size(in->params)) {
3906 oprintf("\tparams: ");
3907 for (i = 0; i != vec_size(in->params); ++i) {
3908 oprintf("%s, ", in->params[i]->name);
3912 ind[strlen(ind)-1] = 0;
3915 void ir_value_dump_string(const char *str, int (*oprintf)(const char*, ...))
3918 for (; *str; ++str) {
3920 case '\n': oprintf("\\n"); break;
3921 case '\r': oprintf("\\r"); break;
3922 case '\t': oprintf("\\t"); break;
3923 case '\v': oprintf("\\v"); break;
3924 case '\f': oprintf("\\f"); break;
3925 case '\b': oprintf("\\b"); break;
3926 case '\a': oprintf("\\a"); break;
3927 case '\\': oprintf("\\\\"); break;
3928 case '"': oprintf("\\\""); break;
3929 default: oprintf("%c", *str); break;
3935 void ir_value_dump(ir_value* v, int (*oprintf)(const char*, ...))
3944 oprintf("fn:%s", v->name);
3947 oprintf("%g", v->constval.vfloat);
3950 oprintf("'%g %g %g'",
3953 v->constval.vvec.z);
3956 oprintf("(entity)");
3959 ir_value_dump_string(v->constval.vstring, oprintf);
3963 oprintf("%i", v->constval.vint);
3968 v->constval.vpointer->name);
3972 oprintf("%s", v->name);
3976 void ir_value_dump_life(const ir_value *self, int (*oprintf)(const char*,...))
3979 oprintf("Life of %12s:", self->name);
3980 for (i = 0; i < vec_size(self->life); ++i)
3982 oprintf(" + [%i, %i]\n", self->life[i].start, self->life[i].end);