2 * Copyright (C) 2012, 2013, 2014
6 * Permission is hereby granted, free of charge, to any person obtaining a copy of
7 * this software and associated documentation files (the "Software"), to deal in
8 * the Software without restriction, including without limitation the rights to
9 * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
10 * of the Software, and to permit persons to whom the Software is furnished to do
11 * so, subject to the following conditions:
13 * The above copyright notice and this permission notice shall be included in all
14 * copies or substantial portions of the Software.
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
30 /***********************************************************************
31 * Type sizes used at multiple points in the IR codegen
34 const char *type_name[TYPE_COUNT] = {
53 static size_t type_sizeof_[TYPE_COUNT] = {
60 1, /* TYPE_FUNCTION */
71 const uint16_t type_store_instr[TYPE_COUNT] = {
72 INSTR_STORE_F, /* should use I when having integer support */
79 INSTR_STORE_ENT, /* should use I */
81 INSTR_STORE_I, /* integer type */
86 INSTR_STORE_V, /* variant, should never be accessed */
88 VINSTR_END, /* struct */
89 VINSTR_END, /* union */
90 VINSTR_END, /* array */
92 VINSTR_END, /* noexpr */
95 const uint16_t field_store_instr[TYPE_COUNT] = {
105 INSTR_STORE_FLD, /* integer type */
110 INSTR_STORE_V, /* variant, should never be accessed */
112 VINSTR_END, /* struct */
113 VINSTR_END, /* union */
114 VINSTR_END, /* array */
115 VINSTR_END, /* nil */
116 VINSTR_END, /* noexpr */
119 const uint16_t type_storep_instr[TYPE_COUNT] = {
120 INSTR_STOREP_F, /* should use I when having integer support */
127 INSTR_STOREP_ENT, /* should use I */
129 INSTR_STOREP_ENT, /* integer type */
134 INSTR_STOREP_V, /* variant, should never be accessed */
136 VINSTR_END, /* struct */
137 VINSTR_END, /* union */
138 VINSTR_END, /* array */
139 VINSTR_END, /* nil */
140 VINSTR_END, /* noexpr */
143 const uint16_t type_eq_instr[TYPE_COUNT] = {
144 INSTR_EQ_F, /* should use I when having integer support */
149 INSTR_EQ_E, /* FLD has no comparison */
151 INSTR_EQ_E, /* should use I */
158 INSTR_EQ_V, /* variant, should never be accessed */
160 VINSTR_END, /* struct */
161 VINSTR_END, /* union */
162 VINSTR_END, /* array */
163 VINSTR_END, /* nil */
164 VINSTR_END, /* noexpr */
167 const uint16_t type_ne_instr[TYPE_COUNT] = {
168 INSTR_NE_F, /* should use I when having integer support */
173 INSTR_NE_E, /* FLD has no comparison */
175 INSTR_NE_E, /* should use I */
182 INSTR_NE_V, /* variant, should never be accessed */
184 VINSTR_END, /* struct */
185 VINSTR_END, /* union */
186 VINSTR_END, /* array */
187 VINSTR_END, /* nil */
188 VINSTR_END, /* noexpr */
191 const uint16_t type_not_instr[TYPE_COUNT] = {
192 INSTR_NOT_F, /* should use I when having integer support */
193 VINSTR_END, /* not to be used, depends on string related -f flags */
199 INSTR_NOT_ENT, /* should use I */
201 INSTR_NOT_I, /* integer type */
206 INSTR_NOT_V, /* variant, should never be accessed */
208 VINSTR_END, /* struct */
209 VINSTR_END, /* union */
210 VINSTR_END, /* array */
211 VINSTR_END, /* nil */
212 VINSTR_END, /* noexpr */
216 static ir_value* ir_value_var(const char *name, int st, int vtype);
217 static bool ir_value_set_name(ir_value*, const char *name);
218 static void ir_value_dump(ir_value*, int (*oprintf)(const char*,...));
220 static ir_value* ir_gen_extparam_proto(ir_builder *ir);
221 static void ir_gen_extparam (ir_builder *ir);
223 static bool ir_builder_set_name(ir_builder *self, const char *name);
225 static ir_function* ir_function_new(struct ir_builder_s *owner, int returntype);
226 static bool ir_function_set_name(ir_function*, const char *name);
227 static void ir_function_delete(ir_function*);
228 static void ir_function_dump(ir_function*, char *ind, int (*oprintf)(const char*,...));
230 static ir_value* ir_block_create_general_instr(ir_block *self, lex_ctx_t, const char *label,
231 int op, ir_value *a, ir_value *b, int outype);
232 static void ir_block_delete(ir_block*);
233 static ir_block* ir_block_new(struct ir_function_s *owner, const char *label);
234 static bool GMQCC_WARN ir_block_create_store(ir_block*, lex_ctx_t, ir_value *target, ir_value *what);
235 static bool ir_block_set_label(ir_block*, const char *label);
236 static void ir_block_dump(ir_block*, char *ind, int (*oprintf)(const char*,...));
238 static bool ir_instr_op(ir_instr*, int op, ir_value *value, bool writing);
239 static void ir_instr_delete(ir_instr*);
240 static void ir_instr_dump(ir_instr* in, char *ind, int (*oprintf)(const char*,...));
241 /* error functions */
243 static void irerror(lex_ctx_t ctx, const char *msg, ...)
247 con_cvprintmsg(ctx, LVL_ERROR, "internal error", msg, ap);
251 static bool GMQCC_WARN irwarning(lex_ctx_t ctx, int warntype, const char *fmt, ...)
256 r = vcompile_warning(ctx, warntype, fmt, ap);
261 /***********************************************************************
262 * Vector utility functions
265 static bool GMQCC_WARN vec_ir_value_find(ir_value **vec, const ir_value *what, size_t *idx)
268 size_t len = vec_size(vec);
269 for (i = 0; i < len; ++i) {
270 if (vec[i] == what) {
278 static bool GMQCC_WARN vec_ir_block_find(ir_block **vec, ir_block *what, size_t *idx)
281 size_t len = vec_size(vec);
282 for (i = 0; i < len; ++i) {
283 if (vec[i] == what) {
291 static bool GMQCC_WARN vec_ir_instr_find(ir_instr **vec, ir_instr *what, size_t *idx)
294 size_t len = vec_size(vec);
295 for (i = 0; i < len; ++i) {
296 if (vec[i] == what) {
304 /***********************************************************************
308 static void ir_block_delete_quick(ir_block* self);
309 static void ir_instr_delete_quick(ir_instr *self);
310 static void ir_function_delete_quick(ir_function *self);
312 ir_builder* ir_builder_new(const char *modulename)
317 self = (ir_builder*)mem_a(sizeof(*self));
321 self->functions = NULL;
322 self->globals = NULL;
324 self->filenames = NULL;
325 self->filestrings = NULL;
326 self->htglobals = util_htnew(IR_HT_SIZE);
327 self->htfields = util_htnew(IR_HT_SIZE);
328 self->htfunctions = util_htnew(IR_HT_SIZE);
330 self->extparams = NULL;
331 self->extparam_protos = NULL;
333 self->first_common_globaltemp = 0;
334 self->max_globaltemps = 0;
335 self->first_common_local = 0;
336 self->max_locals = 0;
338 self->str_immediate = 0;
340 if (!ir_builder_set_name(self, modulename)) {
345 self->nil = ir_value_var("nil", store_value, TYPE_NIL);
346 self->nil->cvq = CV_CONST;
348 for (i = 0; i != IR_MAX_VINSTR_TEMPS; ++i) {
349 /* we write to them, but they're not supposed to be used outside the IR, so
350 * let's not allow the generation of ir_instrs which use these.
351 * So it's a constant noexpr.
353 self->vinstr_temp[i] = ir_value_var("vinstr_temp", store_value, TYPE_NOEXPR);
354 self->vinstr_temp[i]->cvq = CV_CONST;
357 self->reserved_va_count = NULL;
358 self->coverage_func = NULL;
360 self->code = code_init();
365 void ir_builder_delete(ir_builder* self)
368 util_htdel(self->htglobals);
369 util_htdel(self->htfields);
370 util_htdel(self->htfunctions);
371 mem_d((void*)self->name);
372 for (i = 0; i != vec_size(self->functions); ++i) {
373 ir_function_delete_quick(self->functions[i]);
375 vec_free(self->functions);
376 for (i = 0; i != vec_size(self->extparams); ++i) {
377 ir_value_delete(self->extparams[i]);
379 vec_free(self->extparams);
380 vec_free(self->extparam_protos);
381 for (i = 0; i != vec_size(self->globals); ++i) {
382 ir_value_delete(self->globals[i]);
384 vec_free(self->globals);
385 for (i = 0; i != vec_size(self->fields); ++i) {
386 ir_value_delete(self->fields[i]);
388 ir_value_delete(self->nil);
389 for (i = 0; i != IR_MAX_VINSTR_TEMPS; ++i) {
390 ir_value_delete(self->vinstr_temp[i]);
392 vec_free(self->fields);
393 vec_free(self->filenames);
394 vec_free(self->filestrings);
396 code_cleanup(self->code);
400 bool ir_builder_set_name(ir_builder *self, const char *name)
403 mem_d((void*)self->name);
404 self->name = util_strdup(name);
408 static ir_function* ir_builder_get_function(ir_builder *self, const char *name)
410 return (ir_function*)util_htget(self->htfunctions, name);
413 ir_function* ir_builder_create_function(ir_builder *self, const char *name, int outtype)
415 ir_function *fn = ir_builder_get_function(self, name);
420 fn = ir_function_new(self, outtype);
421 if (!ir_function_set_name(fn, name))
423 ir_function_delete(fn);
426 vec_push(self->functions, fn);
427 util_htset(self->htfunctions, name, fn);
429 fn->value = ir_builder_create_global(self, fn->name, TYPE_FUNCTION);
431 ir_function_delete(fn);
435 fn->value->hasvalue = true;
436 fn->value->outtype = outtype;
437 fn->value->constval.vfunc = fn;
438 fn->value->context = fn->context;
443 static ir_value* ir_builder_get_global(ir_builder *self, const char *name)
445 return (ir_value*)util_htget(self->htglobals, name);
448 ir_value* ir_builder_create_global(ir_builder *self, const char *name, int vtype)
454 ve = ir_builder_get_global(self, name);
460 ve = ir_value_var(name, store_global, vtype);
461 vec_push(self->globals, ve);
462 util_htset(self->htglobals, name, ve);
466 ir_value* ir_builder_get_va_count(ir_builder *self)
468 if (self->reserved_va_count)
469 return self->reserved_va_count;
470 return (self->reserved_va_count = ir_builder_create_global(self, "reserved:va_count", TYPE_FLOAT));
473 static ir_value* ir_builder_get_field(ir_builder *self, const char *name)
475 return (ir_value*)util_htget(self->htfields, name);
479 ir_value* ir_builder_create_field(ir_builder *self, const char *name, int vtype)
481 ir_value *ve = ir_builder_get_field(self, name);
486 ve = ir_value_var(name, store_global, TYPE_FIELD);
487 ve->fieldtype = vtype;
488 vec_push(self->fields, ve);
489 util_htset(self->htfields, name, ve);
493 /***********************************************************************
497 static bool ir_function_naive_phi(ir_function*);
498 static void ir_function_enumerate(ir_function*);
499 static bool ir_function_calculate_liferanges(ir_function*);
500 static bool ir_function_allocate_locals(ir_function*);
502 ir_function* ir_function_new(ir_builder* owner, int outtype)
505 self = (ir_function*)mem_a(sizeof(*self));
510 memset(self, 0, sizeof(*self));
513 if (!ir_function_set_name(self, "<@unnamed>")) {
520 self->context.file = "<@no context>";
521 self->context.line = 0;
522 self->outtype = outtype;
531 self->max_varargs = 0;
533 self->code_function_def = -1;
534 self->allocated_locals = 0;
535 self->globaltemps = 0;
541 bool ir_function_set_name(ir_function *self, const char *name)
544 mem_d((void*)self->name);
545 self->name = util_strdup(name);
549 static void ir_function_delete_quick(ir_function *self)
552 mem_d((void*)self->name);
554 for (i = 0; i != vec_size(self->blocks); ++i)
555 ir_block_delete_quick(self->blocks[i]);
556 vec_free(self->blocks);
558 vec_free(self->params);
560 for (i = 0; i != vec_size(self->values); ++i)
561 ir_value_delete(self->values[i]);
562 vec_free(self->values);
564 for (i = 0; i != vec_size(self->locals); ++i)
565 ir_value_delete(self->locals[i]);
566 vec_free(self->locals);
568 /* self->value is deleted by the builder */
573 void ir_function_delete(ir_function *self)
576 mem_d((void*)self->name);
578 for (i = 0; i != vec_size(self->blocks); ++i)
579 ir_block_delete(self->blocks[i]);
580 vec_free(self->blocks);
582 vec_free(self->params);
584 for (i = 0; i != vec_size(self->values); ++i)
585 ir_value_delete(self->values[i]);
586 vec_free(self->values);
588 for (i = 0; i != vec_size(self->locals); ++i)
589 ir_value_delete(self->locals[i]);
590 vec_free(self->locals);
592 /* self->value is deleted by the builder */
597 static void ir_function_collect_value(ir_function *self, ir_value *v)
599 vec_push(self->values, v);
602 ir_block* ir_function_create_block(lex_ctx_t ctx, ir_function *self, const char *label)
604 ir_block* bn = ir_block_new(self, label);
606 vec_push(self->blocks, bn);
608 if ((self->flags & IR_FLAG_BLOCK_COVERAGE) && self->owner->coverage_func)
609 (void)ir_block_create_call(bn, ctx, NULL, self->owner->coverage_func, false);
614 static bool instr_is_operation(uint16_t op)
616 return ( (op >= INSTR_MUL_F && op <= INSTR_GT) ||
617 (op >= INSTR_LOAD_F && op <= INSTR_LOAD_FNC) ||
618 (op == INSTR_ADDRESS) ||
619 (op >= INSTR_NOT_F && op <= INSTR_NOT_FNC) ||
620 (op >= INSTR_AND && op <= INSTR_BITOR) ||
621 (op >= INSTR_CALL0 && op <= INSTR_CALL8) ||
622 (op >= VINSTR_BITAND_V && op <= VINSTR_NEG_V) );
625 static bool ir_function_pass_peephole(ir_function *self)
629 for (b = 0; b < vec_size(self->blocks); ++b) {
631 ir_block *block = self->blocks[b];
633 for (i = 0; i < vec_size(block->instr); ++i) {
635 inst = block->instr[i];
638 (inst->opcode >= INSTR_STORE_F &&
639 inst->opcode <= INSTR_STORE_FNC))
647 oper = block->instr[i-1];
648 if (!instr_is_operation(oper->opcode))
651 /* Don't change semantics of MUL_VF in engines where these may not alias. */
652 if (OPTS_FLAG(LEGACY_VECTOR_MATHS)) {
653 if (oper->opcode == INSTR_MUL_VF && oper->_ops[2]->memberof == oper->_ops[1])
655 if (oper->opcode == INSTR_MUL_FV && oper->_ops[1]->memberof == oper->_ops[2])
659 value = oper->_ops[0];
661 /* only do it for SSA values */
662 if (value->store != store_value)
665 /* don't optimize out the temp if it's used later again */
666 if (vec_size(value->reads) != 1)
669 /* The very next store must use this value */
670 if (value->reads[0] != store)
673 /* And of course the store must _read_ from it, so it's in
675 if (store->_ops[1] != value)
678 ++opts_optimizationcount[OPTIM_PEEPHOLE];
679 (void)!ir_instr_op(oper, 0, store->_ops[0], true);
681 vec_remove(block->instr, i, 1);
682 ir_instr_delete(store);
684 else if (inst->opcode == VINSTR_COND)
686 /* COND on a value resulting from a NOT could
687 * remove the NOT and swap its operands
694 value = inst->_ops[0];
696 if (value->store != store_value ||
697 vec_size(value->reads) != 1 ||
698 value->reads[0] != inst)
703 inot = value->writes[0];
704 if (inot->_ops[0] != value ||
705 inot->opcode < INSTR_NOT_F ||
706 inot->opcode > INSTR_NOT_FNC ||
707 inot->opcode == INSTR_NOT_V || /* can't do these */
708 inot->opcode == INSTR_NOT_S)
714 ++opts_optimizationcount[OPTIM_PEEPHOLE];
716 (void)!ir_instr_op(inst, 0, inot->_ops[1], false);
719 for (inotid = 0; inotid < vec_size(tmp->instr); ++inotid) {
720 if (tmp->instr[inotid] == inot)
723 if (inotid >= vec_size(tmp->instr)) {
724 compile_error(inst->context, "sanity-check failed: failed to find instruction to optimize out");
727 vec_remove(tmp->instr, inotid, 1);
728 ir_instr_delete(inot);
729 /* swap ontrue/onfalse */
731 inst->bops[0] = inst->bops[1];
742 static bool ir_function_pass_tailrecursion(ir_function *self)
746 for (b = 0; b < vec_size(self->blocks); ++b) {
748 ir_instr *ret, *call, *store = NULL;
749 ir_block *block = self->blocks[b];
751 if (!block->final || vec_size(block->instr) < 2)
754 ret = block->instr[vec_size(block->instr)-1];
755 if (ret->opcode != INSTR_DONE && ret->opcode != INSTR_RETURN)
758 call = block->instr[vec_size(block->instr)-2];
759 if (call->opcode >= INSTR_STORE_F && call->opcode <= INSTR_STORE_FNC) {
760 /* account for the unoptimized
762 * STORE %return, %tmp
766 if (vec_size(block->instr) < 3)
770 call = block->instr[vec_size(block->instr)-3];
773 if (call->opcode < INSTR_CALL0 || call->opcode > INSTR_CALL8)
777 /* optimize out the STORE */
779 ret->_ops[0] == store->_ops[0] &&
780 store->_ops[1] == call->_ops[0])
782 ++opts_optimizationcount[OPTIM_PEEPHOLE];
783 call->_ops[0] = store->_ops[0];
784 vec_remove(block->instr, vec_size(block->instr) - 2, 1);
785 ir_instr_delete(store);
794 funcval = call->_ops[1];
797 if (funcval->vtype != TYPE_FUNCTION || funcval->constval.vfunc != self)
800 /* now we have a CALL and a RET, check if it's a tailcall */
801 if (ret->_ops[0] && call->_ops[0] != ret->_ops[0])
804 ++opts_optimizationcount[OPTIM_TAIL_RECURSION];
805 vec_shrinkby(block->instr, 2);
807 block->final = false; /* open it back up */
809 /* emite parameter-stores */
810 for (p = 0; p < vec_size(call->params); ++p) {
811 /* assert(call->params_count <= self->locals_count); */
812 if (!ir_block_create_store(block, call->context, self->locals[p], call->params[p])) {
813 irerror(call->context, "failed to create tailcall store instruction for parameter %i", (int)p);
817 if (!ir_block_create_jump(block, call->context, self->blocks[0])) {
818 irerror(call->context, "failed to create tailcall jump");
822 ir_instr_delete(call);
823 ir_instr_delete(ret);
829 bool ir_function_finalize(ir_function *self)
836 if (OPTS_OPTIMIZATION(OPTIM_PEEPHOLE)) {
837 if (!ir_function_pass_peephole(self)) {
838 irerror(self->context, "generic optimization pass broke something in `%s`", self->name);
843 if (OPTS_OPTIMIZATION(OPTIM_TAIL_RECURSION)) {
844 if (!ir_function_pass_tailrecursion(self)) {
845 irerror(self->context, "tail-recursion optimization pass broke something in `%s`", self->name);
850 if (!ir_function_naive_phi(self)) {
851 irerror(self->context, "internal error: ir_function_naive_phi failed");
855 for (i = 0; i < vec_size(self->locals); ++i) {
856 ir_value *v = self->locals[i];
857 if (v->vtype == TYPE_VECTOR ||
858 (v->vtype == TYPE_FIELD && v->outtype == TYPE_VECTOR))
860 ir_value_vector_member(v, 0);
861 ir_value_vector_member(v, 1);
862 ir_value_vector_member(v, 2);
865 for (i = 0; i < vec_size(self->values); ++i) {
866 ir_value *v = self->values[i];
867 if (v->vtype == TYPE_VECTOR ||
868 (v->vtype == TYPE_FIELD && v->outtype == TYPE_VECTOR))
870 ir_value_vector_member(v, 0);
871 ir_value_vector_member(v, 1);
872 ir_value_vector_member(v, 2);
876 ir_function_enumerate(self);
878 if (!ir_function_calculate_liferanges(self))
880 if (!ir_function_allocate_locals(self))
885 ir_value* ir_function_create_local(ir_function *self, const char *name, int vtype, bool param)
890 vec_size(self->locals) &&
891 self->locals[vec_size(self->locals)-1]->store != store_param) {
892 irerror(self->context, "cannot add parameters after adding locals");
896 ve = ir_value_var(name, (param ? store_param : store_local), vtype);
899 vec_push(self->locals, ve);
903 /***********************************************************************
907 ir_block* ir_block_new(ir_function* owner, const char *name)
910 self = (ir_block*)mem_a(sizeof(*self));
914 memset(self, 0, sizeof(*self));
917 if (name && !ir_block_set_label(self, name)) {
922 self->context.file = "<@no context>";
923 self->context.line = 0;
927 self->entries = NULL;
931 self->is_return = false;
935 self->generated = false;
940 static void ir_block_delete_quick(ir_block* self)
943 if (self->label) mem_d(self->label);
944 for (i = 0; i != vec_size(self->instr); ++i)
945 ir_instr_delete_quick(self->instr[i]);
946 vec_free(self->instr);
947 vec_free(self->entries);
948 vec_free(self->exits);
949 vec_free(self->living);
953 void ir_block_delete(ir_block* self)
956 if (self->label) mem_d(self->label);
957 for (i = 0; i != vec_size(self->instr); ++i)
958 ir_instr_delete(self->instr[i]);
959 vec_free(self->instr);
960 vec_free(self->entries);
961 vec_free(self->exits);
962 vec_free(self->living);
966 bool ir_block_set_label(ir_block *self, const char *name)
969 mem_d((void*)self->label);
970 self->label = util_strdup(name);
971 return !!self->label;
974 /***********************************************************************
978 static ir_instr* ir_instr_new(lex_ctx_t ctx, ir_block* owner, int op)
981 self = (ir_instr*)mem_a(sizeof(*self));
988 self->_ops[0] = NULL;
989 self->_ops[1] = NULL;
990 self->_ops[2] = NULL;
991 self->bops[0] = NULL;
992 self->bops[1] = NULL;
1003 static void ir_instr_delete_quick(ir_instr *self)
1005 vec_free(self->phi);
1006 vec_free(self->params);
1010 static void ir_instr_delete(ir_instr *self)
1013 /* The following calls can only delete from
1014 * vectors, we still want to delete this instruction
1015 * so ignore the return value. Since with the warn_unused_result attribute
1016 * gcc doesn't care about an explicit: (void)foo(); to ignore the result,
1017 * I have to improvise here and use if(foo());
1019 for (i = 0; i < vec_size(self->phi); ++i) {
1021 if (vec_ir_instr_find(self->phi[i].value->writes, self, &idx))
1022 vec_remove(self->phi[i].value->writes, idx, 1);
1023 if (vec_ir_instr_find(self->phi[i].value->reads, self, &idx))
1024 vec_remove(self->phi[i].value->reads, idx, 1);
1026 vec_free(self->phi);
1027 for (i = 0; i < vec_size(self->params); ++i) {
1029 if (vec_ir_instr_find(self->params[i]->writes, self, &idx))
1030 vec_remove(self->params[i]->writes, idx, 1);
1031 if (vec_ir_instr_find(self->params[i]->reads, self, &idx))
1032 vec_remove(self->params[i]->reads, idx, 1);
1034 vec_free(self->params);
1035 (void)!ir_instr_op(self, 0, NULL, false);
1036 (void)!ir_instr_op(self, 1, NULL, false);
1037 (void)!ir_instr_op(self, 2, NULL, false);
1041 static bool ir_instr_op(ir_instr *self, int op, ir_value *v, bool writing)
1043 if (v && v->vtype == TYPE_NOEXPR) {
1044 irerror(self->context, "tried to use a NOEXPR value");
1048 if (self->_ops[op]) {
1050 if (writing && vec_ir_instr_find(self->_ops[op]->writes, self, &idx))
1051 vec_remove(self->_ops[op]->writes, idx, 1);
1052 else if (vec_ir_instr_find(self->_ops[op]->reads, self, &idx))
1053 vec_remove(self->_ops[op]->reads, idx, 1);
1057 vec_push(v->writes, self);
1059 vec_push(v->reads, self);
1065 /***********************************************************************
1069 static void ir_value_code_setaddr(ir_value *self, int32_t gaddr)
1071 self->code.globaladdr = gaddr;
1072 if (self->members[0]) self->members[0]->code.globaladdr = gaddr;
1073 if (self->members[1]) self->members[1]->code.globaladdr = gaddr;
1074 if (self->members[2]) self->members[2]->code.globaladdr = gaddr;
1077 static int32_t ir_value_code_addr(const ir_value *self)
1079 if (self->store == store_return)
1080 return OFS_RETURN + self->code.addroffset;
1081 return self->code.globaladdr + self->code.addroffset;
1084 ir_value* ir_value_var(const char *name, int storetype, int vtype)
1087 self = (ir_value*)mem_a(sizeof(*self));
1088 self->vtype = vtype;
1089 self->fieldtype = TYPE_VOID;
1090 self->outtype = TYPE_VOID;
1091 self->store = storetype;
1095 self->writes = NULL;
1097 self->cvq = CV_NONE;
1098 self->hasvalue = false;
1099 self->context.file = "<@no context>";
1100 self->context.line = 0;
1102 if (name && !ir_value_set_name(self, name)) {
1103 irerror(self->context, "out of memory");
1108 memset(&self->constval, 0, sizeof(self->constval));
1109 memset(&self->code, 0, sizeof(self->code));
1111 self->members[0] = NULL;
1112 self->members[1] = NULL;
1113 self->members[2] = NULL;
1114 self->memberof = NULL;
1116 self->unique_life = false;
1117 self->locked = false;
1118 self->callparam = false;
1124 /* helper function */
1125 static ir_value* ir_builder_imm_float(ir_builder *self, float value, bool add_to_list) {
1126 ir_value *v = ir_value_var("#IMMEDIATE", store_global, TYPE_FLOAT);
1129 v->constval.vfloat = value;
1131 vec_push(self->globals, v);
1133 vec_push(self->const_floats, v);
1137 ir_value* ir_value_vector_member(ir_value *self, unsigned int member)
1145 if (self->members[member])
1146 return self->members[member];
1149 len = strlen(self->name);
1150 name = (char*)mem_a(len + 3);
1151 memcpy(name, self->name, len);
1153 name[len+1] = 'x' + member;
1159 if (self->vtype == TYPE_VECTOR)
1161 m = ir_value_var(name, self->store, TYPE_FLOAT);
1166 m->context = self->context;
1168 self->members[member] = m;
1169 m->code.addroffset = member;
1171 else if (self->vtype == TYPE_FIELD)
1173 if (self->fieldtype != TYPE_VECTOR)
1175 m = ir_value_var(name, self->store, TYPE_FIELD);
1180 m->fieldtype = TYPE_FLOAT;
1181 m->context = self->context;
1183 self->members[member] = m;
1184 m->code.addroffset = member;
1188 irerror(self->context, "invalid member access on %s", self->name);
1196 static GMQCC_INLINE size_t ir_value_sizeof(const ir_value *self)
1198 if (self->vtype == TYPE_FIELD && self->fieldtype == TYPE_VECTOR)
1199 return type_sizeof_[TYPE_VECTOR];
1200 return type_sizeof_[self->vtype];
1203 static ir_value* ir_value_out(ir_function *owner, const char *name, int storetype, int vtype)
1205 ir_value *v = ir_value_var(name, storetype, vtype);
1208 ir_function_collect_value(owner, v);
1212 void ir_value_delete(ir_value* self)
1216 mem_d((void*)self->name);
1219 if (self->vtype == TYPE_STRING)
1220 mem_d((void*)self->constval.vstring);
1222 if (!(self->flags & IR_FLAG_SPLIT_VECTOR)) {
1223 for (i = 0; i < 3; ++i) {
1224 if (self->members[i])
1225 ir_value_delete(self->members[i]);
1228 vec_free(self->reads);
1229 vec_free(self->writes);
1230 vec_free(self->life);
1234 bool ir_value_set_name(ir_value *self, const char *name)
1237 mem_d((void*)self->name);
1238 self->name = util_strdup(name);
1239 return !!self->name;
1242 bool ir_value_set_float(ir_value *self, float f)
1244 if (self->vtype != TYPE_FLOAT)
1246 self->constval.vfloat = f;
1247 self->hasvalue = true;
1251 bool ir_value_set_func(ir_value *self, int f)
1253 if (self->vtype != TYPE_FUNCTION)
1255 self->constval.vint = f;
1256 self->hasvalue = true;
1260 bool ir_value_set_vector(ir_value *self, vec3_t v)
1262 if (self->vtype != TYPE_VECTOR)
1264 self->constval.vvec = v;
1265 self->hasvalue = true;
1269 bool ir_value_set_field(ir_value *self, ir_value *fld)
1271 if (self->vtype != TYPE_FIELD)
1273 self->constval.vpointer = fld;
1274 self->hasvalue = true;
1278 bool ir_value_set_string(ir_value *self, const char *str)
1280 if (self->vtype != TYPE_STRING)
1282 self->constval.vstring = util_strdupe(str);
1283 self->hasvalue = true;
1288 bool ir_value_set_int(ir_value *self, int i)
1290 if (self->vtype != TYPE_INTEGER)
1292 self->constval.vint = i;
1293 self->hasvalue = true;
1298 bool ir_value_lives(ir_value *self, size_t at)
1301 for (i = 0; i < vec_size(self->life); ++i)
1303 ir_life_entry_t *life = &self->life[i];
1304 if (life->start <= at && at <= life->end)
1306 if (life->start > at) /* since it's ordered */
1312 static bool ir_value_life_insert(ir_value *self, size_t idx, ir_life_entry_t e)
1315 vec_push(self->life, e);
1316 for (k = vec_size(self->life)-1; k > idx; --k)
1317 self->life[k] = self->life[k-1];
1318 self->life[idx] = e;
1322 static bool ir_value_life_merge(ir_value *self, size_t s)
1325 const size_t vs = vec_size(self->life);
1326 ir_life_entry_t *life = NULL;
1327 ir_life_entry_t *before = NULL;
1328 ir_life_entry_t new_entry;
1330 /* Find the first range >= s */
1331 for (i = 0; i < vs; ++i)
1334 life = &self->life[i];
1335 if (life->start > s)
1338 /* nothing found? append */
1341 if (life && life->end+1 == s)
1343 /* previous life range can be merged in */
1347 if (life && life->end >= s)
1349 e.start = e.end = s;
1350 vec_push(self->life, e);
1356 if (before->end + 1 == s &&
1357 life->start - 1 == s)
1360 before->end = life->end;
1361 vec_remove(self->life, i, 1);
1364 if (before->end + 1 == s)
1370 /* already contained */
1371 if (before->end >= s)
1375 if (life->start - 1 == s)
1380 /* insert a new entry */
1381 new_entry.start = new_entry.end = s;
1382 return ir_value_life_insert(self, i, new_entry);
1385 static bool ir_value_life_merge_into(ir_value *self, const ir_value *other)
1389 if (!vec_size(other->life))
1392 if (!vec_size(self->life)) {
1393 size_t count = vec_size(other->life);
1394 ir_life_entry_t *life = vec_add(self->life, count);
1395 memcpy(life, other->life, count * sizeof(*life));
1400 for (i = 0; i < vec_size(other->life); ++i)
1402 const ir_life_entry_t *life = &other->life[i];
1405 ir_life_entry_t *entry = &self->life[myi];
1407 if (life->end+1 < entry->start)
1409 /* adding an interval before entry */
1410 if (!ir_value_life_insert(self, myi, *life))
1416 if (life->start < entry->start &&
1417 life->end+1 >= entry->start)
1419 /* starts earlier and overlaps */
1420 entry->start = life->start;
1423 if (life->end > entry->end &&
1424 life->start <= entry->end+1)
1426 /* ends later and overlaps */
1427 entry->end = life->end;
1430 /* see if our change combines it with the next ranges */
1431 while (myi+1 < vec_size(self->life) &&
1432 entry->end+1 >= self->life[1+myi].start)
1434 /* overlaps with (myi+1) */
1435 if (entry->end < self->life[1+myi].end)
1436 entry->end = self->life[1+myi].end;
1437 vec_remove(self->life, myi+1, 1);
1438 entry = &self->life[myi];
1441 /* see if we're after the entry */
1442 if (life->start > entry->end)
1445 /* append if we're at the end */
1446 if (myi >= vec_size(self->life)) {
1447 vec_push(self->life, *life);
1450 /* otherweise check the next range */
1459 static bool ir_values_overlap(const ir_value *a, const ir_value *b)
1461 /* For any life entry in A see if it overlaps with
1462 * any life entry in B.
1463 * Note that the life entries are orderes, so we can make a
1464 * more efficient algorithm there than naively translating the
1468 ir_life_entry_t *la, *lb, *enda, *endb;
1470 /* first of all, if either has no life range, they cannot clash */
1471 if (!vec_size(a->life) || !vec_size(b->life))
1476 enda = la + vec_size(a->life);
1477 endb = lb + vec_size(b->life);
1480 /* check if the entries overlap, for that,
1481 * both must start before the other one ends.
1483 if (la->start < lb->end &&
1484 lb->start < la->end)
1489 /* entries are ordered
1490 * one entry is earlier than the other
1491 * that earlier entry will be moved forward
1493 if (la->start < lb->start)
1495 /* order: A B, move A forward
1496 * check if we hit the end with A
1501 else /* if (lb->start < la->start) actually <= */
1503 /* order: B A, move B forward
1504 * check if we hit the end with B
1513 /***********************************************************************
1517 static bool ir_check_unreachable(ir_block *self)
1519 /* The IR should never have to deal with unreachable code */
1520 if (!self->final/* || OPTS_FLAG(ALLOW_UNREACHABLE_CODE)*/)
1522 irerror(self->context, "unreachable statement (%s)", self->label);
1526 bool ir_block_create_store_op(ir_block *self, lex_ctx_t ctx, int op, ir_value *target, ir_value *what)
1529 if (!ir_check_unreachable(self))
1532 if (target->store == store_value &&
1533 (op < INSTR_STOREP_F || op > INSTR_STOREP_FNC))
1535 irerror(self->context, "cannot store to an SSA value");
1536 irerror(self->context, "trying to store: %s <- %s", target->name, what->name);
1537 irerror(self->context, "instruction: %s", util_instr_str[op]);
1541 in = ir_instr_new(ctx, self, op);
1545 if (!ir_instr_op(in, 0, target, (op < INSTR_STOREP_F || op > INSTR_STOREP_FNC)) ||
1546 !ir_instr_op(in, 1, what, false))
1548 ir_instr_delete(in);
1551 vec_push(self->instr, in);
1555 bool ir_block_create_state_op(ir_block *self, lex_ctx_t ctx, ir_value *frame, ir_value *think)
1558 if (!ir_check_unreachable(self))
1561 in = ir_instr_new(ctx, self, INSTR_STATE);
1565 if (!ir_instr_op(in, 0, frame, false) ||
1566 !ir_instr_op(in, 1, think, false))
1568 ir_instr_delete(in);
1571 vec_push(self->instr, in);
1575 static bool ir_block_create_store(ir_block *self, lex_ctx_t ctx, ir_value *target, ir_value *what)
1579 if (target->vtype == TYPE_VARIANT)
1580 vtype = what->vtype;
1582 vtype = target->vtype;
1585 if (vtype == TYPE_FLOAT && what->vtype == TYPE_INTEGER)
1586 op = INSTR_CONV_ITOF;
1587 else if (vtype == TYPE_INTEGER && what->vtype == TYPE_FLOAT)
1588 op = INSTR_CONV_FTOI;
1590 op = type_store_instr[vtype];
1592 if (OPTS_FLAG(ADJUST_VECTOR_FIELDS)) {
1593 if (op == INSTR_STORE_FLD && what->fieldtype == TYPE_VECTOR)
1597 return ir_block_create_store_op(self, ctx, op, target, what);
1600 bool ir_block_create_storep(ir_block *self, lex_ctx_t ctx, ir_value *target, ir_value *what)
1605 if (target->vtype != TYPE_POINTER)
1608 /* storing using pointer - target is a pointer, type must be
1609 * inferred from source
1611 vtype = what->vtype;
1613 op = type_storep_instr[vtype];
1614 if (OPTS_FLAG(ADJUST_VECTOR_FIELDS)) {
1615 if (op == INSTR_STOREP_FLD && what->fieldtype == TYPE_VECTOR)
1616 op = INSTR_STOREP_V;
1619 return ir_block_create_store_op(self, ctx, op, target, what);
1622 bool ir_block_create_return(ir_block *self, lex_ctx_t ctx, ir_value *v)
1625 if (!ir_check_unreachable(self))
1630 self->is_return = true;
1631 in = ir_instr_new(ctx, self, INSTR_RETURN);
1635 if (v && !ir_instr_op(in, 0, v, false)) {
1636 ir_instr_delete(in);
1640 vec_push(self->instr, in);
1644 bool ir_block_create_if(ir_block *self, lex_ctx_t ctx, ir_value *v,
1645 ir_block *ontrue, ir_block *onfalse)
1648 if (!ir_check_unreachable(self))
1651 /*in = ir_instr_new(ctx, self, (v->vtype == TYPE_STRING ? INSTR_IF_S : INSTR_IF_F));*/
1652 in = ir_instr_new(ctx, self, VINSTR_COND);
1656 if (!ir_instr_op(in, 0, v, false)) {
1657 ir_instr_delete(in);
1661 in->bops[0] = ontrue;
1662 in->bops[1] = onfalse;
1664 vec_push(self->instr, in);
1666 vec_push(self->exits, ontrue);
1667 vec_push(self->exits, onfalse);
1668 vec_push(ontrue->entries, self);
1669 vec_push(onfalse->entries, self);
1673 bool ir_block_create_jump(ir_block *self, lex_ctx_t ctx, ir_block *to)
1676 if (!ir_check_unreachable(self))
1679 in = ir_instr_new(ctx, self, VINSTR_JUMP);
1684 vec_push(self->instr, in);
1686 vec_push(self->exits, to);
1687 vec_push(to->entries, self);
1691 bool ir_block_create_goto(ir_block *self, lex_ctx_t ctx, ir_block *to)
1693 self->owner->flags |= IR_FLAG_HAS_GOTO;
1694 return ir_block_create_jump(self, ctx, to);
1697 ir_instr* ir_block_create_phi(ir_block *self, lex_ctx_t ctx, const char *label, int ot)
1701 if (!ir_check_unreachable(self))
1703 in = ir_instr_new(ctx, self, VINSTR_PHI);
1706 out = ir_value_out(self->owner, label, store_value, ot);
1708 ir_instr_delete(in);
1711 if (!ir_instr_op(in, 0, out, true)) {
1712 ir_instr_delete(in);
1713 ir_value_delete(out);
1716 vec_push(self->instr, in);
1720 ir_value* ir_phi_value(ir_instr *self)
1722 return self->_ops[0];
1725 void ir_phi_add(ir_instr* self, ir_block *b, ir_value *v)
1729 if (!vec_ir_block_find(self->owner->entries, b, NULL)) {
1730 /* Must not be possible to cause this, otherwise the AST
1731 * is doing something wrong.
1733 irerror(self->context, "Invalid entry block for PHI");
1739 vec_push(v->reads, self);
1740 vec_push(self->phi, pe);
1743 /* call related code */
1744 ir_instr* ir_block_create_call(ir_block *self, lex_ctx_t ctx, const char *label, ir_value *func, bool noreturn)
1748 if (!ir_check_unreachable(self))
1750 in = ir_instr_new(ctx, self, (noreturn ? VINSTR_NRCALL : INSTR_CALL0));
1755 self->is_return = true;
1757 out = ir_value_out(self->owner, label, (func->outtype == TYPE_VOID) ? store_return : store_value, func->outtype);
1759 ir_instr_delete(in);
1762 if (!ir_instr_op(in, 0, out, true) ||
1763 !ir_instr_op(in, 1, func, false))
1765 ir_instr_delete(in);
1766 ir_value_delete(out);
1769 vec_push(self->instr, in);
1772 if (!ir_block_create_return(self, ctx, NULL)) {
1773 compile_error(ctx, "internal error: failed to generate dummy-return instruction");
1774 ir_instr_delete(in);
1782 ir_value* ir_call_value(ir_instr *self)
1784 return self->_ops[0];
1787 void ir_call_param(ir_instr* self, ir_value *v)
1789 vec_push(self->params, v);
1790 vec_push(v->reads, self);
1793 /* binary op related code */
1795 ir_value* ir_block_create_binop(ir_block *self, lex_ctx_t ctx,
1796 const char *label, int opcode,
1797 ir_value *left, ir_value *right)
1820 case INSTR_SUB_S: /* -- offset of string as float */
1825 case INSTR_BITOR_IF:
1826 case INSTR_BITOR_FI:
1827 case INSTR_BITAND_FI:
1828 case INSTR_BITAND_IF:
1843 case INSTR_BITAND_I:
1846 case INSTR_RSHIFT_I:
1847 case INSTR_LSHIFT_I:
1855 case VINSTR_BITAND_V:
1856 case VINSTR_BITOR_V:
1857 case VINSTR_BITXOR_V:
1858 case VINSTR_BITAND_VF:
1859 case VINSTR_BITOR_VF:
1860 case VINSTR_BITXOR_VF:
1875 * after the following default case, the value of opcode can never
1876 * be 1, 2, 3, 4, 5, 6, 7, 8, 9, 62, 63, 64, 65
1880 /* boolean operations result in floats */
1883 * opcode >= 10 takes true branch opcode is at least 10
1884 * opcode <= 23 takes false branch opcode is at least 24
1886 if (opcode >= INSTR_EQ_F && opcode <= INSTR_GT)
1890 * At condition "opcode <= 23", the value of "opcode" must be
1892 * At condition "opcode <= 23", the value of "opcode" cannot be
1893 * equal to any of {1, 2, 3, 4, 5, 6, 7, 8, 9, 62, 63, 64, 65}.
1894 * The condition "opcode <= 23" cannot be true.
1896 * Thus ot=2 (TYPE_FLOAT) can never be true
1899 else if (opcode >= INSTR_LE && opcode <= INSTR_GT)
1901 else if (opcode >= INSTR_LE_I && opcode <= INSTR_EQ_FI)
1906 if (ot == TYPE_VOID) {
1907 /* The AST or parser were supposed to check this! */
1911 return ir_block_create_general_instr(self, ctx, label, opcode, left, right, ot);
1914 ir_value* ir_block_create_unary(ir_block *self, lex_ctx_t ctx,
1915 const char *label, int opcode,
1918 int ot = TYPE_FLOAT;
1924 case INSTR_NOT_FNC: /*
1925 case INSTR_NOT_I: */
1930 * Negation for virtual instructions is emulated with 0-value. Thankfully
1931 * the operand for 0 already exists so we just source it from here.
1934 return ir_block_create_general_instr(self, ctx, label, INSTR_SUB_F, NULL, operand, ot);
1936 return ir_block_create_general_instr(self, ctx, label, INSTR_SUB_V, NULL, operand, TYPE_VECTOR);
1939 ot = operand->vtype;
1942 if (ot == TYPE_VOID) {
1943 /* The AST or parser were supposed to check this! */
1947 /* let's use the general instruction creator and pass NULL for OPB */
1948 return ir_block_create_general_instr(self, ctx, label, opcode, operand, NULL, ot);
1951 static ir_value* ir_block_create_general_instr(ir_block *self, lex_ctx_t ctx, const char *label,
1952 int op, ir_value *a, ir_value *b, int outype)
1957 out = ir_value_out(self->owner, label, store_value, outype);
1961 instr = ir_instr_new(ctx, self, op);
1963 ir_value_delete(out);
1967 if (!ir_instr_op(instr, 0, out, true) ||
1968 !ir_instr_op(instr, 1, a, false) ||
1969 !ir_instr_op(instr, 2, b, false) )
1974 vec_push(self->instr, instr);
1978 ir_instr_delete(instr);
1979 ir_value_delete(out);
1983 ir_value* ir_block_create_fieldaddress(ir_block *self, lex_ctx_t ctx, const char *label, ir_value *ent, ir_value *field)
1987 /* Support for various pointer types todo if so desired */
1988 if (ent->vtype != TYPE_ENTITY)
1991 if (field->vtype != TYPE_FIELD)
1994 v = ir_block_create_general_instr(self, ctx, label, INSTR_ADDRESS, ent, field, TYPE_POINTER);
1995 v->fieldtype = field->fieldtype;
1999 ir_value* ir_block_create_load_from_ent(ir_block *self, lex_ctx_t ctx, const char *label, ir_value *ent, ir_value *field, int outype)
2002 if (ent->vtype != TYPE_ENTITY)
2005 /* at some point we could redirect for TYPE_POINTER... but that could lead to carelessness */
2006 if (field->vtype != TYPE_FIELD)
2011 case TYPE_FLOAT: op = INSTR_LOAD_F; break;
2012 case TYPE_VECTOR: op = INSTR_LOAD_V; break;
2013 case TYPE_STRING: op = INSTR_LOAD_S; break;
2014 case TYPE_FIELD: op = INSTR_LOAD_FLD; break;
2015 case TYPE_ENTITY: op = INSTR_LOAD_ENT; break;
2016 case TYPE_FUNCTION: op = INSTR_LOAD_FNC; break;
2018 case TYPE_POINTER: op = INSTR_LOAD_I; break;
2019 case TYPE_INTEGER: op = INSTR_LOAD_I; break;
2022 irerror(self->context, "invalid type for ir_block_create_load_from_ent: %s", type_name[outype]);
2026 return ir_block_create_general_instr(self, ctx, label, op, ent, field, outype);
2029 /* PHI resolving breaks the SSA, and must thus be the last
2030 * step before life-range calculation.
2033 static bool ir_block_naive_phi(ir_block *self);
2034 bool ir_function_naive_phi(ir_function *self)
2038 for (i = 0; i < vec_size(self->blocks); ++i)
2040 if (!ir_block_naive_phi(self->blocks[i]))
2046 static bool ir_block_naive_phi(ir_block *self)
2048 size_t i, p; /*, w;*/
2049 /* FIXME: optionally, create_phi can add the phis
2050 * to a list so we don't need to loop through blocks
2051 * - anyway: "don't optimize YET"
2053 for (i = 0; i < vec_size(self->instr); ++i)
2055 ir_instr *instr = self->instr[i];
2056 if (instr->opcode != VINSTR_PHI)
2059 vec_remove(self->instr, i, 1);
2060 --i; /* NOTE: i+1 below */
2062 for (p = 0; p < vec_size(instr->phi); ++p)
2064 ir_value *v = instr->phi[p].value;
2065 ir_block *b = instr->phi[p].from;
2067 if (v->store == store_value &&
2068 vec_size(v->reads) == 1 &&
2069 vec_size(v->writes) == 1)
2071 /* replace the value */
2072 if (!ir_instr_op(v->writes[0], 0, instr->_ops[0], true))
2077 /* force a move instruction */
2078 ir_instr *prevjump = vec_last(b->instr);
2081 instr->_ops[0]->store = store_global;
2082 if (!ir_block_create_store(b, instr->context, instr->_ops[0], v))
2084 instr->_ops[0]->store = store_value;
2085 vec_push(b->instr, prevjump);
2089 ir_instr_delete(instr);
2094 /***********************************************************************
2095 *IR Temp allocation code
2096 * Propagating value life ranges by walking through the function backwards
2097 * until no more changes are made.
2098 * In theory this should happen once more than once for every nested loop
2100 * Though this implementation might run an additional time for if nests.
2103 /* Enumerate instructions used by value's life-ranges
2105 static void ir_block_enumerate(ir_block *self, size_t *_eid)
2109 for (i = 0; i < vec_size(self->instr); ++i)
2111 self->instr[i]->eid = eid++;
2116 /* Enumerate blocks and instructions.
2117 * The block-enumeration is unordered!
2118 * We do not really use the block enumreation, however
2119 * the instruction enumeration is important for life-ranges.
2121 void ir_function_enumerate(ir_function *self)
2124 size_t instruction_id = 0;
2125 for (i = 0; i < vec_size(self->blocks); ++i)
2127 /* each block now gets an additional "entry" instruction id
2128 * we can use to avoid point-life issues
2130 self->blocks[i]->entry_id = instruction_id;
2133 self->blocks[i]->eid = i;
2134 ir_block_enumerate(self->blocks[i], &instruction_id);
2138 /* Local-value allocator
2139 * After finishing creating the liferange of all values used in a function
2140 * we can allocate their global-positions.
2141 * This is the counterpart to register-allocation in register machines.
2148 } function_allocator;
2150 static bool function_allocator_alloc(function_allocator *alloc, ir_value *var)
2153 size_t vsize = ir_value_sizeof(var);
2155 var->code.local = vec_size(alloc->locals);
2157 slot = ir_value_var("reg", store_global, var->vtype);
2161 if (!ir_value_life_merge_into(slot, var))
2164 vec_push(alloc->locals, slot);
2165 vec_push(alloc->sizes, vsize);
2166 vec_push(alloc->unique, var->unique_life);
2171 ir_value_delete(slot);
2175 static bool ir_function_allocator_assign(ir_function *self, function_allocator *alloc, ir_value *v)
2181 return function_allocator_alloc(alloc, v);
2183 for (a = 0; a < vec_size(alloc->locals); ++a)
2185 /* if it's reserved for a unique liferange: skip */
2186 if (alloc->unique[a])
2189 slot = alloc->locals[a];
2191 /* never resize parameters
2192 * will be required later when overlapping temps + locals
2194 if (a < vec_size(self->params) &&
2195 alloc->sizes[a] < ir_value_sizeof(v))
2200 if (ir_values_overlap(v, slot))
2203 if (!ir_value_life_merge_into(slot, v))
2206 /* adjust size for this slot */
2207 if (alloc->sizes[a] < ir_value_sizeof(v))
2208 alloc->sizes[a] = ir_value_sizeof(v);
2213 if (a >= vec_size(alloc->locals)) {
2214 if (!function_allocator_alloc(alloc, v))
2220 bool ir_function_allocate_locals(ir_function *self)
2225 bool opt_gt = OPTS_OPTIMIZATION(OPTIM_GLOBAL_TEMPS);
2229 function_allocator lockalloc, globalloc;
2231 if (!vec_size(self->locals) && !vec_size(self->values))
2234 globalloc.locals = NULL;
2235 globalloc.sizes = NULL;
2236 globalloc.positions = NULL;
2237 globalloc.unique = NULL;
2238 lockalloc.locals = NULL;
2239 lockalloc.sizes = NULL;
2240 lockalloc.positions = NULL;
2241 lockalloc.unique = NULL;
2243 for (i = 0; i < vec_size(self->locals); ++i)
2245 v = self->locals[i];
2246 if ((self->flags & IR_FLAG_MASK_NO_LOCAL_TEMPS) || !OPTS_OPTIMIZATION(OPTIM_LOCAL_TEMPS)) {
2248 v->unique_life = true;
2250 else if (i >= vec_size(self->params))
2253 v->locked = true; /* lock parameters locals */
2254 if (!function_allocator_alloc((v->locked || !opt_gt ? &lockalloc : &globalloc), v))
2257 for (; i < vec_size(self->locals); ++i)
2259 v = self->locals[i];
2260 if (!vec_size(v->life))
2262 if (!ir_function_allocator_assign(self, (v->locked || !opt_gt ? &lockalloc : &globalloc), v))
2266 /* Allocate a slot for any value that still exists */
2267 for (i = 0; i < vec_size(self->values); ++i)
2269 v = self->values[i];
2271 if (!vec_size(v->life))
2274 /* CALL optimization:
2275 * If the value is a parameter-temp: 1 write, 1 read from a CALL
2276 * and it's not "locked", write it to the OFS_PARM directly.
2278 if (OPTS_OPTIMIZATION(OPTIM_CALL_STORES) && !v->locked && !v->unique_life) {
2279 if (vec_size(v->reads) == 1 && vec_size(v->writes) == 1 &&
2280 (v->reads[0]->opcode == VINSTR_NRCALL ||
2281 (v->reads[0]->opcode >= INSTR_CALL0 && v->reads[0]->opcode <= INSTR_CALL8)
2286 ir_instr *call = v->reads[0];
2287 if (!vec_ir_value_find(call->params, v, ¶m)) {
2288 irerror(call->context, "internal error: unlocked parameter %s not found", v->name);
2291 ++opts_optimizationcount[OPTIM_CALL_STORES];
2292 v->callparam = true;
2294 ir_value_code_setaddr(v, OFS_PARM0 + 3*param);
2296 size_t nprotos = vec_size(self->owner->extparam_protos);
2299 if (nprotos > param)
2300 ep = self->owner->extparam_protos[param];
2303 ep = ir_gen_extparam_proto(self->owner);
2304 while (++nprotos <= param)
2305 ep = ir_gen_extparam_proto(self->owner);
2307 ir_instr_op(v->writes[0], 0, ep, true);
2308 call->params[param+8] = ep;
2312 if (vec_size(v->writes) == 1 && v->writes[0]->opcode == INSTR_CALL0)
2314 v->store = store_return;
2315 if (v->members[0]) v->members[0]->store = store_return;
2316 if (v->members[1]) v->members[1]->store = store_return;
2317 if (v->members[2]) v->members[2]->store = store_return;
2318 ++opts_optimizationcount[OPTIM_CALL_STORES];
2323 if (!ir_function_allocator_assign(self, (v->locked || !opt_gt ? &lockalloc : &globalloc), v))
2327 if (!lockalloc.sizes && !globalloc.sizes) {
2330 vec_push(lockalloc.positions, 0);
2331 vec_push(globalloc.positions, 0);
2333 /* Adjust slot positions based on sizes */
2334 if (lockalloc.sizes) {
2335 pos = (vec_size(lockalloc.sizes) ? lockalloc.positions[0] : 0);
2336 for (i = 1; i < vec_size(lockalloc.sizes); ++i)
2338 pos = lockalloc.positions[i-1] + lockalloc.sizes[i-1];
2339 vec_push(lockalloc.positions, pos);
2341 self->allocated_locals = pos + vec_last(lockalloc.sizes);
2343 if (globalloc.sizes) {
2344 pos = (vec_size(globalloc.sizes) ? globalloc.positions[0] : 0);
2345 for (i = 1; i < vec_size(globalloc.sizes); ++i)
2347 pos = globalloc.positions[i-1] + globalloc.sizes[i-1];
2348 vec_push(globalloc.positions, pos);
2350 self->globaltemps = pos + vec_last(globalloc.sizes);
2353 /* Locals need to know their new position */
2354 for (i = 0; i < vec_size(self->locals); ++i) {
2355 v = self->locals[i];
2356 if (v->locked || !opt_gt)
2357 v->code.local = lockalloc.positions[v->code.local];
2359 v->code.local = globalloc.positions[v->code.local];
2361 /* Take over the actual slot positions on values */
2362 for (i = 0; i < vec_size(self->values); ++i) {
2363 v = self->values[i];
2364 if (v->locked || !opt_gt)
2365 v->code.local = lockalloc.positions[v->code.local];
2367 v->code.local = globalloc.positions[v->code.local];
2375 for (i = 0; i < vec_size(lockalloc.locals); ++i)
2376 ir_value_delete(lockalloc.locals[i]);
2377 for (i = 0; i < vec_size(globalloc.locals); ++i)
2378 ir_value_delete(globalloc.locals[i]);
2379 vec_free(globalloc.unique);
2380 vec_free(globalloc.locals);
2381 vec_free(globalloc.sizes);
2382 vec_free(globalloc.positions);
2383 vec_free(lockalloc.unique);
2384 vec_free(lockalloc.locals);
2385 vec_free(lockalloc.sizes);
2386 vec_free(lockalloc.positions);
2390 /* Get information about which operand
2391 * is read from, or written to.
2393 static void ir_op_read_write(int op, size_t *read, size_t *write)
2413 case INSTR_STOREP_F:
2414 case INSTR_STOREP_V:
2415 case INSTR_STOREP_S:
2416 case INSTR_STOREP_ENT:
2417 case INSTR_STOREP_FLD:
2418 case INSTR_STOREP_FNC:
2429 static bool ir_block_living_add_instr(ir_block *self, size_t eid)
2432 const size_t vs = vec_size(self->living);
2433 bool changed = false;
2434 for (i = 0; i != vs; ++i)
2436 if (ir_value_life_merge(self->living[i], eid))
2442 static bool ir_block_living_lock(ir_block *self)
2445 bool changed = false;
2446 for (i = 0; i != vec_size(self->living); ++i)
2448 if (!self->living[i]->locked) {
2449 self->living[i]->locked = true;
2456 static bool ir_block_life_propagate(ir_block *self, bool *changed)
2460 size_t i, o, p, mem, cnt;
2461 /* bitmasks which operands are read from or written to */
2468 vec_free(self->living);
2470 p = vec_size(self->exits);
2471 for (i = 0; i < p; ++i) {
2472 ir_block *prev = self->exits[i];
2473 cnt = vec_size(prev->living);
2474 for (o = 0; o < cnt; ++o) {
2475 if (!vec_ir_value_find(self->living, prev->living[o], NULL))
2476 vec_push(self->living, prev->living[o]);
2480 i = vec_size(self->instr);
2483 instr = self->instr[i];
2485 /* See which operands are read and write operands */
2486 ir_op_read_write(instr->opcode, &read, &write);
2488 /* Go through the 3 main operands
2489 * writes first, then reads
2491 for (o = 0; o < 3; ++o)
2493 if (!instr->_ops[o]) /* no such operand */
2496 value = instr->_ops[o];
2498 /* We only care about locals */
2499 /* we also calculate parameter liferanges so that locals
2500 * can take up parameter slots */
2501 if (value->store != store_value &&
2502 value->store != store_local &&
2503 value->store != store_param)
2506 /* write operands */
2507 /* When we write to a local, we consider it "dead" for the
2508 * remaining upper part of the function, since in SSA a value
2509 * can only be written once (== created)
2514 bool in_living = vec_ir_value_find(self->living, value, &idx);
2517 /* If the value isn't alive it hasn't been read before... */
2518 /* TODO: See if the warning can be emitted during parsing or AST processing
2519 * otherwise have warning printed here.
2520 * IF printing a warning here: include filecontext_t,
2521 * and make sure it's only printed once
2522 * since this function is run multiple times.
2524 /* con_err( "Value only written %s\n", value->name); */
2525 if (ir_value_life_merge(value, instr->eid))
2528 /* since 'living' won't contain it
2529 * anymore, merge the value, since
2532 if (ir_value_life_merge(value, instr->eid))
2535 vec_remove(self->living, idx, 1);
2537 /* Removing a vector removes all members */
2538 for (mem = 0; mem < 3; ++mem) {
2539 if (value->members[mem] && vec_ir_value_find(self->living, value->members[mem], &idx)) {
2540 if (ir_value_life_merge(value->members[mem], instr->eid))
2542 vec_remove(self->living, idx, 1);
2545 /* Removing the last member removes the vector */
2546 if (value->memberof) {
2547 value = value->memberof;
2548 for (mem = 0; mem < 3; ++mem) {
2549 if (value->members[mem] && vec_ir_value_find(self->living, value->members[mem], NULL))
2552 if (mem == 3 && vec_ir_value_find(self->living, value, &idx)) {
2553 if (ir_value_life_merge(value, instr->eid))
2555 vec_remove(self->living, idx, 1);
2561 /* These operations need a special case as they can break when using
2562 * same source and destination operand otherwise, as the engine may
2563 * read the source multiple times. */
2564 if (instr->opcode == INSTR_MUL_VF ||
2565 instr->opcode == VINSTR_BITAND_VF ||
2566 instr->opcode == VINSTR_BITOR_VF ||
2567 instr->opcode == VINSTR_BITXOR ||
2568 instr->opcode == VINSTR_BITXOR_VF ||
2569 instr->opcode == VINSTR_BITXOR_V ||
2570 instr->opcode == VINSTR_CROSS)
2572 value = instr->_ops[2];
2573 /* the float source will get an additional lifetime */
2574 if (ir_value_life_merge(value, instr->eid+1))
2576 if (value->memberof && ir_value_life_merge(value->memberof, instr->eid+1))
2580 if (instr->opcode == INSTR_MUL_FV ||
2581 instr->opcode == INSTR_LOAD_V ||
2582 instr->opcode == VINSTR_BITXOR ||
2583 instr->opcode == VINSTR_BITXOR_VF ||
2584 instr->opcode == VINSTR_BITXOR_V ||
2585 instr->opcode == VINSTR_CROSS)
2587 value = instr->_ops[1];
2588 /* the float source will get an additional lifetime */
2589 if (ir_value_life_merge(value, instr->eid+1))
2591 if (value->memberof && ir_value_life_merge(value->memberof, instr->eid+1))
2595 for (o = 0; o < 3; ++o)
2597 if (!instr->_ops[o]) /* no such operand */
2600 value = instr->_ops[o];
2602 /* We only care about locals */
2603 /* we also calculate parameter liferanges so that locals
2604 * can take up parameter slots */
2605 if (value->store != store_value &&
2606 value->store != store_local &&
2607 value->store != store_param)
2613 if (!vec_ir_value_find(self->living, value, NULL))
2614 vec_push(self->living, value);
2615 /* reading adds the full vector */
2616 if (value->memberof && !vec_ir_value_find(self->living, value->memberof, NULL))
2617 vec_push(self->living, value->memberof);
2618 for (mem = 0; mem < 3; ++mem) {
2619 if (value->members[mem] && !vec_ir_value_find(self->living, value->members[mem], NULL))
2620 vec_push(self->living, value->members[mem]);
2624 /* PHI operands are always read operands */
2625 for (p = 0; p < vec_size(instr->phi); ++p)
2627 value = instr->phi[p].value;
2628 if (!vec_ir_value_find(self->living, value, NULL))
2629 vec_push(self->living, value);
2630 /* reading adds the full vector */
2631 if (value->memberof && !vec_ir_value_find(self->living, value->memberof, NULL))
2632 vec_push(self->living, value->memberof);
2633 for (mem = 0; mem < 3; ++mem) {
2634 if (value->members[mem] && !vec_ir_value_find(self->living, value->members[mem], NULL))
2635 vec_push(self->living, value->members[mem]);
2639 /* on a call, all these values must be "locked" */
2640 if (instr->opcode >= INSTR_CALL0 && instr->opcode <= INSTR_CALL8) {
2641 if (ir_block_living_lock(self))
2644 /* call params are read operands too */
2645 for (p = 0; p < vec_size(instr->params); ++p)
2647 value = instr->params[p];
2648 if (!vec_ir_value_find(self->living, value, NULL))
2649 vec_push(self->living, value);
2650 /* reading adds the full vector */
2651 if (value->memberof && !vec_ir_value_find(self->living, value->memberof, NULL))
2652 vec_push(self->living, value->memberof);
2653 for (mem = 0; mem < 3; ++mem) {
2654 if (value->members[mem] && !vec_ir_value_find(self->living, value->members[mem], NULL))
2655 vec_push(self->living, value->members[mem]);
2660 if (ir_block_living_add_instr(self, instr->eid))
2663 /* the "entry" instruction ID */
2664 if (ir_block_living_add_instr(self, self->entry_id))
2670 bool ir_function_calculate_liferanges(ir_function *self)
2675 /* parameters live at 0 */
2676 for (i = 0; i < vec_size(self->params); ++i)
2677 if (!ir_value_life_merge(self->locals[i], 0))
2678 compile_error(self->context, "internal error: failed value-life merging");
2683 i = vec_size(self->blocks);
2685 ir_block_life_propagate(self->blocks[i], &changed);
2689 if (vec_size(self->blocks)) {
2690 ir_block *block = self->blocks[0];
2691 for (i = 0; i < vec_size(block->living); ++i) {
2692 ir_value *v = block->living[i];
2693 if (v->store != store_local)
2695 if (v->vtype == TYPE_VECTOR)
2697 self->flags |= IR_FLAG_HAS_UNINITIALIZED;
2698 /* find the instruction reading from it */
2699 for (s = 0; s < vec_size(v->reads); ++s) {
2700 if (v->reads[s]->eid == v->life[0].end)
2703 if (s < vec_size(v->reads)) {
2704 if (irwarning(v->context, WARN_USED_UNINITIALIZED,
2705 "variable `%s` may be used uninitialized in this function\n"
2708 v->reads[s]->context.file, v->reads[s]->context.line)
2716 ir_value *vec = v->memberof;
2717 for (s = 0; s < vec_size(vec->reads); ++s) {
2718 if (vec->reads[s]->eid == v->life[0].end)
2721 if (s < vec_size(vec->reads)) {
2722 if (irwarning(v->context, WARN_USED_UNINITIALIZED,
2723 "variable `%s` may be used uninitialized in this function\n"
2726 vec->reads[s]->context.file, vec->reads[s]->context.line)
2734 if (irwarning(v->context, WARN_USED_UNINITIALIZED,
2735 "variable `%s` may be used uninitialized in this function", v->name))
2744 /***********************************************************************
2747 * Since the IR has the convention of putting 'write' operands
2748 * at the beginning, we have to rotate the operands of instructions
2749 * properly in order to generate valid QCVM code.
2751 * Having destinations at a fixed position is more convenient. In QC
2752 * this is *mostly* OPC, but FTE adds at least 2 instructions which
2753 * read from from OPA, and store to OPB rather than OPC. Which is
2754 * partially the reason why the implementation of these instructions
2755 * in darkplaces has been delayed for so long.
2757 * Breaking conventions is annoying...
2759 static bool ir_builder_gen_global(ir_builder *self, ir_value *global, bool islocal);
2761 static bool gen_global_field(code_t *code, ir_value *global)
2763 if (global->hasvalue)
2765 ir_value *fld = global->constval.vpointer;
2767 irerror(global->context, "Invalid field constant with no field: %s", global->name);
2771 /* copy the field's value */
2772 ir_value_code_setaddr(global, vec_size(code->globals));
2773 vec_push(code->globals, fld->code.fieldaddr);
2774 if (global->fieldtype == TYPE_VECTOR) {
2775 vec_push(code->globals, fld->code.fieldaddr+1);
2776 vec_push(code->globals, fld->code.fieldaddr+2);
2781 ir_value_code_setaddr(global, vec_size(code->globals));
2782 vec_push(code->globals, 0);
2783 if (global->fieldtype == TYPE_VECTOR) {
2784 vec_push(code->globals, 0);
2785 vec_push(code->globals, 0);
2788 if (global->code.globaladdr < 0)
2793 static bool gen_global_pointer(code_t *code, ir_value *global)
2795 if (global->hasvalue)
2797 ir_value *target = global->constval.vpointer;
2799 irerror(global->context, "Invalid pointer constant: %s", global->name);
2800 /* NULL pointers are pointing to the NULL constant, which also
2801 * sits at address 0, but still has an ir_value for itself.
2806 /* Here, relocations ARE possible - in fteqcc-enhanced-qc:
2807 * void() foo; <- proto
2808 * void() *fooptr = &foo;
2809 * void() foo = { code }
2811 if (!target->code.globaladdr) {
2812 /* FIXME: Check for the constant nullptr ir_value!
2813 * because then code.globaladdr being 0 is valid.
2815 irerror(global->context, "FIXME: Relocation support");
2819 ir_value_code_setaddr(global, vec_size(code->globals));
2820 vec_push(code->globals, target->code.globaladdr);
2824 ir_value_code_setaddr(global, vec_size(code->globals));
2825 vec_push(code->globals, 0);
2827 if (global->code.globaladdr < 0)
2832 static bool gen_blocks_recursive(code_t *code, ir_function *func, ir_block *block)
2834 prog_section_statement_t stmt;
2843 block->generated = true;
2844 block->code_start = vec_size(code->statements);
2845 for (i = 0; i < vec_size(block->instr); ++i)
2847 instr = block->instr[i];
2849 if (instr->opcode == VINSTR_PHI) {
2850 irerror(block->context, "cannot generate virtual instruction (phi)");
2854 if (instr->opcode == VINSTR_JUMP) {
2855 target = instr->bops[0];
2856 /* for uncoditional jumps, if the target hasn't been generated
2857 * yet, we generate them right here.
2859 if (!target->generated)
2860 return gen_blocks_recursive(code, func, target);
2862 /* otherwise we generate a jump instruction */
2863 stmt.opcode = INSTR_GOTO;
2864 stmt.o1.s1 = (target->code_start) - vec_size(code->statements);
2867 if (stmt.o1.s1 != 1)
2868 code_push_statement(code, &stmt, instr->context);
2870 /* no further instructions can be in this block */
2874 if (instr->opcode == VINSTR_BITXOR) {
2875 stmt.opcode = INSTR_BITOR;
2876 stmt.o1.s1 = ir_value_code_addr(instr->_ops[1]);
2877 stmt.o2.s1 = ir_value_code_addr(instr->_ops[2]);
2878 stmt.o3.s1 = ir_value_code_addr(instr->_ops[0]);
2879 code_push_statement(code, &stmt, instr->context);
2880 stmt.opcode = INSTR_BITAND;
2881 stmt.o1.s1 = ir_value_code_addr(instr->_ops[1]);
2882 stmt.o2.s1 = ir_value_code_addr(instr->_ops[2]);
2883 stmt.o3.s1 = ir_value_code_addr(func->owner->vinstr_temp[0]);
2884 code_push_statement(code, &stmt, instr->context);
2885 stmt.opcode = INSTR_SUB_F;
2886 stmt.o1.s1 = ir_value_code_addr(instr->_ops[0]);
2887 stmt.o2.s1 = ir_value_code_addr(func->owner->vinstr_temp[0]);
2888 stmt.o3.s1 = ir_value_code_addr(instr->_ops[0]);
2889 code_push_statement(code, &stmt, instr->context);
2891 /* instruction generated */
2895 if (instr->opcode == VINSTR_BITAND_V) {
2896 stmt.opcode = INSTR_BITAND;
2897 stmt.o1.s1 = ir_value_code_addr(instr->_ops[1]);
2898 stmt.o2.s1 = ir_value_code_addr(instr->_ops[2]);
2899 stmt.o3.s1 = ir_value_code_addr(instr->_ops[0]);
2900 code_push_statement(code, &stmt, instr->context);
2904 code_push_statement(code, &stmt, instr->context);
2908 code_push_statement(code, &stmt, instr->context);
2910 /* instruction generated */
2914 if (instr->opcode == VINSTR_BITOR_V) {
2915 stmt.opcode = INSTR_BITOR;
2916 stmt.o1.s1 = ir_value_code_addr(instr->_ops[1]);
2917 stmt.o2.s1 = ir_value_code_addr(instr->_ops[2]);
2918 stmt.o3.s1 = ir_value_code_addr(instr->_ops[0]);
2919 code_push_statement(code, &stmt, instr->context);
2923 code_push_statement(code, &stmt, instr->context);
2927 code_push_statement(code, &stmt, instr->context);
2929 /* instruction generated */
2933 if (instr->opcode == VINSTR_BITXOR_V) {
2934 for (j = 0; j < 3; ++j) {
2935 stmt.opcode = INSTR_BITOR;
2936 stmt.o1.s1 = ir_value_code_addr(instr->_ops[1]) + j;
2937 stmt.o2.s1 = ir_value_code_addr(instr->_ops[2]) + j;
2938 stmt.o3.s1 = ir_value_code_addr(instr->_ops[0]) + j;
2939 code_push_statement(code, &stmt, instr->context);
2940 stmt.opcode = INSTR_BITAND;
2941 stmt.o1.s1 = ir_value_code_addr(instr->_ops[1]) + j;
2942 stmt.o2.s1 = ir_value_code_addr(instr->_ops[2]) + j;
2943 stmt.o3.s1 = ir_value_code_addr(func->owner->vinstr_temp[0]) + j;
2944 code_push_statement(code, &stmt, instr->context);
2946 stmt.opcode = INSTR_SUB_V;
2947 stmt.o1.s1 = ir_value_code_addr(instr->_ops[0]);
2948 stmt.o2.s1 = ir_value_code_addr(func->owner->vinstr_temp[0]);
2949 stmt.o3.s1 = ir_value_code_addr(instr->_ops[0]);
2950 code_push_statement(code, &stmt, instr->context);
2952 /* instruction generated */
2956 if (instr->opcode == VINSTR_BITAND_VF) {
2957 stmt.opcode = INSTR_BITAND;
2958 stmt.o1.s1 = ir_value_code_addr(instr->_ops[1]);
2959 stmt.o2.s1 = ir_value_code_addr(instr->_ops[2]);
2960 stmt.o3.s1 = ir_value_code_addr(instr->_ops[0]);
2961 code_push_statement(code, &stmt, instr->context);
2964 code_push_statement(code, &stmt, instr->context);
2967 code_push_statement(code, &stmt, instr->context);
2969 /* instruction generated */
2973 if (instr->opcode == VINSTR_BITOR_VF) {
2974 stmt.opcode = INSTR_BITOR;
2975 stmt.o1.s1 = ir_value_code_addr(instr->_ops[1]);
2976 stmt.o2.s1 = ir_value_code_addr(instr->_ops[2]);
2977 stmt.o3.s1 = ir_value_code_addr(instr->_ops[0]);
2978 code_push_statement(code, &stmt, instr->context);
2981 code_push_statement(code, &stmt, instr->context);
2984 code_push_statement(code, &stmt, instr->context);
2986 /* instruction generated */
2990 if (instr->opcode == VINSTR_BITXOR_VF) {
2991 for (j = 0; j < 3; ++j) {
2992 stmt.opcode = INSTR_BITOR;
2993 stmt.o1.s1 = ir_value_code_addr(instr->_ops[1]) + j;
2994 stmt.o2.s1 = ir_value_code_addr(instr->_ops[2]);
2995 stmt.o3.s1 = ir_value_code_addr(instr->_ops[0]) + j;
2996 code_push_statement(code, &stmt, instr->context);
2997 stmt.opcode = INSTR_BITAND;
2998 stmt.o1.s1 = ir_value_code_addr(instr->_ops[1]) + j;
2999 stmt.o2.s1 = ir_value_code_addr(instr->_ops[2]);
3000 stmt.o3.s1 = ir_value_code_addr(func->owner->vinstr_temp[0]) + j;
3001 code_push_statement(code, &stmt, instr->context);
3003 stmt.opcode = INSTR_SUB_V;
3004 stmt.o1.s1 = ir_value_code_addr(instr->_ops[0]);
3005 stmt.o2.s1 = ir_value_code_addr(func->owner->vinstr_temp[0]);
3006 stmt.o3.s1 = ir_value_code_addr(instr->_ops[0]);
3007 code_push_statement(code, &stmt, instr->context);
3009 /* instruction generated */
3013 if (instr->opcode == VINSTR_CROSS) {
3014 stmt.opcode = INSTR_MUL_F;
3015 for (j = 0; j < 3; ++j) {
3016 stmt.o1.s1 = ir_value_code_addr(instr->_ops[1]) + (j + 1) % 3;
3017 stmt.o2.s1 = ir_value_code_addr(instr->_ops[2]) + (j + 2) % 3;
3018 stmt.o3.s1 = ir_value_code_addr(instr->_ops[0]) + j;
3019 code_push_statement(code, &stmt, instr->context);
3020 stmt.o1.s1 = ir_value_code_addr(instr->_ops[1]) + (j + 2) % 3;
3021 stmt.o2.s1 = ir_value_code_addr(instr->_ops[2]) + (j + 1) % 3;
3022 stmt.o3.s1 = ir_value_code_addr(func->owner->vinstr_temp[0]) + j;
3023 code_push_statement(code, &stmt, instr->context);
3025 stmt.opcode = INSTR_SUB_V;
3026 stmt.o1.s1 = ir_value_code_addr(instr->_ops[0]);
3027 stmt.o2.s1 = ir_value_code_addr(func->owner->vinstr_temp[0]);
3028 stmt.o3.s1 = ir_value_code_addr(instr->_ops[0]);
3029 code_push_statement(code, &stmt, instr->context);
3031 /* instruction generated */
3035 if (instr->opcode == VINSTR_COND) {
3036 ontrue = instr->bops[0];
3037 onfalse = instr->bops[1];
3038 /* TODO: have the AST signal which block should
3039 * come first: eg. optimize IFs without ELSE...
3042 stmt.o1.u1 = ir_value_code_addr(instr->_ops[0]);
3046 if (ontrue->generated) {
3047 stmt.opcode = INSTR_IF;
3048 stmt.o2.s1 = (ontrue->code_start) - vec_size(code->statements);
3049 if (stmt.o2.s1 != 1)
3050 code_push_statement(code, &stmt, instr->context);
3052 if (onfalse->generated) {
3053 stmt.opcode = INSTR_IFNOT;
3054 stmt.o2.s1 = (onfalse->code_start) - vec_size(code->statements);
3055 if (stmt.o2.s1 != 1)
3056 code_push_statement(code, &stmt, instr->context);
3058 if (!ontrue->generated) {
3059 if (onfalse->generated)
3060 return gen_blocks_recursive(code, func, ontrue);
3062 if (!onfalse->generated) {
3063 if (ontrue->generated)
3064 return gen_blocks_recursive(code, func, onfalse);
3066 /* neither ontrue nor onfalse exist */
3067 stmt.opcode = INSTR_IFNOT;
3068 if (!instr->likely) {
3069 /* Honor the likelyhood hint */
3070 ir_block *tmp = onfalse;
3071 stmt.opcode = INSTR_IF;
3075 stidx = vec_size(code->statements);
3076 code_push_statement(code, &stmt, instr->context);
3077 /* on false we jump, so add ontrue-path */
3078 if (!gen_blocks_recursive(code, func, ontrue))
3080 /* fixup the jump address */
3081 code->statements[stidx].o2.s1 = vec_size(code->statements) - stidx;
3082 /* generate onfalse path */
3083 if (onfalse->generated) {
3084 /* fixup the jump address */
3085 code->statements[stidx].o2.s1 = (onfalse->code_start) - (stidx);
3086 if (stidx+2 == vec_size(code->statements) && code->statements[stidx].o2.s1 == 1) {
3087 code->statements[stidx] = code->statements[stidx+1];
3088 if (code->statements[stidx].o1.s1 < 0)
3089 code->statements[stidx].o1.s1++;
3090 code_pop_statement(code);
3092 stmt.opcode = vec_last(code->statements).opcode;
3093 if (stmt.opcode == INSTR_GOTO ||
3094 stmt.opcode == INSTR_IF ||
3095 stmt.opcode == INSTR_IFNOT ||
3096 stmt.opcode == INSTR_RETURN ||
3097 stmt.opcode == INSTR_DONE)
3099 /* no use jumping from here */
3102 /* may have been generated in the previous recursive call */
3103 stmt.opcode = INSTR_GOTO;
3104 stmt.o1.s1 = (onfalse->code_start) - vec_size(code->statements);
3107 if (stmt.o1.s1 != 1)
3108 code_push_statement(code, &stmt, instr->context);
3111 else if (stidx+2 == vec_size(code->statements) && code->statements[stidx].o2.s1 == 1) {
3112 code->statements[stidx] = code->statements[stidx+1];
3113 if (code->statements[stidx].o1.s1 < 0)
3114 code->statements[stidx].o1.s1++;
3115 code_pop_statement(code);
3117 /* if not, generate now */
3118 return gen_blocks_recursive(code, func, onfalse);
3121 if ( (instr->opcode >= INSTR_CALL0 && instr->opcode <= INSTR_CALL8)
3122 || instr->opcode == VINSTR_NRCALL)
3127 first = vec_size(instr->params);
3130 for (p = 0; p < first; ++p)
3132 ir_value *param = instr->params[p];
3133 if (param->callparam)
3136 stmt.opcode = INSTR_STORE_F;
3139 if (param->vtype == TYPE_FIELD)
3140 stmt.opcode = field_store_instr[param->fieldtype];
3141 else if (param->vtype == TYPE_NIL)
3142 stmt.opcode = INSTR_STORE_V;
3144 stmt.opcode = type_store_instr[param->vtype];
3145 stmt.o1.u1 = ir_value_code_addr(param);
3146 stmt.o2.u1 = OFS_PARM0 + 3 * p;
3148 if (param->vtype == TYPE_VECTOR && (param->flags & IR_FLAG_SPLIT_VECTOR)) {
3149 /* fetch 3 separate floats */
3150 stmt.opcode = INSTR_STORE_F;
3151 stmt.o1.u1 = ir_value_code_addr(param->members[0]);
3152 code_push_statement(code, &stmt, instr->context);
3154 stmt.o1.u1 = ir_value_code_addr(param->members[1]);
3155 code_push_statement(code, &stmt, instr->context);
3157 stmt.o1.u1 = ir_value_code_addr(param->members[2]);
3158 code_push_statement(code, &stmt, instr->context);
3161 code_push_statement(code, &stmt, instr->context);
3163 /* Now handle extparams */
3164 first = vec_size(instr->params);
3165 for (; p < first; ++p)
3167 ir_builder *ir = func->owner;
3168 ir_value *param = instr->params[p];
3169 ir_value *targetparam;
3171 if (param->callparam)
3174 if (p-8 >= vec_size(ir->extparams))
3175 ir_gen_extparam(ir);
3177 targetparam = ir->extparams[p-8];
3179 stmt.opcode = INSTR_STORE_F;
3182 if (param->vtype == TYPE_FIELD)
3183 stmt.opcode = field_store_instr[param->fieldtype];
3184 else if (param->vtype == TYPE_NIL)
3185 stmt.opcode = INSTR_STORE_V;
3187 stmt.opcode = type_store_instr[param->vtype];
3188 stmt.o1.u1 = ir_value_code_addr(param);
3189 stmt.o2.u1 = ir_value_code_addr(targetparam);
3190 if (param->vtype == TYPE_VECTOR && (param->flags & IR_FLAG_SPLIT_VECTOR)) {
3191 /* fetch 3 separate floats */
3192 stmt.opcode = INSTR_STORE_F;
3193 stmt.o1.u1 = ir_value_code_addr(param->members[0]);
3194 code_push_statement(code, &stmt, instr->context);
3196 stmt.o1.u1 = ir_value_code_addr(param->members[1]);
3197 code_push_statement(code, &stmt, instr->context);
3199 stmt.o1.u1 = ir_value_code_addr(param->members[2]);
3200 code_push_statement(code, &stmt, instr->context);
3203 code_push_statement(code, &stmt, instr->context);
3206 stmt.opcode = INSTR_CALL0 + vec_size(instr->params);
3207 if (stmt.opcode > INSTR_CALL8)
3208 stmt.opcode = INSTR_CALL8;
3209 stmt.o1.u1 = ir_value_code_addr(instr->_ops[1]);
3212 code_push_statement(code, &stmt, instr->context);
3214 retvalue = instr->_ops[0];
3215 if (retvalue && retvalue->store != store_return &&
3216 (retvalue->store == store_global || vec_size(retvalue->life)))
3218 /* not to be kept in OFS_RETURN */
3219 if (retvalue->vtype == TYPE_FIELD && OPTS_FLAG(ADJUST_VECTOR_FIELDS))
3220 stmt.opcode = field_store_instr[retvalue->fieldtype];
3222 stmt.opcode = type_store_instr[retvalue->vtype];
3223 stmt.o1.u1 = OFS_RETURN;
3224 stmt.o2.u1 = ir_value_code_addr(retvalue);
3226 code_push_statement(code, &stmt, instr->context);
3231 if (instr->opcode == INSTR_STATE) {
3232 stmt.opcode = instr->opcode;
3234 stmt.o1.u1 = ir_value_code_addr(instr->_ops[0]);
3236 stmt.o2.u1 = ir_value_code_addr(instr->_ops[1]);
3238 code_push_statement(code, &stmt, instr->context);
3242 stmt.opcode = instr->opcode;
3247 /* This is the general order of operands */
3249 stmt.o3.u1 = ir_value_code_addr(instr->_ops[0]);
3252 stmt.o1.u1 = ir_value_code_addr(instr->_ops[1]);
3255 stmt.o2.u1 = ir_value_code_addr(instr->_ops[2]);
3257 if (stmt.opcode == INSTR_RETURN || stmt.opcode == INSTR_DONE)
3259 stmt.o1.u1 = stmt.o3.u1;
3262 else if ((stmt.opcode >= INSTR_STORE_F &&
3263 stmt.opcode <= INSTR_STORE_FNC) ||
3264 (stmt.opcode >= INSTR_STOREP_F &&
3265 stmt.opcode <= INSTR_STOREP_FNC))
3267 /* 2-operand instructions with A -> B */
3268 stmt.o2.u1 = stmt.o3.u1;
3271 /* tiny optimization, don't output
3274 if (stmt.o2.u1 == stmt.o1.u1 &&
3275 OPTS_OPTIMIZATION(OPTIM_PEEPHOLE))
3277 ++opts_optimizationcount[OPTIM_PEEPHOLE];
3281 code_push_statement(code, &stmt, instr->context);
3286 static bool gen_function_code(code_t *code, ir_function *self)
3289 prog_section_statement_t stmt, *retst;
3291 /* Starting from entry point, we generate blocks "as they come"
3292 * for now. Dead blocks will not be translated obviously.
3294 if (!vec_size(self->blocks)) {
3295 irerror(self->context, "Function '%s' declared without body.", self->name);
3299 block = self->blocks[0];
3300 if (block->generated)
3303 if (!gen_blocks_recursive(code, self, block)) {
3304 irerror(self->context, "failed to generate blocks for '%s'", self->name);
3308 /* code_write and qcvm -disasm need to know that the function ends here */
3309 retst = &vec_last(code->statements);
3310 if (OPTS_OPTIMIZATION(OPTIM_VOID_RETURN) &&
3311 self->outtype == TYPE_VOID &&
3312 retst->opcode == INSTR_RETURN &&
3313 !retst->o1.u1 && !retst->o2.u1 && !retst->o3.u1)
3315 retst->opcode = INSTR_DONE;
3316 ++opts_optimizationcount[OPTIM_VOID_RETURN];
3320 stmt.opcode = INSTR_DONE;
3324 last.line = vec_last(code->linenums);
3325 last.column = vec_last(code->columnnums);
3327 code_push_statement(code, &stmt, last);
3332 static qcint_t ir_builder_filestring(ir_builder *ir, const char *filename)
3334 /* NOTE: filename pointers are copied, we never strdup them,
3335 * thus we can use pointer-comparison to find the string.
3340 for (i = 0; i < vec_size(ir->filenames); ++i) {
3341 if (ir->filenames[i] == filename)
3342 return ir->filestrings[i];
3345 str = code_genstring(ir->code, filename);
3346 vec_push(ir->filenames, filename);
3347 vec_push(ir->filestrings, str);
3351 static bool gen_global_function(ir_builder *ir, ir_value *global)
3353 prog_section_function_t fun;
3358 if (!global->hasvalue || (!global->constval.vfunc))
3360 irerror(global->context, "Invalid state of function-global: not constant: %s", global->name);
3364 irfun = global->constval.vfunc;
3366 fun.name = global->code.name;
3367 fun.file = ir_builder_filestring(ir, global->context.file);
3368 fun.profile = 0; /* always 0 */
3369 fun.nargs = vec_size(irfun->params);
3373 for (i = 0;i < 8; ++i) {
3374 if ((int32_t)i >= fun.nargs)
3377 fun.argsize[i] = type_sizeof_[irfun->params[i]];
3381 fun.locals = irfun->allocated_locals;
3384 fun.entry = irfun->builtin+1;
3386 irfun->code_function_def = vec_size(ir->code->functions);
3387 fun.entry = vec_size(ir->code->statements);
3390 vec_push(ir->code->functions, fun);
3394 static ir_value* ir_gen_extparam_proto(ir_builder *ir)
3399 util_snprintf(name, sizeof(name), "EXTPARM#%i", (int)(vec_size(ir->extparam_protos)));
3400 global = ir_value_var(name, store_global, TYPE_VECTOR);
3402 vec_push(ir->extparam_protos, global);
3406 static void ir_gen_extparam(ir_builder *ir)
3408 prog_section_def_t def;
3411 if (vec_size(ir->extparam_protos) < vec_size(ir->extparams)+1)
3412 global = ir_gen_extparam_proto(ir);
3414 global = ir->extparam_protos[vec_size(ir->extparams)];
3416 def.name = code_genstring(ir->code, global->name);
3417 def.type = TYPE_VECTOR;
3418 def.offset = vec_size(ir->code->globals);
3420 vec_push(ir->code->defs, def);
3422 ir_value_code_setaddr(global, def.offset);
3424 vec_push(ir->code->globals, 0);
3425 vec_push(ir->code->globals, 0);
3426 vec_push(ir->code->globals, 0);
3428 vec_push(ir->extparams, global);
3431 static bool gen_function_extparam_copy(code_t *code, ir_function *self)
3433 size_t i, ext, numparams;
3435 ir_builder *ir = self->owner;
3437 prog_section_statement_t stmt;
3439 numparams = vec_size(self->params);
3443 stmt.opcode = INSTR_STORE_F;
3445 for (i = 8; i < numparams; ++i) {
3447 if (ext >= vec_size(ir->extparams))
3448 ir_gen_extparam(ir);
3450 ep = ir->extparams[ext];
3452 stmt.opcode = type_store_instr[self->locals[i]->vtype];
3453 if (self->locals[i]->vtype == TYPE_FIELD &&
3454 self->locals[i]->fieldtype == TYPE_VECTOR)
3456 stmt.opcode = INSTR_STORE_V;
3458 stmt.o1.u1 = ir_value_code_addr(ep);
3459 stmt.o2.u1 = ir_value_code_addr(self->locals[i]);
3460 code_push_statement(code, &stmt, self->context);
3466 static bool gen_function_varargs_copy(code_t *code, ir_function *self)
3468 size_t i, ext, numparams, maxparams;
3470 ir_builder *ir = self->owner;
3472 prog_section_statement_t stmt;
3474 numparams = vec_size(self->params);
3478 stmt.opcode = INSTR_STORE_V;
3480 maxparams = numparams + self->max_varargs;
3481 for (i = numparams; i < maxparams; ++i) {
3483 stmt.o1.u1 = OFS_PARM0 + 3*i;
3484 stmt.o2.u1 = ir_value_code_addr(self->locals[i]);
3485 code_push_statement(code, &stmt, self->context);
3489 while (ext >= vec_size(ir->extparams))
3490 ir_gen_extparam(ir);
3492 ep = ir->extparams[ext];
3494 stmt.o1.u1 = ir_value_code_addr(ep);
3495 stmt.o2.u1 = ir_value_code_addr(self->locals[i]);
3496 code_push_statement(code, &stmt, self->context);
3502 static bool gen_function_locals(ir_builder *ir, ir_value *global)
3504 prog_section_function_t *def;
3507 uint32_t firstlocal, firstglobal;
3509 irfun = global->constval.vfunc;
3510 def = ir->code->functions + irfun->code_function_def;
3512 if (OPTS_OPTION_BOOL(OPTION_G) ||
3513 !OPTS_OPTIMIZATION(OPTIM_OVERLAP_LOCALS) ||
3514 (irfun->flags & IR_FLAG_MASK_NO_OVERLAP))
3516 firstlocal = def->firstlocal = vec_size(ir->code->globals);
3518 firstlocal = def->firstlocal = ir->first_common_local;
3519 ++opts_optimizationcount[OPTIM_OVERLAP_LOCALS];
3522 firstglobal = (OPTS_OPTIMIZATION(OPTIM_GLOBAL_TEMPS) ? ir->first_common_globaltemp : firstlocal);
3524 for (i = vec_size(ir->code->globals); i < firstlocal + irfun->allocated_locals; ++i)
3525 vec_push(ir->code->globals, 0);
3526 for (i = 0; i < vec_size(irfun->locals); ++i) {
3527 ir_value *v = irfun->locals[i];
3528 if (v->locked || !OPTS_OPTIMIZATION(OPTIM_GLOBAL_TEMPS)) {
3529 ir_value_code_setaddr(v, firstlocal + v->code.local);
3530 if (!ir_builder_gen_global(ir, irfun->locals[i], true)) {
3531 irerror(irfun->locals[i]->context, "failed to generate local %s", irfun->locals[i]->name);
3536 ir_value_code_setaddr(v, firstglobal + v->code.local);
3538 for (i = 0; i < vec_size(irfun->values); ++i)
3540 ir_value *v = irfun->values[i];
3544 ir_value_code_setaddr(v, firstlocal + v->code.local);
3546 ir_value_code_setaddr(v, firstglobal + v->code.local);
3551 static bool gen_global_function_code(ir_builder *ir, ir_value *global)
3553 prog_section_function_t *fundef;
3558 irfun = global->constval.vfunc;
3560 if (global->cvq == CV_NONE) {
3561 if (irwarning(global->context, WARN_IMPLICIT_FUNCTION_POINTER,
3562 "function `%s` has no body and in QC implicitly becomes a function-pointer",
3565 /* Not bailing out just now. If this happens a lot you don't want to have
3566 * to rerun gmqcc for each such function.
3572 /* this was a function pointer, don't generate code for those */
3580 * If there is no definition and the thing is eraseable, we can ignore
3581 * outputting the function to begin with.
3583 if (global->flags & IR_FLAG_ERASEABLE && irfun->code_function_def < 0) {
3587 if (irfun->code_function_def < 0) {
3588 irerror(irfun->context, "`%s`: IR global wasn't generated, failed to access function-def", irfun->name);
3591 fundef = &ir->code->functions[irfun->code_function_def];
3593 fundef->entry = vec_size(ir->code->statements);
3594 if (!gen_function_locals(ir, global)) {
3595 irerror(irfun->context, "Failed to generate locals for function %s", irfun->name);
3598 if (!gen_function_extparam_copy(ir->code, irfun)) {
3599 irerror(irfun->context, "Failed to generate extparam-copy code for function %s", irfun->name);
3602 if (irfun->max_varargs && !gen_function_varargs_copy(ir->code, irfun)) {
3603 irerror(irfun->context, "Failed to generate vararg-copy code for function %s", irfun->name);
3606 if (!gen_function_code(ir->code, irfun)) {
3607 irerror(irfun->context, "Failed to generate code for function %s", irfun->name);
3613 static void gen_vector_defs(code_t *code, prog_section_def_t def, const char *name)
3618 if (!name || name[0] == '#' || OPTS_FLAG(SINGLE_VECTOR_DEFS))
3621 def.type = TYPE_FLOAT;
3625 component = (char*)mem_a(len+3);
3626 memcpy(component, name, len);
3628 component[len-0] = 0;
3629 component[len-2] = '_';
3631 component[len-1] = 'x';
3633 for (i = 0; i < 3; ++i) {
3634 def.name = code_genstring(code, component);
3635 vec_push(code->defs, def);
3643 static void gen_vector_fields(code_t *code, prog_section_field_t fld, const char *name)
3648 if (!name || OPTS_FLAG(SINGLE_VECTOR_DEFS))
3651 fld.type = TYPE_FLOAT;
3655 component = (char*)mem_a(len+3);
3656 memcpy(component, name, len);
3658 component[len-0] = 0;
3659 component[len-2] = '_';
3661 component[len-1] = 'x';
3663 for (i = 0; i < 3; ++i) {
3664 fld.name = code_genstring(code, component);
3665 vec_push(code->fields, fld);
3673 static bool ir_builder_gen_global(ir_builder *self, ir_value *global, bool islocal)
3677 prog_section_def_t def;
3678 bool pushdef = opts.optimizeoff;
3680 /* we don't generate split-vectors */
3681 if (global->vtype == TYPE_VECTOR && (global->flags & IR_FLAG_SPLIT_VECTOR))
3684 def.type = global->vtype;
3685 def.offset = vec_size(self->code->globals);
3687 if (OPTS_OPTION_BOOL(OPTION_G) || !islocal)
3692 * if we're eraseable and the function isn't referenced ignore outputting
3695 if (global->flags & IR_FLAG_ERASEABLE && vec_size(global->reads) == 0) {
3699 if (OPTS_OPTIMIZATION(OPTIM_STRIP_CONSTANT_NAMES) &&
3700 !(global->flags & IR_FLAG_INCLUDE_DEF) &&
3701 (global->name[0] == '#' || global->cvq == CV_CONST))
3707 if (global->name[0] == '#') {
3708 if (!self->str_immediate)
3709 self->str_immediate = code_genstring(self->code, "IMMEDIATE");
3710 def.name = global->code.name = self->str_immediate;
3713 def.name = global->code.name = code_genstring(self->code, global->name);
3718 def.offset = ir_value_code_addr(global);
3719 vec_push(self->code->defs, def);
3720 if (global->vtype == TYPE_VECTOR)
3721 gen_vector_defs(self->code, def, global->name);
3722 else if (global->vtype == TYPE_FIELD && global->fieldtype == TYPE_VECTOR)
3723 gen_vector_defs(self->code, def, global->name);
3730 switch (global->vtype)
3733 if (!strcmp(global->name, "end_sys_globals")) {
3734 /* TODO: remember this point... all the defs before this one
3735 * should be checksummed and added to progdefs.h when we generate it.
3738 else if (!strcmp(global->name, "end_sys_fields")) {
3739 /* TODO: same as above but for entity-fields rather than globsl
3742 else if(irwarning(global->context, WARN_VOID_VARIABLES, "unrecognized variable of type void `%s`",
3745 /* Not bailing out */
3748 /* I'd argue setting it to 0 is sufficient, but maybe some depend on knowing how far
3749 * the system fields actually go? Though the engine knows this anyway...
3750 * Maybe this could be an -foption
3751 * fteqcc creates data for end_sys_* - of size 1, so let's do the same
3753 ir_value_code_setaddr(global, vec_size(self->code->globals));
3754 vec_push(self->code->globals, 0);
3756 if (pushdef) vec_push(self->code->defs, def);
3759 if (pushdef) vec_push(self->code->defs, def);
3760 return gen_global_pointer(self->code, global);
3763 vec_push(self->code->defs, def);
3764 if (global->fieldtype == TYPE_VECTOR)
3765 gen_vector_defs(self->code, def, global->name);
3767 return gen_global_field(self->code, global);
3772 ir_value_code_setaddr(global, vec_size(self->code->globals));
3773 if (global->hasvalue) {
3774 iptr = (int32_t*)&global->constval.ivec[0];
3775 vec_push(self->code->globals, *iptr);
3777 vec_push(self->code->globals, 0);
3779 if (!islocal && global->cvq != CV_CONST)
3780 def.type |= DEF_SAVEGLOBAL;
3781 if (pushdef) vec_push(self->code->defs, def);
3783 return global->code.globaladdr >= 0;
3787 ir_value_code_setaddr(global, vec_size(self->code->globals));
3788 if (global->hasvalue) {
3789 uint32_t load = code_genstring(self->code, global->constval.vstring);
3790 vec_push(self->code->globals, load);
3792 vec_push(self->code->globals, 0);
3794 if (!islocal && global->cvq != CV_CONST)
3795 def.type |= DEF_SAVEGLOBAL;
3796 if (pushdef) vec_push(self->code->defs, def);
3797 return global->code.globaladdr >= 0;
3802 ir_value_code_setaddr(global, vec_size(self->code->globals));
3803 if (global->hasvalue) {
3804 iptr = (int32_t*)&global->constval.ivec[0];
3805 vec_push(self->code->globals, iptr[0]);
3806 if (global->code.globaladdr < 0)
3808 for (d = 1; d < type_sizeof_[global->vtype]; ++d) {
3809 vec_push(self->code->globals, iptr[d]);
3812 vec_push(self->code->globals, 0);
3813 if (global->code.globaladdr < 0)
3815 for (d = 1; d < type_sizeof_[global->vtype]; ++d) {
3816 vec_push(self->code->globals, 0);
3819 if (!islocal && global->cvq != CV_CONST)
3820 def.type |= DEF_SAVEGLOBAL;
3823 vec_push(self->code->defs, def);
3824 def.type &= ~DEF_SAVEGLOBAL;
3825 gen_vector_defs(self->code, def, global->name);
3827 return global->code.globaladdr >= 0;
3830 ir_value_code_setaddr(global, vec_size(self->code->globals));
3831 if (!global->hasvalue) {
3832 vec_push(self->code->globals, 0);
3833 if (global->code.globaladdr < 0)
3836 vec_push(self->code->globals, vec_size(self->code->functions));
3837 if (!gen_global_function(self, global))
3840 if (!islocal && global->cvq != CV_CONST)
3841 def.type |= DEF_SAVEGLOBAL;
3842 if (pushdef) vec_push(self->code->defs, def);
3845 /* assume biggest type */
3846 ir_value_code_setaddr(global, vec_size(self->code->globals));
3847 vec_push(self->code->globals, 0);
3848 for (i = 1; i < type_sizeof_[TYPE_VARIANT]; ++i)
3849 vec_push(self->code->globals, 0);
3852 /* refuse to create 'void' type or any other fancy business. */
3853 irerror(global->context, "Invalid type for global variable `%s`: %s",
3854 global->name, type_name[global->vtype]);
3859 static GMQCC_INLINE void ir_builder_prepare_field(code_t *code, ir_value *field)
3861 field->code.fieldaddr = code_alloc_field(code, type_sizeof_[field->fieldtype]);
3864 static bool ir_builder_gen_field(ir_builder *self, ir_value *field)
3866 prog_section_def_t def;
3867 prog_section_field_t fld;
3871 def.type = (uint16_t)field->vtype;
3872 def.offset = (uint16_t)vec_size(self->code->globals);
3874 /* create a global named the same as the field */
3875 if (OPTS_OPTION_U32(OPTION_STANDARD) == COMPILER_GMQCC) {
3876 /* in our standard, the global gets a dot prefix */
3877 size_t len = strlen(field->name);
3880 /* we really don't want to have to allocate this, and 1024
3881 * bytes is more than enough for a variable/field name
3883 if (len+2 >= sizeof(name)) {
3884 irerror(field->context, "invalid field name size: %u", (unsigned int)len);
3889 memcpy(name+1, field->name, len); /* no strncpy - we used strlen above */
3892 def.name = code_genstring(self->code, name);
3893 fld.name = def.name + 1; /* we reuse that string table entry */
3895 /* in plain QC, there cannot be a global with the same name,
3896 * and so we also name the global the same.
3897 * FIXME: fteqcc should create a global as well
3898 * check if it actually uses the same name. Probably does
3900 def.name = code_genstring(self->code, field->name);
3901 fld.name = def.name;
3904 field->code.name = def.name;
3906 vec_push(self->code->defs, def);
3908 fld.type = field->fieldtype;
3910 if (fld.type == TYPE_VOID) {
3911 irerror(field->context, "field is missing a type: %s - don't know its size", field->name);
3915 fld.offset = field->code.fieldaddr;
3917 vec_push(self->code->fields, fld);
3919 ir_value_code_setaddr(field, vec_size(self->code->globals));
3920 vec_push(self->code->globals, fld.offset);
3921 if (fld.type == TYPE_VECTOR) {
3922 vec_push(self->code->globals, fld.offset+1);
3923 vec_push(self->code->globals, fld.offset+2);
3926 if (field->fieldtype == TYPE_VECTOR) {
3927 gen_vector_defs (self->code, def, field->name);
3928 gen_vector_fields(self->code, fld, field->name);
3931 return field->code.globaladdr >= 0;
3934 static void ir_builder_collect_reusables(ir_builder *builder) {
3936 ir_value **reusables = NULL;
3937 for (i = 0; i < vec_size(builder->globals); ++i) {
3938 ir_value *value = builder->globals[i];
3939 if (value->vtype != TYPE_FLOAT || !value->hasvalue)
3941 if (value->cvq == CV_CONST || (value->name && value->name[0] == '#')) {
3942 vec_push(reusables, value);
3945 builder->const_floats = reusables;
3948 static void ir_builder_split_vector(ir_builder *self, ir_value *vec) {
3950 ir_value* found[3] = { NULL, NULL, NULL };
3952 /* must not be written to */
3953 if (vec_size(vec->writes))
3955 /* must not be trying to access individual members */
3956 if (vec->members[0] || vec->members[1] || vec->members[2])
3958 /* should be actually used otherwise it won't be generated anyway */
3959 count = vec_size(vec->reads);
3963 /* may only be used directly as function parameters, so if we find some other instruction cancel */
3964 for (i = 0; i != count; ++i) {
3965 /* we only split vectors if they're used directly as parameter to a call only! */
3966 ir_instr *user = vec->reads[i];
3967 if ((user->opcode < INSTR_CALL0 || user->opcode > INSTR_CALL8) && user->opcode != VINSTR_NRCALL)
3971 vec->flags |= IR_FLAG_SPLIT_VECTOR;
3973 /* find existing floats making up the split */
3974 count = vec_size(self->const_floats);
3975 for (i = 0; i != count; ++i) {
3976 ir_value *c = self->const_floats[i];
3977 if (!found[0] && c->constval.vfloat == vec->constval.vvec.x)
3979 if (!found[1] && c->constval.vfloat == vec->constval.vvec.y)
3981 if (!found[2] && c->constval.vfloat == vec->constval.vvec.z)
3983 if (found[0] && found[1] && found[2])
3987 /* generate floats for not yet found components */
3989 found[0] = ir_builder_imm_float(self, vec->constval.vvec.x, true);
3991 if (vec->constval.vvec.y == vec->constval.vvec.x)
3992 found[1] = found[0];
3994 found[1] = ir_builder_imm_float(self, vec->constval.vvec.y, true);
3997 if (vec->constval.vvec.z == vec->constval.vvec.x)
3998 found[2] = found[0];
3999 else if (vec->constval.vvec.z == vec->constval.vvec.y)
4000 found[2] = found[1];
4002 found[2] = ir_builder_imm_float(self, vec->constval.vvec.z, true);
4005 /* the .members array should be safe to use here. */
4006 vec->members[0] = found[0];
4007 vec->members[1] = found[1];
4008 vec->members[2] = found[2];
4010 /* register the readers for these floats */
4011 count = vec_size(vec->reads);
4012 for (i = 0; i != count; ++i) {
4013 vec_push(found[0]->reads, vec->reads[i]);
4014 vec_push(found[1]->reads, vec->reads[i]);
4015 vec_push(found[2]->reads, vec->reads[i]);
4019 static void ir_builder_split_vectors(ir_builder *self) {
4020 size_t i, count = vec_size(self->globals);
4021 for (i = 0; i != count; ++i) {
4022 ir_value *v = self->globals[i];
4023 if (v->vtype != TYPE_VECTOR || !v->name || v->name[0] != '#')
4025 ir_builder_split_vector(self, self->globals[i]);
4029 bool ir_builder_generate(ir_builder *self, const char *filename)
4031 prog_section_statement_t stmt;
4033 char *lnofile = NULL;
4035 if (OPTS_FLAG(SPLIT_VECTOR_PARAMETERS)) {
4036 ir_builder_collect_reusables(self);
4037 if (vec_size(self->const_floats) > 0)
4038 ir_builder_split_vectors(self);
4041 for (i = 0; i < vec_size(self->fields); ++i)
4043 ir_builder_prepare_field(self->code, self->fields[i]);
4046 for (i = 0; i < vec_size(self->globals); ++i)
4048 if (!ir_builder_gen_global(self, self->globals[i], false)) {
4051 if (self->globals[i]->vtype == TYPE_FUNCTION) {
4052 ir_function *func = self->globals[i]->constval.vfunc;
4053 if (func && self->max_locals < func->allocated_locals &&
4054 !(func->flags & IR_FLAG_MASK_NO_OVERLAP))
4056 self->max_locals = func->allocated_locals;
4058 if (func && self->max_globaltemps < func->globaltemps)
4059 self->max_globaltemps = func->globaltemps;
4063 for (i = 0; i < vec_size(self->fields); ++i)
4065 if (!ir_builder_gen_field(self, self->fields[i])) {
4071 ir_value_code_setaddr(self->nil, vec_size(self->code->globals));
4072 vec_push(self->code->globals, 0);
4073 vec_push(self->code->globals, 0);
4074 vec_push(self->code->globals, 0);
4076 /* generate virtual-instruction temps */
4077 for (i = 0; i < IR_MAX_VINSTR_TEMPS; ++i) {
4078 ir_value_code_setaddr(self->vinstr_temp[i], vec_size(self->code->globals));
4079 vec_push(self->code->globals, 0);
4080 vec_push(self->code->globals, 0);
4081 vec_push(self->code->globals, 0);
4084 /* generate global temps */
4085 self->first_common_globaltemp = vec_size(self->code->globals);
4086 for (i = 0; i < self->max_globaltemps; ++i) {
4087 vec_push(self->code->globals, 0);
4089 /* generate common locals */
4090 self->first_common_local = vec_size(self->code->globals);
4091 for (i = 0; i < self->max_locals; ++i) {
4092 vec_push(self->code->globals, 0);
4095 /* generate function code */
4096 for (i = 0; i < vec_size(self->globals); ++i)
4098 if (self->globals[i]->vtype == TYPE_FUNCTION) {
4099 if (!gen_global_function_code(self, self->globals[i])) {
4105 if (vec_size(self->code->globals) >= 65536) {
4106 irerror(vec_last(self->globals)->context, "This progs file would require more globals than the metadata can handle (%u). Bailing out.", (unsigned int)vec_size(self->code->globals));
4110 /* DP errors if the last instruction is not an INSTR_DONE. */
4111 if (vec_last(self->code->statements).opcode != INSTR_DONE)
4115 stmt.opcode = INSTR_DONE;
4119 last.line = vec_last(self->code->linenums);
4120 last.column = vec_last(self->code->columnnums);
4122 code_push_statement(self->code, &stmt, last);
4125 if (OPTS_OPTION_BOOL(OPTION_PP_ONLY))
4128 if (vec_size(self->code->statements) != vec_size(self->code->linenums)) {
4129 con_err("Linecounter wrong: %lu != %lu\n",
4130 (unsigned long)vec_size(self->code->statements),
4131 (unsigned long)vec_size(self->code->linenums));
4132 } else if (OPTS_FLAG(LNO)) {
4134 size_t filelen = strlen(filename);
4136 memcpy(vec_add(lnofile, filelen+1), filename, filelen+1);
4137 dot = strrchr(lnofile, '.');
4141 vec_shrinkto(lnofile, dot - lnofile);
4143 memcpy(vec_add(lnofile, 5), ".lno", 5);
4146 if (!code_write(self->code, filename, lnofile)) {
4155 /***********************************************************************
4156 *IR DEBUG Dump functions...
4159 #define IND_BUFSZ 1024
4161 static const char *qc_opname(int op)
4163 if (op < 0) return "<INVALID>";
4164 if (op < VINSTR_END)
4165 return util_instr_str[op];
4167 case VINSTR_END: return "END";
4168 case VINSTR_PHI: return "PHI";
4169 case VINSTR_JUMP: return "JUMP";
4170 case VINSTR_COND: return "COND";
4171 case VINSTR_BITXOR: return "BITXOR";
4172 case VINSTR_BITAND_V: return "BITAND_V";
4173 case VINSTR_BITOR_V: return "BITOR_V";
4174 case VINSTR_BITXOR_V: return "BITXOR_V";
4175 case VINSTR_BITAND_VF: return "BITAND_VF";
4176 case VINSTR_BITOR_VF: return "BITOR_VF";
4177 case VINSTR_BITXOR_VF: return "BITXOR_VF";
4178 case VINSTR_CROSS: return "CROSS";
4179 case VINSTR_NEG_F: return "NEG_F";
4180 case VINSTR_NEG_V: return "NEG_V";
4181 default: return "<UNK>";
4185 void ir_builder_dump(ir_builder *b, int (*oprintf)(const char*, ...))
4188 char indent[IND_BUFSZ];
4192 oprintf("module %s\n", b->name);
4193 for (i = 0; i < vec_size(b->globals); ++i)
4196 if (b->globals[i]->hasvalue)
4197 oprintf("%s = ", b->globals[i]->name);
4198 ir_value_dump(b->globals[i], oprintf);
4201 for (i = 0; i < vec_size(b->functions); ++i)
4202 ir_function_dump(b->functions[i], indent, oprintf);
4203 oprintf("endmodule %s\n", b->name);
4206 static const char *storenames[] = {
4207 "[global]", "[local]", "[param]", "[value]", "[return]"
4210 void ir_function_dump(ir_function *f, char *ind,
4211 int (*oprintf)(const char*, ...))
4214 if (f->builtin != 0) {
4215 oprintf("%sfunction %s = builtin %i\n", ind, f->name, -f->builtin);
4218 oprintf("%sfunction %s\n", ind, f->name);
4219 util_strncat(ind, "\t", IND_BUFSZ-1);
4220 if (vec_size(f->locals))
4222 oprintf("%s%i locals:\n", ind, (int)vec_size(f->locals));
4223 for (i = 0; i < vec_size(f->locals); ++i) {
4224 oprintf("%s\t", ind);
4225 ir_value_dump(f->locals[i], oprintf);
4229 oprintf("%sliferanges:\n", ind);
4230 for (i = 0; i < vec_size(f->locals); ++i) {
4231 const char *attr = "";
4233 ir_value *v = f->locals[i];
4234 if (v->unique_life && v->locked)
4235 attr = "unique,locked ";
4236 else if (v->unique_life)
4240 oprintf("%s\t%s: %s %s %s%s@%i ", ind, v->name, type_name[v->vtype],
4241 storenames[v->store],
4242 attr, (v->callparam ? "callparam " : ""),
4243 (int)v->code.local);
4246 for (l = 0; l < vec_size(v->life); ++l) {
4247 oprintf("[%i,%i] ", v->life[l].start, v->life[l].end);
4250 for (m = 0; m < 3; ++m) {
4251 ir_value *vm = v->members[m];
4254 oprintf("%s\t%s: @%i ", ind, vm->name, (int)vm->code.local);
4255 for (l = 0; l < vec_size(vm->life); ++l) {
4256 oprintf("[%i,%i] ", vm->life[l].start, vm->life[l].end);
4261 for (i = 0; i < vec_size(f->values); ++i) {
4262 const char *attr = "";
4264 ir_value *v = f->values[i];
4265 if (v->unique_life && v->locked)
4266 attr = "unique,locked ";
4267 else if (v->unique_life)
4271 oprintf("%s\t%s: %s %s %s%s@%i ", ind, v->name, type_name[v->vtype],
4272 storenames[v->store],
4273 attr, (v->callparam ? "callparam " : ""),
4274 (int)v->code.local);
4277 for (l = 0; l < vec_size(v->life); ++l) {
4278 oprintf("[%i,%i] ", v->life[l].start, v->life[l].end);
4281 for (m = 0; m < 3; ++m) {
4282 ir_value *vm = v->members[m];
4285 if (vm->unique_life && vm->locked)
4286 attr = "unique,locked ";
4287 else if (vm->unique_life)
4289 else if (vm->locked)
4291 oprintf("%s\t%s: %s@%i ", ind, vm->name, attr, (int)vm->code.local);
4292 for (l = 0; l < vec_size(vm->life); ++l) {
4293 oprintf("[%i,%i] ", vm->life[l].start, vm->life[l].end);
4298 if (vec_size(f->blocks))
4300 oprintf("%slife passes: %i\n", ind, (int)f->run_id);
4301 for (i = 0; i < vec_size(f->blocks); ++i) {
4302 ir_block_dump(f->blocks[i], ind, oprintf);
4306 ind[strlen(ind)-1] = 0;
4307 oprintf("%sendfunction %s\n", ind, f->name);
4310 void ir_block_dump(ir_block* b, char *ind,
4311 int (*oprintf)(const char*, ...))
4314 oprintf("%s:%s\n", ind, b->label);
4315 util_strncat(ind, "\t", IND_BUFSZ-1);
4317 if (b->instr && b->instr[0])
4318 oprintf("%s (%i) [entry]\n", ind, (int)(b->instr[0]->eid-1));
4319 for (i = 0; i < vec_size(b->instr); ++i)
4320 ir_instr_dump(b->instr[i], ind, oprintf);
4321 ind[strlen(ind)-1] = 0;
4324 static void dump_phi(ir_instr *in, int (*oprintf)(const char*, ...))
4327 oprintf("%s <- phi ", in->_ops[0]->name);
4328 for (i = 0; i < vec_size(in->phi); ++i)
4330 oprintf("([%s] : %s) ", in->phi[i].from->label,
4331 in->phi[i].value->name);
4336 void ir_instr_dump(ir_instr *in, char *ind,
4337 int (*oprintf)(const char*, ...))
4340 const char *comma = NULL;
4342 oprintf("%s (%i) ", ind, (int)in->eid);
4344 if (in->opcode == VINSTR_PHI) {
4345 dump_phi(in, oprintf);
4349 util_strncat(ind, "\t", IND_BUFSZ-1);
4351 if (in->_ops[0] && (in->_ops[1] || in->_ops[2])) {
4352 ir_value_dump(in->_ops[0], oprintf);
4353 if (in->_ops[1] || in->_ops[2])
4356 if (in->opcode == INSTR_CALL0 || in->opcode == VINSTR_NRCALL) {
4357 oprintf("CALL%i\t", vec_size(in->params));
4359 oprintf("%s\t", qc_opname(in->opcode));
4361 if (in->_ops[0] && !(in->_ops[1] || in->_ops[2])) {
4362 ir_value_dump(in->_ops[0], oprintf);
4367 for (i = 1; i != 3; ++i) {
4371 ir_value_dump(in->_ops[i], oprintf);
4379 oprintf("[%s]", in->bops[0]->label);
4383 oprintf("%s[%s]", comma, in->bops[1]->label);
4384 if (vec_size(in->params)) {
4385 oprintf("\tparams: ");
4386 for (i = 0; i != vec_size(in->params); ++i) {
4387 oprintf("%s, ", in->params[i]->name);
4391 ind[strlen(ind)-1] = 0;
4394 static void ir_value_dump_string(const char *str, int (*oprintf)(const char*, ...))
4397 for (; *str; ++str) {
4399 case '\n': oprintf("\\n"); break;
4400 case '\r': oprintf("\\r"); break;
4401 case '\t': oprintf("\\t"); break;
4402 case '\v': oprintf("\\v"); break;
4403 case '\f': oprintf("\\f"); break;
4404 case '\b': oprintf("\\b"); break;
4405 case '\a': oprintf("\\a"); break;
4406 case '\\': oprintf("\\\\"); break;
4407 case '"': oprintf("\\\""); break;
4408 default: oprintf("%c", *str); break;
4414 void ir_value_dump(ir_value* v, int (*oprintf)(const char*, ...))
4423 oprintf("fn:%s", v->name);
4426 oprintf("%g", v->constval.vfloat);
4429 oprintf("'%g %g %g'",
4432 v->constval.vvec.z);
4435 oprintf("(entity)");
4438 ir_value_dump_string(v->constval.vstring, oprintf);
4442 oprintf("%i", v->constval.vint);
4447 v->constval.vpointer->name);
4451 oprintf("%s", v->name);
4455 void ir_value_dump_life(const ir_value *self, int (*oprintf)(const char*,...))
4458 oprintf("Life of %12s:", self->name);
4459 for (i = 0; i < vec_size(self->life); ++i)
4461 oprintf(" + [%i, %i]\n", self->life[i].start, self->life[i].end);