2 * Copyright (C) 2012, 2013
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->code = code_init();
363 void ir_builder_delete(ir_builder* self)
366 util_htdel(self->htglobals);
367 util_htdel(self->htfields);
368 util_htdel(self->htfunctions);
369 mem_d((void*)self->name);
370 for (i = 0; i != vec_size(self->functions); ++i) {
371 ir_function_delete_quick(self->functions[i]);
373 vec_free(self->functions);
374 for (i = 0; i != vec_size(self->extparams); ++i) {
375 ir_value_delete(self->extparams[i]);
377 vec_free(self->extparams);
378 vec_free(self->extparam_protos);
379 for (i = 0; i != vec_size(self->globals); ++i) {
380 ir_value_delete(self->globals[i]);
382 vec_free(self->globals);
383 for (i = 0; i != vec_size(self->fields); ++i) {
384 ir_value_delete(self->fields[i]);
386 ir_value_delete(self->nil);
387 for (i = 0; i != IR_MAX_VINSTR_TEMPS; ++i) {
388 ir_value_delete(self->vinstr_temp[i]);
390 vec_free(self->fields);
391 vec_free(self->filenames);
392 vec_free(self->filestrings);
394 code_cleanup(self->code);
398 bool ir_builder_set_name(ir_builder *self, const char *name)
401 mem_d((void*)self->name);
402 self->name = util_strdup(name);
406 static ir_function* ir_builder_get_function(ir_builder *self, const char *name)
408 return (ir_function*)util_htget(self->htfunctions, name);
411 ir_function* ir_builder_create_function(ir_builder *self, const char *name, int outtype)
413 ir_function *fn = ir_builder_get_function(self, name);
418 fn = ir_function_new(self, outtype);
419 if (!ir_function_set_name(fn, name))
421 ir_function_delete(fn);
424 vec_push(self->functions, fn);
425 util_htset(self->htfunctions, name, fn);
427 fn->value = ir_builder_create_global(self, fn->name, TYPE_FUNCTION);
429 ir_function_delete(fn);
433 fn->value->hasvalue = true;
434 fn->value->outtype = outtype;
435 fn->value->constval.vfunc = fn;
436 fn->value->context = fn->context;
441 static ir_value* ir_builder_get_global(ir_builder *self, const char *name)
443 return (ir_value*)util_htget(self->htglobals, name);
446 ir_value* ir_builder_create_global(ir_builder *self, const char *name, int vtype)
452 ve = ir_builder_get_global(self, name);
458 ve = ir_value_var(name, store_global, vtype);
459 vec_push(self->globals, ve);
460 util_htset(self->htglobals, name, ve);
464 ir_value* ir_builder_get_va_count(ir_builder *self)
466 if (self->reserved_va_count)
467 return self->reserved_va_count;
468 return (self->reserved_va_count = ir_builder_create_global(self, "reserved:va_count", TYPE_FLOAT));
471 static ir_value* ir_builder_get_field(ir_builder *self, const char *name)
473 return (ir_value*)util_htget(self->htfields, name);
477 ir_value* ir_builder_create_field(ir_builder *self, const char *name, int vtype)
479 ir_value *ve = ir_builder_get_field(self, name);
484 ve = ir_value_var(name, store_global, TYPE_FIELD);
485 ve->fieldtype = vtype;
486 vec_push(self->fields, ve);
487 util_htset(self->htfields, name, ve);
491 /***********************************************************************
495 static bool ir_function_naive_phi(ir_function*);
496 static void ir_function_enumerate(ir_function*);
497 static bool ir_function_calculate_liferanges(ir_function*);
498 static bool ir_function_allocate_locals(ir_function*);
500 ir_function* ir_function_new(ir_builder* owner, int outtype)
503 self = (ir_function*)mem_a(sizeof(*self));
508 memset(self, 0, sizeof(*self));
511 if (!ir_function_set_name(self, "<@unnamed>")) {
518 self->context.file = "<@no context>";
519 self->context.line = 0;
520 self->outtype = outtype;
529 self->max_varargs = 0;
531 self->code_function_def = -1;
532 self->allocated_locals = 0;
533 self->globaltemps = 0;
539 bool ir_function_set_name(ir_function *self, const char *name)
542 mem_d((void*)self->name);
543 self->name = util_strdup(name);
547 static void ir_function_delete_quick(ir_function *self)
550 mem_d((void*)self->name);
552 for (i = 0; i != vec_size(self->blocks); ++i)
553 ir_block_delete_quick(self->blocks[i]);
554 vec_free(self->blocks);
556 vec_free(self->params);
558 for (i = 0; i != vec_size(self->values); ++i)
559 ir_value_delete(self->values[i]);
560 vec_free(self->values);
562 for (i = 0; i != vec_size(self->locals); ++i)
563 ir_value_delete(self->locals[i]);
564 vec_free(self->locals);
566 /* self->value is deleted by the builder */
571 void ir_function_delete(ir_function *self)
574 mem_d((void*)self->name);
576 for (i = 0; i != vec_size(self->blocks); ++i)
577 ir_block_delete(self->blocks[i]);
578 vec_free(self->blocks);
580 vec_free(self->params);
582 for (i = 0; i != vec_size(self->values); ++i)
583 ir_value_delete(self->values[i]);
584 vec_free(self->values);
586 for (i = 0; i != vec_size(self->locals); ++i)
587 ir_value_delete(self->locals[i]);
588 vec_free(self->locals);
590 /* self->value is deleted by the builder */
595 static void ir_function_collect_value(ir_function *self, ir_value *v)
597 vec_push(self->values, v);
600 ir_block* ir_function_create_block(lex_ctx_t ctx, ir_function *self, const char *label)
602 ir_block* bn = ir_block_new(self, label);
604 vec_push(self->blocks, bn);
608 static bool instr_is_operation(uint16_t op)
610 return ( (op >= INSTR_MUL_F && op <= INSTR_GT) ||
611 (op >= INSTR_LOAD_F && op <= INSTR_LOAD_FNC) ||
612 (op == INSTR_ADDRESS) ||
613 (op >= INSTR_NOT_F && op <= INSTR_NOT_FNC) ||
614 (op >= INSTR_AND && op <= INSTR_BITOR) ||
615 (op >= INSTR_CALL0 && op <= INSTR_CALL8) ||
616 (op >= VINSTR_BITAND_V && op <= VINSTR_NEG_V) );
619 static bool ir_function_pass_peephole(ir_function *self)
623 for (b = 0; b < vec_size(self->blocks); ++b) {
625 ir_block *block = self->blocks[b];
627 for (i = 0; i < vec_size(block->instr); ++i) {
629 inst = block->instr[i];
632 (inst->opcode >= INSTR_STORE_F &&
633 inst->opcode <= INSTR_STORE_FNC))
641 oper = block->instr[i-1];
642 if (!instr_is_operation(oper->opcode))
645 /* Don't change semantics of MUL_VF in engines where these may not alias. */
646 if (OPTS_FLAG(LEGACY_VECTOR_MATHS)) {
647 if (oper->opcode == INSTR_MUL_VF && oper->_ops[2]->memberof == oper->_ops[1])
649 if (oper->opcode == INSTR_MUL_FV && oper->_ops[1]->memberof == oper->_ops[2])
653 value = oper->_ops[0];
655 /* only do it for SSA values */
656 if (value->store != store_value)
659 /* don't optimize out the temp if it's used later again */
660 if (vec_size(value->reads) != 1)
663 /* The very next store must use this value */
664 if (value->reads[0] != store)
667 /* And of course the store must _read_ from it, so it's in
669 if (store->_ops[1] != value)
672 ++opts_optimizationcount[OPTIM_PEEPHOLE];
673 (void)!ir_instr_op(oper, 0, store->_ops[0], true);
675 vec_remove(block->instr, i, 1);
676 ir_instr_delete(store);
678 else if (inst->opcode == VINSTR_COND)
680 /* COND on a value resulting from a NOT could
681 * remove the NOT and swap its operands
688 value = inst->_ops[0];
690 if (value->store != store_value ||
691 vec_size(value->reads) != 1 ||
692 value->reads[0] != inst)
697 inot = value->writes[0];
698 if (inot->_ops[0] != value ||
699 inot->opcode < INSTR_NOT_F ||
700 inot->opcode > INSTR_NOT_FNC ||
701 inot->opcode == INSTR_NOT_V || /* can't do these */
702 inot->opcode == INSTR_NOT_S)
708 ++opts_optimizationcount[OPTIM_PEEPHOLE];
710 (void)!ir_instr_op(inst, 0, inot->_ops[1], false);
713 for (inotid = 0; inotid < vec_size(tmp->instr); ++inotid) {
714 if (tmp->instr[inotid] == inot)
717 if (inotid >= vec_size(tmp->instr)) {
718 compile_error(inst->context, "sanity-check failed: failed to find instruction to optimize out");
721 vec_remove(tmp->instr, inotid, 1);
722 ir_instr_delete(inot);
723 /* swap ontrue/onfalse */
725 inst->bops[0] = inst->bops[1];
736 static bool ir_function_pass_tailrecursion(ir_function *self)
740 for (b = 0; b < vec_size(self->blocks); ++b) {
742 ir_instr *ret, *call, *store = NULL;
743 ir_block *block = self->blocks[b];
745 if (!block->final || vec_size(block->instr) < 2)
748 ret = block->instr[vec_size(block->instr)-1];
749 if (ret->opcode != INSTR_DONE && ret->opcode != INSTR_RETURN)
752 call = block->instr[vec_size(block->instr)-2];
753 if (call->opcode >= INSTR_STORE_F && call->opcode <= INSTR_STORE_FNC) {
754 /* account for the unoptimized
756 * STORE %return, %tmp
760 if (vec_size(block->instr) < 3)
764 call = block->instr[vec_size(block->instr)-3];
767 if (call->opcode < INSTR_CALL0 || call->opcode > INSTR_CALL8)
771 /* optimize out the STORE */
773 ret->_ops[0] == store->_ops[0] &&
774 store->_ops[1] == call->_ops[0])
776 ++opts_optimizationcount[OPTIM_PEEPHOLE];
777 call->_ops[0] = store->_ops[0];
778 vec_remove(block->instr, vec_size(block->instr) - 2, 1);
779 ir_instr_delete(store);
788 funcval = call->_ops[1];
791 if (funcval->vtype != TYPE_FUNCTION || funcval->constval.vfunc != self)
794 /* now we have a CALL and a RET, check if it's a tailcall */
795 if (ret->_ops[0] && call->_ops[0] != ret->_ops[0])
798 ++opts_optimizationcount[OPTIM_TAIL_RECURSION];
799 vec_shrinkby(block->instr, 2);
801 block->final = false; /* open it back up */
803 /* emite parameter-stores */
804 for (p = 0; p < vec_size(call->params); ++p) {
805 /* assert(call->params_count <= self->locals_count); */
806 if (!ir_block_create_store(block, call->context, self->locals[p], call->params[p])) {
807 irerror(call->context, "failed to create tailcall store instruction for parameter %i", (int)p);
811 if (!ir_block_create_jump(block, call->context, self->blocks[0])) {
812 irerror(call->context, "failed to create tailcall jump");
816 ir_instr_delete(call);
817 ir_instr_delete(ret);
823 bool ir_function_finalize(ir_function *self)
830 if (OPTS_OPTIMIZATION(OPTIM_PEEPHOLE)) {
831 if (!ir_function_pass_peephole(self)) {
832 irerror(self->context, "generic optimization pass broke something in `%s`", self->name);
837 if (OPTS_OPTIMIZATION(OPTIM_TAIL_RECURSION)) {
838 if (!ir_function_pass_tailrecursion(self)) {
839 irerror(self->context, "tail-recursion optimization pass broke something in `%s`", self->name);
844 if (!ir_function_naive_phi(self)) {
845 irerror(self->context, "internal error: ir_function_naive_phi failed");
849 for (i = 0; i < vec_size(self->locals); ++i) {
850 ir_value *v = self->locals[i];
851 if (v->vtype == TYPE_VECTOR ||
852 (v->vtype == TYPE_FIELD && v->outtype == TYPE_VECTOR))
854 ir_value_vector_member(v, 0);
855 ir_value_vector_member(v, 1);
856 ir_value_vector_member(v, 2);
859 for (i = 0; i < vec_size(self->values); ++i) {
860 ir_value *v = self->values[i];
861 if (v->vtype == TYPE_VECTOR ||
862 (v->vtype == TYPE_FIELD && v->outtype == TYPE_VECTOR))
864 ir_value_vector_member(v, 0);
865 ir_value_vector_member(v, 1);
866 ir_value_vector_member(v, 2);
870 ir_function_enumerate(self);
872 if (!ir_function_calculate_liferanges(self))
874 if (!ir_function_allocate_locals(self))
879 ir_value* ir_function_create_local(ir_function *self, const char *name, int vtype, bool param)
884 vec_size(self->locals) &&
885 self->locals[vec_size(self->locals)-1]->store != store_param) {
886 irerror(self->context, "cannot add parameters after adding locals");
890 ve = ir_value_var(name, (param ? store_param : store_local), vtype);
893 vec_push(self->locals, ve);
897 /***********************************************************************
901 ir_block* ir_block_new(ir_function* owner, const char *name)
904 self = (ir_block*)mem_a(sizeof(*self));
908 memset(self, 0, sizeof(*self));
911 if (name && !ir_block_set_label(self, name)) {
916 self->context.file = "<@no context>";
917 self->context.line = 0;
921 self->entries = NULL;
925 self->is_return = false;
929 self->generated = false;
934 static void ir_block_delete_quick(ir_block* self)
937 if (self->label) mem_d(self->label);
938 for (i = 0; i != vec_size(self->instr); ++i)
939 ir_instr_delete_quick(self->instr[i]);
940 vec_free(self->instr);
941 vec_free(self->entries);
942 vec_free(self->exits);
943 vec_free(self->living);
947 void ir_block_delete(ir_block* self)
950 if (self->label) mem_d(self->label);
951 for (i = 0; i != vec_size(self->instr); ++i)
952 ir_instr_delete(self->instr[i]);
953 vec_free(self->instr);
954 vec_free(self->entries);
955 vec_free(self->exits);
956 vec_free(self->living);
960 bool ir_block_set_label(ir_block *self, const char *name)
963 mem_d((void*)self->label);
964 self->label = util_strdup(name);
965 return !!self->label;
968 /***********************************************************************
972 static ir_instr* ir_instr_new(lex_ctx_t ctx, ir_block* owner, int op)
975 self = (ir_instr*)mem_a(sizeof(*self));
982 self->_ops[0] = NULL;
983 self->_ops[1] = NULL;
984 self->_ops[2] = NULL;
985 self->bops[0] = NULL;
986 self->bops[1] = NULL;
997 static void ir_instr_delete_quick(ir_instr *self)
1000 vec_free(self->params);
1004 static void ir_instr_delete(ir_instr *self)
1007 /* The following calls can only delete from
1008 * vectors, we still want to delete this instruction
1009 * so ignore the return value. Since with the warn_unused_result attribute
1010 * gcc doesn't care about an explicit: (void)foo(); to ignore the result,
1011 * I have to improvise here and use if(foo());
1013 for (i = 0; i < vec_size(self->phi); ++i) {
1015 if (vec_ir_instr_find(self->phi[i].value->writes, self, &idx))
1016 vec_remove(self->phi[i].value->writes, idx, 1);
1017 if (vec_ir_instr_find(self->phi[i].value->reads, self, &idx))
1018 vec_remove(self->phi[i].value->reads, idx, 1);
1020 vec_free(self->phi);
1021 for (i = 0; i < vec_size(self->params); ++i) {
1023 if (vec_ir_instr_find(self->params[i]->writes, self, &idx))
1024 vec_remove(self->params[i]->writes, idx, 1);
1025 if (vec_ir_instr_find(self->params[i]->reads, self, &idx))
1026 vec_remove(self->params[i]->reads, idx, 1);
1028 vec_free(self->params);
1029 (void)!ir_instr_op(self, 0, NULL, false);
1030 (void)!ir_instr_op(self, 1, NULL, false);
1031 (void)!ir_instr_op(self, 2, NULL, false);
1035 static bool ir_instr_op(ir_instr *self, int op, ir_value *v, bool writing)
1037 if (v && v->vtype == TYPE_NOEXPR) {
1038 irerror(self->context, "tried to use a NOEXPR value");
1042 if (self->_ops[op]) {
1044 if (writing && vec_ir_instr_find(self->_ops[op]->writes, self, &idx))
1045 vec_remove(self->_ops[op]->writes, idx, 1);
1046 else if (vec_ir_instr_find(self->_ops[op]->reads, self, &idx))
1047 vec_remove(self->_ops[op]->reads, idx, 1);
1051 vec_push(v->writes, self);
1053 vec_push(v->reads, self);
1059 /***********************************************************************
1063 static void ir_value_code_setaddr(ir_value *self, int32_t gaddr)
1065 self->code.globaladdr = gaddr;
1066 if (self->members[0]) self->members[0]->code.globaladdr = gaddr;
1067 if (self->members[1]) self->members[1]->code.globaladdr = gaddr;
1068 if (self->members[2]) self->members[2]->code.globaladdr = gaddr;
1071 static int32_t ir_value_code_addr(const ir_value *self)
1073 if (self->store == store_return)
1074 return OFS_RETURN + self->code.addroffset;
1075 return self->code.globaladdr + self->code.addroffset;
1078 ir_value* ir_value_var(const char *name, int storetype, int vtype)
1081 self = (ir_value*)mem_a(sizeof(*self));
1082 self->vtype = vtype;
1083 self->fieldtype = TYPE_VOID;
1084 self->outtype = TYPE_VOID;
1085 self->store = storetype;
1089 self->writes = NULL;
1091 self->cvq = CV_NONE;
1092 self->hasvalue = false;
1093 self->context.file = "<@no context>";
1094 self->context.line = 0;
1096 if (name && !ir_value_set_name(self, name)) {
1097 irerror(self->context, "out of memory");
1102 memset(&self->constval, 0, sizeof(self->constval));
1103 memset(&self->code, 0, sizeof(self->code));
1105 self->members[0] = NULL;
1106 self->members[1] = NULL;
1107 self->members[2] = NULL;
1108 self->memberof = NULL;
1110 self->unique_life = false;
1111 self->locked = false;
1112 self->callparam = false;
1118 ir_value* ir_value_vector_member(ir_value *self, unsigned int member)
1126 if (self->members[member])
1127 return self->members[member];
1130 len = strlen(self->name);
1131 name = (char*)mem_a(len + 3);
1132 memcpy(name, self->name, len);
1134 name[len+1] = 'x' + member;
1140 if (self->vtype == TYPE_VECTOR)
1142 m = ir_value_var(name, self->store, TYPE_FLOAT);
1147 m->context = self->context;
1149 self->members[member] = m;
1150 m->code.addroffset = member;
1152 else if (self->vtype == TYPE_FIELD)
1154 if (self->fieldtype != TYPE_VECTOR)
1156 m = ir_value_var(name, self->store, TYPE_FIELD);
1161 m->fieldtype = TYPE_FLOAT;
1162 m->context = self->context;
1164 self->members[member] = m;
1165 m->code.addroffset = member;
1169 irerror(self->context, "invalid member access on %s", self->name);
1177 static GMQCC_INLINE size_t ir_value_sizeof(const ir_value *self)
1179 if (self->vtype == TYPE_FIELD && self->fieldtype == TYPE_VECTOR)
1180 return type_sizeof_[TYPE_VECTOR];
1181 return type_sizeof_[self->vtype];
1184 static ir_value* ir_value_out(ir_function *owner, const char *name, int storetype, int vtype)
1186 ir_value *v = ir_value_var(name, storetype, vtype);
1189 ir_function_collect_value(owner, v);
1193 void ir_value_delete(ir_value* self)
1197 mem_d((void*)self->name);
1200 if (self->vtype == TYPE_STRING)
1201 mem_d((void*)self->constval.vstring);
1203 for (i = 0; i < 3; ++i) {
1204 if (self->members[i])
1205 ir_value_delete(self->members[i]);
1207 vec_free(self->reads);
1208 vec_free(self->writes);
1209 vec_free(self->life);
1213 bool ir_value_set_name(ir_value *self, const char *name)
1216 mem_d((void*)self->name);
1217 self->name = util_strdup(name);
1218 return !!self->name;
1221 bool ir_value_set_float(ir_value *self, float f)
1223 if (self->vtype != TYPE_FLOAT)
1225 self->constval.vfloat = f;
1226 self->hasvalue = true;
1230 bool ir_value_set_func(ir_value *self, int f)
1232 if (self->vtype != TYPE_FUNCTION)
1234 self->constval.vint = f;
1235 self->hasvalue = true;
1239 bool ir_value_set_vector(ir_value *self, vec3_t v)
1241 if (self->vtype != TYPE_VECTOR)
1243 self->constval.vvec = v;
1244 self->hasvalue = true;
1248 bool ir_value_set_field(ir_value *self, ir_value *fld)
1250 if (self->vtype != TYPE_FIELD)
1252 self->constval.vpointer = fld;
1253 self->hasvalue = true;
1257 bool ir_value_set_string(ir_value *self, const char *str)
1259 if (self->vtype != TYPE_STRING)
1261 self->constval.vstring = util_strdupe(str);
1262 self->hasvalue = true;
1267 bool ir_value_set_int(ir_value *self, int i)
1269 if (self->vtype != TYPE_INTEGER)
1271 self->constval.vint = i;
1272 self->hasvalue = true;
1277 bool ir_value_lives(ir_value *self, size_t at)
1280 for (i = 0; i < vec_size(self->life); ++i)
1282 ir_life_entry_t *life = &self->life[i];
1283 if (life->start <= at && at <= life->end)
1285 if (life->start > at) /* since it's ordered */
1291 static bool ir_value_life_insert(ir_value *self, size_t idx, ir_life_entry_t e)
1294 vec_push(self->life, e);
1295 for (k = vec_size(self->life)-1; k > idx; --k)
1296 self->life[k] = self->life[k-1];
1297 self->life[idx] = e;
1301 static bool ir_value_life_merge(ir_value *self, size_t s)
1304 const size_t vs = vec_size(self->life);
1305 ir_life_entry_t *life = NULL;
1306 ir_life_entry_t *before = NULL;
1307 ir_life_entry_t new_entry;
1309 /* Find the first range >= s */
1310 for (i = 0; i < vs; ++i)
1313 life = &self->life[i];
1314 if (life->start > s)
1317 /* nothing found? append */
1320 if (life && life->end+1 == s)
1322 /* previous life range can be merged in */
1326 if (life && life->end >= s)
1328 e.start = e.end = s;
1329 vec_push(self->life, e);
1335 if (before->end + 1 == s &&
1336 life->start - 1 == s)
1339 before->end = life->end;
1340 vec_remove(self->life, i, 1);
1343 if (before->end + 1 == s)
1349 /* already contained */
1350 if (before->end >= s)
1354 if (life->start - 1 == s)
1359 /* insert a new entry */
1360 new_entry.start = new_entry.end = s;
1361 return ir_value_life_insert(self, i, new_entry);
1364 static bool ir_value_life_merge_into(ir_value *self, const ir_value *other)
1368 if (!vec_size(other->life))
1371 if (!vec_size(self->life)) {
1372 size_t count = vec_size(other->life);
1373 ir_life_entry_t *life = vec_add(self->life, count);
1374 memcpy(life, other->life, count * sizeof(*life));
1379 for (i = 0; i < vec_size(other->life); ++i)
1381 const ir_life_entry_t *life = &other->life[i];
1384 ir_life_entry_t *entry = &self->life[myi];
1386 if (life->end+1 < entry->start)
1388 /* adding an interval before entry */
1389 if (!ir_value_life_insert(self, myi, *life))
1395 if (life->start < entry->start &&
1396 life->end+1 >= entry->start)
1398 /* starts earlier and overlaps */
1399 entry->start = life->start;
1402 if (life->end > entry->end &&
1403 life->start <= entry->end+1)
1405 /* ends later and overlaps */
1406 entry->end = life->end;
1409 /* see if our change combines it with the next ranges */
1410 while (myi+1 < vec_size(self->life) &&
1411 entry->end+1 >= self->life[1+myi].start)
1413 /* overlaps with (myi+1) */
1414 if (entry->end < self->life[1+myi].end)
1415 entry->end = self->life[1+myi].end;
1416 vec_remove(self->life, myi+1, 1);
1417 entry = &self->life[myi];
1420 /* see if we're after the entry */
1421 if (life->start > entry->end)
1424 /* append if we're at the end */
1425 if (myi >= vec_size(self->life)) {
1426 vec_push(self->life, *life);
1429 /* otherweise check the next range */
1438 static bool ir_values_overlap(const ir_value *a, const ir_value *b)
1440 /* For any life entry in A see if it overlaps with
1441 * any life entry in B.
1442 * Note that the life entries are orderes, so we can make a
1443 * more efficient algorithm there than naively translating the
1447 ir_life_entry_t *la, *lb, *enda, *endb;
1449 /* first of all, if either has no life range, they cannot clash */
1450 if (!vec_size(a->life) || !vec_size(b->life))
1455 enda = la + vec_size(a->life);
1456 endb = lb + vec_size(b->life);
1459 /* check if the entries overlap, for that,
1460 * both must start before the other one ends.
1462 if (la->start < lb->end &&
1463 lb->start < la->end)
1468 /* entries are ordered
1469 * one entry is earlier than the other
1470 * that earlier entry will be moved forward
1472 if (la->start < lb->start)
1474 /* order: A B, move A forward
1475 * check if we hit the end with A
1480 else /* if (lb->start < la->start) actually <= */
1482 /* order: B A, move B forward
1483 * check if we hit the end with B
1492 /***********************************************************************
1496 static bool ir_check_unreachable(ir_block *self)
1498 /* The IR should never have to deal with unreachable code */
1499 if (!self->final/* || OPTS_FLAG(ALLOW_UNREACHABLE_CODE)*/)
1501 irerror(self->context, "unreachable statement (%s)", self->label);
1505 bool ir_block_create_store_op(ir_block *self, lex_ctx_t ctx, int op, ir_value *target, ir_value *what)
1508 if (!ir_check_unreachable(self))
1511 if (target->store == store_value &&
1512 (op < INSTR_STOREP_F || op > INSTR_STOREP_FNC))
1514 irerror(self->context, "cannot store to an SSA value");
1515 irerror(self->context, "trying to store: %s <- %s", target->name, what->name);
1516 irerror(self->context, "instruction: %s", util_instr_str[op]);
1520 in = ir_instr_new(ctx, self, op);
1524 if (!ir_instr_op(in, 0, target, (op < INSTR_STOREP_F || op > INSTR_STOREP_FNC)) ||
1525 !ir_instr_op(in, 1, what, false))
1527 ir_instr_delete(in);
1530 vec_push(self->instr, in);
1534 static bool ir_block_create_store(ir_block *self, lex_ctx_t ctx, ir_value *target, ir_value *what)
1538 if (target->vtype == TYPE_VARIANT)
1539 vtype = what->vtype;
1541 vtype = target->vtype;
1544 if (vtype == TYPE_FLOAT && what->vtype == TYPE_INTEGER)
1545 op = INSTR_CONV_ITOF;
1546 else if (vtype == TYPE_INTEGER && what->vtype == TYPE_FLOAT)
1547 op = INSTR_CONV_FTOI;
1549 op = type_store_instr[vtype];
1551 if (OPTS_FLAG(ADJUST_VECTOR_FIELDS)) {
1552 if (op == INSTR_STORE_FLD && what->fieldtype == TYPE_VECTOR)
1556 return ir_block_create_store_op(self, ctx, op, target, what);
1559 bool ir_block_create_storep(ir_block *self, lex_ctx_t ctx, ir_value *target, ir_value *what)
1564 if (target->vtype != TYPE_POINTER)
1567 /* storing using pointer - target is a pointer, type must be
1568 * inferred from source
1570 vtype = what->vtype;
1572 op = type_storep_instr[vtype];
1573 if (OPTS_FLAG(ADJUST_VECTOR_FIELDS)) {
1574 if (op == INSTR_STOREP_FLD && what->fieldtype == TYPE_VECTOR)
1575 op = INSTR_STOREP_V;
1578 return ir_block_create_store_op(self, ctx, op, target, what);
1581 bool ir_block_create_return(ir_block *self, lex_ctx_t ctx, ir_value *v)
1584 if (!ir_check_unreachable(self))
1587 self->is_return = true;
1588 in = ir_instr_new(ctx, self, INSTR_RETURN);
1592 if (v && !ir_instr_op(in, 0, v, false)) {
1593 ir_instr_delete(in);
1597 vec_push(self->instr, in);
1601 bool ir_block_create_if(ir_block *self, lex_ctx_t ctx, ir_value *v,
1602 ir_block *ontrue, ir_block *onfalse)
1605 if (!ir_check_unreachable(self))
1608 /*in = ir_instr_new(ctx, self, (v->vtype == TYPE_STRING ? INSTR_IF_S : INSTR_IF_F));*/
1609 in = ir_instr_new(ctx, self, VINSTR_COND);
1613 if (!ir_instr_op(in, 0, v, false)) {
1614 ir_instr_delete(in);
1618 in->bops[0] = ontrue;
1619 in->bops[1] = onfalse;
1621 vec_push(self->instr, in);
1623 vec_push(self->exits, ontrue);
1624 vec_push(self->exits, onfalse);
1625 vec_push(ontrue->entries, self);
1626 vec_push(onfalse->entries, self);
1630 bool ir_block_create_jump(ir_block *self, lex_ctx_t ctx, ir_block *to)
1633 if (!ir_check_unreachable(self))
1636 in = ir_instr_new(ctx, self, VINSTR_JUMP);
1641 vec_push(self->instr, in);
1643 vec_push(self->exits, to);
1644 vec_push(to->entries, self);
1648 bool ir_block_create_goto(ir_block *self, lex_ctx_t ctx, ir_block *to)
1650 self->owner->flags |= IR_FLAG_HAS_GOTO;
1651 return ir_block_create_jump(self, ctx, to);
1654 ir_instr* ir_block_create_phi(ir_block *self, lex_ctx_t ctx, const char *label, int ot)
1658 if (!ir_check_unreachable(self))
1660 in = ir_instr_new(ctx, self, VINSTR_PHI);
1663 out = ir_value_out(self->owner, label, store_value, ot);
1665 ir_instr_delete(in);
1668 if (!ir_instr_op(in, 0, out, true)) {
1669 ir_instr_delete(in);
1670 ir_value_delete(out);
1673 vec_push(self->instr, in);
1677 ir_value* ir_phi_value(ir_instr *self)
1679 return self->_ops[0];
1682 void ir_phi_add(ir_instr* self, ir_block *b, ir_value *v)
1686 if (!vec_ir_block_find(self->owner->entries, b, NULL)) {
1687 /* Must not be possible to cause this, otherwise the AST
1688 * is doing something wrong.
1690 irerror(self->context, "Invalid entry block for PHI");
1696 vec_push(v->reads, self);
1697 vec_push(self->phi, pe);
1700 /* call related code */
1701 ir_instr* ir_block_create_call(ir_block *self, lex_ctx_t ctx, const char *label, ir_value *func, bool noreturn)
1705 if (!ir_check_unreachable(self))
1707 in = ir_instr_new(ctx, self, (noreturn ? VINSTR_NRCALL : INSTR_CALL0));
1712 self->is_return = true;
1714 out = ir_value_out(self->owner, label, (func->outtype == TYPE_VOID) ? store_return : store_value, func->outtype);
1716 ir_instr_delete(in);
1719 if (!ir_instr_op(in, 0, out, true) ||
1720 !ir_instr_op(in, 1, func, false))
1722 ir_instr_delete(in);
1723 ir_value_delete(out);
1726 vec_push(self->instr, in);
1729 if (!ir_block_create_return(self, ctx, NULL)) {
1730 compile_error(ctx, "internal error: failed to generate dummy-return instruction");
1731 ir_instr_delete(in);
1739 ir_value* ir_call_value(ir_instr *self)
1741 return self->_ops[0];
1744 void ir_call_param(ir_instr* self, ir_value *v)
1746 vec_push(self->params, v);
1747 vec_push(v->reads, self);
1750 /* binary op related code */
1752 ir_value* ir_block_create_binop(ir_block *self, lex_ctx_t ctx,
1753 const char *label, int opcode,
1754 ir_value *left, ir_value *right)
1777 case INSTR_SUB_S: /* -- offset of string as float */
1782 case INSTR_BITOR_IF:
1783 case INSTR_BITOR_FI:
1784 case INSTR_BITAND_FI:
1785 case INSTR_BITAND_IF:
1800 case INSTR_BITAND_I:
1803 case INSTR_RSHIFT_I:
1804 case INSTR_LSHIFT_I:
1812 case VINSTR_BITAND_V:
1813 case VINSTR_BITOR_V:
1814 case VINSTR_BITXOR_V:
1815 case VINSTR_BITAND_VF:
1816 case VINSTR_BITOR_VF:
1817 case VINSTR_BITXOR_VF:
1832 * after the following default case, the value of opcode can never
1833 * be 1, 2, 3, 4, 5, 6, 7, 8, 9, 62, 63, 64, 65
1837 /* boolean operations result in floats */
1840 * opcode >= 10 takes true branch opcode is at least 10
1841 * opcode <= 23 takes false branch opcode is at least 24
1843 if (opcode >= INSTR_EQ_F && opcode <= INSTR_GT)
1847 * At condition "opcode <= 23", the value of "opcode" must be
1849 * At condition "opcode <= 23", the value of "opcode" cannot be
1850 * equal to any of {1, 2, 3, 4, 5, 6, 7, 8, 9, 62, 63, 64, 65}.
1851 * The condition "opcode <= 23" cannot be true.
1853 * Thus ot=2 (TYPE_FLOAT) can never be true
1856 else if (opcode >= INSTR_LE && opcode <= INSTR_GT)
1858 else if (opcode >= INSTR_LE_I && opcode <= INSTR_EQ_FI)
1863 if (ot == TYPE_VOID) {
1864 /* The AST or parser were supposed to check this! */
1868 return ir_block_create_general_instr(self, ctx, label, opcode, left, right, ot);
1871 ir_value* ir_block_create_unary(ir_block *self, lex_ctx_t ctx,
1872 const char *label, int opcode,
1875 int ot = TYPE_FLOAT;
1881 case INSTR_NOT_FNC: /*
1882 case INSTR_NOT_I: */
1887 * Negation for virtual instructions is emulated with 0-value. Thankfully
1888 * the operand for 0 already exists so we just source it from here.
1891 return ir_block_create_general_instr(self, ctx, label, INSTR_SUB_F, NULL, operand, ot);
1893 return ir_block_create_general_instr(self, ctx, label, INSTR_SUB_V, NULL, operand, ot);
1896 ot = operand->vtype;
1899 if (ot == TYPE_VOID) {
1900 /* The AST or parser were supposed to check this! */
1904 /* let's use the general instruction creator and pass NULL for OPB */
1905 return ir_block_create_general_instr(self, ctx, label, opcode, operand, NULL, ot);
1908 static ir_value* ir_block_create_general_instr(ir_block *self, lex_ctx_t ctx, const char *label,
1909 int op, ir_value *a, ir_value *b, int outype)
1914 out = ir_value_out(self->owner, label, store_value, outype);
1918 instr = ir_instr_new(ctx, self, op);
1920 ir_value_delete(out);
1924 if (!ir_instr_op(instr, 0, out, true) ||
1925 !ir_instr_op(instr, 1, a, false) ||
1926 !ir_instr_op(instr, 2, b, false) )
1931 vec_push(self->instr, instr);
1935 ir_instr_delete(instr);
1936 ir_value_delete(out);
1940 ir_value* ir_block_create_fieldaddress(ir_block *self, lex_ctx_t ctx, const char *label, ir_value *ent, ir_value *field)
1944 /* Support for various pointer types todo if so desired */
1945 if (ent->vtype != TYPE_ENTITY)
1948 if (field->vtype != TYPE_FIELD)
1951 v = ir_block_create_general_instr(self, ctx, label, INSTR_ADDRESS, ent, field, TYPE_POINTER);
1952 v->fieldtype = field->fieldtype;
1956 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)
1959 if (ent->vtype != TYPE_ENTITY)
1962 /* at some point we could redirect for TYPE_POINTER... but that could lead to carelessness */
1963 if (field->vtype != TYPE_FIELD)
1968 case TYPE_FLOAT: op = INSTR_LOAD_F; break;
1969 case TYPE_VECTOR: op = INSTR_LOAD_V; break;
1970 case TYPE_STRING: op = INSTR_LOAD_S; break;
1971 case TYPE_FIELD: op = INSTR_LOAD_FLD; break;
1972 case TYPE_ENTITY: op = INSTR_LOAD_ENT; break;
1973 case TYPE_FUNCTION: op = INSTR_LOAD_FNC; break;
1975 case TYPE_POINTER: op = INSTR_LOAD_I; break;
1976 case TYPE_INTEGER: op = INSTR_LOAD_I; break;
1979 irerror(self->context, "invalid type for ir_block_create_load_from_ent: %s", type_name[outype]);
1983 return ir_block_create_general_instr(self, ctx, label, op, ent, field, outype);
1986 /* PHI resolving breaks the SSA, and must thus be the last
1987 * step before life-range calculation.
1990 static bool ir_block_naive_phi(ir_block *self);
1991 bool ir_function_naive_phi(ir_function *self)
1995 for (i = 0; i < vec_size(self->blocks); ++i)
1997 if (!ir_block_naive_phi(self->blocks[i]))
2003 static bool ir_block_naive_phi(ir_block *self)
2005 size_t i, p; /*, w;*/
2006 /* FIXME: optionally, create_phi can add the phis
2007 * to a list so we don't need to loop through blocks
2008 * - anyway: "don't optimize YET"
2010 for (i = 0; i < vec_size(self->instr); ++i)
2012 ir_instr *instr = self->instr[i];
2013 if (instr->opcode != VINSTR_PHI)
2016 vec_remove(self->instr, i, 1);
2017 --i; /* NOTE: i+1 below */
2019 for (p = 0; p < vec_size(instr->phi); ++p)
2021 ir_value *v = instr->phi[p].value;
2022 ir_block *b = instr->phi[p].from;
2024 if (v->store == store_value &&
2025 vec_size(v->reads) == 1 &&
2026 vec_size(v->writes) == 1)
2028 /* replace the value */
2029 if (!ir_instr_op(v->writes[0], 0, instr->_ops[0], true))
2034 /* force a move instruction */
2035 ir_instr *prevjump = vec_last(b->instr);
2038 instr->_ops[0]->store = store_global;
2039 if (!ir_block_create_store(b, instr->context, instr->_ops[0], v))
2041 instr->_ops[0]->store = store_value;
2042 vec_push(b->instr, prevjump);
2046 ir_instr_delete(instr);
2051 /***********************************************************************
2052 *IR Temp allocation code
2053 * Propagating value life ranges by walking through the function backwards
2054 * until no more changes are made.
2055 * In theory this should happen once more than once for every nested loop
2057 * Though this implementation might run an additional time for if nests.
2060 /* Enumerate instructions used by value's life-ranges
2062 static void ir_block_enumerate(ir_block *self, size_t *_eid)
2066 for (i = 0; i < vec_size(self->instr); ++i)
2068 self->instr[i]->eid = eid++;
2073 /* Enumerate blocks and instructions.
2074 * The block-enumeration is unordered!
2075 * We do not really use the block enumreation, however
2076 * the instruction enumeration is important for life-ranges.
2078 void ir_function_enumerate(ir_function *self)
2081 size_t instruction_id = 0;
2082 for (i = 0; i < vec_size(self->blocks); ++i)
2084 /* each block now gets an additional "entry" instruction id
2085 * we can use to avoid point-life issues
2087 self->blocks[i]->entry_id = instruction_id;
2090 self->blocks[i]->eid = i;
2091 ir_block_enumerate(self->blocks[i], &instruction_id);
2095 /* Local-value allocator
2096 * After finishing creating the liferange of all values used in a function
2097 * we can allocate their global-positions.
2098 * This is the counterpart to register-allocation in register machines.
2105 } function_allocator;
2107 static bool function_allocator_alloc(function_allocator *alloc, ir_value *var)
2110 size_t vsize = ir_value_sizeof(var);
2112 var->code.local = vec_size(alloc->locals);
2114 slot = ir_value_var("reg", store_global, var->vtype);
2118 if (!ir_value_life_merge_into(slot, var))
2121 vec_push(alloc->locals, slot);
2122 vec_push(alloc->sizes, vsize);
2123 vec_push(alloc->unique, var->unique_life);
2128 ir_value_delete(slot);
2132 static bool ir_function_allocator_assign(ir_function *self, function_allocator *alloc, ir_value *v)
2138 return function_allocator_alloc(alloc, v);
2140 for (a = 0; a < vec_size(alloc->locals); ++a)
2142 /* if it's reserved for a unique liferange: skip */
2143 if (alloc->unique[a])
2146 slot = alloc->locals[a];
2148 /* never resize parameters
2149 * will be required later when overlapping temps + locals
2151 if (a < vec_size(self->params) &&
2152 alloc->sizes[a] < ir_value_sizeof(v))
2157 if (ir_values_overlap(v, slot))
2160 if (!ir_value_life_merge_into(slot, v))
2163 /* adjust size for this slot */
2164 if (alloc->sizes[a] < ir_value_sizeof(v))
2165 alloc->sizes[a] = ir_value_sizeof(v);
2170 if (a >= vec_size(alloc->locals)) {
2171 if (!function_allocator_alloc(alloc, v))
2177 bool ir_function_allocate_locals(ir_function *self)
2182 bool opt_gt = OPTS_OPTIMIZATION(OPTIM_GLOBAL_TEMPS);
2186 function_allocator lockalloc, globalloc;
2188 if (!vec_size(self->locals) && !vec_size(self->values))
2191 globalloc.locals = NULL;
2192 globalloc.sizes = NULL;
2193 globalloc.positions = NULL;
2194 globalloc.unique = NULL;
2195 lockalloc.locals = NULL;
2196 lockalloc.sizes = NULL;
2197 lockalloc.positions = NULL;
2198 lockalloc.unique = NULL;
2200 for (i = 0; i < vec_size(self->locals); ++i)
2202 v = self->locals[i];
2203 if ((self->flags & IR_FLAG_MASK_NO_LOCAL_TEMPS) || !OPTS_OPTIMIZATION(OPTIM_LOCAL_TEMPS)) {
2205 v->unique_life = true;
2207 else if (i >= vec_size(self->params))
2210 v->locked = true; /* lock parameters locals */
2211 if (!function_allocator_alloc((v->locked || !opt_gt ? &lockalloc : &globalloc), v))
2214 for (; i < vec_size(self->locals); ++i)
2216 v = self->locals[i];
2217 if (!vec_size(v->life))
2219 if (!ir_function_allocator_assign(self, (v->locked || !opt_gt ? &lockalloc : &globalloc), v))
2223 /* Allocate a slot for any value that still exists */
2224 for (i = 0; i < vec_size(self->values); ++i)
2226 v = self->values[i];
2228 if (!vec_size(v->life))
2231 /* CALL optimization:
2232 * If the value is a parameter-temp: 1 write, 1 read from a CALL
2233 * and it's not "locked", write it to the OFS_PARM directly.
2235 if (OPTS_OPTIMIZATION(OPTIM_CALL_STORES) && !v->locked && !v->unique_life) {
2236 if (vec_size(v->reads) == 1 && vec_size(v->writes) == 1 &&
2237 (v->reads[0]->opcode == VINSTR_NRCALL ||
2238 (v->reads[0]->opcode >= INSTR_CALL0 && v->reads[0]->opcode <= INSTR_CALL8)
2243 ir_instr *call = v->reads[0];
2244 if (!vec_ir_value_find(call->params, v, ¶m)) {
2245 irerror(call->context, "internal error: unlocked parameter %s not found", v->name);
2248 ++opts_optimizationcount[OPTIM_CALL_STORES];
2249 v->callparam = true;
2251 ir_value_code_setaddr(v, OFS_PARM0 + 3*param);
2253 size_t nprotos = vec_size(self->owner->extparam_protos);
2256 if (nprotos > param)
2257 ep = self->owner->extparam_protos[param];
2260 ep = ir_gen_extparam_proto(self->owner);
2261 while (++nprotos <= param)
2262 ep = ir_gen_extparam_proto(self->owner);
2264 ir_instr_op(v->writes[0], 0, ep, true);
2265 call->params[param+8] = ep;
2269 if (vec_size(v->writes) == 1 && v->writes[0]->opcode == INSTR_CALL0)
2271 v->store = store_return;
2272 if (v->members[0]) v->members[0]->store = store_return;
2273 if (v->members[1]) v->members[1]->store = store_return;
2274 if (v->members[2]) v->members[2]->store = store_return;
2275 ++opts_optimizationcount[OPTIM_CALL_STORES];
2280 if (!ir_function_allocator_assign(self, (v->locked || !opt_gt ? &lockalloc : &globalloc), v))
2284 if (!lockalloc.sizes && !globalloc.sizes) {
2287 vec_push(lockalloc.positions, 0);
2288 vec_push(globalloc.positions, 0);
2290 /* Adjust slot positions based on sizes */
2291 if (lockalloc.sizes) {
2292 pos = (vec_size(lockalloc.sizes) ? lockalloc.positions[0] : 0);
2293 for (i = 1; i < vec_size(lockalloc.sizes); ++i)
2295 pos = lockalloc.positions[i-1] + lockalloc.sizes[i-1];
2296 vec_push(lockalloc.positions, pos);
2298 self->allocated_locals = pos + vec_last(lockalloc.sizes);
2300 if (globalloc.sizes) {
2301 pos = (vec_size(globalloc.sizes) ? globalloc.positions[0] : 0);
2302 for (i = 1; i < vec_size(globalloc.sizes); ++i)
2304 pos = globalloc.positions[i-1] + globalloc.sizes[i-1];
2305 vec_push(globalloc.positions, pos);
2307 self->globaltemps = pos + vec_last(globalloc.sizes);
2310 /* Locals need to know their new position */
2311 for (i = 0; i < vec_size(self->locals); ++i) {
2312 v = self->locals[i];
2313 if (v->locked || !opt_gt)
2314 v->code.local = lockalloc.positions[v->code.local];
2316 v->code.local = globalloc.positions[v->code.local];
2318 /* Take over the actual slot positions on values */
2319 for (i = 0; i < vec_size(self->values); ++i) {
2320 v = self->values[i];
2321 if (v->locked || !opt_gt)
2322 v->code.local = lockalloc.positions[v->code.local];
2324 v->code.local = globalloc.positions[v->code.local];
2332 for (i = 0; i < vec_size(lockalloc.locals); ++i)
2333 ir_value_delete(lockalloc.locals[i]);
2334 for (i = 0; i < vec_size(globalloc.locals); ++i)
2335 ir_value_delete(globalloc.locals[i]);
2336 vec_free(globalloc.unique);
2337 vec_free(globalloc.locals);
2338 vec_free(globalloc.sizes);
2339 vec_free(globalloc.positions);
2340 vec_free(lockalloc.unique);
2341 vec_free(lockalloc.locals);
2342 vec_free(lockalloc.sizes);
2343 vec_free(lockalloc.positions);
2347 /* Get information about which operand
2348 * is read from, or written to.
2350 static void ir_op_read_write(int op, size_t *read, size_t *write)
2370 case INSTR_STOREP_F:
2371 case INSTR_STOREP_V:
2372 case INSTR_STOREP_S:
2373 case INSTR_STOREP_ENT:
2374 case INSTR_STOREP_FLD:
2375 case INSTR_STOREP_FNC:
2386 static bool ir_block_living_add_instr(ir_block *self, size_t eid)
2389 const size_t vs = vec_size(self->living);
2390 bool changed = false;
2391 for (i = 0; i != vs; ++i)
2393 if (ir_value_life_merge(self->living[i], eid))
2399 static bool ir_block_living_lock(ir_block *self)
2402 bool changed = false;
2403 for (i = 0; i != vec_size(self->living); ++i)
2405 if (!self->living[i]->locked) {
2406 self->living[i]->locked = true;
2413 static bool ir_block_life_propagate(ir_block *self, bool *changed)
2417 size_t i, o, p, mem, cnt;
2418 /* bitmasks which operands are read from or written to */
2425 vec_free(self->living);
2427 p = vec_size(self->exits);
2428 for (i = 0; i < p; ++i) {
2429 ir_block *prev = self->exits[i];
2430 cnt = vec_size(prev->living);
2431 for (o = 0; o < cnt; ++o) {
2432 if (!vec_ir_value_find(self->living, prev->living[o], NULL))
2433 vec_push(self->living, prev->living[o]);
2437 i = vec_size(self->instr);
2440 instr = self->instr[i];
2442 /* See which operands are read and write operands */
2443 ir_op_read_write(instr->opcode, &read, &write);
2445 /* Go through the 3 main operands
2446 * writes first, then reads
2448 for (o = 0; o < 3; ++o)
2450 if (!instr->_ops[o]) /* no such operand */
2453 value = instr->_ops[o];
2455 /* We only care about locals */
2456 /* we also calculate parameter liferanges so that locals
2457 * can take up parameter slots */
2458 if (value->store != store_value &&
2459 value->store != store_local &&
2460 value->store != store_param)
2463 /* write operands */
2464 /* When we write to a local, we consider it "dead" for the
2465 * remaining upper part of the function, since in SSA a value
2466 * can only be written once (== created)
2471 bool in_living = vec_ir_value_find(self->living, value, &idx);
2474 /* If the value isn't alive it hasn't been read before... */
2475 /* TODO: See if the warning can be emitted during parsing or AST processing
2476 * otherwise have warning printed here.
2477 * IF printing a warning here: include filecontext_t,
2478 * and make sure it's only printed once
2479 * since this function is run multiple times.
2481 /* con_err( "Value only written %s\n", value->name); */
2482 if (ir_value_life_merge(value, instr->eid))
2485 /* since 'living' won't contain it
2486 * anymore, merge the value, since
2489 if (ir_value_life_merge(value, instr->eid))
2492 vec_remove(self->living, idx, 1);
2494 /* Removing a vector removes all members */
2495 for (mem = 0; mem < 3; ++mem) {
2496 if (value->members[mem] && vec_ir_value_find(self->living, value->members[mem], &idx)) {
2497 if (ir_value_life_merge(value->members[mem], instr->eid))
2499 vec_remove(self->living, idx, 1);
2502 /* Removing the last member removes the vector */
2503 if (value->memberof) {
2504 value = value->memberof;
2505 for (mem = 0; mem < 3; ++mem) {
2506 if (value->members[mem] && vec_ir_value_find(self->living, value->members[mem], NULL))
2509 if (mem == 3 && vec_ir_value_find(self->living, value, &idx)) {
2510 if (ir_value_life_merge(value, instr->eid))
2512 vec_remove(self->living, idx, 1);
2518 /* These operations need a special case as they can break when using
2519 * same source and destination operand otherwise, as the engine may
2520 * read the source multiple times. */
2521 if (instr->opcode == INSTR_MUL_VF ||
2522 instr->opcode == VINSTR_BITAND_VF ||
2523 instr->opcode == VINSTR_BITOR_VF ||
2524 instr->opcode == VINSTR_BITXOR ||
2525 instr->opcode == VINSTR_BITXOR_VF ||
2526 instr->opcode == VINSTR_BITXOR_V ||
2527 instr->opcode == VINSTR_CROSS)
2529 value = instr->_ops[2];
2530 /* the float source will get an additional lifetime */
2531 if (ir_value_life_merge(value, instr->eid+1))
2533 if (value->memberof && ir_value_life_merge(value->memberof, instr->eid+1))
2537 if (instr->opcode == INSTR_MUL_FV ||
2538 instr->opcode == INSTR_LOAD_V ||
2539 instr->opcode == VINSTR_BITXOR ||
2540 instr->opcode == VINSTR_BITXOR_VF ||
2541 instr->opcode == VINSTR_BITXOR_V ||
2542 instr->opcode == VINSTR_CROSS)
2544 value = instr->_ops[1];
2545 /* the float source will get an additional lifetime */
2546 if (ir_value_life_merge(value, instr->eid+1))
2548 if (value->memberof && ir_value_life_merge(value->memberof, instr->eid+1))
2552 for (o = 0; o < 3; ++o)
2554 if (!instr->_ops[o]) /* no such operand */
2557 value = instr->_ops[o];
2559 /* We only care about locals */
2560 /* we also calculate parameter liferanges so that locals
2561 * can take up parameter slots */
2562 if (value->store != store_value &&
2563 value->store != store_local &&
2564 value->store != store_param)
2570 if (!vec_ir_value_find(self->living, value, NULL))
2571 vec_push(self->living, value);
2572 /* reading adds the full vector */
2573 if (value->memberof && !vec_ir_value_find(self->living, value->memberof, NULL))
2574 vec_push(self->living, value->memberof);
2575 for (mem = 0; mem < 3; ++mem) {
2576 if (value->members[mem] && !vec_ir_value_find(self->living, value->members[mem], NULL))
2577 vec_push(self->living, value->members[mem]);
2581 /* PHI operands are always read operands */
2582 for (p = 0; p < vec_size(instr->phi); ++p)
2584 value = instr->phi[p].value;
2585 if (!vec_ir_value_find(self->living, value, NULL))
2586 vec_push(self->living, value);
2587 /* reading adds the full vector */
2588 if (value->memberof && !vec_ir_value_find(self->living, value->memberof, NULL))
2589 vec_push(self->living, value->memberof);
2590 for (mem = 0; mem < 3; ++mem) {
2591 if (value->members[mem] && !vec_ir_value_find(self->living, value->members[mem], NULL))
2592 vec_push(self->living, value->members[mem]);
2596 /* on a call, all these values must be "locked" */
2597 if (instr->opcode >= INSTR_CALL0 && instr->opcode <= INSTR_CALL8) {
2598 if (ir_block_living_lock(self))
2601 /* call params are read operands too */
2602 for (p = 0; p < vec_size(instr->params); ++p)
2604 value = instr->params[p];
2605 if (!vec_ir_value_find(self->living, value, NULL))
2606 vec_push(self->living, value);
2607 /* reading adds the full vector */
2608 if (value->memberof && !vec_ir_value_find(self->living, value->memberof, NULL))
2609 vec_push(self->living, value->memberof);
2610 for (mem = 0; mem < 3; ++mem) {
2611 if (value->members[mem] && !vec_ir_value_find(self->living, value->members[mem], NULL))
2612 vec_push(self->living, value->members[mem]);
2617 if (ir_block_living_add_instr(self, instr->eid))
2620 /* the "entry" instruction ID */
2621 if (ir_block_living_add_instr(self, self->entry_id))
2627 bool ir_function_calculate_liferanges(ir_function *self)
2632 /* parameters live at 0 */
2633 for (i = 0; i < vec_size(self->params); ++i)
2634 if (!ir_value_life_merge(self->locals[i], 0))
2635 compile_error(self->context, "internal error: failed value-life merging");
2640 i = vec_size(self->blocks);
2642 ir_block_life_propagate(self->blocks[i], &changed);
2646 if (vec_size(self->blocks)) {
2647 ir_block *block = self->blocks[0];
2648 for (i = 0; i < vec_size(block->living); ++i) {
2649 ir_value *v = block->living[i];
2650 if (v->store != store_local)
2652 if (v->vtype == TYPE_VECTOR)
2654 self->flags |= IR_FLAG_HAS_UNINITIALIZED;
2655 /* find the instruction reading from it */
2656 for (s = 0; s < vec_size(v->reads); ++s) {
2657 if (v->reads[s]->eid == v->life[0].end)
2660 if (s < vec_size(v->reads)) {
2661 if (irwarning(v->context, WARN_USED_UNINITIALIZED,
2662 "variable `%s` may be used uninitialized in this function\n"
2665 v->reads[s]->context.file, v->reads[s]->context.line)
2673 ir_value *vec = v->memberof;
2674 for (s = 0; s < vec_size(vec->reads); ++s) {
2675 if (vec->reads[s]->eid == v->life[0].end)
2678 if (s < vec_size(vec->reads)) {
2679 if (irwarning(v->context, WARN_USED_UNINITIALIZED,
2680 "variable `%s` may be used uninitialized in this function\n"
2683 vec->reads[s]->context.file, vec->reads[s]->context.line)
2691 if (irwarning(v->context, WARN_USED_UNINITIALIZED,
2692 "variable `%s` may be used uninitialized in this function", v->name))
2701 /***********************************************************************
2704 * Since the IR has the convention of putting 'write' operands
2705 * at the beginning, we have to rotate the operands of instructions
2706 * properly in order to generate valid QCVM code.
2708 * Having destinations at a fixed position is more convenient. In QC
2709 * this is *mostly* OPC, but FTE adds at least 2 instructions which
2710 * read from from OPA, and store to OPB rather than OPC. Which is
2711 * partially the reason why the implementation of these instructions
2712 * in darkplaces has been delayed for so long.
2714 * Breaking conventions is annoying...
2716 static bool ir_builder_gen_global(ir_builder *self, ir_value *global, bool islocal);
2718 static bool gen_global_field(code_t *code, ir_value *global)
2720 if (global->hasvalue)
2722 ir_value *fld = global->constval.vpointer;
2724 irerror(global->context, "Invalid field constant with no field: %s", global->name);
2728 /* copy the field's value */
2729 ir_value_code_setaddr(global, vec_size(code->globals));
2730 vec_push(code->globals, fld->code.fieldaddr);
2731 if (global->fieldtype == TYPE_VECTOR) {
2732 vec_push(code->globals, fld->code.fieldaddr+1);
2733 vec_push(code->globals, fld->code.fieldaddr+2);
2738 ir_value_code_setaddr(global, vec_size(code->globals));
2739 vec_push(code->globals, 0);
2740 if (global->fieldtype == TYPE_VECTOR) {
2741 vec_push(code->globals, 0);
2742 vec_push(code->globals, 0);
2745 if (global->code.globaladdr < 0)
2750 static bool gen_global_pointer(code_t *code, ir_value *global)
2752 if (global->hasvalue)
2754 ir_value *target = global->constval.vpointer;
2756 irerror(global->context, "Invalid pointer constant: %s", global->name);
2757 /* NULL pointers are pointing to the NULL constant, which also
2758 * sits at address 0, but still has an ir_value for itself.
2763 /* Here, relocations ARE possible - in fteqcc-enhanced-qc:
2764 * void() foo; <- proto
2765 * void() *fooptr = &foo;
2766 * void() foo = { code }
2768 if (!target->code.globaladdr) {
2769 /* FIXME: Check for the constant nullptr ir_value!
2770 * because then code.globaladdr being 0 is valid.
2772 irerror(global->context, "FIXME: Relocation support");
2776 ir_value_code_setaddr(global, vec_size(code->globals));
2777 vec_push(code->globals, target->code.globaladdr);
2781 ir_value_code_setaddr(global, vec_size(code->globals));
2782 vec_push(code->globals, 0);
2784 if (global->code.globaladdr < 0)
2789 static bool gen_blocks_recursive(code_t *code, ir_function *func, ir_block *block)
2791 prog_section_statement_t stmt;
2800 block->generated = true;
2801 block->code_start = vec_size(code->statements);
2802 for (i = 0; i < vec_size(block->instr); ++i)
2804 instr = block->instr[i];
2806 if (instr->opcode == VINSTR_PHI) {
2807 irerror(block->context, "cannot generate virtual instruction (phi)");
2811 if (instr->opcode == VINSTR_JUMP) {
2812 target = instr->bops[0];
2813 /* for uncoditional jumps, if the target hasn't been generated
2814 * yet, we generate them right here.
2816 if (!target->generated)
2817 return gen_blocks_recursive(code, func, target);
2819 /* otherwise we generate a jump instruction */
2820 stmt.opcode = INSTR_GOTO;
2821 stmt.o1.s1 = (target->code_start) - vec_size(code->statements);
2824 if (stmt.o1.s1 != 1)
2825 code_push_statement(code, &stmt, instr->context);
2827 /* no further instructions can be in this block */
2831 if (instr->opcode == VINSTR_BITXOR) {
2832 stmt.opcode = INSTR_BITOR;
2833 stmt.o1.s1 = ir_value_code_addr(instr->_ops[1]);
2834 stmt.o2.s1 = ir_value_code_addr(instr->_ops[2]);
2835 stmt.o3.s1 = ir_value_code_addr(instr->_ops[0]);
2836 code_push_statement(code, &stmt, instr->context);
2837 stmt.opcode = INSTR_BITAND;
2838 stmt.o1.s1 = ir_value_code_addr(instr->_ops[1]);
2839 stmt.o2.s1 = ir_value_code_addr(instr->_ops[2]);
2840 stmt.o3.s1 = ir_value_code_addr(func->owner->vinstr_temp[0]);
2841 code_push_statement(code, &stmt, instr->context);
2842 stmt.opcode = INSTR_SUB_F;
2843 stmt.o1.s1 = ir_value_code_addr(instr->_ops[0]);
2844 stmt.o2.s1 = ir_value_code_addr(func->owner->vinstr_temp[0]);
2845 stmt.o3.s1 = ir_value_code_addr(instr->_ops[0]);
2846 code_push_statement(code, &stmt, instr->context);
2848 /* instruction generated */
2852 if (instr->opcode == VINSTR_BITAND_V) {
2853 stmt.opcode = INSTR_BITAND;
2854 stmt.o1.s1 = ir_value_code_addr(instr->_ops[1]);
2855 stmt.o2.s1 = ir_value_code_addr(instr->_ops[2]);
2856 stmt.o3.s1 = ir_value_code_addr(instr->_ops[0]);
2857 code_push_statement(code, &stmt, instr->context);
2861 code_push_statement(code, &stmt, instr->context);
2865 code_push_statement(code, &stmt, instr->context);
2867 /* instruction generated */
2871 if (instr->opcode == VINSTR_BITOR_V) {
2872 stmt.opcode = INSTR_BITOR;
2873 stmt.o1.s1 = ir_value_code_addr(instr->_ops[1]);
2874 stmt.o2.s1 = ir_value_code_addr(instr->_ops[2]);
2875 stmt.o3.s1 = ir_value_code_addr(instr->_ops[0]);
2876 code_push_statement(code, &stmt, instr->context);
2880 code_push_statement(code, &stmt, instr->context);
2884 code_push_statement(code, &stmt, instr->context);
2886 /* instruction generated */
2890 if (instr->opcode == VINSTR_BITXOR_V) {
2891 for (j = 0; j < 3; ++j) {
2892 stmt.opcode = INSTR_BITOR;
2893 stmt.o1.s1 = ir_value_code_addr(instr->_ops[1]) + j;
2894 stmt.o2.s1 = ir_value_code_addr(instr->_ops[2]) + j;
2895 stmt.o3.s1 = ir_value_code_addr(instr->_ops[0]) + j;
2896 code_push_statement(code, &stmt, instr->context);
2897 stmt.opcode = INSTR_BITAND;
2898 stmt.o1.s1 = ir_value_code_addr(instr->_ops[1]) + j;
2899 stmt.o2.s1 = ir_value_code_addr(instr->_ops[2]) + j;
2900 stmt.o3.s1 = ir_value_code_addr(func->owner->vinstr_temp[0]) + j;
2901 code_push_statement(code, &stmt, instr->context);
2903 stmt.opcode = INSTR_SUB_V;
2904 stmt.o1.s1 = ir_value_code_addr(instr->_ops[0]);
2905 stmt.o2.s1 = ir_value_code_addr(func->owner->vinstr_temp[0]);
2906 stmt.o3.s1 = ir_value_code_addr(instr->_ops[0]);
2907 code_push_statement(code, &stmt, instr->context);
2909 /* instruction generated */
2913 if (instr->opcode == VINSTR_BITAND_VF) {
2914 stmt.opcode = INSTR_BITAND;
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);
2921 code_push_statement(code, &stmt, instr->context);
2924 code_push_statement(code, &stmt, instr->context);
2926 /* instruction generated */
2930 if (instr->opcode == VINSTR_BITOR_VF) {
2931 stmt.opcode = INSTR_BITOR;
2932 stmt.o1.s1 = ir_value_code_addr(instr->_ops[1]);
2933 stmt.o2.s1 = ir_value_code_addr(instr->_ops[2]);
2934 stmt.o3.s1 = ir_value_code_addr(instr->_ops[0]);
2935 code_push_statement(code, &stmt, instr->context);
2938 code_push_statement(code, &stmt, instr->context);
2941 code_push_statement(code, &stmt, instr->context);
2943 /* instruction generated */
2947 if (instr->opcode == VINSTR_BITXOR_VF) {
2948 for (j = 0; j < 3; ++j) {
2949 stmt.opcode = INSTR_BITOR;
2950 stmt.o1.s1 = ir_value_code_addr(instr->_ops[1]) + j;
2951 stmt.o2.s1 = ir_value_code_addr(instr->_ops[2]);
2952 stmt.o3.s1 = ir_value_code_addr(instr->_ops[0]) + j;
2953 code_push_statement(code, &stmt, instr->context);
2954 stmt.opcode = INSTR_BITAND;
2955 stmt.o1.s1 = ir_value_code_addr(instr->_ops[1]) + j;
2956 stmt.o2.s1 = ir_value_code_addr(instr->_ops[2]);
2957 stmt.o3.s1 = ir_value_code_addr(func->owner->vinstr_temp[0]) + j;
2958 code_push_statement(code, &stmt, instr->context);
2960 stmt.opcode = INSTR_SUB_V;
2961 stmt.o1.s1 = ir_value_code_addr(instr->_ops[0]);
2962 stmt.o2.s1 = ir_value_code_addr(func->owner->vinstr_temp[0]);
2963 stmt.o3.s1 = ir_value_code_addr(instr->_ops[0]);
2964 code_push_statement(code, &stmt, instr->context);
2966 /* instruction generated */
2970 if (instr->opcode == VINSTR_CROSS) {
2971 stmt.opcode = INSTR_MUL_F;
2972 for (j = 0; j < 3; ++j) {
2973 stmt.o1.s1 = ir_value_code_addr(instr->_ops[1]) + (j + 1) % 3;
2974 stmt.o2.s1 = ir_value_code_addr(instr->_ops[2]) + (j + 2) % 3;
2975 stmt.o3.s1 = ir_value_code_addr(instr->_ops[0]) + j;
2976 code_push_statement(code, &stmt, instr->context);
2977 stmt.o1.s1 = ir_value_code_addr(instr->_ops[1]) + (j + 2) % 3;
2978 stmt.o2.s1 = ir_value_code_addr(instr->_ops[2]) + (j + 1) % 3;
2979 stmt.o3.s1 = ir_value_code_addr(func->owner->vinstr_temp[0]) + j;
2980 code_push_statement(code, &stmt, instr->context);
2982 stmt.opcode = INSTR_SUB_V;
2983 stmt.o1.s1 = ir_value_code_addr(instr->_ops[0]);
2984 stmt.o2.s1 = ir_value_code_addr(func->owner->vinstr_temp[0]);
2985 stmt.o3.s1 = ir_value_code_addr(instr->_ops[0]);
2986 code_push_statement(code, &stmt, instr->context);
2988 /* instruction generated */
2992 if (instr->opcode == VINSTR_COND) {
2993 ontrue = instr->bops[0];
2994 onfalse = instr->bops[1];
2995 /* TODO: have the AST signal which block should
2996 * come first: eg. optimize IFs without ELSE...
2999 stmt.o1.u1 = ir_value_code_addr(instr->_ops[0]);
3003 if (ontrue->generated) {
3004 stmt.opcode = INSTR_IF;
3005 stmt.o2.s1 = (ontrue->code_start) - vec_size(code->statements);
3006 if (stmt.o2.s1 != 1)
3007 code_push_statement(code, &stmt, instr->context);
3009 if (onfalse->generated) {
3010 stmt.opcode = INSTR_IFNOT;
3011 stmt.o2.s1 = (onfalse->code_start) - vec_size(code->statements);
3012 if (stmt.o2.s1 != 1)
3013 code_push_statement(code, &stmt, instr->context);
3015 if (!ontrue->generated) {
3016 if (onfalse->generated)
3017 return gen_blocks_recursive(code, func, ontrue);
3019 if (!onfalse->generated) {
3020 if (ontrue->generated)
3021 return gen_blocks_recursive(code, func, onfalse);
3023 /* neither ontrue nor onfalse exist */
3024 stmt.opcode = INSTR_IFNOT;
3025 if (!instr->likely) {
3026 /* Honor the likelyhood hint */
3027 ir_block *tmp = onfalse;
3028 stmt.opcode = INSTR_IF;
3032 stidx = vec_size(code->statements);
3033 code_push_statement(code, &stmt, instr->context);
3034 /* on false we jump, so add ontrue-path */
3035 if (!gen_blocks_recursive(code, func, ontrue))
3037 /* fixup the jump address */
3038 code->statements[stidx].o2.s1 = vec_size(code->statements) - stidx;
3039 /* generate onfalse path */
3040 if (onfalse->generated) {
3041 /* fixup the jump address */
3042 code->statements[stidx].o2.s1 = (onfalse->code_start) - (stidx);
3043 if (stidx+2 == vec_size(code->statements) && code->statements[stidx].o2.s1 == 1) {
3044 code->statements[stidx] = code->statements[stidx+1];
3045 if (code->statements[stidx].o1.s1 < 0)
3046 code->statements[stidx].o1.s1++;
3047 code_pop_statement(code);
3049 stmt.opcode = vec_last(code->statements).opcode;
3050 if (stmt.opcode == INSTR_GOTO ||
3051 stmt.opcode == INSTR_IF ||
3052 stmt.opcode == INSTR_IFNOT ||
3053 stmt.opcode == INSTR_RETURN ||
3054 stmt.opcode == INSTR_DONE)
3056 /* no use jumping from here */
3059 /* may have been generated in the previous recursive call */
3060 stmt.opcode = INSTR_GOTO;
3061 stmt.o1.s1 = (onfalse->code_start) - vec_size(code->statements);
3064 if (stmt.o1.s1 != 1)
3065 code_push_statement(code, &stmt, instr->context);
3068 else if (stidx+2 == vec_size(code->statements) && code->statements[stidx].o2.s1 == 1) {
3069 code->statements[stidx] = code->statements[stidx+1];
3070 if (code->statements[stidx].o1.s1 < 0)
3071 code->statements[stidx].o1.s1++;
3072 code_pop_statement(code);
3074 /* if not, generate now */
3075 return gen_blocks_recursive(code, func, onfalse);
3078 if ( (instr->opcode >= INSTR_CALL0 && instr->opcode <= INSTR_CALL8)
3079 || instr->opcode == VINSTR_NRCALL)
3084 first = vec_size(instr->params);
3087 for (p = 0; p < first; ++p)
3089 ir_value *param = instr->params[p];
3090 if (param->callparam)
3093 stmt.opcode = INSTR_STORE_F;
3096 if (param->vtype == TYPE_FIELD)
3097 stmt.opcode = field_store_instr[param->fieldtype];
3098 else if (param->vtype == TYPE_NIL)
3099 stmt.opcode = INSTR_STORE_V;
3101 stmt.opcode = type_store_instr[param->vtype];
3102 stmt.o1.u1 = ir_value_code_addr(param);
3103 stmt.o2.u1 = OFS_PARM0 + 3 * p;
3104 code_push_statement(code, &stmt, instr->context);
3106 /* Now handle extparams */
3107 first = vec_size(instr->params);
3108 for (; p < first; ++p)
3110 ir_builder *ir = func->owner;
3111 ir_value *param = instr->params[p];
3112 ir_value *targetparam;
3114 if (param->callparam)
3117 if (p-8 >= vec_size(ir->extparams))
3118 ir_gen_extparam(ir);
3120 targetparam = ir->extparams[p-8];
3122 stmt.opcode = INSTR_STORE_F;
3125 if (param->vtype == TYPE_FIELD)
3126 stmt.opcode = field_store_instr[param->fieldtype];
3127 else if (param->vtype == TYPE_NIL)
3128 stmt.opcode = INSTR_STORE_V;
3130 stmt.opcode = type_store_instr[param->vtype];
3131 stmt.o1.u1 = ir_value_code_addr(param);
3132 stmt.o2.u1 = ir_value_code_addr(targetparam);
3133 code_push_statement(code, &stmt, instr->context);
3136 stmt.opcode = INSTR_CALL0 + vec_size(instr->params);
3137 if (stmt.opcode > INSTR_CALL8)
3138 stmt.opcode = INSTR_CALL8;
3139 stmt.o1.u1 = ir_value_code_addr(instr->_ops[1]);
3142 code_push_statement(code, &stmt, instr->context);
3144 retvalue = instr->_ops[0];
3145 if (retvalue && retvalue->store != store_return &&
3146 (retvalue->store == store_global || vec_size(retvalue->life)))
3148 /* not to be kept in OFS_RETURN */
3149 if (retvalue->vtype == TYPE_FIELD && OPTS_FLAG(ADJUST_VECTOR_FIELDS))
3150 stmt.opcode = field_store_instr[retvalue->fieldtype];
3152 stmt.opcode = type_store_instr[retvalue->vtype];
3153 stmt.o1.u1 = OFS_RETURN;
3154 stmt.o2.u1 = ir_value_code_addr(retvalue);
3156 code_push_statement(code, &stmt, instr->context);
3161 if (instr->opcode == INSTR_STATE) {
3162 irerror(block->context, "TODO: state instruction");
3166 stmt.opcode = instr->opcode;
3171 /* This is the general order of operands */
3173 stmt.o3.u1 = ir_value_code_addr(instr->_ops[0]);
3176 stmt.o1.u1 = ir_value_code_addr(instr->_ops[1]);
3179 stmt.o2.u1 = ir_value_code_addr(instr->_ops[2]);
3181 if (stmt.opcode == INSTR_RETURN || stmt.opcode == INSTR_DONE)
3183 stmt.o1.u1 = stmt.o3.u1;
3186 else if ((stmt.opcode >= INSTR_STORE_F &&
3187 stmt.opcode <= INSTR_STORE_FNC) ||
3188 (stmt.opcode >= INSTR_STOREP_F &&
3189 stmt.opcode <= INSTR_STOREP_FNC))
3191 /* 2-operand instructions with A -> B */
3192 stmt.o2.u1 = stmt.o3.u1;
3195 /* tiny optimization, don't output
3198 if (stmt.o2.u1 == stmt.o1.u1 &&
3199 OPTS_OPTIMIZATION(OPTIM_PEEPHOLE))
3201 ++opts_optimizationcount[OPTIM_PEEPHOLE];
3205 code_push_statement(code, &stmt, instr->context);
3210 static bool gen_function_code(code_t *code, ir_function *self)
3213 prog_section_statement_t stmt, *retst;
3215 /* Starting from entry point, we generate blocks "as they come"
3216 * for now. Dead blocks will not be translated obviously.
3218 if (!vec_size(self->blocks)) {
3219 irerror(self->context, "Function '%s' declared without body.", self->name);
3223 block = self->blocks[0];
3224 if (block->generated)
3227 if (!gen_blocks_recursive(code, self, block)) {
3228 irerror(self->context, "failed to generate blocks for '%s'", self->name);
3232 /* code_write and qcvm -disasm need to know that the function ends here */
3233 retst = &vec_last(code->statements);
3234 if (OPTS_OPTIMIZATION(OPTIM_VOID_RETURN) &&
3235 self->outtype == TYPE_VOID &&
3236 retst->opcode == INSTR_RETURN &&
3237 !retst->o1.u1 && !retst->o2.u1 && !retst->o3.u1)
3239 retst->opcode = INSTR_DONE;
3240 ++opts_optimizationcount[OPTIM_VOID_RETURN];
3244 stmt.opcode = INSTR_DONE;
3248 last.line = vec_last(code->linenums);
3249 last.column = vec_last(code->columnnums);
3251 code_push_statement(code, &stmt, last);
3256 static qcint_t ir_builder_filestring(ir_builder *ir, const char *filename)
3258 /* NOTE: filename pointers are copied, we never strdup them,
3259 * thus we can use pointer-comparison to find the string.
3264 for (i = 0; i < vec_size(ir->filenames); ++i) {
3265 if (ir->filenames[i] == filename)
3266 return ir->filestrings[i];
3269 str = code_genstring(ir->code, filename);
3270 vec_push(ir->filenames, filename);
3271 vec_push(ir->filestrings, str);
3275 static bool gen_global_function(ir_builder *ir, ir_value *global)
3277 prog_section_function_t fun;
3282 if (!global->hasvalue || (!global->constval.vfunc))
3284 irerror(global->context, "Invalid state of function-global: not constant: %s", global->name);
3288 irfun = global->constval.vfunc;
3290 fun.name = global->code.name;
3291 fun.file = ir_builder_filestring(ir, global->context.file);
3292 fun.profile = 0; /* always 0 */
3293 fun.nargs = vec_size(irfun->params);
3297 for (i = 0;i < 8; ++i) {
3298 if ((int32_t)i >= fun.nargs)
3301 fun.argsize[i] = type_sizeof_[irfun->params[i]];
3305 fun.locals = irfun->allocated_locals;
3308 fun.entry = irfun->builtin+1;
3310 irfun->code_function_def = vec_size(ir->code->functions);
3311 fun.entry = vec_size(ir->code->statements);
3314 vec_push(ir->code->functions, fun);
3318 static ir_value* ir_gen_extparam_proto(ir_builder *ir)
3323 util_snprintf(name, sizeof(name), "EXTPARM#%i", (int)(vec_size(ir->extparam_protos)));
3324 global = ir_value_var(name, store_global, TYPE_VECTOR);
3326 vec_push(ir->extparam_protos, global);
3330 static void ir_gen_extparam(ir_builder *ir)
3332 prog_section_def_t def;
3335 if (vec_size(ir->extparam_protos) < vec_size(ir->extparams)+1)
3336 global = ir_gen_extparam_proto(ir);
3338 global = ir->extparam_protos[vec_size(ir->extparams)];
3340 def.name = code_genstring(ir->code, global->name);
3341 def.type = TYPE_VECTOR;
3342 def.offset = vec_size(ir->code->globals);
3344 vec_push(ir->code->defs, def);
3346 ir_value_code_setaddr(global, def.offset);
3348 vec_push(ir->code->globals, 0);
3349 vec_push(ir->code->globals, 0);
3350 vec_push(ir->code->globals, 0);
3352 vec_push(ir->extparams, global);
3355 static bool gen_function_extparam_copy(code_t *code, ir_function *self)
3357 size_t i, ext, numparams;
3359 ir_builder *ir = self->owner;
3361 prog_section_statement_t stmt;
3363 numparams = vec_size(self->params);
3367 stmt.opcode = INSTR_STORE_F;
3369 for (i = 8; i < numparams; ++i) {
3371 if (ext >= vec_size(ir->extparams))
3372 ir_gen_extparam(ir);
3374 ep = ir->extparams[ext];
3376 stmt.opcode = type_store_instr[self->locals[i]->vtype];
3377 if (self->locals[i]->vtype == TYPE_FIELD &&
3378 self->locals[i]->fieldtype == TYPE_VECTOR)
3380 stmt.opcode = INSTR_STORE_V;
3382 stmt.o1.u1 = ir_value_code_addr(ep);
3383 stmt.o2.u1 = ir_value_code_addr(self->locals[i]);
3384 code_push_statement(code, &stmt, self->context);
3390 static bool gen_function_varargs_copy(code_t *code, ir_function *self)
3392 size_t i, ext, numparams, maxparams;
3394 ir_builder *ir = self->owner;
3396 prog_section_statement_t stmt;
3398 numparams = vec_size(self->params);
3402 stmt.opcode = INSTR_STORE_V;
3404 maxparams = numparams + self->max_varargs;
3405 for (i = numparams; i < maxparams; ++i) {
3407 stmt.o1.u1 = OFS_PARM0 + 3*i;
3408 stmt.o2.u1 = ir_value_code_addr(self->locals[i]);
3409 code_push_statement(code, &stmt, self->context);
3413 while (ext >= vec_size(ir->extparams))
3414 ir_gen_extparam(ir);
3416 ep = ir->extparams[ext];
3418 stmt.o1.u1 = ir_value_code_addr(ep);
3419 stmt.o2.u1 = ir_value_code_addr(self->locals[i]);
3420 code_push_statement(code, &stmt, self->context);
3426 static bool gen_function_locals(ir_builder *ir, ir_value *global)
3428 prog_section_function_t *def;
3431 uint32_t firstlocal, firstglobal;
3433 irfun = global->constval.vfunc;
3434 def = ir->code->functions + irfun->code_function_def;
3436 if (OPTS_OPTION_BOOL(OPTION_G) ||
3437 !OPTS_OPTIMIZATION(OPTIM_OVERLAP_LOCALS) ||
3438 (irfun->flags & IR_FLAG_MASK_NO_OVERLAP))
3440 firstlocal = def->firstlocal = vec_size(ir->code->globals);
3442 firstlocal = def->firstlocal = ir->first_common_local;
3443 ++opts_optimizationcount[OPTIM_OVERLAP_LOCALS];
3446 firstglobal = (OPTS_OPTIMIZATION(OPTIM_GLOBAL_TEMPS) ? ir->first_common_globaltemp : firstlocal);
3448 for (i = vec_size(ir->code->globals); i < firstlocal + irfun->allocated_locals; ++i)
3449 vec_push(ir->code->globals, 0);
3450 for (i = 0; i < vec_size(irfun->locals); ++i) {
3451 ir_value *v = irfun->locals[i];
3452 if (v->locked || !OPTS_OPTIMIZATION(OPTIM_GLOBAL_TEMPS)) {
3453 ir_value_code_setaddr(v, firstlocal + v->code.local);
3454 if (!ir_builder_gen_global(ir, irfun->locals[i], true)) {
3455 irerror(irfun->locals[i]->context, "failed to generate local %s", irfun->locals[i]->name);
3460 ir_value_code_setaddr(v, firstglobal + v->code.local);
3462 for (i = 0; i < vec_size(irfun->values); ++i)
3464 ir_value *v = irfun->values[i];
3468 ir_value_code_setaddr(v, firstlocal + v->code.local);
3470 ir_value_code_setaddr(v, firstglobal + v->code.local);
3475 static bool gen_global_function_code(ir_builder *ir, ir_value *global)
3477 prog_section_function_t *fundef;
3482 irfun = global->constval.vfunc;
3484 if (global->cvq == CV_NONE) {
3485 if (irwarning(global->context, WARN_IMPLICIT_FUNCTION_POINTER,
3486 "function `%s` has no body and in QC implicitly becomes a function-pointer",
3489 /* Not bailing out just now. If this happens a lot you don't want to have
3490 * to rerun gmqcc for each such function.
3496 /* this was a function pointer, don't generate code for those */
3504 * If there is no definition and the thing is eraseable, we can ignore
3505 * outputting the function to begin with.
3507 if (global->flags & IR_FLAG_ERASEABLE && irfun->code_function_def < 0) {
3511 if (irfun->code_function_def < 0) {
3512 irerror(irfun->context, "`%s`: IR global wasn't generated, failed to access function-def", irfun->name);
3515 fundef = &ir->code->functions[irfun->code_function_def];
3517 fundef->entry = vec_size(ir->code->statements);
3518 if (!gen_function_locals(ir, global)) {
3519 irerror(irfun->context, "Failed to generate locals for function %s", irfun->name);
3522 if (!gen_function_extparam_copy(ir->code, irfun)) {
3523 irerror(irfun->context, "Failed to generate extparam-copy code for function %s", irfun->name);
3526 if (irfun->max_varargs && !gen_function_varargs_copy(ir->code, irfun)) {
3527 irerror(irfun->context, "Failed to generate vararg-copy code for function %s", irfun->name);
3530 if (!gen_function_code(ir->code, irfun)) {
3531 irerror(irfun->context, "Failed to generate code for function %s", irfun->name);
3537 static void gen_vector_defs(code_t *code, prog_section_def_t def, const char *name)
3542 if (!name || name[0] == '#' || OPTS_FLAG(SINGLE_VECTOR_DEFS))
3545 def.type = TYPE_FLOAT;
3549 component = (char*)mem_a(len+3);
3550 memcpy(component, name, len);
3552 component[len-0] = 0;
3553 component[len-2] = '_';
3555 component[len-1] = 'x';
3557 for (i = 0; i < 3; ++i) {
3558 def.name = code_genstring(code, component);
3559 vec_push(code->defs, def);
3567 static void gen_vector_fields(code_t *code, prog_section_field_t fld, const char *name)
3572 if (!name || OPTS_FLAG(SINGLE_VECTOR_DEFS))
3575 fld.type = TYPE_FLOAT;
3579 component = (char*)mem_a(len+3);
3580 memcpy(component, name, len);
3582 component[len-0] = 0;
3583 component[len-2] = '_';
3585 component[len-1] = 'x';
3587 for (i = 0; i < 3; ++i) {
3588 fld.name = code_genstring(code, component);
3589 vec_push(code->fields, fld);
3597 static bool ir_builder_gen_global(ir_builder *self, ir_value *global, bool islocal)
3601 prog_section_def_t def;
3602 bool pushdef = opts.optimizeoff;
3604 def.type = global->vtype;
3605 def.offset = vec_size(self->code->globals);
3607 if (OPTS_OPTION_BOOL(OPTION_G) || !islocal)
3612 * if we're eraseable and the function isn't referenced ignore outputting
3615 if (global->flags & IR_FLAG_ERASEABLE && vec_size(global->reads) == 0) {
3619 if (OPTS_OPTIMIZATION(OPTIM_STRIP_CONSTANT_NAMES) &&
3620 !(global->flags & IR_FLAG_INCLUDE_DEF) &&
3621 (global->name[0] == '#' || global->cvq == CV_CONST))
3627 if (global->name[0] == '#') {
3628 if (!self->str_immediate)
3629 self->str_immediate = code_genstring(self->code, "IMMEDIATE");
3630 def.name = global->code.name = self->str_immediate;
3633 def.name = global->code.name = code_genstring(self->code, global->name);
3638 def.offset = ir_value_code_addr(global);
3639 vec_push(self->code->defs, def);
3640 if (global->vtype == TYPE_VECTOR)
3641 gen_vector_defs(self->code, def, global->name);
3642 else if (global->vtype == TYPE_FIELD && global->fieldtype == TYPE_VECTOR)
3643 gen_vector_defs(self->code, def, global->name);
3650 switch (global->vtype)
3653 if (!strcmp(global->name, "end_sys_globals")) {
3654 /* TODO: remember this point... all the defs before this one
3655 * should be checksummed and added to progdefs.h when we generate it.
3658 else if (!strcmp(global->name, "end_sys_fields")) {
3659 /* TODO: same as above but for entity-fields rather than globsl
3662 else if(irwarning(global->context, WARN_VOID_VARIABLES, "unrecognized variable of type void `%s`",
3665 /* Not bailing out */
3668 /* I'd argue setting it to 0 is sufficient, but maybe some depend on knowing how far
3669 * the system fields actually go? Though the engine knows this anyway...
3670 * Maybe this could be an -foption
3671 * fteqcc creates data for end_sys_* - of size 1, so let's do the same
3673 ir_value_code_setaddr(global, vec_size(self->code->globals));
3674 vec_push(self->code->globals, 0);
3676 if (pushdef) vec_push(self->code->defs, def);
3679 if (pushdef) vec_push(self->code->defs, def);
3680 return gen_global_pointer(self->code, global);
3683 vec_push(self->code->defs, def);
3684 if (global->fieldtype == TYPE_VECTOR)
3685 gen_vector_defs(self->code, def, global->name);
3687 return gen_global_field(self->code, global);
3692 ir_value_code_setaddr(global, vec_size(self->code->globals));
3693 if (global->hasvalue) {
3694 iptr = (int32_t*)&global->constval.ivec[0];
3695 vec_push(self->code->globals, *iptr);
3697 vec_push(self->code->globals, 0);
3699 if (!islocal && global->cvq != CV_CONST)
3700 def.type |= DEF_SAVEGLOBAL;
3701 if (pushdef) vec_push(self->code->defs, def);
3703 return global->code.globaladdr >= 0;
3707 ir_value_code_setaddr(global, vec_size(self->code->globals));
3708 if (global->hasvalue) {
3709 uint32_t load = code_genstring(self->code, global->constval.vstring);
3710 vec_push(self->code->globals, load);
3712 vec_push(self->code->globals, 0);
3714 if (!islocal && global->cvq != CV_CONST)
3715 def.type |= DEF_SAVEGLOBAL;
3716 if (pushdef) vec_push(self->code->defs, def);
3717 return global->code.globaladdr >= 0;
3722 ir_value_code_setaddr(global, vec_size(self->code->globals));
3723 if (global->hasvalue) {
3724 iptr = (int32_t*)&global->constval.ivec[0];
3725 vec_push(self->code->globals, iptr[0]);
3726 if (global->code.globaladdr < 0)
3728 for (d = 1; d < type_sizeof_[global->vtype]; ++d) {
3729 vec_push(self->code->globals, iptr[d]);
3732 vec_push(self->code->globals, 0);
3733 if (global->code.globaladdr < 0)
3735 for (d = 1; d < type_sizeof_[global->vtype]; ++d) {
3736 vec_push(self->code->globals, 0);
3739 if (!islocal && global->cvq != CV_CONST)
3740 def.type |= DEF_SAVEGLOBAL;
3743 vec_push(self->code->defs, def);
3744 def.type &= ~DEF_SAVEGLOBAL;
3745 gen_vector_defs(self->code, def, global->name);
3747 return global->code.globaladdr >= 0;
3750 ir_value_code_setaddr(global, vec_size(self->code->globals));
3751 if (!global->hasvalue) {
3752 vec_push(self->code->globals, 0);
3753 if (global->code.globaladdr < 0)
3756 vec_push(self->code->globals, vec_size(self->code->functions));
3757 if (!gen_global_function(self, global))
3760 if (!islocal && global->cvq != CV_CONST)
3761 def.type |= DEF_SAVEGLOBAL;
3762 if (pushdef) vec_push(self->code->defs, def);
3765 /* assume biggest type */
3766 ir_value_code_setaddr(global, vec_size(self->code->globals));
3767 vec_push(self->code->globals, 0);
3768 for (i = 1; i < type_sizeof_[TYPE_VARIANT]; ++i)
3769 vec_push(self->code->globals, 0);
3772 /* refuse to create 'void' type or any other fancy business. */
3773 irerror(global->context, "Invalid type for global variable `%s`: %s",
3774 global->name, type_name[global->vtype]);
3779 static GMQCC_INLINE void ir_builder_prepare_field(code_t *code, ir_value *field)
3781 field->code.fieldaddr = code_alloc_field(code, type_sizeof_[field->fieldtype]);
3784 static bool ir_builder_gen_field(ir_builder *self, ir_value *field)
3786 prog_section_def_t def;
3787 prog_section_field_t fld;
3791 def.type = (uint16_t)field->vtype;
3792 def.offset = (uint16_t)vec_size(self->code->globals);
3794 /* create a global named the same as the field */
3795 if (OPTS_OPTION_U32(OPTION_STANDARD) == COMPILER_GMQCC) {
3796 /* in our standard, the global gets a dot prefix */
3797 size_t len = strlen(field->name);
3800 /* we really don't want to have to allocate this, and 1024
3801 * bytes is more than enough for a variable/field name
3803 if (len+2 >= sizeof(name)) {
3804 irerror(field->context, "invalid field name size: %u", (unsigned int)len);
3809 memcpy(name+1, field->name, len); /* no strncpy - we used strlen above */
3812 def.name = code_genstring(self->code, name);
3813 fld.name = def.name + 1; /* we reuse that string table entry */
3815 /* in plain QC, there cannot be a global with the same name,
3816 * and so we also name the global the same.
3817 * FIXME: fteqcc should create a global as well
3818 * check if it actually uses the same name. Probably does
3820 def.name = code_genstring(self->code, field->name);
3821 fld.name = def.name;
3824 field->code.name = def.name;
3826 vec_push(self->code->defs, def);
3828 fld.type = field->fieldtype;
3830 if (fld.type == TYPE_VOID) {
3831 irerror(field->context, "field is missing a type: %s - don't know its size", field->name);
3835 fld.offset = field->code.fieldaddr;
3837 vec_push(self->code->fields, fld);
3839 ir_value_code_setaddr(field, vec_size(self->code->globals));
3840 vec_push(self->code->globals, fld.offset);
3841 if (fld.type == TYPE_VECTOR) {
3842 vec_push(self->code->globals, fld.offset+1);
3843 vec_push(self->code->globals, fld.offset+2);
3846 if (field->fieldtype == TYPE_VECTOR) {
3847 gen_vector_defs (self->code, def, field->name);
3848 gen_vector_fields(self->code, fld, field->name);
3851 return field->code.globaladdr >= 0;
3854 bool ir_builder_generate(ir_builder *self, const char *filename)
3856 prog_section_statement_t stmt;
3858 char *lnofile = NULL;
3860 for (i = 0; i < vec_size(self->fields); ++i)
3862 ir_builder_prepare_field(self->code, self->fields[i]);
3865 for (i = 0; i < vec_size(self->globals); ++i)
3867 if (!ir_builder_gen_global(self, self->globals[i], false)) {
3870 if (self->globals[i]->vtype == TYPE_FUNCTION) {
3871 ir_function *func = self->globals[i]->constval.vfunc;
3872 if (func && self->max_locals < func->allocated_locals &&
3873 !(func->flags & IR_FLAG_MASK_NO_OVERLAP))
3875 self->max_locals = func->allocated_locals;
3877 if (func && self->max_globaltemps < func->globaltemps)
3878 self->max_globaltemps = func->globaltemps;
3882 for (i = 0; i < vec_size(self->fields); ++i)
3884 if (!ir_builder_gen_field(self, self->fields[i])) {
3890 ir_value_code_setaddr(self->nil, vec_size(self->code->globals));
3891 vec_push(self->code->globals, 0);
3892 vec_push(self->code->globals, 0);
3893 vec_push(self->code->globals, 0);
3895 /* generate virtual-instruction temps */
3896 for (i = 0; i < IR_MAX_VINSTR_TEMPS; ++i) {
3897 ir_value_code_setaddr(self->vinstr_temp[i], vec_size(self->code->globals));
3898 vec_push(self->code->globals, 0);
3899 vec_push(self->code->globals, 0);
3900 vec_push(self->code->globals, 0);
3903 /* generate global temps */
3904 self->first_common_globaltemp = vec_size(self->code->globals);
3905 for (i = 0; i < self->max_globaltemps; ++i) {
3906 vec_push(self->code->globals, 0);
3908 /* generate common locals */
3909 self->first_common_local = vec_size(self->code->globals);
3910 for (i = 0; i < self->max_locals; ++i) {
3911 vec_push(self->code->globals, 0);
3914 /* generate function code */
3915 for (i = 0; i < vec_size(self->globals); ++i)
3917 if (self->globals[i]->vtype == TYPE_FUNCTION) {
3918 if (!gen_global_function_code(self, self->globals[i])) {
3924 if (vec_size(self->code->globals) >= 65536) {
3925 irerror(vec_last(self->globals)->context, "This progs file would require more globals than the metadata can handle. Bailing out.");
3929 /* DP errors if the last instruction is not an INSTR_DONE. */
3930 if (vec_last(self->code->statements).opcode != INSTR_DONE)
3934 stmt.opcode = INSTR_DONE;
3938 last.line = vec_last(self->code->linenums);
3939 last.column = vec_last(self->code->columnnums);
3941 code_push_statement(self->code, &stmt, last);
3944 if (OPTS_OPTION_BOOL(OPTION_PP_ONLY))
3947 if (vec_size(self->code->statements) != vec_size(self->code->linenums)) {
3948 con_err("Linecounter wrong: %lu != %lu\n",
3949 (unsigned long)vec_size(self->code->statements),
3950 (unsigned long)vec_size(self->code->linenums));
3951 } else if (OPTS_FLAG(LNO)) {
3953 size_t filelen = strlen(filename);
3955 memcpy(vec_add(lnofile, filelen+1), filename, filelen+1);
3956 dot = strrchr(lnofile, '.');
3960 vec_shrinkto(lnofile, dot - lnofile);
3962 memcpy(vec_add(lnofile, 5), ".lno", 5);
3965 if (!code_write(self->code, filename, lnofile)) {
3974 /***********************************************************************
3975 *IR DEBUG Dump functions...
3978 #define IND_BUFSZ 1024
3980 static const char *qc_opname(int op)
3982 if (op < 0) return "<INVALID>";
3983 if (op < VINSTR_END)
3984 return util_instr_str[op];
3986 case VINSTR_END: return "END";
3987 case VINSTR_PHI: return "PHI";
3988 case VINSTR_JUMP: return "JUMP";
3989 case VINSTR_COND: return "COND";
3990 case VINSTR_BITXOR: return "BITXOR";
3991 case VINSTR_BITAND_V: return "BITAND_V";
3992 case VINSTR_BITOR_V: return "BITOR_V";
3993 case VINSTR_BITXOR_V: return "BITXOR_V";
3994 case VINSTR_BITAND_VF: return "BITAND_VF";
3995 case VINSTR_BITOR_VF: return "BITOR_VF";
3996 case VINSTR_BITXOR_VF: return "BITXOR_VF";
3997 case VINSTR_CROSS: return "CROSS";
3998 case VINSTR_NEG_F: return "NEG_F";
3999 case VINSTR_NEG_V: return "NEG_V";
4000 default: return "<UNK>";
4004 void ir_builder_dump(ir_builder *b, int (*oprintf)(const char*, ...))
4007 char indent[IND_BUFSZ];
4011 oprintf("module %s\n", b->name);
4012 for (i = 0; i < vec_size(b->globals); ++i)
4015 if (b->globals[i]->hasvalue)
4016 oprintf("%s = ", b->globals[i]->name);
4017 ir_value_dump(b->globals[i], oprintf);
4020 for (i = 0; i < vec_size(b->functions); ++i)
4021 ir_function_dump(b->functions[i], indent, oprintf);
4022 oprintf("endmodule %s\n", b->name);
4025 static const char *storenames[] = {
4026 "[global]", "[local]", "[param]", "[value]", "[return]"
4029 void ir_function_dump(ir_function *f, char *ind,
4030 int (*oprintf)(const char*, ...))
4033 if (f->builtin != 0) {
4034 oprintf("%sfunction %s = builtin %i\n", ind, f->name, -f->builtin);
4037 oprintf("%sfunction %s\n", ind, f->name);
4038 util_strncat(ind, "\t", IND_BUFSZ-1);
4039 if (vec_size(f->locals))
4041 oprintf("%s%i locals:\n", ind, (int)vec_size(f->locals));
4042 for (i = 0; i < vec_size(f->locals); ++i) {
4043 oprintf("%s\t", ind);
4044 ir_value_dump(f->locals[i], oprintf);
4048 oprintf("%sliferanges:\n", ind);
4049 for (i = 0; i < vec_size(f->locals); ++i) {
4050 const char *attr = "";
4052 ir_value *v = f->locals[i];
4053 if (v->unique_life && v->locked)
4054 attr = "unique,locked ";
4055 else if (v->unique_life)
4059 oprintf("%s\t%s: %s %s %s%s@%i ", ind, v->name, type_name[v->vtype],
4060 storenames[v->store],
4061 attr, (v->callparam ? "callparam " : ""),
4062 (int)v->code.local);
4065 for (l = 0; l < vec_size(v->life); ++l) {
4066 oprintf("[%i,%i] ", v->life[l].start, v->life[l].end);
4069 for (m = 0; m < 3; ++m) {
4070 ir_value *vm = v->members[m];
4073 oprintf("%s\t%s: @%i ", ind, vm->name, (int)vm->code.local);
4074 for (l = 0; l < vec_size(vm->life); ++l) {
4075 oprintf("[%i,%i] ", vm->life[l].start, vm->life[l].end);
4080 for (i = 0; i < vec_size(f->values); ++i) {
4081 const char *attr = "";
4083 ir_value *v = f->values[i];
4084 if (v->unique_life && v->locked)
4085 attr = "unique,locked ";
4086 else if (v->unique_life)
4090 oprintf("%s\t%s: %s %s %s%s@%i ", ind, v->name, type_name[v->vtype],
4091 storenames[v->store],
4092 attr, (v->callparam ? "callparam " : ""),
4093 (int)v->code.local);
4096 for (l = 0; l < vec_size(v->life); ++l) {
4097 oprintf("[%i,%i] ", v->life[l].start, v->life[l].end);
4100 for (m = 0; m < 3; ++m) {
4101 ir_value *vm = v->members[m];
4104 if (vm->unique_life && vm->locked)
4105 attr = "unique,locked ";
4106 else if (vm->unique_life)
4108 else if (vm->locked)
4110 oprintf("%s\t%s: %s@%i ", ind, vm->name, attr, (int)vm->code.local);
4111 for (l = 0; l < vec_size(vm->life); ++l) {
4112 oprintf("[%i,%i] ", vm->life[l].start, vm->life[l].end);
4117 if (vec_size(f->blocks))
4119 oprintf("%slife passes: %i\n", ind, (int)f->run_id);
4120 for (i = 0; i < vec_size(f->blocks); ++i) {
4121 ir_block_dump(f->blocks[i], ind, oprintf);
4125 ind[strlen(ind)-1] = 0;
4126 oprintf("%sendfunction %s\n", ind, f->name);
4129 void ir_block_dump(ir_block* b, char *ind,
4130 int (*oprintf)(const char*, ...))
4133 oprintf("%s:%s\n", ind, b->label);
4134 util_strncat(ind, "\t", IND_BUFSZ-1);
4136 if (b->instr && b->instr[0])
4137 oprintf("%s (%i) [entry]\n", ind, (int)(b->instr[0]->eid-1));
4138 for (i = 0; i < vec_size(b->instr); ++i)
4139 ir_instr_dump(b->instr[i], ind, oprintf);
4140 ind[strlen(ind)-1] = 0;
4143 static void dump_phi(ir_instr *in, int (*oprintf)(const char*, ...))
4146 oprintf("%s <- phi ", in->_ops[0]->name);
4147 for (i = 0; i < vec_size(in->phi); ++i)
4149 oprintf("([%s] : %s) ", in->phi[i].from->label,
4150 in->phi[i].value->name);
4155 void ir_instr_dump(ir_instr *in, char *ind,
4156 int (*oprintf)(const char*, ...))
4159 const char *comma = NULL;
4161 oprintf("%s (%i) ", ind, (int)in->eid);
4163 if (in->opcode == VINSTR_PHI) {
4164 dump_phi(in, oprintf);
4168 util_strncat(ind, "\t", IND_BUFSZ-1);
4170 if (in->_ops[0] && (in->_ops[1] || in->_ops[2])) {
4171 ir_value_dump(in->_ops[0], oprintf);
4172 if (in->_ops[1] || in->_ops[2])
4175 if (in->opcode == INSTR_CALL0 || in->opcode == VINSTR_NRCALL) {
4176 oprintf("CALL%i\t", vec_size(in->params));
4178 oprintf("%s\t", qc_opname(in->opcode));
4180 if (in->_ops[0] && !(in->_ops[1] || in->_ops[2])) {
4181 ir_value_dump(in->_ops[0], oprintf);
4186 for (i = 1; i != 3; ++i) {
4190 ir_value_dump(in->_ops[i], oprintf);
4198 oprintf("[%s]", in->bops[0]->label);
4202 oprintf("%s[%s]", comma, in->bops[1]->label);
4203 if (vec_size(in->params)) {
4204 oprintf("\tparams: ");
4205 for (i = 0; i != vec_size(in->params); ++i) {
4206 oprintf("%s, ", in->params[i]->name);
4210 ind[strlen(ind)-1] = 0;
4213 static void ir_value_dump_string(const char *str, int (*oprintf)(const char*, ...))
4216 for (; *str; ++str) {
4218 case '\n': oprintf("\\n"); break;
4219 case '\r': oprintf("\\r"); break;
4220 case '\t': oprintf("\\t"); break;
4221 case '\v': oprintf("\\v"); break;
4222 case '\f': oprintf("\\f"); break;
4223 case '\b': oprintf("\\b"); break;
4224 case '\a': oprintf("\\a"); break;
4225 case '\\': oprintf("\\\\"); break;
4226 case '"': oprintf("\\\""); break;
4227 default: oprintf("%c", *str); break;
4233 void ir_value_dump(ir_value* v, int (*oprintf)(const char*, ...))
4242 oprintf("fn:%s", v->name);
4245 oprintf("%g", v->constval.vfloat);
4248 oprintf("'%g %g %g'",
4251 v->constval.vvec.z);
4254 oprintf("(entity)");
4257 ir_value_dump_string(v->constval.vstring, oprintf);
4261 oprintf("%i", v->constval.vint);
4266 v->constval.vpointer->name);
4270 oprintf("%s", v->name);
4274 void ir_value_dump_life(const ir_value *self, int (*oprintf)(const char*,...))
4277 oprintf("Life of %12s:", self->name);
4278 for (i = 0; i < vec_size(self->life); ++i)
4280 oprintf(" + [%i, %i]\n", self->life[i].start, self->life[i].end);