7 /***********************************************************************
8 * Type sizes used at multiple points in the IR codegen
11 const char *type_name[TYPE_COUNT] = {
30 static size_t type_sizeof_[TYPE_COUNT] = {
37 1, /* TYPE_FUNCTION */
48 const uint16_t type_store_instr[TYPE_COUNT] = {
49 INSTR_STORE_F, /* should use I when having integer support */
56 INSTR_STORE_ENT, /* should use I */
58 INSTR_STORE_I, /* integer type */
63 INSTR_STORE_V, /* variant, should never be accessed */
65 VINSTR_END, /* struct */
66 VINSTR_END, /* union */
67 VINSTR_END, /* array */
69 VINSTR_END, /* noexpr */
72 const uint16_t field_store_instr[TYPE_COUNT] = {
82 INSTR_STORE_FLD, /* integer type */
87 INSTR_STORE_V, /* variant, should never be accessed */
89 VINSTR_END, /* struct */
90 VINSTR_END, /* union */
91 VINSTR_END, /* array */
93 VINSTR_END, /* noexpr */
96 const uint16_t type_storep_instr[TYPE_COUNT] = {
97 INSTR_STOREP_F, /* should use I when having integer support */
104 INSTR_STOREP_ENT, /* should use I */
106 INSTR_STOREP_ENT, /* integer type */
111 INSTR_STOREP_V, /* variant, should never be accessed */
113 VINSTR_END, /* struct */
114 VINSTR_END, /* union */
115 VINSTR_END, /* array */
116 VINSTR_END, /* nil */
117 VINSTR_END, /* noexpr */
120 const uint16_t type_eq_instr[TYPE_COUNT] = {
121 INSTR_EQ_F, /* should use I when having integer support */
126 INSTR_EQ_E, /* FLD has no comparison */
128 INSTR_EQ_E, /* should use I */
135 INSTR_EQ_V, /* variant, should never be accessed */
137 VINSTR_END, /* struct */
138 VINSTR_END, /* union */
139 VINSTR_END, /* array */
140 VINSTR_END, /* nil */
141 VINSTR_END, /* noexpr */
144 const uint16_t type_ne_instr[TYPE_COUNT] = {
145 INSTR_NE_F, /* should use I when having integer support */
150 INSTR_NE_E, /* FLD has no comparison */
152 INSTR_NE_E, /* should use I */
159 INSTR_NE_V, /* variant, should never be accessed */
161 VINSTR_END, /* struct */
162 VINSTR_END, /* union */
163 VINSTR_END, /* array */
164 VINSTR_END, /* nil */
165 VINSTR_END, /* noexpr */
168 const uint16_t type_not_instr[TYPE_COUNT] = {
169 INSTR_NOT_F, /* should use I when having integer support */
170 VINSTR_END, /* not to be used, depends on string related -f flags */
176 INSTR_NOT_ENT, /* should use I */
178 INSTR_NOT_I, /* integer type */
183 INSTR_NOT_V, /* variant, should never be accessed */
185 VINSTR_END, /* struct */
186 VINSTR_END, /* union */
187 VINSTR_END, /* array */
188 VINSTR_END, /* nil */
189 VINSTR_END, /* noexpr */
193 static void ir_function_dump(ir_function*, char *ind, int (*oprintf)(const char*,...));
195 static ir_value* ir_block_create_general_instr(ir_block *self, lex_ctx_t, const char *label,
196 int op, ir_value *a, ir_value *b, qc_type outype);
197 static bool GMQCC_WARN ir_block_create_store(ir_block*, lex_ctx_t, ir_value *target, ir_value *what);
198 static void ir_block_dump(ir_block*, char *ind, int (*oprintf)(const char*,...));
200 static bool ir_instr_op(ir_instr*, int op, ir_value *value, bool writing);
201 static void ir_instr_dump(ir_instr* in, char *ind, int (*oprintf)(const char*,...));
202 /* error functions */
204 static void irerror(lex_ctx_t ctx, const char *msg, ...)
208 con_cvprintmsg(ctx, LVL_ERROR, "internal error", msg, ap);
212 static bool GMQCC_WARN irwarning(lex_ctx_t ctx, int warntype, const char *fmt, ...)
217 r = vcompile_warning(ctx, warntype, fmt, ap);
222 /***********************************************************************
223 * Vector utility functions
226 static bool GMQCC_WARN vec_ir_value_find(std::vector<ir_value *> &vec, const ir_value *what, size_t *idx)
228 for (auto &it : vec) {
232 *idx = &it - &vec[0];
238 static bool GMQCC_WARN vec_ir_block_find(std::vector<ir_block *> &vec, ir_block *what, size_t *idx)
240 for (auto &it : vec) {
244 *idx = &it - &vec[0];
250 static bool GMQCC_WARN vec_ir_instr_find(std::vector<ir_instr *> &vec, ir_instr *what, size_t *idx)
252 for (auto &it : vec) {
256 *idx = &it - &vec[0];
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(const std::string& modulename)
271 : m_name(modulename),
274 m_htglobals = util_htnew(IR_HT_SIZE);
275 m_htfields = util_htnew(IR_HT_SIZE);
276 m_htfunctions = util_htnew(IR_HT_SIZE);
278 m_nil = new ir_value("nil", store_value, TYPE_NIL);
279 m_nil->m_cvq = CV_CONST;
281 for (size_t i = 0; i != IR_MAX_VINSTR_TEMPS; ++i) {
282 /* we write to them, but they're not supposed to be used outside the IR, so
283 * let's not allow the generation of ir_instrs which use these.
284 * So it's a constant noexpr.
286 m_vinstr_temp[i] = new ir_value("vinstr_temp", store_value, TYPE_NOEXPR);
287 m_vinstr_temp[i]->m_cvq = CV_CONST;
291 ir_builder::~ir_builder()
293 util_htdel(m_htglobals);
294 util_htdel(m_htfields);
295 util_htdel(m_htfunctions);
296 for (auto& f : m_functions)
297 ir_function_delete_quick(f.release());
298 m_functions.clear(); // delete them now before deleting the rest:
302 for (size_t i = 0; i != IR_MAX_VINSTR_TEMPS; ++i) {
303 delete m_vinstr_temp[i];
307 m_extparam_protos.clear();
310 ir_function* ir_builder::createFunction(const std::string& name, qc_type outtype)
312 ir_function *fn = (ir_function*)util_htget(m_htfunctions, name.c_str());
316 fn = new ir_function(this, outtype);
318 m_functions.emplace_back(fn);
319 util_htset(m_htfunctions, name.c_str(), fn);
321 fn->m_value = createGlobal(fn->m_name, TYPE_FUNCTION);
327 fn->m_value->m_hasvalue = true;
328 fn->m_value->m_outtype = outtype;
329 fn->m_value->m_constval.vfunc = fn;
330 fn->m_value->m_context = fn->m_context;
335 ir_value* ir_builder::createGlobal(const std::string& name, qc_type vtype)
341 ve = (ir_value*)util_htget(m_htglobals, name.c_str());
347 ve = new ir_value(std::string(name), store_global, vtype);
348 m_globals.emplace_back(ve);
349 util_htset(m_htglobals, name.c_str(), ve);
353 ir_value* ir_builder::get_va_count()
355 if (m_reserved_va_count)
356 return m_reserved_va_count;
357 return (m_reserved_va_count = createGlobal("reserved:va_count", TYPE_FLOAT));
360 ir_value* ir_builder::createField(const std::string& name, qc_type vtype)
362 ir_value *ve = (ir_value*)util_htget(m_htfields, name.c_str());
367 ve = new ir_value(std::string(name), store_global, TYPE_FIELD);
368 ve->m_fieldtype = vtype;
369 m_fields.emplace_back(ve);
370 util_htset(m_htfields, name.c_str(), ve);
374 /***********************************************************************
378 static bool ir_function_naive_phi(ir_function*);
379 static void ir_function_enumerate(ir_function*);
380 static bool ir_function_calculate_liferanges(ir_function*);
381 static bool ir_function_allocate_locals(ir_function*);
383 ir_function::ir_function(ir_builder* owner_, qc_type outtype_)
385 m_name("<@unnamed>"),
388 m_context.file = "<@no context>";
392 ir_function::~ir_function()
396 static void ir_function_delete_quick(ir_function *self)
398 for (auto& b : self->m_blocks)
399 ir_block_delete_quick(b.release());
403 static void ir_function_collect_value(ir_function *self, ir_value *v)
405 self->m_values.emplace_back(v);
408 ir_block* ir_function_create_block(lex_ctx_t ctx, ir_function *self, const char *label)
410 ir_block* bn = new ir_block(self, label ? std::string(label) : std::string());
412 self->m_blocks.emplace_back(bn);
414 if ((self->m_flags & IR_FLAG_BLOCK_COVERAGE) && self->m_owner->m_coverage_func)
415 (void)ir_block_create_call(bn, ctx, nullptr, self->m_owner->m_coverage_func, false);
420 static bool instr_is_operation(uint16_t op)
422 return ( (op >= INSTR_MUL_F && op <= INSTR_GT) ||
423 (op >= INSTR_LOAD_F && op <= INSTR_LOAD_FNC) ||
424 (op == INSTR_ADDRESS) ||
425 (op >= INSTR_NOT_F && op <= INSTR_NOT_FNC) ||
426 (op >= INSTR_AND && op <= INSTR_BITOR) ||
427 (op >= INSTR_CALL0 && op <= INSTR_CALL8) ||
428 (op >= VINSTR_BITAND_V && op <= VINSTR_NEG_V) );
431 static bool ir_function_pass_peephole(ir_function *self)
433 for (auto& bp : self->m_blocks) {
434 ir_block *block = bp.get();
435 for (size_t i = 0; i < block->m_instr.size(); ++i) {
437 inst = block->m_instr[i];
440 (inst->m_opcode >= INSTR_STORE_F &&
441 inst->m_opcode <= INSTR_STORE_FNC))
449 oper = block->m_instr[i-1];
450 if (!instr_is_operation(oper->m_opcode))
453 /* Don't change semantics of MUL_VF in engines where these may not alias. */
454 if (OPTS_FLAG(LEGACY_VECTOR_MATHS)) {
455 if (oper->m_opcode == INSTR_MUL_VF && oper->_m_ops[2]->m_memberof == oper->_m_ops[1])
457 if (oper->m_opcode == INSTR_MUL_FV && oper->_m_ops[1]->m_memberof == oper->_m_ops[2])
461 value = oper->_m_ops[0];
463 /* only do it for SSA values */
464 if (value->m_store != store_value)
467 /* don't optimize out the temp if it's used later again */
468 if (value->m_reads.size() != 1)
471 /* The very next store must use this value */
472 if (value->m_reads[0] != store)
475 /* And of course the store must _read_ from it, so it's in
477 if (store->_m_ops[1] != value)
480 ++opts_optimizationcount[OPTIM_PEEPHOLE];
481 (void)!ir_instr_op(oper, 0, store->_m_ops[0], true);
483 block->m_instr.erase(block->m_instr.begin() + i);
486 else if (inst->m_opcode == VINSTR_COND)
488 /* COND on a value resulting from a NOT could
489 * remove the NOT and swap its operands
496 value = inst->_m_ops[0];
498 if (value->m_store != store_value || value->m_reads.size() != 1 || value->m_reads[0] != inst)
501 inot = value->m_writes[0];
502 if (inot->_m_ops[0] != value ||
503 inot->m_opcode < INSTR_NOT_F ||
504 inot->m_opcode > INSTR_NOT_FNC ||
505 inot->m_opcode == INSTR_NOT_V || /* can't do these */
506 inot->m_opcode == INSTR_NOT_S)
512 ++opts_optimizationcount[OPTIM_PEEPHOLE];
514 (void)!ir_instr_op(inst, 0, inot->_m_ops[1], false);
517 for (inotid = 0; inotid < tmp->m_instr.size(); ++inotid) {
518 if (tmp->m_instr[inotid] == inot)
521 if (inotid >= tmp->m_instr.size()) {
522 compile_error(inst->m_context, "sanity-check failed: failed to find instruction to optimize out");
525 tmp->m_instr.erase(tmp->m_instr.begin() + inotid);
527 /* swap ontrue/onfalse */
528 tmp = inst->m_bops[0];
529 inst->m_bops[0] = inst->m_bops[1];
530 inst->m_bops[1] = tmp;
540 static bool ir_function_pass_tailrecursion(ir_function *self)
544 for (auto& bp : self->m_blocks) {
545 ir_block *block = bp.get();
548 ir_instr *ret, *call, *store = nullptr;
550 if (!block->m_final || block->m_instr.size() < 2)
553 ret = block->m_instr.back();
554 if (ret->m_opcode != INSTR_DONE && ret->m_opcode != INSTR_RETURN)
557 call = block->m_instr[block->m_instr.size()-2];
558 if (call->m_opcode >= INSTR_STORE_F && call->m_opcode <= INSTR_STORE_FNC) {
559 /* account for the unoptimized
561 * STORE %return, %tmp
565 if (block->m_instr.size() < 3)
569 call = block->m_instr[block->m_instr.size()-3];
572 if (call->m_opcode < INSTR_CALL0 || call->m_opcode > INSTR_CALL8)
576 /* optimize out the STORE */
577 if (ret->_m_ops[0] &&
578 ret->_m_ops[0] == store->_m_ops[0] &&
579 store->_m_ops[1] == call->_m_ops[0])
581 ++opts_optimizationcount[OPTIM_PEEPHOLE];
582 call->_m_ops[0] = store->_m_ops[0];
583 block->m_instr.erase(block->m_instr.end()-2);
590 if (!call->_m_ops[0])
593 funcval = call->_m_ops[1];
596 if (funcval->m_vtype != TYPE_FUNCTION || funcval->m_constval.vfunc != self)
599 /* now we have a CALL and a RET, check if it's a tailcall */
600 if (ret->_m_ops[0] && call->_m_ops[0] != ret->_m_ops[0])
603 ++opts_optimizationcount[OPTIM_TAIL_RECURSION];
604 block->m_instr.erase(block->m_instr.end()-2, block->m_instr.end());
606 block->m_final = false; /* open it back up */
608 /* emite parameter-stores */
609 for (p = 0; p < call->m_params.size(); ++p) {
610 /* assert(call->params_count <= self->locals_count); */
611 if (!ir_block_create_store(block, call->m_context, self->m_locals[p].get(), call->m_params[p])) {
612 irerror(call->m_context, "failed to create tailcall store instruction for parameter %i", (int)p);
616 if (!ir_block_create_jump(block, call->m_context, self->m_blocks[0].get())) {
617 irerror(call->m_context, "failed to create tailcall jump");
628 bool ir_function_finalize(ir_function *self)
633 for (auto& lp : self->m_locals) {
634 ir_value *v = lp.get();
635 if (v->m_reads.empty() && v->m_writes.size() && !(v->m_flags & IR_FLAG_NOREF)) {
636 // if it's a vector check to ensure all it's members are unused before
637 // claiming it's unused, otherwise skip the vector entierly
638 if (v->m_vtype == TYPE_VECTOR)
640 size_t mask = (1 << 3) - 1, bits = 0;
641 for (size_t i = 0; i < 3; i++)
642 if (!v->m_members[i] || (v->m_members[i]->m_reads.empty()
643 && v->m_members[i]->m_writes.size()))
645 // all components are unused so just report the vector
646 if (bits == mask && irwarning(v->m_context, WARN_UNUSED_VARIABLE,
647 "unused variable: `%s`", v->m_name.c_str()))
649 else if (bits != mask)
650 // individual components are unused so mention them
651 for (size_t i = 0; i < 3; i++)
652 if ((bits & (1 << i))
653 && irwarning(v->m_context, WARN_UNUSED_COMPONENT,
654 "unused vector component: `%s.%c`", v->m_name.c_str(), "xyz"[i]))
657 // just a standard variable
658 else if (irwarning(v->m_context, WARN_UNUSED_VARIABLE,
659 "unused variable: `%s`", v->m_name.c_str())) return false;
663 if (OPTS_OPTIMIZATION(OPTIM_PEEPHOLE)) {
664 if (!ir_function_pass_peephole(self)) {
665 irerror(self->m_context, "generic optimization pass broke something in `%s`", self->m_name.c_str());
670 if (OPTS_OPTIMIZATION(OPTIM_TAIL_RECURSION)) {
671 if (!ir_function_pass_tailrecursion(self)) {
672 irerror(self->m_context, "tail-recursion optimization pass broke something in `%s`", self->m_name.c_str());
677 if (!ir_function_naive_phi(self)) {
678 irerror(self->m_context, "internal error: ir_function_naive_phi failed");
682 for (auto& lp : self->m_locals) {
683 ir_value *v = lp.get();
684 if (v->m_vtype == TYPE_VECTOR ||
685 (v->m_vtype == TYPE_FIELD && v->m_outtype == TYPE_VECTOR))
692 for (auto& vp : self->m_values) {
693 ir_value *v = vp.get();
694 if (v->m_vtype == TYPE_VECTOR ||
695 (v->m_vtype == TYPE_FIELD && v->m_outtype == TYPE_VECTOR))
703 ir_function_enumerate(self);
705 if (!ir_function_calculate_liferanges(self))
707 if (!ir_function_allocate_locals(self))
712 ir_value* ir_function_create_local(ir_function *self, const std::string& name, qc_type vtype, bool param)
717 !self->m_locals.empty() &&
718 self->m_locals.back()->m_store != store_param)
720 irerror(self->m_context, "cannot add parameters after adding locals");
724 ve = new ir_value(std::string(name), (param ? store_param : store_local), vtype);
727 self->m_locals.emplace_back(ve);
731 /***********************************************************************
735 ir_block::ir_block(ir_function* owner, const std::string& name)
739 m_context.file = "<@no context>";
743 ir_block::~ir_block()
745 for (auto &i : m_instr)
749 static void ir_block_delete_quick(ir_block* self)
751 for (auto &i : self->m_instr)
752 ir_instr_delete_quick(i);
753 self->m_instr.clear();
757 /***********************************************************************
761 ir_instr::ir_instr(lex_ctx_t ctx, ir_block* owner_, int op)
768 ir_instr::~ir_instr()
770 // The following calls can only delete from
771 // vectors, we still want to delete this instruction
772 // so ignore the return value. Since with the warn_unused_result attribute
773 // gcc doesn't care about an explicit: (void)foo(); to ignore the result,
774 // I have to improvise here and use if(foo());
775 for (auto &it : m_phi) {
777 if (vec_ir_instr_find(it.value->m_writes, this, &idx))
778 it.value->m_writes.erase(it.value->m_writes.begin() + idx);
779 if (vec_ir_instr_find(it.value->m_reads, this, &idx))
780 it.value->m_reads.erase(it.value->m_reads.begin() + idx);
782 for (auto &it : m_params) {
784 if (vec_ir_instr_find(it->m_writes, this, &idx))
785 it->m_writes.erase(it->m_writes.begin() + idx);
786 if (vec_ir_instr_find(it->m_reads, this, &idx))
787 it->m_reads.erase(it->m_reads.begin() + idx);
789 (void)!ir_instr_op(this, 0, nullptr, false);
790 (void)!ir_instr_op(this, 1, nullptr, false);
791 (void)!ir_instr_op(this, 2, nullptr, false);
794 static void ir_instr_delete_quick(ir_instr *self)
797 self->m_params.clear();
798 self->_m_ops[0] = nullptr;
799 self->_m_ops[1] = nullptr;
800 self->_m_ops[2] = nullptr;
804 static bool ir_instr_op(ir_instr *self, int op, ir_value *v, bool writing)
806 if (v && v->m_vtype == TYPE_NOEXPR) {
807 irerror(self->m_context, "tried to use a NOEXPR value");
811 if (self->_m_ops[op]) {
813 if (writing && vec_ir_instr_find(self->_m_ops[op]->m_writes, self, &idx))
814 self->_m_ops[op]->m_writes.erase(self->_m_ops[op]->m_writes.begin() + idx);
815 else if (vec_ir_instr_find(self->_m_ops[op]->m_reads, self, &idx))
816 self->_m_ops[op]->m_reads.erase(self->_m_ops[op]->m_reads.begin() + idx);
820 v->m_writes.push_back(self);
822 v->m_reads.push_back(self);
824 self->_m_ops[op] = v;
828 /***********************************************************************
832 void ir_value::setCodeAddress(int32_t gaddr)
834 m_code.globaladdr = gaddr;
835 if (m_members[0]) m_members[0]->m_code.globaladdr = gaddr;
836 if (m_members[1]) m_members[1]->m_code.globaladdr = gaddr;
837 if (m_members[2]) m_members[2]->m_code.globaladdr = gaddr;
840 int32_t ir_value::codeAddress() const
842 if (m_store == store_return)
843 return OFS_RETURN + m_code.addroffset;
844 return m_code.globaladdr + m_code.addroffset;
847 ir_value::ir_value(std::string&& name_, store_type store_, qc_type vtype_)
848 : m_name(move(name_))
852 m_fieldtype = TYPE_VOID;
853 m_outtype = TYPE_VOID;
858 m_context.file = "<@no context>";
861 memset(&m_constval, 0, sizeof(m_constval));
862 memset(&m_code, 0, sizeof(m_code));
864 m_members[0] = nullptr;
865 m_members[1] = nullptr;
866 m_members[2] = nullptr;
867 m_memberof = nullptr;
869 m_unique_life = false;
874 ir_value::ir_value(ir_function *owner, std::string&& name, store_type storetype, qc_type vtype)
875 : ir_value(move(name), storetype, vtype)
877 ir_function_collect_value(owner, this);
880 ir_value::~ir_value()
884 if (m_vtype == TYPE_STRING)
885 mem_d((void*)m_constval.vstring);
887 if (!(m_flags & IR_FLAG_SPLIT_VECTOR)) {
888 for (i = 0; i < 3; ++i) {
896 /* helper function */
897 ir_value* ir_builder::literalFloat(float value, bool add_to_list) {
898 ir_value *v = new ir_value("#IMMEDIATE", store_global, TYPE_FLOAT);
899 v->m_flags |= IR_FLAG_ERASABLE;
900 v->m_hasvalue = true;
902 v->m_constval.vfloat = value;
904 m_globals.emplace_back(v);
906 m_const_floats.emplace_back(v);
910 ir_value* ir_value::vectorMember(unsigned int member)
917 if (m_members[member])
918 return m_members[member];
920 if (!m_name.empty()) {
921 char member_name[3] = { '_', char('x' + member), 0 };
922 name = m_name + member_name;
925 if (m_vtype == TYPE_VECTOR)
927 m = new ir_value(move(name), m_store, TYPE_FLOAT);
930 m->m_context = m_context;
932 m_members[member] = m;
933 m->m_code.addroffset = member;
935 else if (m_vtype == TYPE_FIELD)
937 if (m_fieldtype != TYPE_VECTOR)
939 m = new ir_value(move(name), m_store, TYPE_FIELD);
942 m->m_fieldtype = TYPE_FLOAT;
943 m->m_context = m_context;
945 m_members[member] = m;
946 m->m_code.addroffset = member;
950 irerror(m_context, "invalid member access on %s", m_name.c_str());
954 m->m_memberof = this;
958 size_t ir_value::size() const {
959 if (m_vtype == TYPE_FIELD && m_fieldtype == TYPE_VECTOR)
960 return type_sizeof_[TYPE_VECTOR];
961 return type_sizeof_[m_vtype];
964 bool ir_value::setFloat(float f)
966 if (m_vtype != TYPE_FLOAT)
968 m_constval.vfloat = f;
973 bool ir_value::setFunc(int f)
975 if (m_vtype != TYPE_FUNCTION)
982 bool ir_value::setVector(vec3_t v)
984 if (m_vtype != TYPE_VECTOR)
991 bool ir_value::setField(ir_value *fld)
993 if (m_vtype != TYPE_FIELD)
995 m_constval.vpointer = fld;
1000 bool ir_value::setString(const char *str)
1002 if (m_vtype != TYPE_STRING)
1004 m_constval.vstring = util_strdupe(str);
1010 bool ir_value::setInt(int i)
1012 if (m_vtype != TYPE_INTEGER)
1014 m_constval.vint = i;
1020 bool ir_value::lives(size_t at)
1022 for (auto& l : m_life) {
1023 if (l.start <= at && at <= l.end)
1025 if (l.start > at) /* since it's ordered */
1031 bool ir_value::insertLife(size_t idx, ir_life_entry_t e)
1033 m_life.insert(m_life.begin() + idx, e);
1037 bool ir_value::setAlive(size_t s)
1040 const size_t vs = m_life.size();
1041 ir_life_entry_t *life_found = nullptr;
1042 ir_life_entry_t *before = nullptr;
1043 ir_life_entry_t new_entry;
1045 /* Find the first range >= s */
1046 for (i = 0; i < vs; ++i)
1048 before = life_found;
1049 life_found = &m_life[i];
1050 if (life_found->start > s)
1053 /* nothing found? append */
1056 if (life_found && life_found->end+1 == s)
1058 /* previous life range can be merged in */
1062 if (life_found && life_found->end >= s)
1064 e.start = e.end = s;
1065 m_life.emplace_back(e);
1071 if (before->end + 1 == s &&
1072 life_found->start - 1 == s)
1075 before->end = life_found->end;
1076 m_life.erase(m_life.begin()+i);
1079 if (before->end + 1 == s)
1085 /* already contained */
1086 if (before->end >= s)
1090 if (life_found->start - 1 == s)
1092 life_found->start--;
1095 /* insert a new entry */
1096 new_entry.start = new_entry.end = s;
1097 return insertLife(i, new_entry);
1100 bool ir_value::mergeLife(const ir_value *other)
1104 if (other->m_life.empty())
1107 if (m_life.empty()) {
1108 m_life = other->m_life;
1113 for (i = 0; i < other->m_life.size(); ++i)
1115 const ir_life_entry_t &otherlife = other->m_life[i];
1118 ir_life_entry_t *entry = &m_life[myi];
1120 if (otherlife.end+1 < entry->start)
1122 /* adding an interval before entry */
1123 if (!insertLife(myi, otherlife))
1129 if (otherlife.start < entry->start &&
1130 otherlife.end+1 >= entry->start)
1132 /* starts earlier and overlaps */
1133 entry->start = otherlife.start;
1136 if (otherlife.end > entry->end &&
1137 otherlife.start <= entry->end+1)
1139 /* ends later and overlaps */
1140 entry->end = otherlife.end;
1143 /* see if our change combines it with the next ranges */
1144 while (myi+1 < m_life.size() &&
1145 entry->end+1 >= m_life[1+myi].start)
1147 /* overlaps with (myi+1) */
1148 if (entry->end < m_life[1+myi].end)
1149 entry->end = m_life[1+myi].end;
1150 m_life.erase(m_life.begin() + (myi + 1));
1151 entry = &m_life[myi];
1154 /* see if we're after the entry */
1155 if (otherlife.start > entry->end)
1158 /* append if we're at the end */
1159 if (myi >= m_life.size()) {
1160 m_life.emplace_back(otherlife);
1163 /* otherweise check the next range */
1172 static bool ir_values_overlap(const ir_value *a, const ir_value *b)
1174 /* For any life entry in A see if it overlaps with
1175 * any life entry in B.
1176 * Note that the life entries are orderes, so we can make a
1177 * more efficient algorithm there than naively translating the
1181 const ir_life_entry_t *la, *lb, *enda, *endb;
1183 /* first of all, if either has no life range, they cannot clash */
1184 if (a->m_life.empty() || b->m_life.empty())
1187 la = &a->m_life.front();
1188 lb = &b->m_life.front();
1189 enda = &a->m_life.back() + 1;
1190 endb = &b->m_life.back() + 1;
1193 /* check if the entries overlap, for that,
1194 * both must start before the other one ends.
1196 if (la->start < lb->end &&
1197 lb->start < la->end)
1202 /* entries are ordered
1203 * one entry is earlier than the other
1204 * that earlier entry will be moved forward
1206 if (la->start < lb->start)
1208 /* order: A B, move A forward
1209 * check if we hit the end with A
1214 else /* if (lb->start < la->start) actually <= */
1216 /* order: B A, move B forward
1217 * check if we hit the end with B
1226 /***********************************************************************
1230 static bool ir_check_unreachable(ir_block *self)
1232 /* The IR should never have to deal with unreachable code */
1233 if (!self->m_final/* || OPTS_FLAG(ALLOW_UNREACHABLE_CODE)*/)
1235 irerror(self->m_context, "unreachable statement (%s)", self->m_label.c_str());
1239 bool ir_block_create_store_op(ir_block *self, lex_ctx_t ctx, int op, ir_value *target, ir_value *what)
1242 if (!ir_check_unreachable(self))
1245 if (target->m_store == store_value &&
1246 (op < INSTR_STOREP_F || op > INSTR_STOREP_FNC))
1248 irerror(self->m_context, "cannot store to an SSA value");
1249 irerror(self->m_context, "trying to store: %s <- %s", target->m_name.c_str(), what->m_name.c_str());
1250 irerror(self->m_context, "instruction: %s", util_instr_str[op]);
1254 in = new ir_instr(ctx, self, op);
1258 if (!ir_instr_op(in, 0, target, (op < INSTR_STOREP_F || op > INSTR_STOREP_FNC)) ||
1259 !ir_instr_op(in, 1, what, false))
1264 self->m_instr.push_back(in);
1268 bool ir_block_create_state_op(ir_block *self, lex_ctx_t ctx, ir_value *frame, ir_value *think)
1271 if (!ir_check_unreachable(self))
1274 in = new ir_instr(ctx, self, INSTR_STATE);
1278 if (!ir_instr_op(in, 0, frame, false) ||
1279 !ir_instr_op(in, 1, think, false))
1284 self->m_instr.push_back(in);
1288 static bool ir_block_create_store(ir_block *self, lex_ctx_t ctx, ir_value *target, ir_value *what)
1292 if (target->m_vtype == TYPE_VARIANT)
1293 vtype = what->m_vtype;
1295 vtype = target->m_vtype;
1298 if (vtype == TYPE_FLOAT && what->m_vtype == TYPE_INTEGER)
1299 op = INSTR_CONV_ITOF;
1300 else if (vtype == TYPE_INTEGER && what->m_vtype == TYPE_FLOAT)
1301 op = INSTR_CONV_FTOI;
1303 op = type_store_instr[vtype];
1305 if (OPTS_FLAG(ADJUST_VECTOR_FIELDS)) {
1306 if (op == INSTR_STORE_FLD && what->m_fieldtype == TYPE_VECTOR)
1310 return ir_block_create_store_op(self, ctx, op, target, what);
1313 bool ir_block_create_storep(ir_block *self, lex_ctx_t ctx, ir_value *target, ir_value *what)
1318 if (target->m_vtype != TYPE_POINTER)
1321 /* storing using pointer - target is a pointer, type must be
1322 * inferred from source
1324 vtype = what->m_vtype;
1326 op = type_storep_instr[vtype];
1327 if (OPTS_FLAG(ADJUST_VECTOR_FIELDS)) {
1328 if (op == INSTR_STOREP_FLD && what->m_fieldtype == TYPE_VECTOR)
1329 op = INSTR_STOREP_V;
1332 return ir_block_create_store_op(self, ctx, op, target, what);
1335 bool ir_block_create_return(ir_block *self, lex_ctx_t ctx, ir_value *v)
1338 if (!ir_check_unreachable(self))
1341 self->m_final = true;
1343 self->m_is_return = true;
1344 in = new ir_instr(ctx, self, INSTR_RETURN);
1348 if (v && !ir_instr_op(in, 0, v, false)) {
1353 self->m_instr.push_back(in);
1357 bool ir_block_create_if(ir_block *self, lex_ctx_t ctx, ir_value *v,
1358 ir_block *ontrue, ir_block *onfalse)
1361 if (!ir_check_unreachable(self))
1363 self->m_final = true;
1364 /*in = new ir_instr(ctx, self, (v->m_vtype == TYPE_STRING ? INSTR_IF_S : INSTR_IF_F));*/
1365 in = new ir_instr(ctx, self, VINSTR_COND);
1369 if (!ir_instr_op(in, 0, v, false)) {
1374 in->m_bops[0] = ontrue;
1375 in->m_bops[1] = onfalse;
1377 self->m_instr.push_back(in);
1379 self->m_exits.push_back(ontrue);
1380 self->m_exits.push_back(onfalse);
1381 ontrue->m_entries.push_back(self);
1382 onfalse->m_entries.push_back(self);
1386 bool ir_block_create_jump(ir_block *self, lex_ctx_t ctx, ir_block *to)
1389 if (!ir_check_unreachable(self))
1391 self->m_final = true;
1392 in = new ir_instr(ctx, self, VINSTR_JUMP);
1397 self->m_instr.push_back(in);
1399 self->m_exits.push_back(to);
1400 to->m_entries.push_back(self);
1404 bool ir_block_create_goto(ir_block *self, lex_ctx_t ctx, ir_block *to)
1406 self->m_owner->m_flags |= IR_FLAG_HAS_GOTO;
1407 return ir_block_create_jump(self, ctx, to);
1410 ir_instr* ir_block_create_phi(ir_block *self, lex_ctx_t ctx, const char *label, qc_type ot)
1414 if (!ir_check_unreachable(self))
1416 in = new ir_instr(ctx, self, VINSTR_PHI);
1419 out = new ir_value(self->m_owner, label ? label : "", store_value, ot);
1424 if (!ir_instr_op(in, 0, out, true)) {
1428 self->m_instr.push_back(in);
1432 ir_value* ir_phi_value(ir_instr *self)
1434 return self->_m_ops[0];
1437 void ir_phi_add(ir_instr* self, ir_block *b, ir_value *v)
1441 if (!vec_ir_block_find(self->m_owner->m_entries, b, nullptr)) {
1442 // Must not be possible to cause this, otherwise the AST
1443 // is doing something wrong.
1444 irerror(self->m_context, "Invalid entry block for PHI");
1450 v->m_reads.push_back(self);
1451 self->m_phi.push_back(pe);
1454 /* call related code */
1455 ir_instr* ir_block_create_call(ir_block *self, lex_ctx_t ctx, const char *label, ir_value *func, bool noreturn)
1459 if (!ir_check_unreachable(self))
1461 in = new ir_instr(ctx, self, (noreturn ? VINSTR_NRCALL : INSTR_CALL0));
1465 self->m_final = true;
1466 self->m_is_return = true;
1468 out = new ir_value(self->m_owner, label ? label : "", (func->m_outtype == TYPE_VOID) ? store_return : store_value, func->m_outtype);
1473 if (!ir_instr_op(in, 0, out, true) ||
1474 !ir_instr_op(in, 1, func, false))
1479 self->m_instr.push_back(in);
1482 if (!ir_block_create_return(self, ctx, nullptr)) {
1483 compile_error(ctx, "internal error: failed to generate dummy-return instruction");
1492 ir_value* ir_call_value(ir_instr *self)
1494 return self->_m_ops[0];
1497 void ir_call_param(ir_instr* self, ir_value *v)
1499 self->m_params.push_back(v);
1500 v->m_reads.push_back(self);
1503 /* binary op related code */
1505 ir_value* ir_block_create_binop(ir_block *self, lex_ctx_t ctx,
1506 const char *label, int opcode,
1507 ir_value *left, ir_value *right)
1509 qc_type ot = TYPE_VOID;
1530 case INSTR_SUB_S: /* -- offset of string as float */
1535 case INSTR_BITOR_IF:
1536 case INSTR_BITOR_FI:
1537 case INSTR_BITAND_FI:
1538 case INSTR_BITAND_IF:
1553 case INSTR_BITAND_I:
1556 case INSTR_RSHIFT_I:
1557 case INSTR_LSHIFT_I:
1565 case VINSTR_BITAND_V:
1566 case VINSTR_BITOR_V:
1567 case VINSTR_BITXOR_V:
1568 case VINSTR_BITAND_VF:
1569 case VINSTR_BITOR_VF:
1570 case VINSTR_BITXOR_VF:
1585 * after the following default case, the value of opcode can never
1586 * be 1, 2, 3, 4, 5, 6, 7, 8, 9, 62, 63, 64, 65
1590 /* boolean operations result in floats */
1593 * opcode >= 10 takes true branch opcode is at least 10
1594 * opcode <= 23 takes false branch opcode is at least 24
1596 if (opcode >= INSTR_EQ_F && opcode <= INSTR_GT)
1600 * At condition "opcode <= 23", the value of "opcode" must be
1602 * At condition "opcode <= 23", the value of "opcode" cannot be
1603 * equal to any of {1, 2, 3, 4, 5, 6, 7, 8, 9, 62, 63, 64, 65}.
1604 * The condition "opcode <= 23" cannot be true.
1606 * Thus ot=2 (TYPE_FLOAT) can never be true
1609 else if (opcode >= INSTR_LE && opcode <= INSTR_GT)
1611 else if (opcode >= INSTR_LE_I && opcode <= INSTR_EQ_FI)
1616 if (ot == TYPE_VOID) {
1617 /* The AST or parser were supposed to check this! */
1621 return ir_block_create_general_instr(self, ctx, label, opcode, left, right, ot);
1624 ir_value* ir_block_create_unary(ir_block *self, lex_ctx_t ctx,
1625 const char *label, int opcode,
1628 qc_type ot = TYPE_FLOAT;
1634 case INSTR_NOT_FNC: /*
1635 case INSTR_NOT_I: */
1640 * Negation for virtual instructions is emulated with 0-value. Thankfully
1641 * the operand for 0 already exists so we just source it from here.
1644 return ir_block_create_general_instr(self, ctx, label, INSTR_SUB_F, nullptr, operand, ot);
1646 return ir_block_create_general_instr(self, ctx, label, INSTR_SUB_V, self->m_owner->m_owner->m_nil, operand, TYPE_VECTOR);
1649 ot = operand->m_vtype;
1652 if (ot == TYPE_VOID) {
1653 /* The AST or parser were supposed to check this! */
1657 /* let's use the general instruction creator and pass nullptr for OPB */
1658 return ir_block_create_general_instr(self, ctx, label, opcode, operand, nullptr, ot);
1661 static ir_value* ir_block_create_general_instr(ir_block *self, lex_ctx_t ctx, const char *label,
1662 int op, ir_value *a, ir_value *b, qc_type outype)
1667 out = new ir_value(self->m_owner, label ? label : "", store_value, outype);
1671 instr = new ir_instr(ctx, self, op);
1676 if (!ir_instr_op(instr, 0, out, true) ||
1677 !ir_instr_op(instr, 1, a, false) ||
1678 !ir_instr_op(instr, 2, b, false) )
1683 self->m_instr.push_back(instr);
1691 ir_value* ir_block_create_fieldaddress(ir_block *self, lex_ctx_t ctx, const char *label, ir_value *ent, ir_value *field)
1695 /* Support for various pointer types todo if so desired */
1696 if (ent->m_vtype != TYPE_ENTITY)
1699 if (field->m_vtype != TYPE_FIELD)
1702 v = ir_block_create_general_instr(self, ctx, label, INSTR_ADDRESS, ent, field, TYPE_POINTER);
1703 v->m_fieldtype = field->m_fieldtype;
1707 ir_value* ir_block_create_load_from_ent(ir_block *self, lex_ctx_t ctx, const char *label, ir_value *ent, ir_value *field, qc_type outype)
1710 if (ent->m_vtype != TYPE_ENTITY)
1713 /* at some point we could redirect for TYPE_POINTER... but that could lead to carelessness */
1714 if (field->m_vtype != TYPE_FIELD)
1719 case TYPE_FLOAT: op = INSTR_LOAD_F; break;
1720 case TYPE_VECTOR: op = INSTR_LOAD_V; break;
1721 case TYPE_STRING: op = INSTR_LOAD_S; break;
1722 case TYPE_FIELD: op = INSTR_LOAD_FLD; break;
1723 case TYPE_ENTITY: op = INSTR_LOAD_ENT; break;
1724 case TYPE_FUNCTION: op = INSTR_LOAD_FNC; break;
1726 case TYPE_POINTER: op = INSTR_LOAD_I; break;
1727 case TYPE_INTEGER: op = INSTR_LOAD_I; break;
1730 irerror(self->m_context, "invalid type for ir_block_create_load_from_ent: %s", type_name[outype]);
1734 return ir_block_create_general_instr(self, ctx, label, op, ent, field, outype);
1737 /* PHI resolving breaks the SSA, and must thus be the last
1738 * step before life-range calculation.
1741 static bool ir_block_naive_phi(ir_block *self);
1742 bool ir_function_naive_phi(ir_function *self)
1744 for (auto& b : self->m_blocks)
1745 if (!ir_block_naive_phi(b.get()))
1750 static bool ir_block_naive_phi(ir_block *self)
1753 /* FIXME: optionally, create_phi can add the phis
1754 * to a list so we don't need to loop through blocks
1755 * - anyway: "don't optimize YET"
1757 for (i = 0; i < self->m_instr.size(); ++i)
1759 ir_instr *instr = self->m_instr[i];
1760 if (instr->m_opcode != VINSTR_PHI)
1763 self->m_instr.erase(self->m_instr.begin()+i);
1764 --i; /* NOTE: i+1 below */
1766 for (auto &it : instr->m_phi) {
1767 ir_value *v = it.value;
1768 ir_block *b = it.from;
1769 if (v->m_store == store_value && v->m_reads.size() == 1 && v->m_writes.size() == 1) {
1770 /* replace the value */
1771 if (!ir_instr_op(v->m_writes[0], 0, instr->_m_ops[0], true))
1774 /* force a move instruction */
1775 ir_instr *prevjump = b->m_instr.back();
1776 b->m_instr.pop_back();
1778 instr->_m_ops[0]->m_store = store_global;
1779 if (!ir_block_create_store(b, instr->m_context, instr->_m_ops[0], v))
1781 instr->_m_ops[0]->m_store = store_value;
1782 b->m_instr.push_back(prevjump);
1791 /***********************************************************************
1792 *IR Temp allocation code
1793 * Propagating value life ranges by walking through the function backwards
1794 * until no more changes are made.
1795 * In theory this should happen once more than once for every nested loop
1797 * Though this implementation might run an additional time for if nests.
1800 /* Enumerate instructions used by value's life-ranges
1802 static void ir_block_enumerate(ir_block *self, size_t *_eid)
1805 for (auto &i : self->m_instr)
1810 /* Enumerate blocks and instructions.
1811 * The block-enumeration is unordered!
1812 * We do not really use the block enumreation, however
1813 * the instruction enumeration is important for life-ranges.
1815 void ir_function_enumerate(ir_function *self)
1817 size_t instruction_id = 0;
1818 size_t block_eid = 0;
1819 for (auto& block : self->m_blocks)
1821 /* each block now gets an additional "entry" instruction id
1822 * we can use to avoid point-life issues
1824 block->m_entry_id = instruction_id;
1825 block->m_eid = block_eid;
1829 ir_block_enumerate(block.get(), &instruction_id);
1833 /* Local-value allocator
1834 * After finishing creating the liferange of all values used in a function
1835 * we can allocate their global-positions.
1836 * This is the counterpart to register-allocation in register machines.
1838 struct function_allocator {
1839 std::vector<std::unique_ptr<ir_value>> locals;
1840 std::vector<size_t> sizes;
1841 std::vector<size_t> positions;
1842 std::vector<bool> unique;
1845 static bool function_allocator_alloc(function_allocator *alloc, ir_value *var)
1848 size_t vsize = var->size();
1850 var->m_code.local = alloc->locals.size();
1852 slot = new ir_value("reg", store_global, var->m_vtype);
1856 if (!slot->mergeLife(var))
1859 alloc->locals.emplace_back(slot);
1860 alloc->sizes.push_back(vsize);
1861 alloc->unique.push_back(var->m_unique_life);
1870 static bool ir_function_allocator_assign(ir_function *self, function_allocator *alloc, ir_value *v)
1874 if (v->m_unique_life)
1875 return function_allocator_alloc(alloc, v);
1877 for (a = 0; a < alloc->locals.size(); ++a)
1879 /* if it's reserved for a unique liferange: skip */
1880 if (alloc->unique[a])
1883 ir_value *slot = alloc->locals[a].get();
1885 /* never resize parameters
1886 * will be required later when overlapping temps + locals
1888 if (a < self->m_params.size() &&
1889 alloc->sizes[a] < v->size())
1894 if (ir_values_overlap(v, slot))
1897 if (!slot->mergeLife(v))
1900 /* adjust size for this slot */
1901 if (alloc->sizes[a] < v->size())
1902 alloc->sizes[a] = v->size();
1904 v->m_code.local = a;
1907 if (a >= alloc->locals.size()) {
1908 if (!function_allocator_alloc(alloc, v))
1914 bool ir_function_allocate_locals(ir_function *self)
1917 bool opt_gt = OPTS_OPTIMIZATION(OPTIM_GLOBAL_TEMPS);
1919 function_allocator lockalloc, globalloc;
1921 if (self->m_locals.empty() && self->m_values.empty())
1925 for (i = 0; i < self->m_locals.size(); ++i)
1927 ir_value *v = self->m_locals[i].get();
1928 if ((self->m_flags & IR_FLAG_MASK_NO_LOCAL_TEMPS) || !OPTS_OPTIMIZATION(OPTIM_LOCAL_TEMPS)) {
1930 v->m_unique_life = true;
1932 else if (i >= self->m_params.size())
1935 v->m_locked = true; /* lock parameters locals */
1936 if (!function_allocator_alloc((v->m_locked || !opt_gt ? &lockalloc : &globalloc), v))
1939 for (; i < self->m_locals.size(); ++i)
1941 ir_value *v = self->m_locals[i].get();
1942 if (v->m_life.empty())
1944 if (!ir_function_allocator_assign(self, (v->m_locked || !opt_gt ? &lockalloc : &globalloc), v))
1948 /* Allocate a slot for any value that still exists */
1949 for (i = 0; i < self->m_values.size(); ++i)
1951 ir_value *v = self->m_values[i].get();
1953 if (v->m_life.empty())
1956 /* CALL optimization:
1957 * If the value is a parameter-temp: 1 write, 1 read from a CALL
1958 * and it's not "locked", write it to the OFS_PARM directly.
1960 if (OPTS_OPTIMIZATION(OPTIM_CALL_STORES) && !v->m_locked && !v->m_unique_life) {
1961 if (v->m_reads.size() == 1 && v->m_writes.size() == 1 &&
1962 (v->m_reads[0]->m_opcode == VINSTR_NRCALL ||
1963 (v->m_reads[0]->m_opcode >= INSTR_CALL0 && v->m_reads[0]->m_opcode <= INSTR_CALL8)
1968 ir_instr *call = v->m_reads[0];
1969 if (!vec_ir_value_find(call->m_params, v, ¶m)) {
1970 irerror(call->m_context, "internal error: unlocked parameter %s not found", v->m_name.c_str());
1973 ++opts_optimizationcount[OPTIM_CALL_STORES];
1974 v->m_callparam = true;
1976 v->setCodeAddress(OFS_PARM0 + 3*param);
1978 size_t nprotos = self->m_owner->m_extparam_protos.size();
1981 if (nprotos > param)
1982 ep = self->m_owner->m_extparam_protos[param].get();
1985 ep = self->m_owner->generateExtparamProto();
1986 while (++nprotos <= param)
1987 ep = self->m_owner->generateExtparamProto();
1989 ir_instr_op(v->m_writes[0], 0, ep, true);
1990 call->m_params[param+8] = ep;
1994 if (v->m_writes.size() == 1 && v->m_writes[0]->m_opcode == INSTR_CALL0) {
1995 v->m_store = store_return;
1996 if (v->m_members[0]) v->m_members[0]->m_store = store_return;
1997 if (v->m_members[1]) v->m_members[1]->m_store = store_return;
1998 if (v->m_members[2]) v->m_members[2]->m_store = store_return;
1999 ++opts_optimizationcount[OPTIM_CALL_STORES];
2004 if (!ir_function_allocator_assign(self, (v->m_locked || !opt_gt ? &lockalloc : &globalloc), v))
2008 if (lockalloc.sizes.empty() && globalloc.sizes.empty())
2011 lockalloc.positions.push_back(0);
2012 globalloc.positions.push_back(0);
2014 /* Adjust slot positions based on sizes */
2015 if (!lockalloc.sizes.empty()) {
2016 pos = (lockalloc.sizes.size() ? lockalloc.positions[0] : 0);
2017 for (i = 1; i < lockalloc.sizes.size(); ++i)
2019 pos = lockalloc.positions[i-1] + lockalloc.sizes[i-1];
2020 lockalloc.positions.push_back(pos);
2022 self->m_allocated_locals = pos + lockalloc.sizes.back();
2024 if (!globalloc.sizes.empty()) {
2025 pos = (globalloc.sizes.size() ? globalloc.positions[0] : 0);
2026 for (i = 1; i < globalloc.sizes.size(); ++i)
2028 pos = globalloc.positions[i-1] + globalloc.sizes[i-1];
2029 globalloc.positions.push_back(pos);
2031 self->m_globaltemps = pos + globalloc.sizes.back();
2034 /* Locals need to know their new position */
2035 for (auto& local : self->m_locals) {
2036 if (local->m_locked || !opt_gt)
2037 local->m_code.local = lockalloc.positions[local->m_code.local];
2039 local->m_code.local = globalloc.positions[local->m_code.local];
2041 /* Take over the actual slot positions on values */
2042 for (auto& value : self->m_values) {
2043 if (value->m_locked || !opt_gt)
2044 value->m_code.local = lockalloc.positions[value->m_code.local];
2046 value->m_code.local = globalloc.positions[value->m_code.local];
2052 /* Get information about which operand
2053 * is read from, or written to.
2055 static void ir_op_read_write(int op, size_t *read, size_t *write)
2075 case INSTR_STOREP_F:
2076 case INSTR_STOREP_V:
2077 case INSTR_STOREP_S:
2078 case INSTR_STOREP_ENT:
2079 case INSTR_STOREP_FLD:
2080 case INSTR_STOREP_FNC:
2091 static bool ir_block_living_add_instr(ir_block *self, size_t eid) {
2092 bool changed = false;
2093 for (auto &it : self->m_living)
2094 if (it->setAlive(eid))
2099 static bool ir_block_living_lock(ir_block *self) {
2100 bool changed = false;
2101 for (auto &it : self->m_living) {
2104 it->m_locked = true;
2110 static bool ir_block_life_propagate(ir_block *self, bool *changed)
2115 // bitmasks which operands are read from or written to
2118 self->m_living.clear();
2120 for (auto &prev : self->m_exits) {
2121 for (auto &it : prev->m_living)
2122 if (!vec_ir_value_find(self->m_living, it, nullptr))
2123 self->m_living.push_back(it);
2126 i = self->m_instr.size();
2129 instr = self->m_instr[i];
2131 /* See which operands are read and write operands */
2132 ir_op_read_write(instr->m_opcode, &read, &write);
2134 /* Go through the 3 main operands
2135 * writes first, then reads
2137 for (o = 0; o < 3; ++o)
2139 if (!instr->_m_ops[o]) /* no such operand */
2142 value = instr->_m_ops[o];
2144 /* We only care about locals */
2145 /* we also calculate parameter liferanges so that locals
2146 * can take up parameter slots */
2147 if (value->m_store != store_value &&
2148 value->m_store != store_local &&
2149 value->m_store != store_param)
2152 /* write operands */
2153 /* When we write to a local, we consider it "dead" for the
2154 * remaining upper part of the function, since in SSA a value
2155 * can only be written once (== created)
2160 bool in_living = vec_ir_value_find(self->m_living, value, &idx);
2163 /* If the value isn't alive it hasn't been read before... */
2164 /* TODO: See if the warning can be emitted during parsing or AST processing
2165 * otherwise have warning printed here.
2166 * IF printing a warning here: include filecontext_t,
2167 * and make sure it's only printed once
2168 * since this function is run multiple times.
2170 /* con_err( "Value only written %s\n", value->m_name); */
2171 if (value->setAlive(instr->m_eid))
2174 /* since 'living' won't contain it
2175 * anymore, merge the value, since
2178 if (value->setAlive(instr->m_eid))
2181 self->m_living.erase(self->m_living.begin() + idx);
2183 /* Removing a vector removes all members */
2184 for (mem = 0; mem < 3; ++mem) {
2185 if (value->m_members[mem] && vec_ir_value_find(self->m_living, value->m_members[mem], &idx)) {
2186 if (value->m_members[mem]->setAlive(instr->m_eid))
2188 self->m_living.erase(self->m_living.begin() + idx);
2191 /* Removing the last member removes the vector */
2192 if (value->m_memberof) {
2193 value = value->m_memberof;
2194 for (mem = 0; mem < 3; ++mem) {
2195 if (value->m_members[mem] && vec_ir_value_find(self->m_living, value->m_members[mem], nullptr))
2198 if (mem == 3 && vec_ir_value_find(self->m_living, value, &idx)) {
2199 if (value->setAlive(instr->m_eid))
2201 self->m_living.erase(self->m_living.begin() + idx);
2207 /* These operations need a special case as they can break when using
2208 * same source and destination operand otherwise, as the engine may
2209 * read the source multiple times. */
2210 if (instr->m_opcode == INSTR_MUL_VF ||
2211 instr->m_opcode == VINSTR_BITAND_VF ||
2212 instr->m_opcode == VINSTR_BITOR_VF ||
2213 instr->m_opcode == VINSTR_BITXOR ||
2214 instr->m_opcode == VINSTR_BITXOR_VF ||
2215 instr->m_opcode == VINSTR_BITXOR_V ||
2216 instr->m_opcode == VINSTR_CROSS)
2218 value = instr->_m_ops[2];
2219 /* the float source will get an additional lifetime */
2220 if (value->setAlive(instr->m_eid+1))
2222 if (value->m_memberof && value->m_memberof->setAlive(instr->m_eid+1))
2226 if (instr->m_opcode == INSTR_MUL_FV ||
2227 instr->m_opcode == INSTR_LOAD_V ||
2228 instr->m_opcode == VINSTR_BITXOR ||
2229 instr->m_opcode == VINSTR_BITXOR_VF ||
2230 instr->m_opcode == VINSTR_BITXOR_V ||
2231 instr->m_opcode == VINSTR_CROSS)
2233 value = instr->_m_ops[1];
2234 /* the float source will get an additional lifetime */
2235 if (value->setAlive(instr->m_eid+1))
2237 if (value->m_memberof && value->m_memberof->setAlive(instr->m_eid+1))
2241 for (o = 0; o < 3; ++o)
2243 if (!instr->_m_ops[o]) /* no such operand */
2246 value = instr->_m_ops[o];
2248 /* We only care about locals */
2249 /* we also calculate parameter liferanges so that locals
2250 * can take up parameter slots */
2251 if (value->m_store != store_value &&
2252 value->m_store != store_local &&
2253 value->m_store != store_param)
2259 if (!vec_ir_value_find(self->m_living, value, nullptr))
2260 self->m_living.push_back(value);
2261 /* reading adds the full vector */
2262 if (value->m_memberof && !vec_ir_value_find(self->m_living, value->m_memberof, nullptr))
2263 self->m_living.push_back(value->m_memberof);
2264 for (mem = 0; mem < 3; ++mem) {
2265 if (value->m_members[mem] && !vec_ir_value_find(self->m_living, value->m_members[mem], nullptr))
2266 self->m_living.push_back(value->m_members[mem]);
2270 /* PHI operands are always read operands */
2271 for (auto &it : instr->m_phi) {
2273 if (!vec_ir_value_find(self->m_living, value, nullptr))
2274 self->m_living.push_back(value);
2275 /* reading adds the full vector */
2276 if (value->m_memberof && !vec_ir_value_find(self->m_living, value->m_memberof, nullptr))
2277 self->m_living.push_back(value->m_memberof);
2278 for (mem = 0; mem < 3; ++mem) {
2279 if (value->m_members[mem] && !vec_ir_value_find(self->m_living, value->m_members[mem], nullptr))
2280 self->m_living.push_back(value->m_members[mem]);
2284 /* on a call, all these values must be "locked" */
2285 if (instr->m_opcode >= INSTR_CALL0 && instr->m_opcode <= INSTR_CALL8) {
2286 if (ir_block_living_lock(self))
2289 /* call params are read operands too */
2290 for (auto &it : instr->m_params) {
2292 if (!vec_ir_value_find(self->m_living, value, nullptr))
2293 self->m_living.push_back(value);
2294 /* reading adds the full vector */
2295 if (value->m_memberof && !vec_ir_value_find(self->m_living, value->m_memberof, nullptr))
2296 self->m_living.push_back(value->m_memberof);
2297 for (mem = 0; mem < 3; ++mem) {
2298 if (value->m_members[mem] && !vec_ir_value_find(self->m_living, value->m_members[mem], nullptr))
2299 self->m_living.push_back(value->m_members[mem]);
2304 if (ir_block_living_add_instr(self, instr->m_eid))
2307 /* the "entry" instruction ID */
2308 if (ir_block_living_add_instr(self, self->m_entry_id))
2314 bool ir_function_calculate_liferanges(ir_function *self)
2316 /* parameters live at 0 */
2317 for (size_t i = 0; i < self->m_params.size(); ++i)
2318 if (!self->m_locals[i].get()->setAlive(0))
2319 compile_error(self->m_context, "internal error: failed value-life merging");
2325 for (auto i = self->m_blocks.rbegin(); i != self->m_blocks.rend(); ++i)
2326 ir_block_life_propagate(i->get(), &changed);
2329 if (self->m_blocks.size()) {
2330 ir_block *block = self->m_blocks[0].get();
2331 for (auto &it : block->m_living) {
2333 if (v->m_store != store_local)
2335 if (v->m_vtype == TYPE_VECTOR)
2337 self->m_flags |= IR_FLAG_HAS_UNINITIALIZED;
2338 /* find the instruction reading from it */
2340 for (; s < v->m_reads.size(); ++s) {
2341 if (v->m_reads[s]->m_eid == v->m_life[0].end)
2344 if (s < v->m_reads.size()) {
2345 if (irwarning(v->m_context, WARN_USED_UNINITIALIZED,
2346 "variable `%s` may be used uninitialized in this function\n"
2349 v->m_reads[s]->m_context.file, v->m_reads[s]->m_context.line)
2356 if (v->m_memberof) {
2357 ir_value *vec = v->m_memberof;
2358 for (s = 0; s < vec->m_reads.size(); ++s) {
2359 if (vec->m_reads[s]->m_eid == v->m_life[0].end)
2362 if (s < vec->m_reads.size()) {
2363 if (irwarning(v->m_context, WARN_USED_UNINITIALIZED,
2364 "variable `%s` may be used uninitialized in this function\n"
2367 vec->m_reads[s]->m_context.file, vec->m_reads[s]->m_context.line)
2375 if (irwarning(v->m_context, WARN_USED_UNINITIALIZED,
2376 "variable `%s` may be used uninitialized in this function", v->m_name.c_str()))
2385 /***********************************************************************
2388 * Since the IR has the convention of putting 'write' operands
2389 * at the beginning, we have to rotate the operands of instructions
2390 * properly in order to generate valid QCVM code.
2392 * Having destinations at a fixed position is more convenient. In QC
2393 * this is *mostly* OPC, but FTE adds at least 2 instructions which
2394 * read from from OPA, and store to OPB rather than OPC. Which is
2395 * partially the reason why the implementation of these instructions
2396 * in darkplaces has been delayed for so long.
2398 * Breaking conventions is annoying...
2400 static bool gen_global_field(code_t *code, ir_value *global)
2402 if (global->m_hasvalue)
2404 ir_value *fld = global->m_constval.vpointer;
2406 irerror(global->m_context, "Invalid field constant with no field: %s", global->m_name.c_str());
2410 /* copy the field's value */
2411 global->setCodeAddress(code->globals.size());
2412 code->globals.push_back(fld->m_code.fieldaddr);
2413 if (global->m_fieldtype == TYPE_VECTOR) {
2414 code->globals.push_back(fld->m_code.fieldaddr+1);
2415 code->globals.push_back(fld->m_code.fieldaddr+2);
2420 global->setCodeAddress(code->globals.size());
2421 code->globals.push_back(0);
2422 if (global->m_fieldtype == TYPE_VECTOR) {
2423 code->globals.push_back(0);
2424 code->globals.push_back(0);
2427 if (global->m_code.globaladdr < 0)
2432 static bool gen_global_pointer(code_t *code, ir_value *global)
2434 if (global->m_hasvalue)
2436 ir_value *target = global->m_constval.vpointer;
2438 irerror(global->m_context, "Invalid pointer constant: %s", global->m_name.c_str());
2439 /* nullptr pointers are pointing to the nullptr constant, which also
2440 * sits at address 0, but still has an ir_value for itself.
2445 /* Here, relocations ARE possible - in fteqcc-enhanced-qc:
2446 * void() foo; <- proto
2447 * void() *fooptr = &foo;
2448 * void() foo = { code }
2450 if (!target->m_code.globaladdr) {
2451 /* FIXME: Check for the constant nullptr ir_value!
2452 * because then code.globaladdr being 0 is valid.
2454 irerror(global->m_context, "FIXME: Relocation support");
2458 global->setCodeAddress(code->globals.size());
2459 code->globals.push_back(target->m_code.globaladdr);
2463 global->setCodeAddress(code->globals.size());
2464 code->globals.push_back(0);
2466 if (global->m_code.globaladdr < 0)
2471 static bool gen_blocks_recursive(code_t *code, ir_function *func, ir_block *block)
2473 prog_section_statement_t stmt;
2482 block->m_generated = true;
2483 block->m_code_start = code->statements.size();
2484 for (i = 0; i < block->m_instr.size(); ++i)
2486 instr = block->m_instr[i];
2488 if (instr->m_opcode == VINSTR_PHI) {
2489 irerror(block->m_context, "cannot generate virtual instruction (phi)");
2493 if (instr->m_opcode == VINSTR_JUMP) {
2494 target = instr->m_bops[0];
2495 /* for uncoditional jumps, if the target hasn't been generated
2496 * yet, we generate them right here.
2498 if (!target->m_generated)
2499 return gen_blocks_recursive(code, func, target);
2501 /* otherwise we generate a jump instruction */
2502 stmt.opcode = INSTR_GOTO;
2503 stmt.o1.s1 = target->m_code_start - code->statements.size();
2506 if (stmt.o1.s1 != 1)
2507 code_push_statement(code, &stmt, instr->m_context);
2509 /* no further instructions can be in this block */
2513 if (instr->m_opcode == VINSTR_BITXOR) {
2514 stmt.opcode = INSTR_BITOR;
2515 stmt.o1.s1 = instr->_m_ops[1]->codeAddress();
2516 stmt.o2.s1 = instr->_m_ops[2]->codeAddress();
2517 stmt.o3.s1 = instr->_m_ops[0]->codeAddress();
2518 code_push_statement(code, &stmt, instr->m_context);
2519 stmt.opcode = INSTR_BITAND;
2520 stmt.o1.s1 = instr->_m_ops[1]->codeAddress();
2521 stmt.o2.s1 = instr->_m_ops[2]->codeAddress();
2522 stmt.o3.s1 = func->m_owner->m_vinstr_temp[0]->codeAddress();
2523 code_push_statement(code, &stmt, instr->m_context);
2524 stmt.opcode = INSTR_SUB_F;
2525 stmt.o1.s1 = instr->_m_ops[0]->codeAddress();
2526 stmt.o2.s1 = func->m_owner->m_vinstr_temp[0]->codeAddress();
2527 stmt.o3.s1 = instr->_m_ops[0]->codeAddress();
2528 code_push_statement(code, &stmt, instr->m_context);
2530 /* instruction generated */
2534 if (instr->m_opcode == VINSTR_BITAND_V) {
2535 stmt.opcode = INSTR_BITAND;
2536 stmt.o1.s1 = instr->_m_ops[1]->codeAddress();
2537 stmt.o2.s1 = instr->_m_ops[2]->codeAddress();
2538 stmt.o3.s1 = instr->_m_ops[0]->codeAddress();
2539 code_push_statement(code, &stmt, instr->m_context);
2543 code_push_statement(code, &stmt, instr->m_context);
2547 code_push_statement(code, &stmt, instr->m_context);
2549 /* instruction generated */
2553 if (instr->m_opcode == VINSTR_BITOR_V) {
2554 stmt.opcode = INSTR_BITOR;
2555 stmt.o1.s1 = instr->_m_ops[1]->codeAddress();
2556 stmt.o2.s1 = instr->_m_ops[2]->codeAddress();
2557 stmt.o3.s1 = instr->_m_ops[0]->codeAddress();
2558 code_push_statement(code, &stmt, instr->m_context);
2562 code_push_statement(code, &stmt, instr->m_context);
2566 code_push_statement(code, &stmt, instr->m_context);
2568 /* instruction generated */
2572 if (instr->m_opcode == VINSTR_BITXOR_V) {
2573 for (j = 0; j < 3; ++j) {
2574 stmt.opcode = INSTR_BITOR;
2575 stmt.o1.s1 = instr->_m_ops[1]->codeAddress() + j;
2576 stmt.o2.s1 = instr->_m_ops[2]->codeAddress() + j;
2577 stmt.o3.s1 = instr->_m_ops[0]->codeAddress() + j;
2578 code_push_statement(code, &stmt, instr->m_context);
2579 stmt.opcode = INSTR_BITAND;
2580 stmt.o1.s1 = instr->_m_ops[1]->codeAddress() + j;
2581 stmt.o2.s1 = instr->_m_ops[2]->codeAddress() + j;
2582 stmt.o3.s1 = func->m_owner->m_vinstr_temp[0]->codeAddress() + j;
2583 code_push_statement(code, &stmt, instr->m_context);
2585 stmt.opcode = INSTR_SUB_V;
2586 stmt.o1.s1 = instr->_m_ops[0]->codeAddress();
2587 stmt.o2.s1 = func->m_owner->m_vinstr_temp[0]->codeAddress();
2588 stmt.o3.s1 = instr->_m_ops[0]->codeAddress();
2589 code_push_statement(code, &stmt, instr->m_context);
2591 /* instruction generated */
2595 if (instr->m_opcode == VINSTR_BITAND_VF) {
2596 stmt.opcode = INSTR_BITAND;
2597 stmt.o1.s1 = instr->_m_ops[1]->codeAddress();
2598 stmt.o2.s1 = instr->_m_ops[2]->codeAddress();
2599 stmt.o3.s1 = instr->_m_ops[0]->codeAddress();
2600 code_push_statement(code, &stmt, instr->m_context);
2603 code_push_statement(code, &stmt, instr->m_context);
2606 code_push_statement(code, &stmt, instr->m_context);
2608 /* instruction generated */
2612 if (instr->m_opcode == VINSTR_BITOR_VF) {
2613 stmt.opcode = INSTR_BITOR;
2614 stmt.o1.s1 = instr->_m_ops[1]->codeAddress();
2615 stmt.o2.s1 = instr->_m_ops[2]->codeAddress();
2616 stmt.o3.s1 = instr->_m_ops[0]->codeAddress();
2617 code_push_statement(code, &stmt, instr->m_context);
2620 code_push_statement(code, &stmt, instr->m_context);
2623 code_push_statement(code, &stmt, instr->m_context);
2625 /* instruction generated */
2629 if (instr->m_opcode == VINSTR_BITXOR_VF) {
2630 for (j = 0; j < 3; ++j) {
2631 stmt.opcode = INSTR_BITOR;
2632 stmt.o1.s1 = instr->_m_ops[1]->codeAddress() + j;
2633 stmt.o2.s1 = instr->_m_ops[2]->codeAddress();
2634 stmt.o3.s1 = instr->_m_ops[0]->codeAddress() + j;
2635 code_push_statement(code, &stmt, instr->m_context);
2636 stmt.opcode = INSTR_BITAND;
2637 stmt.o1.s1 = instr->_m_ops[1]->codeAddress() + j;
2638 stmt.o2.s1 = instr->_m_ops[2]->codeAddress();
2639 stmt.o3.s1 = func->m_owner->m_vinstr_temp[0]->codeAddress() + j;
2640 code_push_statement(code, &stmt, instr->m_context);
2642 stmt.opcode = INSTR_SUB_V;
2643 stmt.o1.s1 = instr->_m_ops[0]->codeAddress();
2644 stmt.o2.s1 = func->m_owner->m_vinstr_temp[0]->codeAddress();
2645 stmt.o3.s1 = instr->_m_ops[0]->codeAddress();
2646 code_push_statement(code, &stmt, instr->m_context);
2648 /* instruction generated */
2652 if (instr->m_opcode == VINSTR_CROSS) {
2653 stmt.opcode = INSTR_MUL_F;
2654 for (j = 0; j < 3; ++j) {
2655 stmt.o1.s1 = instr->_m_ops[1]->codeAddress() + (j + 1) % 3;
2656 stmt.o2.s1 = instr->_m_ops[2]->codeAddress() + (j + 2) % 3;
2657 stmt.o3.s1 = instr->_m_ops[0]->codeAddress() + j;
2658 code_push_statement(code, &stmt, instr->m_context);
2659 stmt.o1.s1 = instr->_m_ops[1]->codeAddress() + (j + 2) % 3;
2660 stmt.o2.s1 = instr->_m_ops[2]->codeAddress() + (j + 1) % 3;
2661 stmt.o3.s1 = func->m_owner->m_vinstr_temp[0]->codeAddress() + j;
2662 code_push_statement(code, &stmt, instr->m_context);
2664 stmt.opcode = INSTR_SUB_V;
2665 stmt.o1.s1 = instr->_m_ops[0]->codeAddress();
2666 stmt.o2.s1 = func->m_owner->m_vinstr_temp[0]->codeAddress();
2667 stmt.o3.s1 = instr->_m_ops[0]->codeAddress();
2668 code_push_statement(code, &stmt, instr->m_context);
2670 /* instruction generated */
2674 if (instr->m_opcode == VINSTR_COND) {
2675 ontrue = instr->m_bops[0];
2676 onfalse = instr->m_bops[1];
2677 /* TODO: have the AST signal which block should
2678 * come first: eg. optimize IFs without ELSE...
2681 stmt.o1.u1 = instr->_m_ops[0]->codeAddress();
2685 if (ontrue->m_generated) {
2686 stmt.opcode = INSTR_IF;
2687 stmt.o2.s1 = ontrue->m_code_start - code->statements.size();
2688 if (stmt.o2.s1 != 1)
2689 code_push_statement(code, &stmt, instr->m_context);
2691 if (onfalse->m_generated) {
2692 stmt.opcode = INSTR_IFNOT;
2693 stmt.o2.s1 = onfalse->m_code_start - code->statements.size();
2694 if (stmt.o2.s1 != 1)
2695 code_push_statement(code, &stmt, instr->m_context);
2697 if (!ontrue->m_generated) {
2698 if (onfalse->m_generated)
2699 return gen_blocks_recursive(code, func, ontrue);
2701 if (!onfalse->m_generated) {
2702 if (ontrue->m_generated)
2703 return gen_blocks_recursive(code, func, onfalse);
2705 /* neither ontrue nor onfalse exist */
2706 stmt.opcode = INSTR_IFNOT;
2707 if (!instr->m_likely) {
2708 /* Honor the likelyhood hint */
2709 ir_block *tmp = onfalse;
2710 stmt.opcode = INSTR_IF;
2714 stidx = code->statements.size();
2715 code_push_statement(code, &stmt, instr->m_context);
2716 /* on false we jump, so add ontrue-path */
2717 if (!gen_blocks_recursive(code, func, ontrue))
2719 /* fixup the jump address */
2720 code->statements[stidx].o2.s1 = code->statements.size() - stidx;
2721 /* generate onfalse path */
2722 if (onfalse->m_generated) {
2723 /* fixup the jump address */
2724 code->statements[stidx].o2.s1 = onfalse->m_code_start - stidx;
2725 if (stidx+2 == code->statements.size() && code->statements[stidx].o2.s1 == 1) {
2726 code->statements[stidx] = code->statements[stidx+1];
2727 if (code->statements[stidx].o1.s1 < 0)
2728 code->statements[stidx].o1.s1++;
2729 code_pop_statement(code);
2731 stmt.opcode = code->statements.back().opcode;
2732 if (stmt.opcode == INSTR_GOTO ||
2733 stmt.opcode == INSTR_IF ||
2734 stmt.opcode == INSTR_IFNOT ||
2735 stmt.opcode == INSTR_RETURN ||
2736 stmt.opcode == INSTR_DONE)
2738 /* no use jumping from here */
2741 /* may have been generated in the previous recursive call */
2742 stmt.opcode = INSTR_GOTO;
2743 stmt.o1.s1 = onfalse->m_code_start - code->statements.size();
2746 if (stmt.o1.s1 != 1)
2747 code_push_statement(code, &stmt, instr->m_context);
2750 else if (stidx+2 == code->statements.size() && code->statements[stidx].o2.s1 == 1) {
2751 code->statements[stidx] = code->statements[stidx+1];
2752 if (code->statements[stidx].o1.s1 < 0)
2753 code->statements[stidx].o1.s1++;
2754 code_pop_statement(code);
2756 /* if not, generate now */
2757 return gen_blocks_recursive(code, func, onfalse);
2760 if ( (instr->m_opcode >= INSTR_CALL0 && instr->m_opcode <= INSTR_CALL8)
2761 || instr->m_opcode == VINSTR_NRCALL)
2766 first = instr->m_params.size();
2769 for (p = 0; p < first; ++p)
2771 ir_value *param = instr->m_params[p];
2772 if (param->m_callparam)
2775 stmt.opcode = INSTR_STORE_F;
2778 if (param->m_vtype == TYPE_FIELD)
2779 stmt.opcode = field_store_instr[param->m_fieldtype];
2780 else if (param->m_vtype == TYPE_NIL)
2781 stmt.opcode = INSTR_STORE_V;
2783 stmt.opcode = type_store_instr[param->m_vtype];
2784 stmt.o1.u1 = param->codeAddress();
2785 stmt.o2.u1 = OFS_PARM0 + 3 * p;
2787 if (param->m_vtype == TYPE_VECTOR && (param->m_flags & IR_FLAG_SPLIT_VECTOR)) {
2788 /* fetch 3 separate floats */
2789 stmt.opcode = INSTR_STORE_F;
2790 stmt.o1.u1 = param->m_members[0]->codeAddress();
2791 code_push_statement(code, &stmt, instr->m_context);
2793 stmt.o1.u1 = param->m_members[1]->codeAddress();
2794 code_push_statement(code, &stmt, instr->m_context);
2796 stmt.o1.u1 = param->m_members[2]->codeAddress();
2797 code_push_statement(code, &stmt, instr->m_context);
2800 code_push_statement(code, &stmt, instr->m_context);
2802 /* Now handle extparams */
2803 first = instr->m_params.size();
2804 for (; p < first; ++p)
2806 ir_builder *ir = func->m_owner;
2807 ir_value *param = instr->m_params[p];
2808 ir_value *targetparam;
2810 if (param->m_callparam)
2813 if (p-8 >= ir->m_extparams.size())
2814 ir->generateExtparam();
2816 targetparam = ir->m_extparams[p-8];
2818 stmt.opcode = INSTR_STORE_F;
2821 if (param->m_vtype == TYPE_FIELD)
2822 stmt.opcode = field_store_instr[param->m_fieldtype];
2823 else if (param->m_vtype == TYPE_NIL)
2824 stmt.opcode = INSTR_STORE_V;
2826 stmt.opcode = type_store_instr[param->m_vtype];
2827 stmt.o1.u1 = param->codeAddress();
2828 stmt.o2.u1 = targetparam->codeAddress();
2829 if (param->m_vtype == TYPE_VECTOR && (param->m_flags & IR_FLAG_SPLIT_VECTOR)) {
2830 /* fetch 3 separate floats */
2831 stmt.opcode = INSTR_STORE_F;
2832 stmt.o1.u1 = param->m_members[0]->codeAddress();
2833 code_push_statement(code, &stmt, instr->m_context);
2835 stmt.o1.u1 = param->m_members[1]->codeAddress();
2836 code_push_statement(code, &stmt, instr->m_context);
2838 stmt.o1.u1 = param->m_members[2]->codeAddress();
2839 code_push_statement(code, &stmt, instr->m_context);
2842 code_push_statement(code, &stmt, instr->m_context);
2845 stmt.opcode = INSTR_CALL0 + instr->m_params.size();
2846 if (stmt.opcode > INSTR_CALL8)
2847 stmt.opcode = INSTR_CALL8;
2848 stmt.o1.u1 = instr->_m_ops[1]->codeAddress();
2851 code_push_statement(code, &stmt, instr->m_context);
2853 retvalue = instr->_m_ops[0];
2854 if (retvalue && retvalue->m_store != store_return &&
2855 (retvalue->m_store == store_global || retvalue->m_life.size()))
2857 /* not to be kept in OFS_RETURN */
2858 if (retvalue->m_vtype == TYPE_FIELD && OPTS_FLAG(ADJUST_VECTOR_FIELDS))
2859 stmt.opcode = field_store_instr[retvalue->m_fieldtype];
2861 stmt.opcode = type_store_instr[retvalue->m_vtype];
2862 stmt.o1.u1 = OFS_RETURN;
2863 stmt.o2.u1 = retvalue->codeAddress();
2865 code_push_statement(code, &stmt, instr->m_context);
2870 if (instr->m_opcode == INSTR_STATE) {
2871 stmt.opcode = instr->m_opcode;
2872 if (instr->_m_ops[0])
2873 stmt.o1.u1 = instr->_m_ops[0]->codeAddress();
2874 if (instr->_m_ops[1])
2875 stmt.o2.u1 = instr->_m_ops[1]->codeAddress();
2877 code_push_statement(code, &stmt, instr->m_context);
2881 stmt.opcode = instr->m_opcode;
2886 /* This is the general order of operands */
2887 if (instr->_m_ops[0])
2888 stmt.o3.u1 = instr->_m_ops[0]->codeAddress();
2890 if (instr->_m_ops[1])
2891 stmt.o1.u1 = instr->_m_ops[1]->codeAddress();
2893 if (instr->_m_ops[2])
2894 stmt.o2.u1 = instr->_m_ops[2]->codeAddress();
2896 if (stmt.opcode == INSTR_RETURN || stmt.opcode == INSTR_DONE)
2898 stmt.o1.u1 = stmt.o3.u1;
2901 else if ((stmt.opcode >= INSTR_STORE_F &&
2902 stmt.opcode <= INSTR_STORE_FNC) ||
2903 (stmt.opcode >= INSTR_STOREP_F &&
2904 stmt.opcode <= INSTR_STOREP_FNC))
2906 /* 2-operand instructions with A -> B */
2907 stmt.o2.u1 = stmt.o3.u1;
2910 /* tiny optimization, don't output
2913 if (stmt.o2.u1 == stmt.o1.u1 &&
2914 OPTS_OPTIMIZATION(OPTIM_PEEPHOLE))
2916 ++opts_optimizationcount[OPTIM_PEEPHOLE];
2920 code_push_statement(code, &stmt, instr->m_context);
2925 static bool gen_function_code(code_t *code, ir_function *self)
2928 prog_section_statement_t stmt, *retst;
2930 /* Starting from entry point, we generate blocks "as they come"
2931 * for now. Dead blocks will not be translated obviously.
2933 if (self->m_blocks.empty()) {
2934 irerror(self->m_context, "Function '%s' declared without body.", self->m_name.c_str());
2938 block = self->m_blocks[0].get();
2939 if (block->m_generated)
2942 if (!gen_blocks_recursive(code, self, block)) {
2943 irerror(self->m_context, "failed to generate blocks for '%s'", self->m_name.c_str());
2947 /* code_write and qcvm -disasm need to know that the function ends here */
2948 retst = &code->statements.back();
2949 if (OPTS_OPTIMIZATION(OPTIM_VOID_RETURN) &&
2950 self->m_outtype == TYPE_VOID &&
2951 retst->opcode == INSTR_RETURN &&
2952 !retst->o1.u1 && !retst->o2.u1 && !retst->o3.u1)
2954 retst->opcode = INSTR_DONE;
2955 ++opts_optimizationcount[OPTIM_VOID_RETURN];
2959 stmt.opcode = INSTR_DONE;
2963 last.line = code->linenums.back();
2964 last.column = code->columnnums.back();
2966 code_push_statement(code, &stmt, last);
2971 qcint_t ir_builder::filestring(const char *filename)
2973 /* NOTE: filename pointers are copied, we never strdup them,
2974 * thus we can use pointer-comparison to find the string.
2978 for (size_t i = 0; i != m_filenames.size(); ++i) {
2979 if (!strcmp(m_filenames[i], filename))
2983 str = code_genstring(m_code.get(), filename);
2984 m_filenames.push_back(filename);
2985 m_filestrings.push_back(str);
2989 bool ir_builder::generateGlobalFunction(ir_value *global)
2991 prog_section_function_t fun;
2996 if (!global->m_hasvalue || (!global->m_constval.vfunc)) {
2997 irerror(global->m_context, "Invalid state of function-global: not constant: %s", global->m_name.c_str());
3001 irfun = global->m_constval.vfunc;
3002 fun.name = global->m_code.name;
3003 fun.file = filestring(global->m_context.file);
3004 fun.profile = 0; /* always 0 */
3005 fun.nargs = irfun->m_params.size();
3009 for (i = 0; i < 8; ++i) {
3010 if ((int32_t)i >= fun.nargs)
3013 fun.argsize[i] = type_sizeof_[irfun->m_params[i]];
3017 fun.locals = irfun->m_allocated_locals;
3019 if (irfun->m_builtin)
3020 fun.entry = irfun->m_builtin+1;
3022 irfun->m_code_function_def = m_code->functions.size();
3023 fun.entry = m_code->statements.size();
3026 m_code->functions.push_back(fun);
3030 ir_value* ir_builder::generateExtparamProto()
3034 util_snprintf(name, sizeof(name), "EXTPARM#%i", (int)(m_extparam_protos.size()));
3035 ir_value *global = new ir_value(name, store_global, TYPE_VECTOR);
3036 m_extparam_protos.emplace_back(global);
3041 void ir_builder::generateExtparam()
3043 prog_section_def_t def;
3046 if (m_extparam_protos.size() < m_extparams.size()+1)
3047 global = generateExtparamProto();
3049 global = m_extparam_protos[m_extparams.size()].get();
3051 def.name = code_genstring(m_code.get(), global->m_name.c_str());
3052 def.type = TYPE_VECTOR;
3053 def.offset = m_code->globals.size();
3055 m_code->defs.push_back(def);
3057 global->setCodeAddress(def.offset);
3059 m_code->globals.push_back(0);
3060 m_code->globals.push_back(0);
3061 m_code->globals.push_back(0);
3063 m_extparams.emplace_back(global);
3066 static bool gen_function_extparam_copy(code_t *code, ir_function *self)
3068 ir_builder *ir = self->m_owner;
3070 size_t numparams = self->m_params.size();
3074 prog_section_statement_t stmt;
3075 stmt.opcode = INSTR_STORE_F;
3077 for (size_t i = 8; i < numparams; ++i) {
3079 if (ext >= ir->m_extparams.size())
3080 ir->generateExtparam();
3082 ir_value *ep = ir->m_extparams[ext];
3084 stmt.opcode = type_store_instr[self->m_locals[i]->m_vtype];
3085 if (self->m_locals[i]->m_vtype == TYPE_FIELD &&
3086 self->m_locals[i]->m_fieldtype == TYPE_VECTOR)
3088 stmt.opcode = INSTR_STORE_V;
3090 stmt.o1.u1 = ep->codeAddress();
3091 stmt.o2.u1 = self->m_locals[i].get()->codeAddress();
3092 code_push_statement(code, &stmt, self->m_context);
3098 static bool gen_function_varargs_copy(code_t *code, ir_function *self)
3100 size_t i, ext, numparams, maxparams;
3102 ir_builder *ir = self->m_owner;
3104 prog_section_statement_t stmt;
3106 numparams = self->m_params.size();
3110 stmt.opcode = INSTR_STORE_V;
3112 maxparams = numparams + self->m_max_varargs;
3113 for (i = numparams; i < maxparams; ++i) {
3115 stmt.o1.u1 = OFS_PARM0 + 3*i;
3116 stmt.o2.u1 = self->m_locals[i].get()->codeAddress();
3117 code_push_statement(code, &stmt, self->m_context);
3121 while (ext >= ir->m_extparams.size())
3122 ir->generateExtparam();
3124 ep = ir->m_extparams[ext];
3126 stmt.o1.u1 = ep->codeAddress();
3127 stmt.o2.u1 = self->m_locals[i].get()->codeAddress();
3128 code_push_statement(code, &stmt, self->m_context);
3134 bool ir_builder::generateFunctionLocals(ir_value *global)
3136 prog_section_function_t *def;
3138 uint32_t firstlocal, firstglobal;
3140 irfun = global->m_constval.vfunc;
3141 def = &m_code->functions[0] + irfun->m_code_function_def;
3143 if (OPTS_OPTION_BOOL(OPTION_G) ||
3144 !OPTS_OPTIMIZATION(OPTIM_OVERLAP_LOCALS) ||
3145 (irfun->m_flags & IR_FLAG_MASK_NO_OVERLAP))
3147 firstlocal = def->firstlocal = m_code->globals.size();
3149 firstlocal = def->firstlocal = m_first_common_local;
3150 ++opts_optimizationcount[OPTIM_OVERLAP_LOCALS];
3153 firstglobal = (OPTS_OPTIMIZATION(OPTIM_GLOBAL_TEMPS) ? m_first_common_globaltemp : firstlocal);
3155 for (size_t i = m_code->globals.size(); i < firstlocal + irfun->m_allocated_locals; ++i)
3156 m_code->globals.push_back(0);
3158 for (auto& lp : irfun->m_locals) {
3159 ir_value *v = lp.get();
3160 if (v->m_locked || !OPTS_OPTIMIZATION(OPTIM_GLOBAL_TEMPS)) {
3161 v->setCodeAddress(firstlocal + v->m_code.local);
3162 if (!generateGlobal(v, true)) {
3163 irerror(v->m_context, "failed to generate local %s", v->m_name.c_str());
3168 v->setCodeAddress(firstglobal + v->m_code.local);
3170 for (auto& vp : irfun->m_values) {
3171 ir_value *v = vp.get();
3175 v->setCodeAddress(firstlocal + v->m_code.local);
3177 v->setCodeAddress(firstglobal + v->m_code.local);
3182 bool ir_builder::generateGlobalFunctionCode(ir_value *global)
3184 prog_section_function_t *fundef;
3187 irfun = global->m_constval.vfunc;
3189 if (global->m_cvq == CV_NONE) {
3190 if (irwarning(global->m_context, WARN_IMPLICIT_FUNCTION_POINTER,
3191 "function `%s` has no body and in QC implicitly becomes a function-pointer",
3192 global->m_name.c_str()))
3194 /* Not bailing out just now. If this happens a lot you don't want to have
3195 * to rerun gmqcc for each such function.
3201 /* this was a function pointer, don't generate code for those */
3205 if (irfun->m_builtin)
3209 * If there is no definition and the thing is eraseable, we can ignore
3210 * outputting the function to begin with.
3212 if (global->m_flags & IR_FLAG_ERASABLE && irfun->m_code_function_def < 0) {
3216 if (irfun->m_code_function_def < 0) {
3217 irerror(irfun->m_context, "`%s`: IR global wasn't generated, failed to access function-def", irfun->m_name.c_str());
3220 fundef = &m_code->functions[irfun->m_code_function_def];
3222 fundef->entry = m_code->statements.size();
3223 if (!generateFunctionLocals(global)) {
3224 irerror(irfun->m_context, "Failed to generate locals for function %s", irfun->m_name.c_str());
3227 if (!gen_function_extparam_copy(m_code.get(), irfun)) {
3228 irerror(irfun->m_context, "Failed to generate extparam-copy code for function %s", irfun->m_name.c_str());
3231 if (irfun->m_max_varargs && !gen_function_varargs_copy(m_code.get(), irfun)) {
3232 irerror(irfun->m_context, "Failed to generate vararg-copy code for function %s", irfun->m_name.c_str());
3235 if (!gen_function_code(m_code.get(), irfun)) {
3236 irerror(irfun->m_context, "Failed to generate code for function %s", irfun->m_name.c_str());
3242 static void gen_vector_defs(code_t *code, prog_section_def_t def, const char *name)
3247 if (!name || name[0] == '#' || OPTS_FLAG(SINGLE_VECTOR_DEFS))
3250 def.type = TYPE_FLOAT;
3254 component = (char*)mem_a(len+3);
3255 memcpy(component, name, len);
3257 component[len-0] = 0;
3258 component[len-2] = '_';
3260 component[len-1] = 'x';
3262 for (i = 0; i < 3; ++i) {
3263 def.name = code_genstring(code, component);
3264 code->defs.push_back(def);
3272 static void gen_vector_fields(code_t *code, prog_section_field_t fld, const char *name)
3277 if (!name || OPTS_FLAG(SINGLE_VECTOR_DEFS))
3280 fld.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 fld.name = code_genstring(code, component);
3294 code->fields.push_back(fld);
3302 bool ir_builder::generateGlobal(ir_value *global, bool islocal)
3306 prog_section_def_t def;
3307 bool pushdef = opts.optimizeoff;
3309 /* we don't generate split-vectors */
3310 if (global->m_vtype == TYPE_VECTOR && (global->m_flags & IR_FLAG_SPLIT_VECTOR))
3313 def.type = global->m_vtype;
3314 def.offset = m_code->globals.size();
3316 if (OPTS_OPTION_BOOL(OPTION_G) || !islocal)
3321 * if we're eraseable and the function isn't referenced ignore outputting
3324 if (global->m_flags & IR_FLAG_ERASABLE && global->m_reads.empty()) {
3328 if (OPTS_OPTIMIZATION(OPTIM_STRIP_CONSTANT_NAMES) &&
3329 !(global->m_flags & IR_FLAG_INCLUDE_DEF) &&
3330 (global->m_name[0] == '#' || global->m_cvq == CV_CONST))
3336 if (global->m_name[0] == '#') {
3337 if (!m_str_immediate)
3338 m_str_immediate = code_genstring(m_code.get(), "IMMEDIATE");
3339 def.name = global->m_code.name = m_str_immediate;
3342 def.name = global->m_code.name = code_genstring(m_code.get(), global->m_name.c_str());
3347 def.offset = global->codeAddress();
3348 m_code->defs.push_back(def);
3349 if (global->m_vtype == TYPE_VECTOR)
3350 gen_vector_defs(m_code.get(), def, global->m_name.c_str());
3351 else if (global->m_vtype == TYPE_FIELD && global->m_fieldtype == TYPE_VECTOR)
3352 gen_vector_defs(m_code.get(), def, global->m_name.c_str());
3359 switch (global->m_vtype)
3362 if (0 == global->m_name.compare("end_sys_globals")) {
3363 // TODO: remember this point... all the defs before this one
3364 // should be checksummed and added to progdefs.h when we generate it.
3366 else if (0 == global->m_name.compare("end_sys_fields")) {
3367 // TODO: same as above but for entity-fields rather than globsl
3369 else if(irwarning(global->m_context, WARN_VOID_VARIABLES, "unrecognized variable of type void `%s`",
3370 global->m_name.c_str()))
3372 /* Not bailing out */
3375 /* I'd argue setting it to 0 is sufficient, but maybe some depend on knowing how far
3376 * the system fields actually go? Though the engine knows this anyway...
3377 * Maybe this could be an -foption
3378 * fteqcc creates data for end_sys_* - of size 1, so let's do the same
3380 global->setCodeAddress(m_code->globals.size());
3381 m_code->globals.push_back(0);
3384 m_code->defs.push_back(def);
3388 m_code->defs.push_back(def);
3389 return gen_global_pointer(m_code.get(), global);
3392 m_code->defs.push_back(def);
3393 if (global->m_fieldtype == TYPE_VECTOR)
3394 gen_vector_defs(m_code.get(), def, global->m_name.c_str());
3396 return gen_global_field(m_code.get(), global);
3401 global->setCodeAddress(m_code->globals.size());
3402 if (global->m_hasvalue) {
3403 if (global->m_cvq == CV_CONST && global->m_reads.empty())
3405 iptr = (int32_t*)&global->m_constval.ivec[0];
3406 m_code->globals.push_back(*iptr);
3408 m_code->globals.push_back(0);
3410 if (!islocal && global->m_cvq != CV_CONST)
3411 def.type |= DEF_SAVEGLOBAL;
3413 m_code->defs.push_back(def);
3415 return global->m_code.globaladdr >= 0;
3419 global->setCodeAddress(m_code->globals.size());
3420 if (global->m_hasvalue) {
3421 if (global->m_cvq == CV_CONST && global->m_reads.empty())
3423 uint32_t load = code_genstring(m_code.get(), global->m_constval.vstring);
3424 m_code->globals.push_back(load);
3426 m_code->globals.push_back(0);
3428 if (!islocal && global->m_cvq != CV_CONST)
3429 def.type |= DEF_SAVEGLOBAL;
3431 m_code->defs.push_back(def);
3432 return global->m_code.globaladdr >= 0;
3437 global->setCodeAddress(m_code->globals.size());
3438 if (global->m_hasvalue) {
3439 iptr = (int32_t*)&global->m_constval.ivec[0];
3440 m_code->globals.push_back(iptr[0]);
3441 if (global->m_code.globaladdr < 0)
3443 for (d = 1; d < type_sizeof_[global->m_vtype]; ++d) {
3444 m_code->globals.push_back(iptr[d]);
3447 m_code->globals.push_back(0);
3448 if (global->m_code.globaladdr < 0)
3450 for (d = 1; d < type_sizeof_[global->m_vtype]; ++d) {
3451 m_code->globals.push_back(0);
3454 if (!islocal && global->m_cvq != CV_CONST)
3455 def.type |= DEF_SAVEGLOBAL;
3458 m_code->defs.push_back(def);
3459 def.type &= ~DEF_SAVEGLOBAL;
3460 gen_vector_defs(m_code.get(), def, global->m_name.c_str());
3462 return global->m_code.globaladdr >= 0;
3465 global->setCodeAddress(m_code->globals.size());
3466 if (!global->m_hasvalue) {
3467 m_code->globals.push_back(0);
3468 if (global->m_code.globaladdr < 0)
3471 m_code->globals.push_back(m_code->functions.size());
3472 if (!generateGlobalFunction(global))
3475 if (!islocal && global->m_cvq != CV_CONST)
3476 def.type |= DEF_SAVEGLOBAL;
3478 m_code->defs.push_back(def);
3481 /* assume biggest type */
3482 global->setCodeAddress(m_code->globals.size());
3483 m_code->globals.push_back(0);
3484 for (i = 1; i < type_sizeof_[TYPE_VARIANT]; ++i)
3485 m_code->globals.push_back(0);
3488 /* refuse to create 'void' type or any other fancy business. */
3489 irerror(global->m_context, "Invalid type for global variable `%s`: %s",
3490 global->m_name.c_str(), type_name[global->m_vtype]);
3495 static GMQCC_INLINE void ir_builder_prepare_field(code_t *code, ir_value *field)
3497 field->m_code.fieldaddr = code_alloc_field(code, type_sizeof_[field->m_fieldtype]);
3500 static bool ir_builder_gen_field(ir_builder *self, ir_value *field)
3502 prog_section_def_t def;
3503 prog_section_field_t fld;
3507 def.type = (uint16_t)field->m_vtype;
3508 def.offset = (uint16_t)self->m_code->globals.size();
3510 /* create a global named the same as the field */
3511 if (OPTS_OPTION_U32(OPTION_STANDARD) == COMPILER_GMQCC) {
3512 /* in our standard, the global gets a dot prefix */
3513 size_t len = field->m_name.length();
3516 /* we really don't want to have to allocate this, and 1024
3517 * bytes is more than enough for a variable/field name
3519 if (len+2 >= sizeof(name)) {
3520 irerror(field->m_context, "invalid field name size: %u", (unsigned int)len);
3525 memcpy(name+1, field->m_name.c_str(), len); // no strncpy - we used strlen above
3528 def.name = code_genstring(self->m_code.get(), name);
3529 fld.name = def.name + 1; /* we reuse that string table entry */
3531 /* in plain QC, there cannot be a global with the same name,
3532 * and so we also name the global the same.
3533 * FIXME: fteqcc should create a global as well
3534 * check if it actually uses the same name. Probably does
3536 def.name = code_genstring(self->m_code.get(), field->m_name.c_str());
3537 fld.name = def.name;
3540 field->m_code.name = def.name;
3542 self->m_code->defs.push_back(def);
3544 fld.type = field->m_fieldtype;
3546 if (fld.type == TYPE_VOID) {
3547 irerror(field->m_context, "field is missing a type: %s - don't know its size", field->m_name.c_str());
3551 fld.offset = field->m_code.fieldaddr;
3553 self->m_code->fields.push_back(fld);
3555 field->setCodeAddress(self->m_code->globals.size());
3556 self->m_code->globals.push_back(fld.offset);
3557 if (fld.type == TYPE_VECTOR) {
3558 self->m_code->globals.push_back(fld.offset+1);
3559 self->m_code->globals.push_back(fld.offset+2);
3562 if (field->m_fieldtype == TYPE_VECTOR) {
3563 gen_vector_defs (self->m_code.get(), def, field->m_name.c_str());
3564 gen_vector_fields(self->m_code.get(), fld, field->m_name.c_str());
3567 return field->m_code.globaladdr >= 0;
3570 static void ir_builder_collect_reusables(ir_builder *builder) {
3571 std::vector<ir_value*> reusables;
3573 for (auto& gp : builder->m_globals) {
3574 ir_value *value = gp.get();
3575 if (value->m_vtype != TYPE_FLOAT || !value->m_hasvalue)
3577 if (value->m_cvq == CV_CONST || (value->m_name.length() >= 1 && value->m_name[0] == '#'))
3578 reusables.emplace_back(value);
3580 builder->m_const_floats = move(reusables);
3583 static void ir_builder_split_vector(ir_builder *self, ir_value *vec) {
3584 ir_value* found[3] = { nullptr, nullptr, nullptr };
3586 // must not be written to
3587 if (vec->m_writes.size())
3589 // must not be trying to access individual members
3590 if (vec->m_members[0] || vec->m_members[1] || vec->m_members[2])
3592 // should be actually used otherwise it won't be generated anyway
3593 if (vec->m_reads.empty())
3595 //size_t count = vec->m_reads.size();
3599 // may only be used directly as function parameters, so if we find some other instruction cancel
3600 for (ir_instr *user : vec->m_reads) {
3601 // we only split vectors if they're used directly as parameter to a call only!
3602 if ((user->m_opcode < INSTR_CALL0 || user->m_opcode > INSTR_CALL8) && user->m_opcode != VINSTR_NRCALL)
3606 vec->m_flags |= IR_FLAG_SPLIT_VECTOR;
3608 // find existing floats making up the split
3609 for (ir_value *c : self->m_const_floats) {
3610 if (!found[0] && c->m_constval.vfloat == vec->m_constval.vvec.x)
3612 if (!found[1] && c->m_constval.vfloat == vec->m_constval.vvec.y)
3614 if (!found[2] && c->m_constval.vfloat == vec->m_constval.vvec.z)
3616 if (found[0] && found[1] && found[2])
3620 // generate floats for not yet found components
3622 found[0] = self->literalFloat(vec->m_constval.vvec.x, true);
3624 if (vec->m_constval.vvec.y == vec->m_constval.vvec.x)
3625 found[1] = found[0];
3627 found[1] = self->literalFloat(vec->m_constval.vvec.y, true);
3630 if (vec->m_constval.vvec.z == vec->m_constval.vvec.x)
3631 found[2] = found[0];
3632 else if (vec->m_constval.vvec.z == vec->m_constval.vvec.y)
3633 found[2] = found[1];
3635 found[2] = self->literalFloat(vec->m_constval.vvec.z, true);
3638 // the .members array should be safe to use here
3639 vec->m_members[0] = found[0];
3640 vec->m_members[1] = found[1];
3641 vec->m_members[2] = found[2];
3643 // register the readers for these floats
3644 found[0]->m_reads.insert(found[0]->m_reads.end(), vec->m_reads.begin(), vec->m_reads.end());
3645 found[1]->m_reads.insert(found[1]->m_reads.end(), vec->m_reads.begin(), vec->m_reads.end());
3646 found[2]->m_reads.insert(found[2]->m_reads.end(), vec->m_reads.begin(), vec->m_reads.end());
3649 static void ir_builder_split_vectors(ir_builder *self) {
3650 // member values may be added to self->m_globals during this operation, but
3651 // no new vectors will be added, we need to iterate via an index as
3652 // c++ iterators would be invalidated
3653 const size_t count = self->m_globals.size();
3654 for (size_t i = 0; i != count; ++i) {
3655 ir_value *v = self->m_globals[i].get();
3656 if (v->m_vtype != TYPE_VECTOR || !v->m_name.length() || v->m_name[0] != '#')
3658 ir_builder_split_vector(self, v);
3662 bool ir_builder::generate(const char *filename)
3664 prog_section_statement_t stmt;
3665 char *lnofile = nullptr;
3667 if (OPTS_FLAG(SPLIT_VECTOR_PARAMETERS)) {
3668 ir_builder_collect_reusables(this);
3669 if (!m_const_floats.empty())
3670 ir_builder_split_vectors(this);
3673 for (auto& fp : m_fields)
3674 ir_builder_prepare_field(m_code.get(), fp.get());
3676 for (auto& gp : m_globals) {
3677 ir_value *global = gp.get();
3678 if (!generateGlobal(global, false)) {
3681 if (global->m_vtype == TYPE_FUNCTION) {
3682 ir_function *func = global->m_constval.vfunc;
3683 if (func && m_max_locals < func->m_allocated_locals &&
3684 !(func->m_flags & IR_FLAG_MASK_NO_OVERLAP))
3686 m_max_locals = func->m_allocated_locals;
3688 if (func && m_max_globaltemps < func->m_globaltemps)
3689 m_max_globaltemps = func->m_globaltemps;
3693 for (auto& fp : m_fields) {
3694 if (!ir_builder_gen_field(this, fp.get()))
3699 m_nil->setCodeAddress(m_code->globals.size());
3700 m_code->globals.push_back(0);
3701 m_code->globals.push_back(0);
3702 m_code->globals.push_back(0);
3704 // generate virtual-instruction temps
3705 for (size_t i = 0; i < IR_MAX_VINSTR_TEMPS; ++i) {
3706 m_vinstr_temp[i]->setCodeAddress(m_code->globals.size());
3707 m_code->globals.push_back(0);
3708 m_code->globals.push_back(0);
3709 m_code->globals.push_back(0);
3712 // generate global temps
3713 m_first_common_globaltemp = m_code->globals.size();
3714 m_code->globals.insert(m_code->globals.end(), m_max_globaltemps, 0);
3716 //for (size_t i = 0; i < m_max_globaltemps; ++i) {
3717 // m_code->globals.push_back(0);
3719 // generate common locals
3720 m_first_common_local = m_code->globals.size();
3721 m_code->globals.insert(m_code->globals.end(), m_max_locals, 0);
3723 //for (i = 0; i < m_max_locals; ++i) {
3724 // m_code->globals.push_back(0);
3727 // generate function code
3729 for (auto& gp : m_globals) {
3730 ir_value *global = gp.get();
3731 if (global->m_vtype == TYPE_FUNCTION) {
3732 if (!this->generateGlobalFunctionCode(global))
3737 if (m_code->globals.size() >= 65536) {
3738 irerror(m_globals.back()->m_context,
3739 "This progs file would require more globals than the metadata can handle (%zu). Bailing out.",
3740 m_code->globals.size());
3744 /* DP errors if the last instruction is not an INSTR_DONE. */
3745 if (m_code->statements.back().opcode != INSTR_DONE)
3749 stmt.opcode = INSTR_DONE;
3753 last.line = m_code->linenums.back();
3754 last.column = m_code->columnnums.back();
3756 code_push_statement(m_code.get(), &stmt, last);
3759 if (OPTS_OPTION_BOOL(OPTION_PP_ONLY))
3762 if (m_code->statements.size() != m_code->linenums.size()) {
3763 con_err("Linecounter wrong: %lu != %lu\n",
3764 m_code->statements.size(),
3765 m_code->linenums.size());
3766 } else if (OPTS_FLAG(LNO)) {
3768 size_t filelen = strlen(filename);
3770 memcpy(vec_add(lnofile, filelen+1), filename, filelen+1);
3771 dot = strrchr(lnofile, '.');
3775 vec_shrinkto(lnofile, dot - lnofile);
3777 memcpy(vec_add(lnofile, 5), ".lno", 5);
3780 if (!code_write(m_code.get(), filename, lnofile)) {
3789 /***********************************************************************
3790 *IR DEBUG Dump functions...
3793 #define IND_BUFSZ 1024
3795 static const char *qc_opname(int op)
3797 if (op < 0) return "<INVALID>";
3798 if (op < VINSTR_END)
3799 return util_instr_str[op];
3801 case VINSTR_END: return "END";
3802 case VINSTR_PHI: return "PHI";
3803 case VINSTR_JUMP: return "JUMP";
3804 case VINSTR_COND: return "COND";
3805 case VINSTR_BITXOR: return "BITXOR";
3806 case VINSTR_BITAND_V: return "BITAND_V";
3807 case VINSTR_BITOR_V: return "BITOR_V";
3808 case VINSTR_BITXOR_V: return "BITXOR_V";
3809 case VINSTR_BITAND_VF: return "BITAND_VF";
3810 case VINSTR_BITOR_VF: return "BITOR_VF";
3811 case VINSTR_BITXOR_VF: return "BITXOR_VF";
3812 case VINSTR_CROSS: return "CROSS";
3813 case VINSTR_NEG_F: return "NEG_F";
3814 case VINSTR_NEG_V: return "NEG_V";
3815 default: return "<UNK>";
3819 void ir_builder::dump(int (*oprintf)(const char*, ...)) const
3822 char indent[IND_BUFSZ];
3826 oprintf("module %s\n", m_name.c_str());
3827 for (i = 0; i < m_globals.size(); ++i)
3830 if (m_globals[i]->m_hasvalue)
3831 oprintf("%s = ", m_globals[i]->m_name.c_str());
3832 m_globals[i].get()->dump(oprintf);
3835 for (i = 0; i < m_functions.size(); ++i)
3836 ir_function_dump(m_functions[i].get(), indent, oprintf);
3837 oprintf("endmodule %s\n", m_name.c_str());
3840 static const char *storenames[] = {
3841 "[global]", "[local]", "[param]", "[value]", "[return]"
3844 void ir_function_dump(ir_function *f, char *ind,
3845 int (*oprintf)(const char*, ...))
3848 if (f->m_builtin != 0) {
3849 oprintf("%sfunction %s = builtin %i\n", ind, f->m_name.c_str(), -f->m_builtin);
3852 oprintf("%sfunction %s\n", ind, f->m_name.c_str());
3853 util_strncat(ind, "\t", IND_BUFSZ-1);
3854 if (f->m_locals.size())
3856 oprintf("%s%i locals:\n", ind, (int)f->m_locals.size());
3857 for (i = 0; i < f->m_locals.size(); ++i) {
3858 oprintf("%s\t", ind);
3859 f->m_locals[i].get()->dump(oprintf);
3863 oprintf("%sliferanges:\n", ind);
3864 for (i = 0; i < f->m_locals.size(); ++i) {
3865 const char *attr = "";
3867 ir_value *v = f->m_locals[i].get();
3868 if (v->m_unique_life && v->m_locked)
3869 attr = "unique,locked ";
3870 else if (v->m_unique_life)
3872 else if (v->m_locked)
3874 oprintf("%s\t%s: %s %s %s%s@%i ", ind, v->m_name.c_str(), type_name[v->m_vtype],
3875 storenames[v->m_store],
3876 attr, (v->m_callparam ? "callparam " : ""),
3877 (int)v->m_code.local);
3878 if (v->m_life.empty())
3880 for (l = 0; l < v->m_life.size(); ++l) {
3881 oprintf("[%i,%i] ", v->m_life[l].start, v->m_life[l].end);
3884 for (m = 0; m < 3; ++m) {
3885 ir_value *vm = v->m_members[m];
3888 oprintf("%s\t%s: @%i ", ind, vm->m_name.c_str(), (int)vm->m_code.local);
3889 for (l = 0; l < vm->m_life.size(); ++l) {
3890 oprintf("[%i,%i] ", vm->m_life[l].start, vm->m_life[l].end);
3895 for (i = 0; i < f->m_values.size(); ++i) {
3896 const char *attr = "";
3898 ir_value *v = f->m_values[i].get();
3899 if (v->m_unique_life && v->m_locked)
3900 attr = "unique,locked ";
3901 else if (v->m_unique_life)
3903 else if (v->m_locked)
3905 oprintf("%s\t%s: %s %s %s%s@%i ", ind, v->m_name.c_str(), type_name[v->m_vtype],
3906 storenames[v->m_store],
3907 attr, (v->m_callparam ? "callparam " : ""),
3908 (int)v->m_code.local);
3909 if (v->m_life.empty())
3911 for (l = 0; l < v->m_life.size(); ++l) {
3912 oprintf("[%i,%i] ", v->m_life[l].start, v->m_life[l].end);
3915 for (m = 0; m < 3; ++m) {
3916 ir_value *vm = v->m_members[m];
3919 if (vm->m_unique_life && vm->m_locked)
3920 attr = "unique,locked ";
3921 else if (vm->m_unique_life)
3923 else if (vm->m_locked)
3925 oprintf("%s\t%s: %s@%i ", ind, vm->m_name.c_str(), attr, (int)vm->m_code.local);
3926 for (l = 0; l < vm->m_life.size(); ++l) {
3927 oprintf("[%i,%i] ", vm->m_life[l].start, vm->m_life[l].end);
3932 if (f->m_blocks.size())
3934 oprintf("%slife passes: %i\n", ind, (int)f->m_run_id);
3935 for (i = 0; i < f->m_blocks.size(); ++i) {
3936 ir_block_dump(f->m_blocks[i].get(), ind, oprintf);
3940 ind[strlen(ind)-1] = 0;
3941 oprintf("%sendfunction %s\n", ind, f->m_name.c_str());
3944 void ir_block_dump(ir_block* b, char *ind,
3945 int (*oprintf)(const char*, ...))
3947 oprintf("%s:%s\n", ind, b->m_label.c_str());
3948 util_strncat(ind, "\t", IND_BUFSZ-1);
3950 if (!b->m_instr.empty() && b->m_instr[0])
3951 oprintf("%s (%i) [entry]\n", ind, (int)(b->m_instr[0]->m_eid-1));
3952 for (auto &i : b->m_instr)
3953 ir_instr_dump(i, ind, oprintf);
3954 ind[strlen(ind)-1] = 0;
3957 static void dump_phi(ir_instr *in, int (*oprintf)(const char*, ...))
3959 oprintf("%s <- phi ", in->_m_ops[0]->m_name.c_str());
3960 for (auto &it : in->m_phi) {
3961 oprintf("([%s] : %s) ", it.from->m_label.c_str(),
3962 it.value->m_name.c_str());
3967 void ir_instr_dump(ir_instr *in, char *ind,
3968 int (*oprintf)(const char*, ...))
3971 const char *comma = nullptr;
3973 oprintf("%s (%i) ", ind, (int)in->m_eid);
3975 if (in->m_opcode == VINSTR_PHI) {
3976 dump_phi(in, oprintf);
3980 util_strncat(ind, "\t", IND_BUFSZ-1);
3982 if (in->_m_ops[0] && (in->_m_ops[1] || in->_m_ops[2])) {
3983 in->_m_ops[0]->dump(oprintf);
3984 if (in->_m_ops[1] || in->_m_ops[2])
3987 if (in->m_opcode == INSTR_CALL0 || in->m_opcode == VINSTR_NRCALL) {
3988 oprintf("CALL%i\t", in->m_params.size());
3990 oprintf("%s\t", qc_opname(in->m_opcode));
3992 if (in->_m_ops[0] && !(in->_m_ops[1] || in->_m_ops[2])) {
3993 in->_m_ops[0]->dump(oprintf);
3998 for (i = 1; i != 3; ++i) {
3999 if (in->_m_ops[i]) {
4002 in->_m_ops[i]->dump(oprintf);
4007 if (in->m_bops[0]) {
4010 oprintf("[%s]", in->m_bops[0]->m_label.c_str());
4014 oprintf("%s[%s]", comma, in->m_bops[1]->m_label.c_str());
4015 if (in->m_params.size()) {
4016 oprintf("\tparams: ");
4017 for (auto &it : in->m_params)
4018 oprintf("%s, ", it->m_name.c_str());
4021 ind[strlen(ind)-1] = 0;
4024 static void ir_value_dump_string(const char *str, int (*oprintf)(const char*, ...))
4027 for (; *str; ++str) {
4029 case '\n': oprintf("\\n"); break;
4030 case '\r': oprintf("\\r"); break;
4031 case '\t': oprintf("\\t"); break;
4032 case '\v': oprintf("\\v"); break;
4033 case '\f': oprintf("\\f"); break;
4034 case '\b': oprintf("\\b"); break;
4035 case '\a': oprintf("\\a"); break;
4036 case '\\': oprintf("\\\\"); break;
4037 case '"': oprintf("\\\""); break;
4038 default: oprintf("%c", *str); break;
4044 void ir_value::dump(int (*oprintf)(const char*, ...)) const
4053 oprintf("fn:%s", m_name.c_str());
4056 oprintf("%g", m_constval.vfloat);
4059 oprintf("'%g %g %g'",
4065 oprintf("(entity)");
4068 ir_value_dump_string(m_constval.vstring, oprintf);
4072 oprintf("%i", m_constval.vint);
4077 m_constval.vpointer->m_name.c_str());
4081 oprintf("%s", m_name.c_str());
4085 void ir_value::dumpLife(int (*oprintf)(const char*,...)) const
4087 oprintf("Life of %12s:", m_name.c_str());
4088 for (size_t i = 0; i < m_life.size(); ++i)
4090 oprintf(" + [%i, %i]\n", m_life[i].start, m_life[i].end);