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);
1128 v->constval.vfloat = value;
1130 vec_push(self->globals, v);
1132 vec_push(self->const_floats, v);
1136 ir_value* ir_value_vector_member(ir_value *self, unsigned int member)
1144 if (self->members[member])
1145 return self->members[member];
1148 len = strlen(self->name);
1149 name = (char*)mem_a(len + 3);
1150 memcpy(name, self->name, len);
1152 name[len+1] = 'x' + member;
1158 if (self->vtype == TYPE_VECTOR)
1160 m = ir_value_var(name, self->store, TYPE_FLOAT);
1165 m->context = self->context;
1167 self->members[member] = m;
1168 m->code.addroffset = member;
1170 else if (self->vtype == TYPE_FIELD)
1172 if (self->fieldtype != TYPE_VECTOR)
1174 m = ir_value_var(name, self->store, TYPE_FIELD);
1179 m->fieldtype = TYPE_FLOAT;
1180 m->context = self->context;
1182 self->members[member] = m;
1183 m->code.addroffset = member;
1187 irerror(self->context, "invalid member access on %s", self->name);
1195 static GMQCC_INLINE size_t ir_value_sizeof(const ir_value *self)
1197 if (self->vtype == TYPE_FIELD && self->fieldtype == TYPE_VECTOR)
1198 return type_sizeof_[TYPE_VECTOR];
1199 return type_sizeof_[self->vtype];
1202 static ir_value* ir_value_out(ir_function *owner, const char *name, int storetype, int vtype)
1204 ir_value *v = ir_value_var(name, storetype, vtype);
1207 ir_function_collect_value(owner, v);
1211 void ir_value_delete(ir_value* self)
1215 mem_d((void*)self->name);
1218 if (self->vtype == TYPE_STRING)
1219 mem_d((void*)self->constval.vstring);
1221 if (!(self->flags & IR_FLAG_SPLIT_VECTOR)) {
1222 for (i = 0; i < 3; ++i) {
1223 if (self->members[i])
1224 ir_value_delete(self->members[i]);
1227 vec_free(self->reads);
1228 vec_free(self->writes);
1229 vec_free(self->life);
1233 bool ir_value_set_name(ir_value *self, const char *name)
1236 mem_d((void*)self->name);
1237 self->name = util_strdup(name);
1238 return !!self->name;
1241 bool ir_value_set_float(ir_value *self, float f)
1243 if (self->vtype != TYPE_FLOAT)
1245 self->constval.vfloat = f;
1246 self->hasvalue = true;
1250 bool ir_value_set_func(ir_value *self, int f)
1252 if (self->vtype != TYPE_FUNCTION)
1254 self->constval.vint = f;
1255 self->hasvalue = true;
1259 bool ir_value_set_vector(ir_value *self, vec3_t v)
1261 if (self->vtype != TYPE_VECTOR)
1263 self->constval.vvec = v;
1264 self->hasvalue = true;
1268 bool ir_value_set_field(ir_value *self, ir_value *fld)
1270 if (self->vtype != TYPE_FIELD)
1272 self->constval.vpointer = fld;
1273 self->hasvalue = true;
1277 bool ir_value_set_string(ir_value *self, const char *str)
1279 if (self->vtype != TYPE_STRING)
1281 self->constval.vstring = util_strdupe(str);
1282 self->hasvalue = true;
1287 bool ir_value_set_int(ir_value *self, int i)
1289 if (self->vtype != TYPE_INTEGER)
1291 self->constval.vint = i;
1292 self->hasvalue = true;
1297 bool ir_value_lives(ir_value *self, size_t at)
1300 for (i = 0; i < vec_size(self->life); ++i)
1302 ir_life_entry_t *life = &self->life[i];
1303 if (life->start <= at && at <= life->end)
1305 if (life->start > at) /* since it's ordered */
1311 static bool ir_value_life_insert(ir_value *self, size_t idx, ir_life_entry_t e)
1314 vec_push(self->life, e);
1315 for (k = vec_size(self->life)-1; k > idx; --k)
1316 self->life[k] = self->life[k-1];
1317 self->life[idx] = e;
1321 static bool ir_value_life_merge(ir_value *self, size_t s)
1324 const size_t vs = vec_size(self->life);
1325 ir_life_entry_t *life = NULL;
1326 ir_life_entry_t *before = NULL;
1327 ir_life_entry_t new_entry;
1329 /* Find the first range >= s */
1330 for (i = 0; i < vs; ++i)
1333 life = &self->life[i];
1334 if (life->start > s)
1337 /* nothing found? append */
1340 if (life && life->end+1 == s)
1342 /* previous life range can be merged in */
1346 if (life && life->end >= s)
1348 e.start = e.end = s;
1349 vec_push(self->life, e);
1355 if (before->end + 1 == s &&
1356 life->start - 1 == s)
1359 before->end = life->end;
1360 vec_remove(self->life, i, 1);
1363 if (before->end + 1 == s)
1369 /* already contained */
1370 if (before->end >= s)
1374 if (life->start - 1 == s)
1379 /* insert a new entry */
1380 new_entry.start = new_entry.end = s;
1381 return ir_value_life_insert(self, i, new_entry);
1384 static bool ir_value_life_merge_into(ir_value *self, const ir_value *other)
1388 if (!vec_size(other->life))
1391 if (!vec_size(self->life)) {
1392 size_t count = vec_size(other->life);
1393 ir_life_entry_t *life = vec_add(self->life, count);
1394 memcpy(life, other->life, count * sizeof(*life));
1399 for (i = 0; i < vec_size(other->life); ++i)
1401 const ir_life_entry_t *life = &other->life[i];
1404 ir_life_entry_t *entry = &self->life[myi];
1406 if (life->end+1 < entry->start)
1408 /* adding an interval before entry */
1409 if (!ir_value_life_insert(self, myi, *life))
1415 if (life->start < entry->start &&
1416 life->end+1 >= entry->start)
1418 /* starts earlier and overlaps */
1419 entry->start = life->start;
1422 if (life->end > entry->end &&
1423 life->start <= entry->end+1)
1425 /* ends later and overlaps */
1426 entry->end = life->end;
1429 /* see if our change combines it with the next ranges */
1430 while (myi+1 < vec_size(self->life) &&
1431 entry->end+1 >= self->life[1+myi].start)
1433 /* overlaps with (myi+1) */
1434 if (entry->end < self->life[1+myi].end)
1435 entry->end = self->life[1+myi].end;
1436 vec_remove(self->life, myi+1, 1);
1437 entry = &self->life[myi];
1440 /* see if we're after the entry */
1441 if (life->start > entry->end)
1444 /* append if we're at the end */
1445 if (myi >= vec_size(self->life)) {
1446 vec_push(self->life, *life);
1449 /* otherweise check the next range */
1458 static bool ir_values_overlap(const ir_value *a, const ir_value *b)
1460 /* For any life entry in A see if it overlaps with
1461 * any life entry in B.
1462 * Note that the life entries are orderes, so we can make a
1463 * more efficient algorithm there than naively translating the
1467 ir_life_entry_t *la, *lb, *enda, *endb;
1469 /* first of all, if either has no life range, they cannot clash */
1470 if (!vec_size(a->life) || !vec_size(b->life))
1475 enda = la + vec_size(a->life);
1476 endb = lb + vec_size(b->life);
1479 /* check if the entries overlap, for that,
1480 * both must start before the other one ends.
1482 if (la->start < lb->end &&
1483 lb->start < la->end)
1488 /* entries are ordered
1489 * one entry is earlier than the other
1490 * that earlier entry will be moved forward
1492 if (la->start < lb->start)
1494 /* order: A B, move A forward
1495 * check if we hit the end with A
1500 else /* if (lb->start < la->start) actually <= */
1502 /* order: B A, move B forward
1503 * check if we hit the end with B
1512 /***********************************************************************
1516 static bool ir_check_unreachable(ir_block *self)
1518 /* The IR should never have to deal with unreachable code */
1519 if (!self->final/* || OPTS_FLAG(ALLOW_UNREACHABLE_CODE)*/)
1521 irerror(self->context, "unreachable statement (%s)", self->label);
1525 bool ir_block_create_store_op(ir_block *self, lex_ctx_t ctx, int op, ir_value *target, ir_value *what)
1528 if (!ir_check_unreachable(self))
1531 if (target->store == store_value &&
1532 (op < INSTR_STOREP_F || op > INSTR_STOREP_FNC))
1534 irerror(self->context, "cannot store to an SSA value");
1535 irerror(self->context, "trying to store: %s <- %s", target->name, what->name);
1536 irerror(self->context, "instruction: %s", util_instr_str[op]);
1540 in = ir_instr_new(ctx, self, op);
1544 if (!ir_instr_op(in, 0, target, (op < INSTR_STOREP_F || op > INSTR_STOREP_FNC)) ||
1545 !ir_instr_op(in, 1, what, false))
1547 ir_instr_delete(in);
1550 vec_push(self->instr, in);
1554 bool ir_block_create_state_op(ir_block *self, lex_ctx_t ctx, ir_value *frame, ir_value *think)
1557 if (!ir_check_unreachable(self))
1560 in = ir_instr_new(ctx, self, INSTR_STATE);
1564 if (!ir_instr_op(in, 0, frame, false) ||
1565 !ir_instr_op(in, 1, think, false))
1567 ir_instr_delete(in);
1570 vec_push(self->instr, in);
1574 static bool ir_block_create_store(ir_block *self, lex_ctx_t ctx, ir_value *target, ir_value *what)
1578 if (target->vtype == TYPE_VARIANT)
1579 vtype = what->vtype;
1581 vtype = target->vtype;
1584 if (vtype == TYPE_FLOAT && what->vtype == TYPE_INTEGER)
1585 op = INSTR_CONV_ITOF;
1586 else if (vtype == TYPE_INTEGER && what->vtype == TYPE_FLOAT)
1587 op = INSTR_CONV_FTOI;
1589 op = type_store_instr[vtype];
1591 if (OPTS_FLAG(ADJUST_VECTOR_FIELDS)) {
1592 if (op == INSTR_STORE_FLD && what->fieldtype == TYPE_VECTOR)
1596 return ir_block_create_store_op(self, ctx, op, target, what);
1599 bool ir_block_create_storep(ir_block *self, lex_ctx_t ctx, ir_value *target, ir_value *what)
1604 if (target->vtype != TYPE_POINTER)
1607 /* storing using pointer - target is a pointer, type must be
1608 * inferred from source
1610 vtype = what->vtype;
1612 op = type_storep_instr[vtype];
1613 if (OPTS_FLAG(ADJUST_VECTOR_FIELDS)) {
1614 if (op == INSTR_STOREP_FLD && what->fieldtype == TYPE_VECTOR)
1615 op = INSTR_STOREP_V;
1618 return ir_block_create_store_op(self, ctx, op, target, what);
1621 bool ir_block_create_return(ir_block *self, lex_ctx_t ctx, ir_value *v)
1624 if (!ir_check_unreachable(self))
1629 self->is_return = true;
1630 in = ir_instr_new(ctx, self, INSTR_RETURN);
1634 if (v && !ir_instr_op(in, 0, v, false)) {
1635 ir_instr_delete(in);
1639 vec_push(self->instr, in);
1643 bool ir_block_create_if(ir_block *self, lex_ctx_t ctx, ir_value *v,
1644 ir_block *ontrue, ir_block *onfalse)
1647 if (!ir_check_unreachable(self))
1650 /*in = ir_instr_new(ctx, self, (v->vtype == TYPE_STRING ? INSTR_IF_S : INSTR_IF_F));*/
1651 in = ir_instr_new(ctx, self, VINSTR_COND);
1655 if (!ir_instr_op(in, 0, v, false)) {
1656 ir_instr_delete(in);
1660 in->bops[0] = ontrue;
1661 in->bops[1] = onfalse;
1663 vec_push(self->instr, in);
1665 vec_push(self->exits, ontrue);
1666 vec_push(self->exits, onfalse);
1667 vec_push(ontrue->entries, self);
1668 vec_push(onfalse->entries, self);
1672 bool ir_block_create_jump(ir_block *self, lex_ctx_t ctx, ir_block *to)
1675 if (!ir_check_unreachable(self))
1678 in = ir_instr_new(ctx, self, VINSTR_JUMP);
1683 vec_push(self->instr, in);
1685 vec_push(self->exits, to);
1686 vec_push(to->entries, self);
1690 bool ir_block_create_goto(ir_block *self, lex_ctx_t ctx, ir_block *to)
1692 self->owner->flags |= IR_FLAG_HAS_GOTO;
1693 return ir_block_create_jump(self, ctx, to);
1696 ir_instr* ir_block_create_phi(ir_block *self, lex_ctx_t ctx, const char *label, int ot)
1700 if (!ir_check_unreachable(self))
1702 in = ir_instr_new(ctx, self, VINSTR_PHI);
1705 out = ir_value_out(self->owner, label, store_value, ot);
1707 ir_instr_delete(in);
1710 if (!ir_instr_op(in, 0, out, true)) {
1711 ir_instr_delete(in);
1712 ir_value_delete(out);
1715 vec_push(self->instr, in);
1719 ir_value* ir_phi_value(ir_instr *self)
1721 return self->_ops[0];
1724 void ir_phi_add(ir_instr* self, ir_block *b, ir_value *v)
1728 if (!vec_ir_block_find(self->owner->entries, b, NULL)) {
1729 /* Must not be possible to cause this, otherwise the AST
1730 * is doing something wrong.
1732 irerror(self->context, "Invalid entry block for PHI");
1738 vec_push(v->reads, self);
1739 vec_push(self->phi, pe);
1742 /* call related code */
1743 ir_instr* ir_block_create_call(ir_block *self, lex_ctx_t ctx, const char *label, ir_value *func, bool noreturn)
1747 if (!ir_check_unreachable(self))
1749 in = ir_instr_new(ctx, self, (noreturn ? VINSTR_NRCALL : INSTR_CALL0));
1754 self->is_return = true;
1756 out = ir_value_out(self->owner, label, (func->outtype == TYPE_VOID) ? store_return : store_value, func->outtype);
1758 ir_instr_delete(in);
1761 if (!ir_instr_op(in, 0, out, true) ||
1762 !ir_instr_op(in, 1, func, false))
1764 ir_instr_delete(in);
1765 ir_value_delete(out);
1768 vec_push(self->instr, in);
1771 if (!ir_block_create_return(self, ctx, NULL)) {
1772 compile_error(ctx, "internal error: failed to generate dummy-return instruction");
1773 ir_instr_delete(in);
1781 ir_value* ir_call_value(ir_instr *self)
1783 return self->_ops[0];
1786 void ir_call_param(ir_instr* self, ir_value *v)
1788 vec_push(self->params, v);
1789 vec_push(v->reads, self);
1792 /* binary op related code */
1794 ir_value* ir_block_create_binop(ir_block *self, lex_ctx_t ctx,
1795 const char *label, int opcode,
1796 ir_value *left, ir_value *right)
1819 case INSTR_SUB_S: /* -- offset of string as float */
1824 case INSTR_BITOR_IF:
1825 case INSTR_BITOR_FI:
1826 case INSTR_BITAND_FI:
1827 case INSTR_BITAND_IF:
1842 case INSTR_BITAND_I:
1845 case INSTR_RSHIFT_I:
1846 case INSTR_LSHIFT_I:
1854 case VINSTR_BITAND_V:
1855 case VINSTR_BITOR_V:
1856 case VINSTR_BITXOR_V:
1857 case VINSTR_BITAND_VF:
1858 case VINSTR_BITOR_VF:
1859 case VINSTR_BITXOR_VF:
1874 * after the following default case, the value of opcode can never
1875 * be 1, 2, 3, 4, 5, 6, 7, 8, 9, 62, 63, 64, 65
1879 /* boolean operations result in floats */
1882 * opcode >= 10 takes true branch opcode is at least 10
1883 * opcode <= 23 takes false branch opcode is at least 24
1885 if (opcode >= INSTR_EQ_F && opcode <= INSTR_GT)
1889 * At condition "opcode <= 23", the value of "opcode" must be
1891 * At condition "opcode <= 23", the value of "opcode" cannot be
1892 * equal to any of {1, 2, 3, 4, 5, 6, 7, 8, 9, 62, 63, 64, 65}.
1893 * The condition "opcode <= 23" cannot be true.
1895 * Thus ot=2 (TYPE_FLOAT) can never be true
1898 else if (opcode >= INSTR_LE && opcode <= INSTR_GT)
1900 else if (opcode >= INSTR_LE_I && opcode <= INSTR_EQ_FI)
1905 if (ot == TYPE_VOID) {
1906 /* The AST or parser were supposed to check this! */
1910 return ir_block_create_general_instr(self, ctx, label, opcode, left, right, ot);
1913 ir_value* ir_block_create_unary(ir_block *self, lex_ctx_t ctx,
1914 const char *label, int opcode,
1917 int ot = TYPE_FLOAT;
1923 case INSTR_NOT_FNC: /*
1924 case INSTR_NOT_I: */
1929 * Negation for virtual instructions is emulated with 0-value. Thankfully
1930 * the operand for 0 already exists so we just source it from here.
1933 return ir_block_create_general_instr(self, ctx, label, INSTR_SUB_F, NULL, operand, ot);
1935 return ir_block_create_general_instr(self, ctx, label, INSTR_SUB_V, NULL, operand, TYPE_VECTOR);
1938 ot = operand->vtype;
1941 if (ot == TYPE_VOID) {
1942 /* The AST or parser were supposed to check this! */
1946 /* let's use the general instruction creator and pass NULL for OPB */
1947 return ir_block_create_general_instr(self, ctx, label, opcode, operand, NULL, ot);
1950 static ir_value* ir_block_create_general_instr(ir_block *self, lex_ctx_t ctx, const char *label,
1951 int op, ir_value *a, ir_value *b, int outype)
1956 out = ir_value_out(self->owner, label, store_value, outype);
1960 instr = ir_instr_new(ctx, self, op);
1962 ir_value_delete(out);
1966 if (!ir_instr_op(instr, 0, out, true) ||
1967 !ir_instr_op(instr, 1, a, false) ||
1968 !ir_instr_op(instr, 2, b, false) )
1973 vec_push(self->instr, instr);
1977 ir_instr_delete(instr);
1978 ir_value_delete(out);
1982 ir_value* ir_block_create_fieldaddress(ir_block *self, lex_ctx_t ctx, const char *label, ir_value *ent, ir_value *field)
1986 /* Support for various pointer types todo if so desired */
1987 if (ent->vtype != TYPE_ENTITY)
1990 if (field->vtype != TYPE_FIELD)
1993 v = ir_block_create_general_instr(self, ctx, label, INSTR_ADDRESS, ent, field, TYPE_POINTER);
1994 v->fieldtype = field->fieldtype;
1998 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)
2001 if (ent->vtype != TYPE_ENTITY)
2004 /* at some point we could redirect for TYPE_POINTER... but that could lead to carelessness */
2005 if (field->vtype != TYPE_FIELD)
2010 case TYPE_FLOAT: op = INSTR_LOAD_F; break;
2011 case TYPE_VECTOR: op = INSTR_LOAD_V; break;
2012 case TYPE_STRING: op = INSTR_LOAD_S; break;
2013 case TYPE_FIELD: op = INSTR_LOAD_FLD; break;
2014 case TYPE_ENTITY: op = INSTR_LOAD_ENT; break;
2015 case TYPE_FUNCTION: op = INSTR_LOAD_FNC; break;
2017 case TYPE_POINTER: op = INSTR_LOAD_I; break;
2018 case TYPE_INTEGER: op = INSTR_LOAD_I; break;
2021 irerror(self->context, "invalid type for ir_block_create_load_from_ent: %s", type_name[outype]);
2025 return ir_block_create_general_instr(self, ctx, label, op, ent, field, outype);
2028 /* PHI resolving breaks the SSA, and must thus be the last
2029 * step before life-range calculation.
2032 static bool ir_block_naive_phi(ir_block *self);
2033 bool ir_function_naive_phi(ir_function *self)
2037 for (i = 0; i < vec_size(self->blocks); ++i)
2039 if (!ir_block_naive_phi(self->blocks[i]))
2045 static bool ir_block_naive_phi(ir_block *self)
2047 size_t i, p; /*, w;*/
2048 /* FIXME: optionally, create_phi can add the phis
2049 * to a list so we don't need to loop through blocks
2050 * - anyway: "don't optimize YET"
2052 for (i = 0; i < vec_size(self->instr); ++i)
2054 ir_instr *instr = self->instr[i];
2055 if (instr->opcode != VINSTR_PHI)
2058 vec_remove(self->instr, i, 1);
2059 --i; /* NOTE: i+1 below */
2061 for (p = 0; p < vec_size(instr->phi); ++p)
2063 ir_value *v = instr->phi[p].value;
2064 ir_block *b = instr->phi[p].from;
2066 if (v->store == store_value &&
2067 vec_size(v->reads) == 1 &&
2068 vec_size(v->writes) == 1)
2070 /* replace the value */
2071 if (!ir_instr_op(v->writes[0], 0, instr->_ops[0], true))
2076 /* force a move instruction */
2077 ir_instr *prevjump = vec_last(b->instr);
2080 instr->_ops[0]->store = store_global;
2081 if (!ir_block_create_store(b, instr->context, instr->_ops[0], v))
2083 instr->_ops[0]->store = store_value;
2084 vec_push(b->instr, prevjump);
2088 ir_instr_delete(instr);
2093 /***********************************************************************
2094 *IR Temp allocation code
2095 * Propagating value life ranges by walking through the function backwards
2096 * until no more changes are made.
2097 * In theory this should happen once more than once for every nested loop
2099 * Though this implementation might run an additional time for if nests.
2102 /* Enumerate instructions used by value's life-ranges
2104 static void ir_block_enumerate(ir_block *self, size_t *_eid)
2108 for (i = 0; i < vec_size(self->instr); ++i)
2110 self->instr[i]->eid = eid++;
2115 /* Enumerate blocks and instructions.
2116 * The block-enumeration is unordered!
2117 * We do not really use the block enumreation, however
2118 * the instruction enumeration is important for life-ranges.
2120 void ir_function_enumerate(ir_function *self)
2123 size_t instruction_id = 0;
2124 for (i = 0; i < vec_size(self->blocks); ++i)
2126 /* each block now gets an additional "entry" instruction id
2127 * we can use to avoid point-life issues
2129 self->blocks[i]->entry_id = instruction_id;
2132 self->blocks[i]->eid = i;
2133 ir_block_enumerate(self->blocks[i], &instruction_id);
2137 /* Local-value allocator
2138 * After finishing creating the liferange of all values used in a function
2139 * we can allocate their global-positions.
2140 * This is the counterpart to register-allocation in register machines.
2147 } function_allocator;
2149 static bool function_allocator_alloc(function_allocator *alloc, ir_value *var)
2152 size_t vsize = ir_value_sizeof(var);
2154 var->code.local = vec_size(alloc->locals);
2156 slot = ir_value_var("reg", store_global, var->vtype);
2160 if (!ir_value_life_merge_into(slot, var))
2163 vec_push(alloc->locals, slot);
2164 vec_push(alloc->sizes, vsize);
2165 vec_push(alloc->unique, var->unique_life);
2170 ir_value_delete(slot);
2174 static bool ir_function_allocator_assign(ir_function *self, function_allocator *alloc, ir_value *v)
2180 return function_allocator_alloc(alloc, v);
2182 for (a = 0; a < vec_size(alloc->locals); ++a)
2184 /* if it's reserved for a unique liferange: skip */
2185 if (alloc->unique[a])
2188 slot = alloc->locals[a];
2190 /* never resize parameters
2191 * will be required later when overlapping temps + locals
2193 if (a < vec_size(self->params) &&
2194 alloc->sizes[a] < ir_value_sizeof(v))
2199 if (ir_values_overlap(v, slot))
2202 if (!ir_value_life_merge_into(slot, v))
2205 /* adjust size for this slot */
2206 if (alloc->sizes[a] < ir_value_sizeof(v))
2207 alloc->sizes[a] = ir_value_sizeof(v);
2212 if (a >= vec_size(alloc->locals)) {
2213 if (!function_allocator_alloc(alloc, v))
2219 bool ir_function_allocate_locals(ir_function *self)
2224 bool opt_gt = OPTS_OPTIMIZATION(OPTIM_GLOBAL_TEMPS);
2228 function_allocator lockalloc, globalloc;
2230 if (!vec_size(self->locals) && !vec_size(self->values))
2233 globalloc.locals = NULL;
2234 globalloc.sizes = NULL;
2235 globalloc.positions = NULL;
2236 globalloc.unique = NULL;
2237 lockalloc.locals = NULL;
2238 lockalloc.sizes = NULL;
2239 lockalloc.positions = NULL;
2240 lockalloc.unique = NULL;
2242 for (i = 0; i < vec_size(self->locals); ++i)
2244 v = self->locals[i];
2245 if ((self->flags & IR_FLAG_MASK_NO_LOCAL_TEMPS) || !OPTS_OPTIMIZATION(OPTIM_LOCAL_TEMPS)) {
2247 v->unique_life = true;
2249 else if (i >= vec_size(self->params))
2252 v->locked = true; /* lock parameters locals */
2253 if (!function_allocator_alloc((v->locked || !opt_gt ? &lockalloc : &globalloc), v))
2256 for (; i < vec_size(self->locals); ++i)
2258 v = self->locals[i];
2259 if (!vec_size(v->life))
2261 if (!ir_function_allocator_assign(self, (v->locked || !opt_gt ? &lockalloc : &globalloc), v))
2265 /* Allocate a slot for any value that still exists */
2266 for (i = 0; i < vec_size(self->values); ++i)
2268 v = self->values[i];
2270 if (!vec_size(v->life))
2273 /* CALL optimization:
2274 * If the value is a parameter-temp: 1 write, 1 read from a CALL
2275 * and it's not "locked", write it to the OFS_PARM directly.
2277 if (OPTS_OPTIMIZATION(OPTIM_CALL_STORES) && !v->locked && !v->unique_life) {
2278 if (vec_size(v->reads) == 1 && vec_size(v->writes) == 1 &&
2279 (v->reads[0]->opcode == VINSTR_NRCALL ||
2280 (v->reads[0]->opcode >= INSTR_CALL0 && v->reads[0]->opcode <= INSTR_CALL8)
2285 ir_instr *call = v->reads[0];
2286 if (!vec_ir_value_find(call->params, v, ¶m)) {
2287 irerror(call->context, "internal error: unlocked parameter %s not found", v->name);
2290 ++opts_optimizationcount[OPTIM_CALL_STORES];
2291 v->callparam = true;
2293 ir_value_code_setaddr(v, OFS_PARM0 + 3*param);
2295 size_t nprotos = vec_size(self->owner->extparam_protos);
2298 if (nprotos > param)
2299 ep = self->owner->extparam_protos[param];
2302 ep = ir_gen_extparam_proto(self->owner);
2303 while (++nprotos <= param)
2304 ep = ir_gen_extparam_proto(self->owner);
2306 ir_instr_op(v->writes[0], 0, ep, true);
2307 call->params[param+8] = ep;
2311 if (vec_size(v->writes) == 1 && v->writes[0]->opcode == INSTR_CALL0)
2313 v->store = store_return;
2314 if (v->members[0]) v->members[0]->store = store_return;
2315 if (v->members[1]) v->members[1]->store = store_return;
2316 if (v->members[2]) v->members[2]->store = store_return;
2317 ++opts_optimizationcount[OPTIM_CALL_STORES];
2322 if (!ir_function_allocator_assign(self, (v->locked || !opt_gt ? &lockalloc : &globalloc), v))
2326 if (!lockalloc.sizes && !globalloc.sizes) {
2329 vec_push(lockalloc.positions, 0);
2330 vec_push(globalloc.positions, 0);
2332 /* Adjust slot positions based on sizes */
2333 if (lockalloc.sizes) {
2334 pos = (vec_size(lockalloc.sizes) ? lockalloc.positions[0] : 0);
2335 for (i = 1; i < vec_size(lockalloc.sizes); ++i)
2337 pos = lockalloc.positions[i-1] + lockalloc.sizes[i-1];
2338 vec_push(lockalloc.positions, pos);
2340 self->allocated_locals = pos + vec_last(lockalloc.sizes);
2342 if (globalloc.sizes) {
2343 pos = (vec_size(globalloc.sizes) ? globalloc.positions[0] : 0);
2344 for (i = 1; i < vec_size(globalloc.sizes); ++i)
2346 pos = globalloc.positions[i-1] + globalloc.sizes[i-1];
2347 vec_push(globalloc.positions, pos);
2349 self->globaltemps = pos + vec_last(globalloc.sizes);
2352 /* Locals need to know their new position */
2353 for (i = 0; i < vec_size(self->locals); ++i) {
2354 v = self->locals[i];
2355 if (v->locked || !opt_gt)
2356 v->code.local = lockalloc.positions[v->code.local];
2358 v->code.local = globalloc.positions[v->code.local];
2360 /* Take over the actual slot positions on values */
2361 for (i = 0; i < vec_size(self->values); ++i) {
2362 v = self->values[i];
2363 if (v->locked || !opt_gt)
2364 v->code.local = lockalloc.positions[v->code.local];
2366 v->code.local = globalloc.positions[v->code.local];
2374 for (i = 0; i < vec_size(lockalloc.locals); ++i)
2375 ir_value_delete(lockalloc.locals[i]);
2376 for (i = 0; i < vec_size(globalloc.locals); ++i)
2377 ir_value_delete(globalloc.locals[i]);
2378 vec_free(globalloc.unique);
2379 vec_free(globalloc.locals);
2380 vec_free(globalloc.sizes);
2381 vec_free(globalloc.positions);
2382 vec_free(lockalloc.unique);
2383 vec_free(lockalloc.locals);
2384 vec_free(lockalloc.sizes);
2385 vec_free(lockalloc.positions);
2389 /* Get information about which operand
2390 * is read from, or written to.
2392 static void ir_op_read_write(int op, size_t *read, size_t *write)
2412 case INSTR_STOREP_F:
2413 case INSTR_STOREP_V:
2414 case INSTR_STOREP_S:
2415 case INSTR_STOREP_ENT:
2416 case INSTR_STOREP_FLD:
2417 case INSTR_STOREP_FNC:
2428 static bool ir_block_living_add_instr(ir_block *self, size_t eid)
2431 const size_t vs = vec_size(self->living);
2432 bool changed = false;
2433 for (i = 0; i != vs; ++i)
2435 if (ir_value_life_merge(self->living[i], eid))
2441 static bool ir_block_living_lock(ir_block *self)
2444 bool changed = false;
2445 for (i = 0; i != vec_size(self->living); ++i)
2447 if (!self->living[i]->locked) {
2448 self->living[i]->locked = true;
2455 static bool ir_block_life_propagate(ir_block *self, bool *changed)
2459 size_t i, o, p, mem, cnt;
2460 /* bitmasks which operands are read from or written to */
2467 vec_free(self->living);
2469 p = vec_size(self->exits);
2470 for (i = 0; i < p; ++i) {
2471 ir_block *prev = self->exits[i];
2472 cnt = vec_size(prev->living);
2473 for (o = 0; o < cnt; ++o) {
2474 if (!vec_ir_value_find(self->living, prev->living[o], NULL))
2475 vec_push(self->living, prev->living[o]);
2479 i = vec_size(self->instr);
2482 instr = self->instr[i];
2484 /* See which operands are read and write operands */
2485 ir_op_read_write(instr->opcode, &read, &write);
2487 /* Go through the 3 main operands
2488 * writes first, then reads
2490 for (o = 0; o < 3; ++o)
2492 if (!instr->_ops[o]) /* no such operand */
2495 value = instr->_ops[o];
2497 /* We only care about locals */
2498 /* we also calculate parameter liferanges so that locals
2499 * can take up parameter slots */
2500 if (value->store != store_value &&
2501 value->store != store_local &&
2502 value->store != store_param)
2505 /* write operands */
2506 /* When we write to a local, we consider it "dead" for the
2507 * remaining upper part of the function, since in SSA a value
2508 * can only be written once (== created)
2513 bool in_living = vec_ir_value_find(self->living, value, &idx);
2516 /* If the value isn't alive it hasn't been read before... */
2517 /* TODO: See if the warning can be emitted during parsing or AST processing
2518 * otherwise have warning printed here.
2519 * IF printing a warning here: include filecontext_t,
2520 * and make sure it's only printed once
2521 * since this function is run multiple times.
2523 /* con_err( "Value only written %s\n", value->name); */
2524 if (ir_value_life_merge(value, instr->eid))
2527 /* since 'living' won't contain it
2528 * anymore, merge the value, since
2531 if (ir_value_life_merge(value, instr->eid))
2534 vec_remove(self->living, idx, 1);
2536 /* Removing a vector removes all members */
2537 for (mem = 0; mem < 3; ++mem) {
2538 if (value->members[mem] && vec_ir_value_find(self->living, value->members[mem], &idx)) {
2539 if (ir_value_life_merge(value->members[mem], instr->eid))
2541 vec_remove(self->living, idx, 1);
2544 /* Removing the last member removes the vector */
2545 if (value->memberof) {
2546 value = value->memberof;
2547 for (mem = 0; mem < 3; ++mem) {
2548 if (value->members[mem] && vec_ir_value_find(self->living, value->members[mem], NULL))
2551 if (mem == 3 && vec_ir_value_find(self->living, value, &idx)) {
2552 if (ir_value_life_merge(value, instr->eid))
2554 vec_remove(self->living, idx, 1);
2560 /* These operations need a special case as they can break when using
2561 * same source and destination operand otherwise, as the engine may
2562 * read the source multiple times. */
2563 if (instr->opcode == INSTR_MUL_VF ||
2564 instr->opcode == VINSTR_BITAND_VF ||
2565 instr->opcode == VINSTR_BITOR_VF ||
2566 instr->opcode == VINSTR_BITXOR ||
2567 instr->opcode == VINSTR_BITXOR_VF ||
2568 instr->opcode == VINSTR_BITXOR_V ||
2569 instr->opcode == VINSTR_CROSS)
2571 value = instr->_ops[2];
2572 /* the float source will get an additional lifetime */
2573 if (ir_value_life_merge(value, instr->eid+1))
2575 if (value->memberof && ir_value_life_merge(value->memberof, instr->eid+1))
2579 if (instr->opcode == INSTR_MUL_FV ||
2580 instr->opcode == INSTR_LOAD_V ||
2581 instr->opcode == VINSTR_BITXOR ||
2582 instr->opcode == VINSTR_BITXOR_VF ||
2583 instr->opcode == VINSTR_BITXOR_V ||
2584 instr->opcode == VINSTR_CROSS)
2586 value = instr->_ops[1];
2587 /* the float source will get an additional lifetime */
2588 if (ir_value_life_merge(value, instr->eid+1))
2590 if (value->memberof && ir_value_life_merge(value->memberof, instr->eid+1))
2594 for (o = 0; o < 3; ++o)
2596 if (!instr->_ops[o]) /* no such operand */
2599 value = instr->_ops[o];
2601 /* We only care about locals */
2602 /* we also calculate parameter liferanges so that locals
2603 * can take up parameter slots */
2604 if (value->store != store_value &&
2605 value->store != store_local &&
2606 value->store != store_param)
2612 if (!vec_ir_value_find(self->living, value, NULL))
2613 vec_push(self->living, value);
2614 /* reading adds the full vector */
2615 if (value->memberof && !vec_ir_value_find(self->living, value->memberof, NULL))
2616 vec_push(self->living, value->memberof);
2617 for (mem = 0; mem < 3; ++mem) {
2618 if (value->members[mem] && !vec_ir_value_find(self->living, value->members[mem], NULL))
2619 vec_push(self->living, value->members[mem]);
2623 /* PHI operands are always read operands */
2624 for (p = 0; p < vec_size(instr->phi); ++p)
2626 value = instr->phi[p].value;
2627 if (!vec_ir_value_find(self->living, value, NULL))
2628 vec_push(self->living, value);
2629 /* reading adds the full vector */
2630 if (value->memberof && !vec_ir_value_find(self->living, value->memberof, NULL))
2631 vec_push(self->living, value->memberof);
2632 for (mem = 0; mem < 3; ++mem) {
2633 if (value->members[mem] && !vec_ir_value_find(self->living, value->members[mem], NULL))
2634 vec_push(self->living, value->members[mem]);
2638 /* on a call, all these values must be "locked" */
2639 if (instr->opcode >= INSTR_CALL0 && instr->opcode <= INSTR_CALL8) {
2640 if (ir_block_living_lock(self))
2643 /* call params are read operands too */
2644 for (p = 0; p < vec_size(instr->params); ++p)
2646 value = instr->params[p];
2647 if (!vec_ir_value_find(self->living, value, NULL))
2648 vec_push(self->living, value);
2649 /* reading adds the full vector */
2650 if (value->memberof && !vec_ir_value_find(self->living, value->memberof, NULL))
2651 vec_push(self->living, value->memberof);
2652 for (mem = 0; mem < 3; ++mem) {
2653 if (value->members[mem] && !vec_ir_value_find(self->living, value->members[mem], NULL))
2654 vec_push(self->living, value->members[mem]);
2659 if (ir_block_living_add_instr(self, instr->eid))
2662 /* the "entry" instruction ID */
2663 if (ir_block_living_add_instr(self, self->entry_id))
2669 bool ir_function_calculate_liferanges(ir_function *self)
2674 /* parameters live at 0 */
2675 for (i = 0; i < vec_size(self->params); ++i)
2676 if (!ir_value_life_merge(self->locals[i], 0))
2677 compile_error(self->context, "internal error: failed value-life merging");
2682 i = vec_size(self->blocks);
2684 ir_block_life_propagate(self->blocks[i], &changed);
2688 if (vec_size(self->blocks)) {
2689 ir_block *block = self->blocks[0];
2690 for (i = 0; i < vec_size(block->living); ++i) {
2691 ir_value *v = block->living[i];
2692 if (v->store != store_local)
2694 if (v->vtype == TYPE_VECTOR)
2696 self->flags |= IR_FLAG_HAS_UNINITIALIZED;
2697 /* find the instruction reading from it */
2698 for (s = 0; s < vec_size(v->reads); ++s) {
2699 if (v->reads[s]->eid == v->life[0].end)
2702 if (s < vec_size(v->reads)) {
2703 if (irwarning(v->context, WARN_USED_UNINITIALIZED,
2704 "variable `%s` may be used uninitialized in this function\n"
2707 v->reads[s]->context.file, v->reads[s]->context.line)
2715 ir_value *vec = v->memberof;
2716 for (s = 0; s < vec_size(vec->reads); ++s) {
2717 if (vec->reads[s]->eid == v->life[0].end)
2720 if (s < vec_size(vec->reads)) {
2721 if (irwarning(v->context, WARN_USED_UNINITIALIZED,
2722 "variable `%s` may be used uninitialized in this function\n"
2725 vec->reads[s]->context.file, vec->reads[s]->context.line)
2733 if (irwarning(v->context, WARN_USED_UNINITIALIZED,
2734 "variable `%s` may be used uninitialized in this function", v->name))
2743 /***********************************************************************
2746 * Since the IR has the convention of putting 'write' operands
2747 * at the beginning, we have to rotate the operands of instructions
2748 * properly in order to generate valid QCVM code.
2750 * Having destinations at a fixed position is more convenient. In QC
2751 * this is *mostly* OPC, but FTE adds at least 2 instructions which
2752 * read from from OPA, and store to OPB rather than OPC. Which is
2753 * partially the reason why the implementation of these instructions
2754 * in darkplaces has been delayed for so long.
2756 * Breaking conventions is annoying...
2758 static bool ir_builder_gen_global(ir_builder *self, ir_value *global, bool islocal);
2760 static bool gen_global_field(code_t *code, ir_value *global)
2762 if (global->hasvalue)
2764 ir_value *fld = global->constval.vpointer;
2766 irerror(global->context, "Invalid field constant with no field: %s", global->name);
2770 /* copy the field's value */
2771 ir_value_code_setaddr(global, vec_size(code->globals));
2772 vec_push(code->globals, fld->code.fieldaddr);
2773 if (global->fieldtype == TYPE_VECTOR) {
2774 vec_push(code->globals, fld->code.fieldaddr+1);
2775 vec_push(code->globals, fld->code.fieldaddr+2);
2780 ir_value_code_setaddr(global, vec_size(code->globals));
2781 vec_push(code->globals, 0);
2782 if (global->fieldtype == TYPE_VECTOR) {
2783 vec_push(code->globals, 0);
2784 vec_push(code->globals, 0);
2787 if (global->code.globaladdr < 0)
2792 static bool gen_global_pointer(code_t *code, ir_value *global)
2794 if (global->hasvalue)
2796 ir_value *target = global->constval.vpointer;
2798 irerror(global->context, "Invalid pointer constant: %s", global->name);
2799 /* NULL pointers are pointing to the NULL constant, which also
2800 * sits at address 0, but still has an ir_value for itself.
2805 /* Here, relocations ARE possible - in fteqcc-enhanced-qc:
2806 * void() foo; <- proto
2807 * void() *fooptr = &foo;
2808 * void() foo = { code }
2810 if (!target->code.globaladdr) {
2811 /* FIXME: Check for the constant nullptr ir_value!
2812 * because then code.globaladdr being 0 is valid.
2814 irerror(global->context, "FIXME: Relocation support");
2818 ir_value_code_setaddr(global, vec_size(code->globals));
2819 vec_push(code->globals, target->code.globaladdr);
2823 ir_value_code_setaddr(global, vec_size(code->globals));
2824 vec_push(code->globals, 0);
2826 if (global->code.globaladdr < 0)
2831 static bool gen_blocks_recursive(code_t *code, ir_function *func, ir_block *block)
2833 prog_section_statement_t stmt;
2842 block->generated = true;
2843 block->code_start = vec_size(code->statements);
2844 for (i = 0; i < vec_size(block->instr); ++i)
2846 instr = block->instr[i];
2848 if (instr->opcode == VINSTR_PHI) {
2849 irerror(block->context, "cannot generate virtual instruction (phi)");
2853 if (instr->opcode == VINSTR_JUMP) {
2854 target = instr->bops[0];
2855 /* for uncoditional jumps, if the target hasn't been generated
2856 * yet, we generate them right here.
2858 if (!target->generated)
2859 return gen_blocks_recursive(code, func, target);
2861 /* otherwise we generate a jump instruction */
2862 stmt.opcode = INSTR_GOTO;
2863 stmt.o1.s1 = (target->code_start) - vec_size(code->statements);
2866 if (stmt.o1.s1 != 1)
2867 code_push_statement(code, &stmt, instr->context);
2869 /* no further instructions can be in this block */
2873 if (instr->opcode == VINSTR_BITXOR) {
2874 stmt.opcode = INSTR_BITOR;
2875 stmt.o1.s1 = ir_value_code_addr(instr->_ops[1]);
2876 stmt.o2.s1 = ir_value_code_addr(instr->_ops[2]);
2877 stmt.o3.s1 = ir_value_code_addr(instr->_ops[0]);
2878 code_push_statement(code, &stmt, instr->context);
2879 stmt.opcode = INSTR_BITAND;
2880 stmt.o1.s1 = ir_value_code_addr(instr->_ops[1]);
2881 stmt.o2.s1 = ir_value_code_addr(instr->_ops[2]);
2882 stmt.o3.s1 = ir_value_code_addr(func->owner->vinstr_temp[0]);
2883 code_push_statement(code, &stmt, instr->context);
2884 stmt.opcode = INSTR_SUB_F;
2885 stmt.o1.s1 = ir_value_code_addr(instr->_ops[0]);
2886 stmt.o2.s1 = ir_value_code_addr(func->owner->vinstr_temp[0]);
2887 stmt.o3.s1 = ir_value_code_addr(instr->_ops[0]);
2888 code_push_statement(code, &stmt, instr->context);
2890 /* instruction generated */
2894 if (instr->opcode == VINSTR_BITAND_V) {
2895 stmt.opcode = INSTR_BITAND;
2896 stmt.o1.s1 = ir_value_code_addr(instr->_ops[1]);
2897 stmt.o2.s1 = ir_value_code_addr(instr->_ops[2]);
2898 stmt.o3.s1 = ir_value_code_addr(instr->_ops[0]);
2899 code_push_statement(code, &stmt, instr->context);
2903 code_push_statement(code, &stmt, instr->context);
2907 code_push_statement(code, &stmt, instr->context);
2909 /* instruction generated */
2913 if (instr->opcode == VINSTR_BITOR_V) {
2914 stmt.opcode = INSTR_BITOR;
2915 stmt.o1.s1 = ir_value_code_addr(instr->_ops[1]);
2916 stmt.o2.s1 = ir_value_code_addr(instr->_ops[2]);
2917 stmt.o3.s1 = ir_value_code_addr(instr->_ops[0]);
2918 code_push_statement(code, &stmt, instr->context);
2922 code_push_statement(code, &stmt, instr->context);
2926 code_push_statement(code, &stmt, instr->context);
2928 /* instruction generated */
2932 if (instr->opcode == VINSTR_BITXOR_V) {
2933 for (j = 0; j < 3; ++j) {
2934 stmt.opcode = INSTR_BITOR;
2935 stmt.o1.s1 = ir_value_code_addr(instr->_ops[1]) + j;
2936 stmt.o2.s1 = ir_value_code_addr(instr->_ops[2]) + j;
2937 stmt.o3.s1 = ir_value_code_addr(instr->_ops[0]) + j;
2938 code_push_statement(code, &stmt, instr->context);
2939 stmt.opcode = INSTR_BITAND;
2940 stmt.o1.s1 = ir_value_code_addr(instr->_ops[1]) + j;
2941 stmt.o2.s1 = ir_value_code_addr(instr->_ops[2]) + j;
2942 stmt.o3.s1 = ir_value_code_addr(func->owner->vinstr_temp[0]) + j;
2943 code_push_statement(code, &stmt, instr->context);
2945 stmt.opcode = INSTR_SUB_V;
2946 stmt.o1.s1 = ir_value_code_addr(instr->_ops[0]);
2947 stmt.o2.s1 = ir_value_code_addr(func->owner->vinstr_temp[0]);
2948 stmt.o3.s1 = ir_value_code_addr(instr->_ops[0]);
2949 code_push_statement(code, &stmt, instr->context);
2951 /* instruction generated */
2955 if (instr->opcode == VINSTR_BITAND_VF) {
2956 stmt.opcode = INSTR_BITAND;
2957 stmt.o1.s1 = ir_value_code_addr(instr->_ops[1]);
2958 stmt.o2.s1 = ir_value_code_addr(instr->_ops[2]);
2959 stmt.o3.s1 = ir_value_code_addr(instr->_ops[0]);
2960 code_push_statement(code, &stmt, instr->context);
2963 code_push_statement(code, &stmt, instr->context);
2966 code_push_statement(code, &stmt, instr->context);
2968 /* instruction generated */
2972 if (instr->opcode == VINSTR_BITOR_VF) {
2973 stmt.opcode = INSTR_BITOR;
2974 stmt.o1.s1 = ir_value_code_addr(instr->_ops[1]);
2975 stmt.o2.s1 = ir_value_code_addr(instr->_ops[2]);
2976 stmt.o3.s1 = ir_value_code_addr(instr->_ops[0]);
2977 code_push_statement(code, &stmt, instr->context);
2980 code_push_statement(code, &stmt, instr->context);
2983 code_push_statement(code, &stmt, instr->context);
2985 /* instruction generated */
2989 if (instr->opcode == VINSTR_BITXOR_VF) {
2990 for (j = 0; j < 3; ++j) {
2991 stmt.opcode = INSTR_BITOR;
2992 stmt.o1.s1 = ir_value_code_addr(instr->_ops[1]) + j;
2993 stmt.o2.s1 = ir_value_code_addr(instr->_ops[2]);
2994 stmt.o3.s1 = ir_value_code_addr(instr->_ops[0]) + j;
2995 code_push_statement(code, &stmt, instr->context);
2996 stmt.opcode = INSTR_BITAND;
2997 stmt.o1.s1 = ir_value_code_addr(instr->_ops[1]) + j;
2998 stmt.o2.s1 = ir_value_code_addr(instr->_ops[2]);
2999 stmt.o3.s1 = ir_value_code_addr(func->owner->vinstr_temp[0]) + j;
3000 code_push_statement(code, &stmt, instr->context);
3002 stmt.opcode = INSTR_SUB_V;
3003 stmt.o1.s1 = ir_value_code_addr(instr->_ops[0]);
3004 stmt.o2.s1 = ir_value_code_addr(func->owner->vinstr_temp[0]);
3005 stmt.o3.s1 = ir_value_code_addr(instr->_ops[0]);
3006 code_push_statement(code, &stmt, instr->context);
3008 /* instruction generated */
3012 if (instr->opcode == VINSTR_CROSS) {
3013 stmt.opcode = INSTR_MUL_F;
3014 for (j = 0; j < 3; ++j) {
3015 stmt.o1.s1 = ir_value_code_addr(instr->_ops[1]) + (j + 1) % 3;
3016 stmt.o2.s1 = ir_value_code_addr(instr->_ops[2]) + (j + 2) % 3;
3017 stmt.o3.s1 = ir_value_code_addr(instr->_ops[0]) + j;
3018 code_push_statement(code, &stmt, instr->context);
3019 stmt.o1.s1 = ir_value_code_addr(instr->_ops[1]) + (j + 2) % 3;
3020 stmt.o2.s1 = ir_value_code_addr(instr->_ops[2]) + (j + 1) % 3;
3021 stmt.o3.s1 = ir_value_code_addr(func->owner->vinstr_temp[0]) + j;
3022 code_push_statement(code, &stmt, instr->context);
3024 stmt.opcode = INSTR_SUB_V;
3025 stmt.o1.s1 = ir_value_code_addr(instr->_ops[0]);
3026 stmt.o2.s1 = ir_value_code_addr(func->owner->vinstr_temp[0]);
3027 stmt.o3.s1 = ir_value_code_addr(instr->_ops[0]);
3028 code_push_statement(code, &stmt, instr->context);
3030 /* instruction generated */
3034 if (instr->opcode == VINSTR_COND) {
3035 ontrue = instr->bops[0];
3036 onfalse = instr->bops[1];
3037 /* TODO: have the AST signal which block should
3038 * come first: eg. optimize IFs without ELSE...
3041 stmt.o1.u1 = ir_value_code_addr(instr->_ops[0]);
3045 if (ontrue->generated) {
3046 stmt.opcode = INSTR_IF;
3047 stmt.o2.s1 = (ontrue->code_start) - vec_size(code->statements);
3048 if (stmt.o2.s1 != 1)
3049 code_push_statement(code, &stmt, instr->context);
3051 if (onfalse->generated) {
3052 stmt.opcode = INSTR_IFNOT;
3053 stmt.o2.s1 = (onfalse->code_start) - vec_size(code->statements);
3054 if (stmt.o2.s1 != 1)
3055 code_push_statement(code, &stmt, instr->context);
3057 if (!ontrue->generated) {
3058 if (onfalse->generated)
3059 return gen_blocks_recursive(code, func, ontrue);
3061 if (!onfalse->generated) {
3062 if (ontrue->generated)
3063 return gen_blocks_recursive(code, func, onfalse);
3065 /* neither ontrue nor onfalse exist */
3066 stmt.opcode = INSTR_IFNOT;
3067 if (!instr->likely) {
3068 /* Honor the likelyhood hint */
3069 ir_block *tmp = onfalse;
3070 stmt.opcode = INSTR_IF;
3074 stidx = vec_size(code->statements);
3075 code_push_statement(code, &stmt, instr->context);
3076 /* on false we jump, so add ontrue-path */
3077 if (!gen_blocks_recursive(code, func, ontrue))
3079 /* fixup the jump address */
3080 code->statements[stidx].o2.s1 = vec_size(code->statements) - stidx;
3081 /* generate onfalse path */
3082 if (onfalse->generated) {
3083 /* fixup the jump address */
3084 code->statements[stidx].o2.s1 = (onfalse->code_start) - (stidx);
3085 if (stidx+2 == vec_size(code->statements) && code->statements[stidx].o2.s1 == 1) {
3086 code->statements[stidx] = code->statements[stidx+1];
3087 if (code->statements[stidx].o1.s1 < 0)
3088 code->statements[stidx].o1.s1++;
3089 code_pop_statement(code);
3091 stmt.opcode = vec_last(code->statements).opcode;
3092 if (stmt.opcode == INSTR_GOTO ||
3093 stmt.opcode == INSTR_IF ||
3094 stmt.opcode == INSTR_IFNOT ||
3095 stmt.opcode == INSTR_RETURN ||
3096 stmt.opcode == INSTR_DONE)
3098 /* no use jumping from here */
3101 /* may have been generated in the previous recursive call */
3102 stmt.opcode = INSTR_GOTO;
3103 stmt.o1.s1 = (onfalse->code_start) - vec_size(code->statements);
3106 if (stmt.o1.s1 != 1)
3107 code_push_statement(code, &stmt, instr->context);
3110 else if (stidx+2 == vec_size(code->statements) && code->statements[stidx].o2.s1 == 1) {
3111 code->statements[stidx] = code->statements[stidx+1];
3112 if (code->statements[stidx].o1.s1 < 0)
3113 code->statements[stidx].o1.s1++;
3114 code_pop_statement(code);
3116 /* if not, generate now */
3117 return gen_blocks_recursive(code, func, onfalse);
3120 if ( (instr->opcode >= INSTR_CALL0 && instr->opcode <= INSTR_CALL8)
3121 || instr->opcode == VINSTR_NRCALL)
3126 first = vec_size(instr->params);
3129 for (p = 0; p < first; ++p)
3131 ir_value *param = instr->params[p];
3132 if (param->callparam)
3135 stmt.opcode = INSTR_STORE_F;
3138 if (param->vtype == TYPE_FIELD)
3139 stmt.opcode = field_store_instr[param->fieldtype];
3140 else if (param->vtype == TYPE_NIL)
3141 stmt.opcode = INSTR_STORE_V;
3143 stmt.opcode = type_store_instr[param->vtype];
3144 stmt.o1.u1 = ir_value_code_addr(param);
3145 stmt.o2.u1 = OFS_PARM0 + 3 * p;
3147 if (param->vtype == TYPE_VECTOR && (param->flags & IR_FLAG_SPLIT_VECTOR)) {
3148 /* fetch 3 separate floats */
3149 stmt.opcode = INSTR_STORE_F;
3150 stmt.o1.u1 = ir_value_code_addr(param->members[0]);
3151 code_push_statement(code, &stmt, instr->context);
3153 stmt.o1.u1 = ir_value_code_addr(param->members[1]);
3154 code_push_statement(code, &stmt, instr->context);
3156 stmt.o1.u1 = ir_value_code_addr(param->members[2]);
3157 code_push_statement(code, &stmt, instr->context);
3160 code_push_statement(code, &stmt, instr->context);
3162 /* Now handle extparams */
3163 first = vec_size(instr->params);
3164 for (; p < first; ++p)
3166 ir_builder *ir = func->owner;
3167 ir_value *param = instr->params[p];
3168 ir_value *targetparam;
3170 if (param->callparam)
3173 if (p-8 >= vec_size(ir->extparams))
3174 ir_gen_extparam(ir);
3176 targetparam = ir->extparams[p-8];
3178 stmt.opcode = INSTR_STORE_F;
3181 if (param->vtype == TYPE_FIELD)
3182 stmt.opcode = field_store_instr[param->fieldtype];
3183 else if (param->vtype == TYPE_NIL)
3184 stmt.opcode = INSTR_STORE_V;
3186 stmt.opcode = type_store_instr[param->vtype];
3187 stmt.o1.u1 = ir_value_code_addr(param);
3188 stmt.o2.u1 = ir_value_code_addr(targetparam);
3189 if (param->vtype == TYPE_VECTOR && (param->flags & IR_FLAG_SPLIT_VECTOR)) {
3190 /* fetch 3 separate floats */
3191 stmt.opcode = INSTR_STORE_F;
3192 stmt.o1.u1 = ir_value_code_addr(param->members[0]);
3193 code_push_statement(code, &stmt, instr->context);
3195 stmt.o1.u1 = ir_value_code_addr(param->members[1]);
3196 code_push_statement(code, &stmt, instr->context);
3198 stmt.o1.u1 = ir_value_code_addr(param->members[2]);
3199 code_push_statement(code, &stmt, instr->context);
3202 code_push_statement(code, &stmt, instr->context);
3205 stmt.opcode = INSTR_CALL0 + vec_size(instr->params);
3206 if (stmt.opcode > INSTR_CALL8)
3207 stmt.opcode = INSTR_CALL8;
3208 stmt.o1.u1 = ir_value_code_addr(instr->_ops[1]);
3211 code_push_statement(code, &stmt, instr->context);
3213 retvalue = instr->_ops[0];
3214 if (retvalue && retvalue->store != store_return &&
3215 (retvalue->store == store_global || vec_size(retvalue->life)))
3217 /* not to be kept in OFS_RETURN */
3218 if (retvalue->vtype == TYPE_FIELD && OPTS_FLAG(ADJUST_VECTOR_FIELDS))
3219 stmt.opcode = field_store_instr[retvalue->fieldtype];
3221 stmt.opcode = type_store_instr[retvalue->vtype];
3222 stmt.o1.u1 = OFS_RETURN;
3223 stmt.o2.u1 = ir_value_code_addr(retvalue);
3225 code_push_statement(code, &stmt, instr->context);
3230 if (instr->opcode == INSTR_STATE) {
3231 stmt.opcode = instr->opcode;
3233 stmt.o1.u1 = ir_value_code_addr(instr->_ops[0]);
3235 stmt.o2.u1 = ir_value_code_addr(instr->_ops[1]);
3237 code_push_statement(code, &stmt, instr->context);
3241 stmt.opcode = instr->opcode;
3246 /* This is the general order of operands */
3248 stmt.o3.u1 = ir_value_code_addr(instr->_ops[0]);
3251 stmt.o1.u1 = ir_value_code_addr(instr->_ops[1]);
3254 stmt.o2.u1 = ir_value_code_addr(instr->_ops[2]);
3256 if (stmt.opcode == INSTR_RETURN || stmt.opcode == INSTR_DONE)
3258 stmt.o1.u1 = stmt.o3.u1;
3261 else if ((stmt.opcode >= INSTR_STORE_F &&
3262 stmt.opcode <= INSTR_STORE_FNC) ||
3263 (stmt.opcode >= INSTR_STOREP_F &&
3264 stmt.opcode <= INSTR_STOREP_FNC))
3266 /* 2-operand instructions with A -> B */
3267 stmt.o2.u1 = stmt.o3.u1;
3270 /* tiny optimization, don't output
3273 if (stmt.o2.u1 == stmt.o1.u1 &&
3274 OPTS_OPTIMIZATION(OPTIM_PEEPHOLE))
3276 ++opts_optimizationcount[OPTIM_PEEPHOLE];
3280 code_push_statement(code, &stmt, instr->context);
3285 static bool gen_function_code(code_t *code, ir_function *self)
3288 prog_section_statement_t stmt, *retst;
3290 /* Starting from entry point, we generate blocks "as they come"
3291 * for now. Dead blocks will not be translated obviously.
3293 if (!vec_size(self->blocks)) {
3294 irerror(self->context, "Function '%s' declared without body.", self->name);
3298 block = self->blocks[0];
3299 if (block->generated)
3302 if (!gen_blocks_recursive(code, self, block)) {
3303 irerror(self->context, "failed to generate blocks for '%s'", self->name);
3307 /* code_write and qcvm -disasm need to know that the function ends here */
3308 retst = &vec_last(code->statements);
3309 if (OPTS_OPTIMIZATION(OPTIM_VOID_RETURN) &&
3310 self->outtype == TYPE_VOID &&
3311 retst->opcode == INSTR_RETURN &&
3312 !retst->o1.u1 && !retst->o2.u1 && !retst->o3.u1)
3314 retst->opcode = INSTR_DONE;
3315 ++opts_optimizationcount[OPTIM_VOID_RETURN];
3319 stmt.opcode = INSTR_DONE;
3323 last.line = vec_last(code->linenums);
3324 last.column = vec_last(code->columnnums);
3326 code_push_statement(code, &stmt, last);
3331 static qcint_t ir_builder_filestring(ir_builder *ir, const char *filename)
3333 /* NOTE: filename pointers are copied, we never strdup them,
3334 * thus we can use pointer-comparison to find the string.
3339 for (i = 0; i < vec_size(ir->filenames); ++i) {
3340 if (ir->filenames[i] == filename)
3341 return ir->filestrings[i];
3344 str = code_genstring(ir->code, filename);
3345 vec_push(ir->filenames, filename);
3346 vec_push(ir->filestrings, str);
3350 static bool gen_global_function(ir_builder *ir, ir_value *global)
3352 prog_section_function_t fun;
3357 if (!global->hasvalue || (!global->constval.vfunc))
3359 irerror(global->context, "Invalid state of function-global: not constant: %s", global->name);
3363 irfun = global->constval.vfunc;
3365 fun.name = global->code.name;
3366 fun.file = ir_builder_filestring(ir, global->context.file);
3367 fun.profile = 0; /* always 0 */
3368 fun.nargs = vec_size(irfun->params);
3372 for (i = 0;i < 8; ++i) {
3373 if ((int32_t)i >= fun.nargs)
3376 fun.argsize[i] = type_sizeof_[irfun->params[i]];
3380 fun.locals = irfun->allocated_locals;
3383 fun.entry = irfun->builtin+1;
3385 irfun->code_function_def = vec_size(ir->code->functions);
3386 fun.entry = vec_size(ir->code->statements);
3389 vec_push(ir->code->functions, fun);
3393 static ir_value* ir_gen_extparam_proto(ir_builder *ir)
3398 util_snprintf(name, sizeof(name), "EXTPARM#%i", (int)(vec_size(ir->extparam_protos)));
3399 global = ir_value_var(name, store_global, TYPE_VECTOR);
3401 vec_push(ir->extparam_protos, global);
3405 static void ir_gen_extparam(ir_builder *ir)
3407 prog_section_def_t def;
3410 if (vec_size(ir->extparam_protos) < vec_size(ir->extparams)+1)
3411 global = ir_gen_extparam_proto(ir);
3413 global = ir->extparam_protos[vec_size(ir->extparams)];
3415 def.name = code_genstring(ir->code, global->name);
3416 def.type = TYPE_VECTOR;
3417 def.offset = vec_size(ir->code->globals);
3419 vec_push(ir->code->defs, def);
3421 ir_value_code_setaddr(global, def.offset);
3423 vec_push(ir->code->globals, 0);
3424 vec_push(ir->code->globals, 0);
3425 vec_push(ir->code->globals, 0);
3427 vec_push(ir->extparams, global);
3430 static bool gen_function_extparam_copy(code_t *code, ir_function *self)
3432 size_t i, ext, numparams;
3434 ir_builder *ir = self->owner;
3436 prog_section_statement_t stmt;
3438 numparams = vec_size(self->params);
3442 stmt.opcode = INSTR_STORE_F;
3444 for (i = 8; i < numparams; ++i) {
3446 if (ext >= vec_size(ir->extparams))
3447 ir_gen_extparam(ir);
3449 ep = ir->extparams[ext];
3451 stmt.opcode = type_store_instr[self->locals[i]->vtype];
3452 if (self->locals[i]->vtype == TYPE_FIELD &&
3453 self->locals[i]->fieldtype == TYPE_VECTOR)
3455 stmt.opcode = INSTR_STORE_V;
3457 stmt.o1.u1 = ir_value_code_addr(ep);
3458 stmt.o2.u1 = ir_value_code_addr(self->locals[i]);
3459 code_push_statement(code, &stmt, self->context);
3465 static bool gen_function_varargs_copy(code_t *code, ir_function *self)
3467 size_t i, ext, numparams, maxparams;
3469 ir_builder *ir = self->owner;
3471 prog_section_statement_t stmt;
3473 numparams = vec_size(self->params);
3477 stmt.opcode = INSTR_STORE_V;
3479 maxparams = numparams + self->max_varargs;
3480 for (i = numparams; i < maxparams; ++i) {
3482 stmt.o1.u1 = OFS_PARM0 + 3*i;
3483 stmt.o2.u1 = ir_value_code_addr(self->locals[i]);
3484 code_push_statement(code, &stmt, self->context);
3488 while (ext >= vec_size(ir->extparams))
3489 ir_gen_extparam(ir);
3491 ep = ir->extparams[ext];
3493 stmt.o1.u1 = ir_value_code_addr(ep);
3494 stmt.o2.u1 = ir_value_code_addr(self->locals[i]);
3495 code_push_statement(code, &stmt, self->context);
3501 static bool gen_function_locals(ir_builder *ir, ir_value *global)
3503 prog_section_function_t *def;
3506 uint32_t firstlocal, firstglobal;
3508 irfun = global->constval.vfunc;
3509 def = ir->code->functions + irfun->code_function_def;
3511 if (OPTS_OPTION_BOOL(OPTION_G) ||
3512 !OPTS_OPTIMIZATION(OPTIM_OVERLAP_LOCALS) ||
3513 (irfun->flags & IR_FLAG_MASK_NO_OVERLAP))
3515 firstlocal = def->firstlocal = vec_size(ir->code->globals);
3517 firstlocal = def->firstlocal = ir->first_common_local;
3518 ++opts_optimizationcount[OPTIM_OVERLAP_LOCALS];
3521 firstglobal = (OPTS_OPTIMIZATION(OPTIM_GLOBAL_TEMPS) ? ir->first_common_globaltemp : firstlocal);
3523 for (i = vec_size(ir->code->globals); i < firstlocal + irfun->allocated_locals; ++i)
3524 vec_push(ir->code->globals, 0);
3525 for (i = 0; i < vec_size(irfun->locals); ++i) {
3526 ir_value *v = irfun->locals[i];
3527 if (v->locked || !OPTS_OPTIMIZATION(OPTIM_GLOBAL_TEMPS)) {
3528 ir_value_code_setaddr(v, firstlocal + v->code.local);
3529 if (!ir_builder_gen_global(ir, irfun->locals[i], true)) {
3530 irerror(irfun->locals[i]->context, "failed to generate local %s", irfun->locals[i]->name);
3535 ir_value_code_setaddr(v, firstglobal + v->code.local);
3537 for (i = 0; i < vec_size(irfun->values); ++i)
3539 ir_value *v = irfun->values[i];
3543 ir_value_code_setaddr(v, firstlocal + v->code.local);
3545 ir_value_code_setaddr(v, firstglobal + v->code.local);
3550 static bool gen_global_function_code(ir_builder *ir, ir_value *global)
3552 prog_section_function_t *fundef;
3557 irfun = global->constval.vfunc;
3559 if (global->cvq == CV_NONE) {
3560 if (irwarning(global->context, WARN_IMPLICIT_FUNCTION_POINTER,
3561 "function `%s` has no body and in QC implicitly becomes a function-pointer",
3564 /* Not bailing out just now. If this happens a lot you don't want to have
3565 * to rerun gmqcc for each such function.
3571 /* this was a function pointer, don't generate code for those */
3579 * If there is no definition and the thing is eraseable, we can ignore
3580 * outputting the function to begin with.
3582 if (global->flags & IR_FLAG_ERASEABLE && irfun->code_function_def < 0) {
3586 if (irfun->code_function_def < 0) {
3587 irerror(irfun->context, "`%s`: IR global wasn't generated, failed to access function-def", irfun->name);
3590 fundef = &ir->code->functions[irfun->code_function_def];
3592 fundef->entry = vec_size(ir->code->statements);
3593 if (!gen_function_locals(ir, global)) {
3594 irerror(irfun->context, "Failed to generate locals for function %s", irfun->name);
3597 if (!gen_function_extparam_copy(ir->code, irfun)) {
3598 irerror(irfun->context, "Failed to generate extparam-copy code for function %s", irfun->name);
3601 if (irfun->max_varargs && !gen_function_varargs_copy(ir->code, irfun)) {
3602 irerror(irfun->context, "Failed to generate vararg-copy code for function %s", irfun->name);
3605 if (!gen_function_code(ir->code, irfun)) {
3606 irerror(irfun->context, "Failed to generate code for function %s", irfun->name);
3612 static void gen_vector_defs(code_t *code, prog_section_def_t def, const char *name)
3617 if (!name || name[0] == '#' || OPTS_FLAG(SINGLE_VECTOR_DEFS))
3620 def.type = TYPE_FLOAT;
3624 component = (char*)mem_a(len+3);
3625 memcpy(component, name, len);
3627 component[len-0] = 0;
3628 component[len-2] = '_';
3630 component[len-1] = 'x';
3632 for (i = 0; i < 3; ++i) {
3633 def.name = code_genstring(code, component);
3634 vec_push(code->defs, def);
3642 static void gen_vector_fields(code_t *code, prog_section_field_t fld, const char *name)
3647 if (!name || OPTS_FLAG(SINGLE_VECTOR_DEFS))
3650 fld.type = TYPE_FLOAT;
3654 component = (char*)mem_a(len+3);
3655 memcpy(component, name, len);
3657 component[len-0] = 0;
3658 component[len-2] = '_';
3660 component[len-1] = 'x';
3662 for (i = 0; i < 3; ++i) {
3663 fld.name = code_genstring(code, component);
3664 vec_push(code->fields, fld);
3672 static bool ir_builder_gen_global(ir_builder *self, ir_value *global, bool islocal)
3676 prog_section_def_t def;
3677 bool pushdef = opts.optimizeoff;
3679 /* we don't generate split-vectors */
3680 if (global->vtype == TYPE_VECTOR && (global->flags & IR_FLAG_SPLIT_VECTOR))
3683 def.type = global->vtype;
3684 def.offset = vec_size(self->code->globals);
3686 if (OPTS_OPTION_BOOL(OPTION_G) || !islocal)
3691 * if we're eraseable and the function isn't referenced ignore outputting
3694 if (global->flags & IR_FLAG_ERASEABLE && vec_size(global->reads) == 0) {
3698 if (OPTS_OPTIMIZATION(OPTIM_STRIP_CONSTANT_NAMES) &&
3699 !(global->flags & IR_FLAG_INCLUDE_DEF) &&
3700 (global->name[0] == '#' || global->cvq == CV_CONST))
3706 if (global->name[0] == '#') {
3707 if (!self->str_immediate)
3708 self->str_immediate = code_genstring(self->code, "IMMEDIATE");
3709 def.name = global->code.name = self->str_immediate;
3712 def.name = global->code.name = code_genstring(self->code, global->name);
3717 def.offset = ir_value_code_addr(global);
3718 vec_push(self->code->defs, def);
3719 if (global->vtype == TYPE_VECTOR)
3720 gen_vector_defs(self->code, def, global->name);
3721 else if (global->vtype == TYPE_FIELD && global->fieldtype == TYPE_VECTOR)
3722 gen_vector_defs(self->code, def, global->name);
3729 switch (global->vtype)
3732 if (!strcmp(global->name, "end_sys_globals")) {
3733 /* TODO: remember this point... all the defs before this one
3734 * should be checksummed and added to progdefs.h when we generate it.
3737 else if (!strcmp(global->name, "end_sys_fields")) {
3738 /* TODO: same as above but for entity-fields rather than globsl
3741 else if(irwarning(global->context, WARN_VOID_VARIABLES, "unrecognized variable of type void `%s`",
3744 /* Not bailing out */
3747 /* I'd argue setting it to 0 is sufficient, but maybe some depend on knowing how far
3748 * the system fields actually go? Though the engine knows this anyway...
3749 * Maybe this could be an -foption
3750 * fteqcc creates data for end_sys_* - of size 1, so let's do the same
3752 ir_value_code_setaddr(global, vec_size(self->code->globals));
3753 vec_push(self->code->globals, 0);
3755 if (pushdef) vec_push(self->code->defs, def);
3758 if (pushdef) vec_push(self->code->defs, def);
3759 return gen_global_pointer(self->code, global);
3762 vec_push(self->code->defs, def);
3763 if (global->fieldtype == TYPE_VECTOR)
3764 gen_vector_defs(self->code, def, global->name);
3766 return gen_global_field(self->code, global);
3771 ir_value_code_setaddr(global, vec_size(self->code->globals));
3772 if (global->hasvalue) {
3773 iptr = (int32_t*)&global->constval.ivec[0];
3774 vec_push(self->code->globals, *iptr);
3776 vec_push(self->code->globals, 0);
3778 if (!islocal && global->cvq != CV_CONST)
3779 def.type |= DEF_SAVEGLOBAL;
3780 if (pushdef) vec_push(self->code->defs, def);
3782 return global->code.globaladdr >= 0;
3786 ir_value_code_setaddr(global, vec_size(self->code->globals));
3787 if (global->hasvalue) {
3788 uint32_t load = code_genstring(self->code, global->constval.vstring);
3789 vec_push(self->code->globals, load);
3791 vec_push(self->code->globals, 0);
3793 if (!islocal && global->cvq != CV_CONST)
3794 def.type |= DEF_SAVEGLOBAL;
3795 if (pushdef) vec_push(self->code->defs, def);
3796 return global->code.globaladdr >= 0;
3801 ir_value_code_setaddr(global, vec_size(self->code->globals));
3802 if (global->hasvalue) {
3803 iptr = (int32_t*)&global->constval.ivec[0];
3804 vec_push(self->code->globals, iptr[0]);
3805 if (global->code.globaladdr < 0)
3807 for (d = 1; d < type_sizeof_[global->vtype]; ++d) {
3808 vec_push(self->code->globals, iptr[d]);
3811 vec_push(self->code->globals, 0);
3812 if (global->code.globaladdr < 0)
3814 for (d = 1; d < type_sizeof_[global->vtype]; ++d) {
3815 vec_push(self->code->globals, 0);
3818 if (!islocal && global->cvq != CV_CONST)
3819 def.type |= DEF_SAVEGLOBAL;
3822 vec_push(self->code->defs, def);
3823 def.type &= ~DEF_SAVEGLOBAL;
3824 gen_vector_defs(self->code, def, global->name);
3826 return global->code.globaladdr >= 0;
3829 ir_value_code_setaddr(global, vec_size(self->code->globals));
3830 if (!global->hasvalue) {
3831 vec_push(self->code->globals, 0);
3832 if (global->code.globaladdr < 0)
3835 vec_push(self->code->globals, vec_size(self->code->functions));
3836 if (!gen_global_function(self, global))
3839 if (!islocal && global->cvq != CV_CONST)
3840 def.type |= DEF_SAVEGLOBAL;
3841 if (pushdef) vec_push(self->code->defs, def);
3844 /* assume biggest type */
3845 ir_value_code_setaddr(global, vec_size(self->code->globals));
3846 vec_push(self->code->globals, 0);
3847 for (i = 1; i < type_sizeof_[TYPE_VARIANT]; ++i)
3848 vec_push(self->code->globals, 0);
3851 /* refuse to create 'void' type or any other fancy business. */
3852 irerror(global->context, "Invalid type for global variable `%s`: %s",
3853 global->name, type_name[global->vtype]);
3858 static GMQCC_INLINE void ir_builder_prepare_field(code_t *code, ir_value *field)
3860 field->code.fieldaddr = code_alloc_field(code, type_sizeof_[field->fieldtype]);
3863 static bool ir_builder_gen_field(ir_builder *self, ir_value *field)
3865 prog_section_def_t def;
3866 prog_section_field_t fld;
3870 def.type = (uint16_t)field->vtype;
3871 def.offset = (uint16_t)vec_size(self->code->globals);
3873 /* create a global named the same as the field */
3874 if (OPTS_OPTION_U32(OPTION_STANDARD) == COMPILER_GMQCC) {
3875 /* in our standard, the global gets a dot prefix */
3876 size_t len = strlen(field->name);
3879 /* we really don't want to have to allocate this, and 1024
3880 * bytes is more than enough for a variable/field name
3882 if (len+2 >= sizeof(name)) {
3883 irerror(field->context, "invalid field name size: %u", (unsigned int)len);
3888 memcpy(name+1, field->name, len); /* no strncpy - we used strlen above */
3891 def.name = code_genstring(self->code, name);
3892 fld.name = def.name + 1; /* we reuse that string table entry */
3894 /* in plain QC, there cannot be a global with the same name,
3895 * and so we also name the global the same.
3896 * FIXME: fteqcc should create a global as well
3897 * check if it actually uses the same name. Probably does
3899 def.name = code_genstring(self->code, field->name);
3900 fld.name = def.name;
3903 field->code.name = def.name;
3905 vec_push(self->code->defs, def);
3907 fld.type = field->fieldtype;
3909 if (fld.type == TYPE_VOID) {
3910 irerror(field->context, "field is missing a type: %s - don't know its size", field->name);
3914 fld.offset = field->code.fieldaddr;
3916 vec_push(self->code->fields, fld);
3918 ir_value_code_setaddr(field, vec_size(self->code->globals));
3919 vec_push(self->code->globals, fld.offset);
3920 if (fld.type == TYPE_VECTOR) {
3921 vec_push(self->code->globals, fld.offset+1);
3922 vec_push(self->code->globals, fld.offset+2);
3925 if (field->fieldtype == TYPE_VECTOR) {
3926 gen_vector_defs (self->code, def, field->name);
3927 gen_vector_fields(self->code, fld, field->name);
3930 return field->code.globaladdr >= 0;
3933 static void ir_builder_collect_reusables(ir_builder *builder) {
3935 ir_value **reusables = NULL;
3936 for (i = 0; i < vec_size(builder->globals); ++i) {
3937 ir_value *value = builder->globals[i];
3938 if (value->vtype != TYPE_FLOAT || !value->hasvalue)
3940 if (value->cvq == CV_CONST || (value->name && value->name[0] == '#')) {
3941 vec_push(reusables, value);
3944 builder->const_floats = reusables;
3947 static void ir_builder_split_vector(ir_builder *self, ir_value *vec) {
3949 ir_value* found[3] = { NULL, NULL, NULL };
3951 /* must not be written to */
3952 if (vec_size(vec->writes))
3954 /* must not be trying to access individual members */
3955 if (vec->members[0] || vec->members[1] || vec->members[2])
3957 /* should be actually used otherwise it won't be generated anyway */
3958 count = vec_size(vec->reads);
3962 /* may only be used directly as function parameters, so if we find some other instruction cancel */
3963 for (i = 0; i != count; ++i) {
3964 /* we only split vectors if they're used directly as parameter to a call only! */
3965 ir_instr *user = vec->reads[i];
3966 if ((user->opcode < INSTR_CALL0 || user->opcode > INSTR_CALL8) && user->opcode != VINSTR_NRCALL)
3970 vec->flags |= IR_FLAG_SPLIT_VECTOR;
3972 /* find existing floats making up the split */
3973 count = vec_size(self->const_floats);
3974 for (i = 0; i != count; ++i) {
3975 ir_value *c = self->const_floats[i];
3976 if (!found[0] && c->constval.vfloat == vec->constval.vvec.x)
3978 if (!found[1] && c->constval.vfloat == vec->constval.vvec.y)
3980 if (!found[2] && c->constval.vfloat == vec->constval.vvec.z)
3982 if (found[0] && found[1] && found[2])
3986 /* generate floats for not yet found components */
3988 found[0] = ir_builder_imm_float(self, vec->constval.vvec.x, true);
3990 if (vec->constval.vvec.y == vec->constval.vvec.x)
3991 found[1] = found[0];
3993 found[1] = ir_builder_imm_float(self, vec->constval.vvec.y, true);
3996 if (vec->constval.vvec.z == vec->constval.vvec.x)
3997 found[2] = found[0];
3998 else if (vec->constval.vvec.z == vec->constval.vvec.y)
3999 found[2] = found[1];
4001 found[2] = ir_builder_imm_float(self, vec->constval.vvec.z, true);
4004 /* the .members array should be safe to use here. */
4005 vec->members[0] = found[0];
4006 vec->members[1] = found[1];
4007 vec->members[2] = found[2];
4009 /* register the readers for these floats */
4010 count = vec_size(vec->reads);
4011 for (i = 0; i != count; ++i) {
4012 vec_push(found[0]->reads, vec->reads[i]);
4013 vec_push(found[1]->reads, vec->reads[i]);
4014 vec_push(found[2]->reads, vec->reads[i]);
4018 static void ir_builder_split_vectors(ir_builder *self) {
4019 size_t i, count = vec_size(self->globals);
4020 for (i = 0; i != count; ++i) {
4021 ir_value *v = self->globals[i];
4022 if (v->vtype != TYPE_VECTOR || !v->name || v->name[0] != '#')
4024 ir_builder_split_vector(self, self->globals[i]);
4028 bool ir_builder_generate(ir_builder *self, const char *filename)
4030 prog_section_statement_t stmt;
4032 char *lnofile = NULL;
4034 if (OPTS_FLAG(SPLIT_VECTOR_PARAMETERS)) {
4035 ir_builder_collect_reusables(self);
4036 if (vec_size(self->const_floats) > 0)
4037 ir_builder_split_vectors(self);
4040 for (i = 0; i < vec_size(self->fields); ++i)
4042 ir_builder_prepare_field(self->code, self->fields[i]);
4045 for (i = 0; i < vec_size(self->globals); ++i)
4047 if (!ir_builder_gen_global(self, self->globals[i], false)) {
4050 if (self->globals[i]->vtype == TYPE_FUNCTION) {
4051 ir_function *func = self->globals[i]->constval.vfunc;
4052 if (func && self->max_locals < func->allocated_locals &&
4053 !(func->flags & IR_FLAG_MASK_NO_OVERLAP))
4055 self->max_locals = func->allocated_locals;
4057 if (func && self->max_globaltemps < func->globaltemps)
4058 self->max_globaltemps = func->globaltemps;
4062 for (i = 0; i < vec_size(self->fields); ++i)
4064 if (!ir_builder_gen_field(self, self->fields[i])) {
4070 ir_value_code_setaddr(self->nil, vec_size(self->code->globals));
4071 vec_push(self->code->globals, 0);
4072 vec_push(self->code->globals, 0);
4073 vec_push(self->code->globals, 0);
4075 /* generate virtual-instruction temps */
4076 for (i = 0; i < IR_MAX_VINSTR_TEMPS; ++i) {
4077 ir_value_code_setaddr(self->vinstr_temp[i], vec_size(self->code->globals));
4078 vec_push(self->code->globals, 0);
4079 vec_push(self->code->globals, 0);
4080 vec_push(self->code->globals, 0);
4083 /* generate global temps */
4084 self->first_common_globaltemp = vec_size(self->code->globals);
4085 for (i = 0; i < self->max_globaltemps; ++i) {
4086 vec_push(self->code->globals, 0);
4088 /* generate common locals */
4089 self->first_common_local = vec_size(self->code->globals);
4090 for (i = 0; i < self->max_locals; ++i) {
4091 vec_push(self->code->globals, 0);
4094 /* generate function code */
4095 for (i = 0; i < vec_size(self->globals); ++i)
4097 if (self->globals[i]->vtype == TYPE_FUNCTION) {
4098 if (!gen_global_function_code(self, self->globals[i])) {
4104 if (vec_size(self->code->globals) >= 65536) {
4105 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));
4109 /* DP errors if the last instruction is not an INSTR_DONE. */
4110 if (vec_last(self->code->statements).opcode != INSTR_DONE)
4114 stmt.opcode = INSTR_DONE;
4118 last.line = vec_last(self->code->linenums);
4119 last.column = vec_last(self->code->columnnums);
4121 code_push_statement(self->code, &stmt, last);
4124 if (OPTS_OPTION_BOOL(OPTION_PP_ONLY))
4127 if (vec_size(self->code->statements) != vec_size(self->code->linenums)) {
4128 con_err("Linecounter wrong: %lu != %lu\n",
4129 (unsigned long)vec_size(self->code->statements),
4130 (unsigned long)vec_size(self->code->linenums));
4131 } else if (OPTS_FLAG(LNO)) {
4133 size_t filelen = strlen(filename);
4135 memcpy(vec_add(lnofile, filelen+1), filename, filelen+1);
4136 dot = strrchr(lnofile, '.');
4140 vec_shrinkto(lnofile, dot - lnofile);
4142 memcpy(vec_add(lnofile, 5), ".lno", 5);
4145 if (!code_write(self->code, filename, lnofile)) {
4154 /***********************************************************************
4155 *IR DEBUG Dump functions...
4158 #define IND_BUFSZ 1024
4160 static const char *qc_opname(int op)
4162 if (op < 0) return "<INVALID>";
4163 if (op < VINSTR_END)
4164 return util_instr_str[op];
4166 case VINSTR_END: return "END";
4167 case VINSTR_PHI: return "PHI";
4168 case VINSTR_JUMP: return "JUMP";
4169 case VINSTR_COND: return "COND";
4170 case VINSTR_BITXOR: return "BITXOR";
4171 case VINSTR_BITAND_V: return "BITAND_V";
4172 case VINSTR_BITOR_V: return "BITOR_V";
4173 case VINSTR_BITXOR_V: return "BITXOR_V";
4174 case VINSTR_BITAND_VF: return "BITAND_VF";
4175 case VINSTR_BITOR_VF: return "BITOR_VF";
4176 case VINSTR_BITXOR_VF: return "BITXOR_VF";
4177 case VINSTR_CROSS: return "CROSS";
4178 case VINSTR_NEG_F: return "NEG_F";
4179 case VINSTR_NEG_V: return "NEG_V";
4180 default: return "<UNK>";
4184 void ir_builder_dump(ir_builder *b, int (*oprintf)(const char*, ...))
4187 char indent[IND_BUFSZ];
4191 oprintf("module %s\n", b->name);
4192 for (i = 0; i < vec_size(b->globals); ++i)
4195 if (b->globals[i]->hasvalue)
4196 oprintf("%s = ", b->globals[i]->name);
4197 ir_value_dump(b->globals[i], oprintf);
4200 for (i = 0; i < vec_size(b->functions); ++i)
4201 ir_function_dump(b->functions[i], indent, oprintf);
4202 oprintf("endmodule %s\n", b->name);
4205 static const char *storenames[] = {
4206 "[global]", "[local]", "[param]", "[value]", "[return]"
4209 void ir_function_dump(ir_function *f, char *ind,
4210 int (*oprintf)(const char*, ...))
4213 if (f->builtin != 0) {
4214 oprintf("%sfunction %s = builtin %i\n", ind, f->name, -f->builtin);
4217 oprintf("%sfunction %s\n", ind, f->name);
4218 util_strncat(ind, "\t", IND_BUFSZ-1);
4219 if (vec_size(f->locals))
4221 oprintf("%s%i locals:\n", ind, (int)vec_size(f->locals));
4222 for (i = 0; i < vec_size(f->locals); ++i) {
4223 oprintf("%s\t", ind);
4224 ir_value_dump(f->locals[i], oprintf);
4228 oprintf("%sliferanges:\n", ind);
4229 for (i = 0; i < vec_size(f->locals); ++i) {
4230 const char *attr = "";
4232 ir_value *v = f->locals[i];
4233 if (v->unique_life && v->locked)
4234 attr = "unique,locked ";
4235 else if (v->unique_life)
4239 oprintf("%s\t%s: %s %s %s%s@%i ", ind, v->name, type_name[v->vtype],
4240 storenames[v->store],
4241 attr, (v->callparam ? "callparam " : ""),
4242 (int)v->code.local);
4245 for (l = 0; l < vec_size(v->life); ++l) {
4246 oprintf("[%i,%i] ", v->life[l].start, v->life[l].end);
4249 for (m = 0; m < 3; ++m) {
4250 ir_value *vm = v->members[m];
4253 oprintf("%s\t%s: @%i ", ind, vm->name, (int)vm->code.local);
4254 for (l = 0; l < vec_size(vm->life); ++l) {
4255 oprintf("[%i,%i] ", vm->life[l].start, vm->life[l].end);
4260 for (i = 0; i < vec_size(f->values); ++i) {
4261 const char *attr = "";
4263 ir_value *v = f->values[i];
4264 if (v->unique_life && v->locked)
4265 attr = "unique,locked ";
4266 else if (v->unique_life)
4270 oprintf("%s\t%s: %s %s %s%s@%i ", ind, v->name, type_name[v->vtype],
4271 storenames[v->store],
4272 attr, (v->callparam ? "callparam " : ""),
4273 (int)v->code.local);
4276 for (l = 0; l < vec_size(v->life); ++l) {
4277 oprintf("[%i,%i] ", v->life[l].start, v->life[l].end);
4280 for (m = 0; m < 3; ++m) {
4281 ir_value *vm = v->members[m];
4284 if (vm->unique_life && vm->locked)
4285 attr = "unique,locked ";
4286 else if (vm->unique_life)
4288 else if (vm->locked)
4290 oprintf("%s\t%s: %s@%i ", ind, vm->name, attr, (int)vm->code.local);
4291 for (l = 0; l < vec_size(vm->life); ++l) {
4292 oprintf("[%i,%i] ", vm->life[l].start, vm->life[l].end);
4297 if (vec_size(f->blocks))
4299 oprintf("%slife passes: %i\n", ind, (int)f->run_id);
4300 for (i = 0; i < vec_size(f->blocks); ++i) {
4301 ir_block_dump(f->blocks[i], ind, oprintf);
4305 ind[strlen(ind)-1] = 0;
4306 oprintf("%sendfunction %s\n", ind, f->name);
4309 void ir_block_dump(ir_block* b, char *ind,
4310 int (*oprintf)(const char*, ...))
4313 oprintf("%s:%s\n", ind, b->label);
4314 util_strncat(ind, "\t", IND_BUFSZ-1);
4316 if (b->instr && b->instr[0])
4317 oprintf("%s (%i) [entry]\n", ind, (int)(b->instr[0]->eid-1));
4318 for (i = 0; i < vec_size(b->instr); ++i)
4319 ir_instr_dump(b->instr[i], ind, oprintf);
4320 ind[strlen(ind)-1] = 0;
4323 static void dump_phi(ir_instr *in, int (*oprintf)(const char*, ...))
4326 oprintf("%s <- phi ", in->_ops[0]->name);
4327 for (i = 0; i < vec_size(in->phi); ++i)
4329 oprintf("([%s] : %s) ", in->phi[i].from->label,
4330 in->phi[i].value->name);
4335 void ir_instr_dump(ir_instr *in, char *ind,
4336 int (*oprintf)(const char*, ...))
4339 const char *comma = NULL;
4341 oprintf("%s (%i) ", ind, (int)in->eid);
4343 if (in->opcode == VINSTR_PHI) {
4344 dump_phi(in, oprintf);
4348 util_strncat(ind, "\t", IND_BUFSZ-1);
4350 if (in->_ops[0] && (in->_ops[1] || in->_ops[2])) {
4351 ir_value_dump(in->_ops[0], oprintf);
4352 if (in->_ops[1] || in->_ops[2])
4355 if (in->opcode == INSTR_CALL0 || in->opcode == VINSTR_NRCALL) {
4356 oprintf("CALL%i\t", vec_size(in->params));
4358 oprintf("%s\t", qc_opname(in->opcode));
4360 if (in->_ops[0] && !(in->_ops[1] || in->_ops[2])) {
4361 ir_value_dump(in->_ops[0], oprintf);
4366 for (i = 1; i != 3; ++i) {
4370 ir_value_dump(in->_ops[i], oprintf);
4378 oprintf("[%s]", in->bops[0]->label);
4382 oprintf("%s[%s]", comma, in->bops[1]->label);
4383 if (vec_size(in->params)) {
4384 oprintf("\tparams: ");
4385 for (i = 0; i != vec_size(in->params); ++i) {
4386 oprintf("%s, ", in->params[i]->name);
4390 ind[strlen(ind)-1] = 0;
4393 static void ir_value_dump_string(const char *str, int (*oprintf)(const char*, ...))
4396 for (; *str; ++str) {
4398 case '\n': oprintf("\\n"); break;
4399 case '\r': oprintf("\\r"); break;
4400 case '\t': oprintf("\\t"); break;
4401 case '\v': oprintf("\\v"); break;
4402 case '\f': oprintf("\\f"); break;
4403 case '\b': oprintf("\\b"); break;
4404 case '\a': oprintf("\\a"); break;
4405 case '\\': oprintf("\\\\"); break;
4406 case '"': oprintf("\\\""); break;
4407 default: oprintf("%c", *str); break;
4413 void ir_value_dump(ir_value* v, int (*oprintf)(const char*, ...))
4422 oprintf("fn:%s", v->name);
4425 oprintf("%g", v->constval.vfloat);
4428 oprintf("'%g %g %g'",
4431 v->constval.vvec.z);
4434 oprintf("(entity)");
4437 ir_value_dump_string(v->constval.vstring, oprintf);
4441 oprintf("%i", v->constval.vint);
4446 v->constval.vpointer->name);
4450 oprintf("%s", v->name);
4454 void ir_value_dump_life(const ir_value *self, int (*oprintf)(const char*,...))
4457 oprintf("Life of %12s:", self->name);
4458 for (i = 0; i < vec_size(self->life); ++i)
4460 oprintf(" + [%i, %i]\n", self->life[i].start, self->life[i].end);