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 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_BITXOR_VF) );
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:
1831 * after the following default case, the value of opcode can never
1832 * be 1, 2, 3, 4, 5, 6, 7, 8, 9, 62, 63, 64, 65
1836 /* boolean operations result in floats */
1839 * opcode >= 10 takes true branch opcode is at least 10
1840 * opcode <= 23 takes false branch opcode is at least 24
1842 if (opcode >= INSTR_EQ_F && opcode <= INSTR_GT)
1846 * At condition "opcode <= 23", the value of "opcode" must be
1848 * At condition "opcode <= 23", the value of "opcode" cannot be
1849 * equal to any of {1, 2, 3, 4, 5, 6, 7, 8, 9, 62, 63, 64, 65}.
1850 * The condition "opcode <= 23" cannot be true.
1852 * Thus ot=2 (TYPE_FLOAT) can never be true
1855 else if (opcode >= INSTR_LE && opcode <= INSTR_GT)
1857 else if (opcode >= INSTR_LE_I && opcode <= INSTR_EQ_FI)
1862 if (ot == TYPE_VOID) {
1863 /* The AST or parser were supposed to check this! */
1867 return ir_block_create_general_instr(self, ctx, label, opcode, left, right, ot);
1870 ir_value* ir_block_create_unary(ir_block *self, lex_ctx_t ctx,
1871 const char *label, int opcode,
1874 int ot = TYPE_FLOAT;
1886 /* QC doesn't have other unary operations. We expect extensions to fill
1887 * the above list, otherwise we assume out-type = in-type, eg for an
1891 ot = operand->vtype;
1894 if (ot == TYPE_VOID) {
1895 /* The AST or parser were supposed to check this! */
1899 /* let's use the general instruction creator and pass NULL for OPB */
1900 return ir_block_create_general_instr(self, ctx, label, opcode, operand, NULL, ot);
1903 static ir_value* ir_block_create_general_instr(ir_block *self, lex_ctx_t ctx, const char *label,
1904 int op, ir_value *a, ir_value *b, int outype)
1909 out = ir_value_out(self->owner, label, store_value, outype);
1913 instr = ir_instr_new(ctx, self, op);
1915 ir_value_delete(out);
1919 if (!ir_instr_op(instr, 0, out, true) ||
1920 !ir_instr_op(instr, 1, a, false) ||
1921 !ir_instr_op(instr, 2, b, false) )
1926 vec_push(self->instr, instr);
1930 ir_instr_delete(instr);
1931 ir_value_delete(out);
1935 ir_value* ir_block_create_fieldaddress(ir_block *self, lex_ctx_t ctx, const char *label, ir_value *ent, ir_value *field)
1939 /* Support for various pointer types todo if so desired */
1940 if (ent->vtype != TYPE_ENTITY)
1943 if (field->vtype != TYPE_FIELD)
1946 v = ir_block_create_general_instr(self, ctx, label, INSTR_ADDRESS, ent, field, TYPE_POINTER);
1947 v->fieldtype = field->fieldtype;
1951 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)
1954 if (ent->vtype != TYPE_ENTITY)
1957 /* at some point we could redirect for TYPE_POINTER... but that could lead to carelessness */
1958 if (field->vtype != TYPE_FIELD)
1963 case TYPE_FLOAT: op = INSTR_LOAD_F; break;
1964 case TYPE_VECTOR: op = INSTR_LOAD_V; break;
1965 case TYPE_STRING: op = INSTR_LOAD_S; break;
1966 case TYPE_FIELD: op = INSTR_LOAD_FLD; break;
1967 case TYPE_ENTITY: op = INSTR_LOAD_ENT; break;
1968 case TYPE_FUNCTION: op = INSTR_LOAD_FNC; break;
1970 case TYPE_POINTER: op = INSTR_LOAD_I; break;
1971 case TYPE_INTEGER: op = INSTR_LOAD_I; break;
1974 irerror(self->context, "invalid type for ir_block_create_load_from_ent: %s", type_name[outype]);
1978 return ir_block_create_general_instr(self, ctx, label, op, ent, field, outype);
1981 /* PHI resolving breaks the SSA, and must thus be the last
1982 * step before life-range calculation.
1985 static bool ir_block_naive_phi(ir_block *self);
1986 bool ir_function_naive_phi(ir_function *self)
1990 for (i = 0; i < vec_size(self->blocks); ++i)
1992 if (!ir_block_naive_phi(self->blocks[i]))
1998 static bool ir_block_naive_phi(ir_block *self)
2000 size_t i, p; /*, w;*/
2001 /* FIXME: optionally, create_phi can add the phis
2002 * to a list so we don't need to loop through blocks
2003 * - anyway: "don't optimize YET"
2005 for (i = 0; i < vec_size(self->instr); ++i)
2007 ir_instr *instr = self->instr[i];
2008 if (instr->opcode != VINSTR_PHI)
2011 vec_remove(self->instr, i, 1);
2012 --i; /* NOTE: i+1 below */
2014 for (p = 0; p < vec_size(instr->phi); ++p)
2016 ir_value *v = instr->phi[p].value;
2017 ir_block *b = instr->phi[p].from;
2019 if (v->store == store_value &&
2020 vec_size(v->reads) == 1 &&
2021 vec_size(v->writes) == 1)
2023 /* replace the value */
2024 if (!ir_instr_op(v->writes[0], 0, instr->_ops[0], true))
2029 /* force a move instruction */
2030 ir_instr *prevjump = vec_last(b->instr);
2033 instr->_ops[0]->store = store_global;
2034 if (!ir_block_create_store(b, instr->context, instr->_ops[0], v))
2036 instr->_ops[0]->store = store_value;
2037 vec_push(b->instr, prevjump);
2041 ir_instr_delete(instr);
2046 /***********************************************************************
2047 *IR Temp allocation code
2048 * Propagating value life ranges by walking through the function backwards
2049 * until no more changes are made.
2050 * In theory this should happen once more than once for every nested loop
2052 * Though this implementation might run an additional time for if nests.
2055 /* Enumerate instructions used by value's life-ranges
2057 static void ir_block_enumerate(ir_block *self, size_t *_eid)
2061 for (i = 0; i < vec_size(self->instr); ++i)
2063 self->instr[i]->eid = eid++;
2068 /* Enumerate blocks and instructions.
2069 * The block-enumeration is unordered!
2070 * We do not really use the block enumreation, however
2071 * the instruction enumeration is important for life-ranges.
2073 void ir_function_enumerate(ir_function *self)
2076 size_t instruction_id = 0;
2077 for (i = 0; i < vec_size(self->blocks); ++i)
2079 /* each block now gets an additional "entry" instruction id
2080 * we can use to avoid point-life issues
2082 self->blocks[i]->entry_id = instruction_id;
2085 self->blocks[i]->eid = i;
2086 ir_block_enumerate(self->blocks[i], &instruction_id);
2090 /* Local-value allocator
2091 * After finishing creating the liferange of all values used in a function
2092 * we can allocate their global-positions.
2093 * This is the counterpart to register-allocation in register machines.
2100 } function_allocator;
2102 static bool function_allocator_alloc(function_allocator *alloc, ir_value *var)
2105 size_t vsize = ir_value_sizeof(var);
2107 var->code.local = vec_size(alloc->locals);
2109 slot = ir_value_var("reg", store_global, var->vtype);
2113 if (!ir_value_life_merge_into(slot, var))
2116 vec_push(alloc->locals, slot);
2117 vec_push(alloc->sizes, vsize);
2118 vec_push(alloc->unique, var->unique_life);
2123 ir_value_delete(slot);
2127 static bool ir_function_allocator_assign(ir_function *self, function_allocator *alloc, ir_value *v)
2133 return function_allocator_alloc(alloc, v);
2135 for (a = 0; a < vec_size(alloc->locals); ++a)
2137 /* if it's reserved for a unique liferange: skip */
2138 if (alloc->unique[a])
2141 slot = alloc->locals[a];
2143 /* never resize parameters
2144 * will be required later when overlapping temps + locals
2146 if (a < vec_size(self->params) &&
2147 alloc->sizes[a] < ir_value_sizeof(v))
2152 if (ir_values_overlap(v, slot))
2155 if (!ir_value_life_merge_into(slot, v))
2158 /* adjust size for this slot */
2159 if (alloc->sizes[a] < ir_value_sizeof(v))
2160 alloc->sizes[a] = ir_value_sizeof(v);
2165 if (a >= vec_size(alloc->locals)) {
2166 if (!function_allocator_alloc(alloc, v))
2172 bool ir_function_allocate_locals(ir_function *self)
2177 bool opt_gt = OPTS_OPTIMIZATION(OPTIM_GLOBAL_TEMPS);
2181 function_allocator lockalloc, globalloc;
2183 if (!vec_size(self->locals) && !vec_size(self->values))
2186 globalloc.locals = NULL;
2187 globalloc.sizes = NULL;
2188 globalloc.positions = NULL;
2189 globalloc.unique = NULL;
2190 lockalloc.locals = NULL;
2191 lockalloc.sizes = NULL;
2192 lockalloc.positions = NULL;
2193 lockalloc.unique = NULL;
2195 for (i = 0; i < vec_size(self->locals); ++i)
2197 v = self->locals[i];
2198 if ((self->flags & IR_FLAG_MASK_NO_LOCAL_TEMPS) || !OPTS_OPTIMIZATION(OPTIM_LOCAL_TEMPS)) {
2200 v->unique_life = true;
2202 else if (i >= vec_size(self->params))
2205 v->locked = true; /* lock parameters locals */
2206 if (!function_allocator_alloc((v->locked || !opt_gt ? &lockalloc : &globalloc), v))
2209 for (; i < vec_size(self->locals); ++i)
2211 v = self->locals[i];
2212 if (!vec_size(v->life))
2214 if (!ir_function_allocator_assign(self, (v->locked || !opt_gt ? &lockalloc : &globalloc), v))
2218 /* Allocate a slot for any value that still exists */
2219 for (i = 0; i < vec_size(self->values); ++i)
2221 v = self->values[i];
2223 if (!vec_size(v->life))
2226 /* CALL optimization:
2227 * If the value is a parameter-temp: 1 write, 1 read from a CALL
2228 * and it's not "locked", write it to the OFS_PARM directly.
2230 if (OPTS_OPTIMIZATION(OPTIM_CALL_STORES) && !v->locked && !v->unique_life) {
2231 if (vec_size(v->reads) == 1 && vec_size(v->writes) == 1 &&
2232 (v->reads[0]->opcode == VINSTR_NRCALL ||
2233 (v->reads[0]->opcode >= INSTR_CALL0 && v->reads[0]->opcode <= INSTR_CALL8)
2238 ir_instr *call = v->reads[0];
2239 if (!vec_ir_value_find(call->params, v, ¶m)) {
2240 irerror(call->context, "internal error: unlocked parameter %s not found", v->name);
2243 ++opts_optimizationcount[OPTIM_CALL_STORES];
2244 v->callparam = true;
2246 ir_value_code_setaddr(v, OFS_PARM0 + 3*param);
2248 size_t nprotos = vec_size(self->owner->extparam_protos);
2251 if (nprotos > param)
2252 ep = self->owner->extparam_protos[param];
2255 ep = ir_gen_extparam_proto(self->owner);
2256 while (++nprotos <= param)
2257 ep = ir_gen_extparam_proto(self->owner);
2259 ir_instr_op(v->writes[0], 0, ep, true);
2260 call->params[param+8] = ep;
2264 if (vec_size(v->writes) == 1 && v->writes[0]->opcode == INSTR_CALL0)
2266 v->store = store_return;
2267 if (v->members[0]) v->members[0]->store = store_return;
2268 if (v->members[1]) v->members[1]->store = store_return;
2269 if (v->members[2]) v->members[2]->store = store_return;
2270 ++opts_optimizationcount[OPTIM_CALL_STORES];
2275 if (!ir_function_allocator_assign(self, (v->locked || !opt_gt ? &lockalloc : &globalloc), v))
2279 if (!lockalloc.sizes && !globalloc.sizes) {
2282 vec_push(lockalloc.positions, 0);
2283 vec_push(globalloc.positions, 0);
2285 /* Adjust slot positions based on sizes */
2286 if (lockalloc.sizes) {
2287 pos = (vec_size(lockalloc.sizes) ? lockalloc.positions[0] : 0);
2288 for (i = 1; i < vec_size(lockalloc.sizes); ++i)
2290 pos = lockalloc.positions[i-1] + lockalloc.sizes[i-1];
2291 vec_push(lockalloc.positions, pos);
2293 self->allocated_locals = pos + vec_last(lockalloc.sizes);
2295 if (globalloc.sizes) {
2296 pos = (vec_size(globalloc.sizes) ? globalloc.positions[0] : 0);
2297 for (i = 1; i < vec_size(globalloc.sizes); ++i)
2299 pos = globalloc.positions[i-1] + globalloc.sizes[i-1];
2300 vec_push(globalloc.positions, pos);
2302 self->globaltemps = pos + vec_last(globalloc.sizes);
2305 /* Locals need to know their new position */
2306 for (i = 0; i < vec_size(self->locals); ++i) {
2307 v = self->locals[i];
2308 if (v->locked || !opt_gt)
2309 v->code.local = lockalloc.positions[v->code.local];
2311 v->code.local = globalloc.positions[v->code.local];
2313 /* Take over the actual slot positions on values */
2314 for (i = 0; i < vec_size(self->values); ++i) {
2315 v = self->values[i];
2316 if (v->locked || !opt_gt)
2317 v->code.local = lockalloc.positions[v->code.local];
2319 v->code.local = globalloc.positions[v->code.local];
2327 for (i = 0; i < vec_size(lockalloc.locals); ++i)
2328 ir_value_delete(lockalloc.locals[i]);
2329 for (i = 0; i < vec_size(globalloc.locals); ++i)
2330 ir_value_delete(globalloc.locals[i]);
2331 vec_free(globalloc.unique);
2332 vec_free(globalloc.locals);
2333 vec_free(globalloc.sizes);
2334 vec_free(globalloc.positions);
2335 vec_free(lockalloc.unique);
2336 vec_free(lockalloc.locals);
2337 vec_free(lockalloc.sizes);
2338 vec_free(lockalloc.positions);
2342 /* Get information about which operand
2343 * is read from, or written to.
2345 static void ir_op_read_write(int op, size_t *read, size_t *write)
2365 case INSTR_STOREP_F:
2366 case INSTR_STOREP_V:
2367 case INSTR_STOREP_S:
2368 case INSTR_STOREP_ENT:
2369 case INSTR_STOREP_FLD:
2370 case INSTR_STOREP_FNC:
2381 static bool ir_block_living_add_instr(ir_block *self, size_t eid)
2384 const size_t vs = vec_size(self->living);
2385 bool changed = false;
2386 for (i = 0; i != vs; ++i)
2388 if (ir_value_life_merge(self->living[i], eid))
2394 static bool ir_block_living_lock(ir_block *self)
2397 bool changed = false;
2398 for (i = 0; i != vec_size(self->living); ++i)
2400 if (!self->living[i]->locked) {
2401 self->living[i]->locked = true;
2408 static bool ir_block_life_propagate(ir_block *self, bool *changed)
2412 size_t i, o, p, mem, cnt;
2413 /* bitmasks which operands are read from or written to */
2420 vec_free(self->living);
2422 p = vec_size(self->exits);
2423 for (i = 0; i < p; ++i) {
2424 ir_block *prev = self->exits[i];
2425 cnt = vec_size(prev->living);
2426 for (o = 0; o < cnt; ++o) {
2427 if (!vec_ir_value_find(self->living, prev->living[o], NULL))
2428 vec_push(self->living, prev->living[o]);
2432 i = vec_size(self->instr);
2435 instr = self->instr[i];
2437 /* See which operands are read and write operands */
2438 ir_op_read_write(instr->opcode, &read, &write);
2440 /* Go through the 3 main operands
2441 * writes first, then reads
2443 for (o = 0; o < 3; ++o)
2445 if (!instr->_ops[o]) /* no such operand */
2448 value = instr->_ops[o];
2450 /* We only care about locals */
2451 /* we also calculate parameter liferanges so that locals
2452 * can take up parameter slots */
2453 if (value->store != store_value &&
2454 value->store != store_local &&
2455 value->store != store_param)
2458 /* write operands */
2459 /* When we write to a local, we consider it "dead" for the
2460 * remaining upper part of the function, since in SSA a value
2461 * can only be written once (== created)
2466 bool in_living = vec_ir_value_find(self->living, value, &idx);
2469 /* If the value isn't alive it hasn't been read before... */
2470 /* TODO: See if the warning can be emitted during parsing or AST processing
2471 * otherwise have warning printed here.
2472 * IF printing a warning here: include filecontext_t,
2473 * and make sure it's only printed once
2474 * since this function is run multiple times.
2476 /* con_err( "Value only written %s\n", value->name); */
2477 if (ir_value_life_merge(value, instr->eid))
2480 /* since 'living' won't contain it
2481 * anymore, merge the value, since
2484 if (ir_value_life_merge(value, instr->eid))
2487 vec_remove(self->living, idx, 1);
2489 /* Removing a vector removes all members */
2490 for (mem = 0; mem < 3; ++mem) {
2491 if (value->members[mem] && vec_ir_value_find(self->living, value->members[mem], &idx)) {
2492 if (ir_value_life_merge(value->members[mem], instr->eid))
2494 vec_remove(self->living, idx, 1);
2497 /* Removing the last member removes the vector */
2498 if (value->memberof) {
2499 value = value->memberof;
2500 for (mem = 0; mem < 3; ++mem) {
2501 if (value->members[mem] && vec_ir_value_find(self->living, value->members[mem], NULL))
2504 if (mem == 3 && vec_ir_value_find(self->living, value, &idx)) {
2505 if (ir_value_life_merge(value, instr->eid))
2507 vec_remove(self->living, idx, 1);
2513 /* These operations need a special case as they can break when using
2514 * same source and destination operand otherwise, as the engine may
2515 * read the source multiple times. */
2516 if (instr->opcode == INSTR_MUL_VF ||
2517 instr->opcode == VINSTR_BITAND_VF ||
2518 instr->opcode == VINSTR_BITOR_VF ||
2519 instr->opcode == VINSTR_BITXOR ||
2520 instr->opcode == VINSTR_BITXOR_VF ||
2521 instr->opcode == VINSTR_BITXOR_V)
2523 value = instr->_ops[2];
2524 /* the float source will get an additional lifetime */
2525 if (ir_value_life_merge(value, instr->eid+1))
2527 if (value->memberof && ir_value_life_merge(value->memberof, instr->eid+1))
2531 if (instr->opcode == INSTR_MUL_FV ||
2532 instr->opcode == INSTR_LOAD_V ||
2533 instr->opcode == VINSTR_BITXOR ||
2534 instr->opcode == VINSTR_BITXOR_VF ||
2535 instr->opcode == VINSTR_BITXOR_V)
2537 value = instr->_ops[1];
2538 /* the float source will get an additional lifetime */
2539 if (ir_value_life_merge(value, instr->eid+1))
2541 if (value->memberof && ir_value_life_merge(value->memberof, instr->eid+1))
2545 for (o = 0; o < 3; ++o)
2547 if (!instr->_ops[o]) /* no such operand */
2550 value = instr->_ops[o];
2552 /* We only care about locals */
2553 /* we also calculate parameter liferanges so that locals
2554 * can take up parameter slots */
2555 if (value->store != store_value &&
2556 value->store != store_local &&
2557 value->store != store_param)
2563 if (!vec_ir_value_find(self->living, value, NULL))
2564 vec_push(self->living, value);
2565 /* reading adds the full vector */
2566 if (value->memberof && !vec_ir_value_find(self->living, value->memberof, NULL))
2567 vec_push(self->living, value->memberof);
2568 for (mem = 0; mem < 3; ++mem) {
2569 if (value->members[mem] && !vec_ir_value_find(self->living, value->members[mem], NULL))
2570 vec_push(self->living, value->members[mem]);
2574 /* PHI operands are always read operands */
2575 for (p = 0; p < vec_size(instr->phi); ++p)
2577 value = instr->phi[p].value;
2578 if (!vec_ir_value_find(self->living, value, NULL))
2579 vec_push(self->living, value);
2580 /* reading adds the full vector */
2581 if (value->memberof && !vec_ir_value_find(self->living, value->memberof, NULL))
2582 vec_push(self->living, value->memberof);
2583 for (mem = 0; mem < 3; ++mem) {
2584 if (value->members[mem] && !vec_ir_value_find(self->living, value->members[mem], NULL))
2585 vec_push(self->living, value->members[mem]);
2589 /* on a call, all these values must be "locked" */
2590 if (instr->opcode >= INSTR_CALL0 && instr->opcode <= INSTR_CALL8) {
2591 if (ir_block_living_lock(self))
2594 /* call params are read operands too */
2595 for (p = 0; p < vec_size(instr->params); ++p)
2597 value = instr->params[p];
2598 if (!vec_ir_value_find(self->living, value, NULL))
2599 vec_push(self->living, value);
2600 /* reading adds the full vector */
2601 if (value->memberof && !vec_ir_value_find(self->living, value->memberof, NULL))
2602 vec_push(self->living, value->memberof);
2603 for (mem = 0; mem < 3; ++mem) {
2604 if (value->members[mem] && !vec_ir_value_find(self->living, value->members[mem], NULL))
2605 vec_push(self->living, value->members[mem]);
2610 if (ir_block_living_add_instr(self, instr->eid))
2613 /* the "entry" instruction ID */
2614 if (ir_block_living_add_instr(self, self->entry_id))
2620 bool ir_function_calculate_liferanges(ir_function *self)
2625 /* parameters live at 0 */
2626 for (i = 0; i < vec_size(self->params); ++i)
2627 if (!ir_value_life_merge(self->locals[i], 0))
2628 compile_error(self->context, "internal error: failed value-life merging");
2633 i = vec_size(self->blocks);
2635 ir_block_life_propagate(self->blocks[i], &changed);
2639 if (vec_size(self->blocks)) {
2640 ir_block *block = self->blocks[0];
2641 for (i = 0; i < vec_size(block->living); ++i) {
2642 ir_value *v = block->living[i];
2643 if (v->store != store_local)
2645 if (v->vtype == TYPE_VECTOR)
2647 self->flags |= IR_FLAG_HAS_UNINITIALIZED;
2648 /* find the instruction reading from it */
2649 for (s = 0; s < vec_size(v->reads); ++s) {
2650 if (v->reads[s]->eid == v->life[0].end)
2653 if (s < vec_size(v->reads)) {
2654 if (irwarning(v->context, WARN_USED_UNINITIALIZED,
2655 "variable `%s` may be used uninitialized in this function\n"
2658 v->reads[s]->context.file, v->reads[s]->context.line)
2666 ir_value *vec = v->memberof;
2667 for (s = 0; s < vec_size(vec->reads); ++s) {
2668 if (vec->reads[s]->eid == v->life[0].end)
2671 if (s < vec_size(vec->reads)) {
2672 if (irwarning(v->context, WARN_USED_UNINITIALIZED,
2673 "variable `%s` may be used uninitialized in this function\n"
2676 vec->reads[s]->context.file, vec->reads[s]->context.line)
2684 if (irwarning(v->context, WARN_USED_UNINITIALIZED,
2685 "variable `%s` may be used uninitialized in this function", v->name))
2694 /***********************************************************************
2697 * Since the IR has the convention of putting 'write' operands
2698 * at the beginning, we have to rotate the operands of instructions
2699 * properly in order to generate valid QCVM code.
2701 * Having destinations at a fixed position is more convenient. In QC
2702 * this is *mostly* OPC, but FTE adds at least 2 instructions which
2703 * read from from OPA, and store to OPB rather than OPC. Which is
2704 * partially the reason why the implementation of these instructions
2705 * in darkplaces has been delayed for so long.
2707 * Breaking conventions is annoying...
2709 static bool ir_builder_gen_global(ir_builder *self, ir_value *global, bool islocal);
2711 static bool gen_global_field(code_t *code, ir_value *global)
2713 if (global->hasvalue)
2715 ir_value *fld = global->constval.vpointer;
2717 irerror(global->context, "Invalid field constant with no field: %s", global->name);
2721 /* copy the field's value */
2722 ir_value_code_setaddr(global, vec_size(code->globals));
2723 vec_push(code->globals, fld->code.fieldaddr);
2724 if (global->fieldtype == TYPE_VECTOR) {
2725 vec_push(code->globals, fld->code.fieldaddr+1);
2726 vec_push(code->globals, fld->code.fieldaddr+2);
2731 ir_value_code_setaddr(global, vec_size(code->globals));
2732 vec_push(code->globals, 0);
2733 if (global->fieldtype == TYPE_VECTOR) {
2734 vec_push(code->globals, 0);
2735 vec_push(code->globals, 0);
2738 if (global->code.globaladdr < 0)
2743 static bool gen_global_pointer(code_t *code, ir_value *global)
2745 if (global->hasvalue)
2747 ir_value *target = global->constval.vpointer;
2749 irerror(global->context, "Invalid pointer constant: %s", global->name);
2750 /* NULL pointers are pointing to the NULL constant, which also
2751 * sits at address 0, but still has an ir_value for itself.
2756 /* Here, relocations ARE possible - in fteqcc-enhanced-qc:
2757 * void() foo; <- proto
2758 * void() *fooptr = &foo;
2759 * void() foo = { code }
2761 if (!target->code.globaladdr) {
2762 /* FIXME: Check for the constant nullptr ir_value!
2763 * because then code.globaladdr being 0 is valid.
2765 irerror(global->context, "FIXME: Relocation support");
2769 ir_value_code_setaddr(global, vec_size(code->globals));
2770 vec_push(code->globals, target->code.globaladdr);
2774 ir_value_code_setaddr(global, vec_size(code->globals));
2775 vec_push(code->globals, 0);
2777 if (global->code.globaladdr < 0)
2782 static bool gen_blocks_recursive(code_t *code, ir_function *func, ir_block *block)
2784 prog_section_statement_t stmt;
2793 block->generated = true;
2794 block->code_start = vec_size(code->statements);
2795 for (i = 0; i < vec_size(block->instr); ++i)
2797 instr = block->instr[i];
2799 if (instr->opcode == VINSTR_PHI) {
2800 irerror(block->context, "cannot generate virtual instruction (phi)");
2804 if (instr->opcode == VINSTR_JUMP) {
2805 target = instr->bops[0];
2806 /* for uncoditional jumps, if the target hasn't been generated
2807 * yet, we generate them right here.
2809 if (!target->generated)
2810 return gen_blocks_recursive(code, func, target);
2812 /* otherwise we generate a jump instruction */
2813 stmt.opcode = INSTR_GOTO;
2814 stmt.o1.s1 = (target->code_start) - vec_size(code->statements);
2817 if (stmt.o1.s1 != 1)
2818 code_push_statement(code, &stmt, instr->context);
2820 /* no further instructions can be in this block */
2824 if (instr->opcode == VINSTR_BITXOR) {
2825 stmt.opcode = INSTR_BITOR;
2826 stmt.o1.s1 = ir_value_code_addr(instr->_ops[1]);
2827 stmt.o2.s1 = ir_value_code_addr(instr->_ops[2]);
2828 stmt.o3.s1 = ir_value_code_addr(instr->_ops[0]);
2829 code_push_statement(code, &stmt, instr->context);
2830 stmt.opcode = INSTR_BITAND;
2831 stmt.o1.s1 = ir_value_code_addr(instr->_ops[1]);
2832 stmt.o2.s1 = ir_value_code_addr(instr->_ops[2]);
2833 stmt.o3.s1 = ir_value_code_addr(func->owner->vinstr_temp[0]);
2834 code_push_statement(code, &stmt, instr->context);
2835 stmt.opcode = INSTR_SUB_F;
2836 stmt.o1.s1 = ir_value_code_addr(instr->_ops[0]);
2837 stmt.o2.s1 = ir_value_code_addr(func->owner->vinstr_temp[0]);
2838 stmt.o3.s1 = ir_value_code_addr(instr->_ops[0]);
2839 code_push_statement(code, &stmt, instr->context);
2841 /* instruction generated */
2845 if (instr->opcode == VINSTR_BITAND_V) {
2846 stmt.opcode = INSTR_BITAND;
2847 stmt.o1.s1 = ir_value_code_addr(instr->_ops[1]);
2848 stmt.o2.s1 = ir_value_code_addr(instr->_ops[2]);
2849 stmt.o3.s1 = ir_value_code_addr(instr->_ops[0]);
2850 code_push_statement(code, &stmt, instr->context);
2854 code_push_statement(code, &stmt, instr->context);
2858 code_push_statement(code, &stmt, instr->context);
2860 /* instruction generated */
2864 if (instr->opcode == VINSTR_BITOR_V) {
2865 stmt.opcode = INSTR_BITOR;
2866 stmt.o1.s1 = ir_value_code_addr(instr->_ops[1]);
2867 stmt.o2.s1 = ir_value_code_addr(instr->_ops[2]);
2868 stmt.o3.s1 = ir_value_code_addr(instr->_ops[0]);
2869 code_push_statement(code, &stmt, instr->context);
2873 code_push_statement(code, &stmt, instr->context);
2877 code_push_statement(code, &stmt, instr->context);
2879 /* instruction generated */
2883 if (instr->opcode == VINSTR_BITXOR_V) {
2884 for (j = 0; j < 3; ++j) {
2885 stmt.opcode = INSTR_BITOR;
2886 stmt.o1.s1 = ir_value_code_addr(instr->_ops[1]) + j;
2887 stmt.o2.s1 = ir_value_code_addr(instr->_ops[2]) + j;
2888 stmt.o3.s1 = ir_value_code_addr(instr->_ops[0]) + j;
2889 code_push_statement(code, &stmt, instr->context);
2890 stmt.opcode = INSTR_BITAND;
2891 stmt.o1.s1 = ir_value_code_addr(instr->_ops[1]) + j;
2892 stmt.o2.s1 = ir_value_code_addr(instr->_ops[2]) + j;
2893 stmt.o3.s1 = ir_value_code_addr(func->owner->vinstr_temp[0]) + j;
2894 code_push_statement(code, &stmt, instr->context);
2896 stmt.opcode = INSTR_SUB_V;
2897 stmt.o1.s1 = ir_value_code_addr(instr->_ops[0]);
2898 stmt.o2.s1 = ir_value_code_addr(func->owner->vinstr_temp[0]);
2899 stmt.o3.s1 = ir_value_code_addr(instr->_ops[0]);
2900 code_push_statement(code, &stmt, instr->context);
2902 /* instruction generated */
2906 if (instr->opcode == VINSTR_BITAND_VF) {
2907 stmt.opcode = INSTR_BITAND;
2908 stmt.o1.s1 = ir_value_code_addr(instr->_ops[1]);
2909 stmt.o2.s1 = ir_value_code_addr(instr->_ops[2]);
2910 stmt.o3.s1 = ir_value_code_addr(instr->_ops[0]);
2911 code_push_statement(code, &stmt, instr->context);
2914 code_push_statement(code, &stmt, instr->context);
2917 code_push_statement(code, &stmt, instr->context);
2919 /* instruction generated */
2923 if (instr->opcode == VINSTR_BITOR_VF) {
2924 stmt.opcode = INSTR_BITOR;
2925 stmt.o1.s1 = ir_value_code_addr(instr->_ops[1]);
2926 stmt.o2.s1 = ir_value_code_addr(instr->_ops[2]);
2927 stmt.o3.s1 = ir_value_code_addr(instr->_ops[0]);
2928 code_push_statement(code, &stmt, instr->context);
2931 code_push_statement(code, &stmt, instr->context);
2934 code_push_statement(code, &stmt, instr->context);
2936 /* instruction generated */
2940 if (instr->opcode == VINSTR_BITXOR_VF) {
2941 for (j = 0; j < 3; ++j) {
2942 stmt.opcode = INSTR_BITOR;
2943 stmt.o1.s1 = ir_value_code_addr(instr->_ops[1]) + j;
2944 stmt.o2.s1 = ir_value_code_addr(instr->_ops[2]);
2945 stmt.o3.s1 = ir_value_code_addr(instr->_ops[0]) + j;
2946 code_push_statement(code, &stmt, instr->context);
2947 stmt.opcode = INSTR_BITAND;
2948 stmt.o1.s1 = ir_value_code_addr(instr->_ops[1]) + j;
2949 stmt.o2.s1 = ir_value_code_addr(instr->_ops[2]);
2950 stmt.o3.s1 = ir_value_code_addr(func->owner->vinstr_temp[0]) + j;
2951 code_push_statement(code, &stmt, instr->context);
2953 stmt.opcode = INSTR_SUB_V;
2954 stmt.o1.s1 = ir_value_code_addr(instr->_ops[0]);
2955 stmt.o2.s1 = ir_value_code_addr(func->owner->vinstr_temp[0]);
2956 stmt.o3.s1 = ir_value_code_addr(instr->_ops[0]);
2957 code_push_statement(code, &stmt, instr->context);
2959 /* instruction generated */
2963 if (instr->opcode == VINSTR_COND) {
2964 ontrue = instr->bops[0];
2965 onfalse = instr->bops[1];
2966 /* TODO: have the AST signal which block should
2967 * come first: eg. optimize IFs without ELSE...
2970 stmt.o1.u1 = ir_value_code_addr(instr->_ops[0]);
2974 if (ontrue->generated) {
2975 stmt.opcode = INSTR_IF;
2976 stmt.o2.s1 = (ontrue->code_start) - vec_size(code->statements);
2977 if (stmt.o2.s1 != 1)
2978 code_push_statement(code, &stmt, instr->context);
2980 if (onfalse->generated) {
2981 stmt.opcode = INSTR_IFNOT;
2982 stmt.o2.s1 = (onfalse->code_start) - vec_size(code->statements);
2983 if (stmt.o2.s1 != 1)
2984 code_push_statement(code, &stmt, instr->context);
2986 if (!ontrue->generated) {
2987 if (onfalse->generated)
2988 return gen_blocks_recursive(code, func, ontrue);
2990 if (!onfalse->generated) {
2991 if (ontrue->generated)
2992 return gen_blocks_recursive(code, func, onfalse);
2994 /* neither ontrue nor onfalse exist */
2995 stmt.opcode = INSTR_IFNOT;
2996 if (!instr->likely) {
2997 /* Honor the likelyhood hint */
2998 ir_block *tmp = onfalse;
2999 stmt.opcode = INSTR_IF;
3003 stidx = vec_size(code->statements);
3004 code_push_statement(code, &stmt, instr->context);
3005 /* on false we jump, so add ontrue-path */
3006 if (!gen_blocks_recursive(code, func, ontrue))
3008 /* fixup the jump address */
3009 code->statements[stidx].o2.s1 = vec_size(code->statements) - stidx;
3010 /* generate onfalse path */
3011 if (onfalse->generated) {
3012 /* fixup the jump address */
3013 code->statements[stidx].o2.s1 = (onfalse->code_start) - (stidx);
3014 if (stidx+2 == vec_size(code->statements) && code->statements[stidx].o2.s1 == 1) {
3015 code->statements[stidx] = code->statements[stidx+1];
3016 if (code->statements[stidx].o1.s1 < 0)
3017 code->statements[stidx].o1.s1++;
3018 code_pop_statement(code);
3020 stmt.opcode = vec_last(code->statements).opcode;
3021 if (stmt.opcode == INSTR_GOTO ||
3022 stmt.opcode == INSTR_IF ||
3023 stmt.opcode == INSTR_IFNOT ||
3024 stmt.opcode == INSTR_RETURN ||
3025 stmt.opcode == INSTR_DONE)
3027 /* no use jumping from here */
3030 /* may have been generated in the previous recursive call */
3031 stmt.opcode = INSTR_GOTO;
3032 stmt.o1.s1 = (onfalse->code_start) - vec_size(code->statements);
3035 if (stmt.o1.s1 != 1)
3036 code_push_statement(code, &stmt, instr->context);
3039 else if (stidx+2 == vec_size(code->statements) && code->statements[stidx].o2.s1 == 1) {
3040 code->statements[stidx] = code->statements[stidx+1];
3041 if (code->statements[stidx].o1.s1 < 0)
3042 code->statements[stidx].o1.s1++;
3043 code_pop_statement(code);
3045 /* if not, generate now */
3046 return gen_blocks_recursive(code, func, onfalse);
3049 if ( (instr->opcode >= INSTR_CALL0 && instr->opcode <= INSTR_CALL8)
3050 || instr->opcode == VINSTR_NRCALL)
3055 first = vec_size(instr->params);
3058 for (p = 0; p < first; ++p)
3060 ir_value *param = instr->params[p];
3061 if (param->callparam)
3064 stmt.opcode = INSTR_STORE_F;
3067 if (param->vtype == TYPE_FIELD)
3068 stmt.opcode = field_store_instr[param->fieldtype];
3069 else if (param->vtype == TYPE_NIL)
3070 stmt.opcode = INSTR_STORE_V;
3072 stmt.opcode = type_store_instr[param->vtype];
3073 stmt.o1.u1 = ir_value_code_addr(param);
3074 stmt.o2.u1 = OFS_PARM0 + 3 * p;
3075 code_push_statement(code, &stmt, instr->context);
3077 /* Now handle extparams */
3078 first = vec_size(instr->params);
3079 for (; p < first; ++p)
3081 ir_builder *ir = func->owner;
3082 ir_value *param = instr->params[p];
3083 ir_value *targetparam;
3085 if (param->callparam)
3088 if (p-8 >= vec_size(ir->extparams))
3089 ir_gen_extparam(ir);
3091 targetparam = ir->extparams[p-8];
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 = ir_value_code_addr(targetparam);
3104 code_push_statement(code, &stmt, instr->context);
3107 stmt.opcode = INSTR_CALL0 + vec_size(instr->params);
3108 if (stmt.opcode > INSTR_CALL8)
3109 stmt.opcode = INSTR_CALL8;
3110 stmt.o1.u1 = ir_value_code_addr(instr->_ops[1]);
3113 code_push_statement(code, &stmt, instr->context);
3115 retvalue = instr->_ops[0];
3116 if (retvalue && retvalue->store != store_return &&
3117 (retvalue->store == store_global || vec_size(retvalue->life)))
3119 /* not to be kept in OFS_RETURN */
3120 if (retvalue->vtype == TYPE_FIELD && OPTS_FLAG(ADJUST_VECTOR_FIELDS))
3121 stmt.opcode = field_store_instr[retvalue->fieldtype];
3123 stmt.opcode = type_store_instr[retvalue->vtype];
3124 stmt.o1.u1 = OFS_RETURN;
3125 stmt.o2.u1 = ir_value_code_addr(retvalue);
3127 code_push_statement(code, &stmt, instr->context);
3132 if (instr->opcode == INSTR_STATE) {
3133 irerror(block->context, "TODO: state instruction");
3137 stmt.opcode = instr->opcode;
3142 /* This is the general order of operands */
3144 stmt.o3.u1 = ir_value_code_addr(instr->_ops[0]);
3147 stmt.o1.u1 = ir_value_code_addr(instr->_ops[1]);
3150 stmt.o2.u1 = ir_value_code_addr(instr->_ops[2]);
3152 if (stmt.opcode == INSTR_RETURN || stmt.opcode == INSTR_DONE)
3154 stmt.o1.u1 = stmt.o3.u1;
3157 else if ((stmt.opcode >= INSTR_STORE_F &&
3158 stmt.opcode <= INSTR_STORE_FNC) ||
3159 (stmt.opcode >= INSTR_STOREP_F &&
3160 stmt.opcode <= INSTR_STOREP_FNC))
3162 /* 2-operand instructions with A -> B */
3163 stmt.o2.u1 = stmt.o3.u1;
3166 /* tiny optimization, don't output
3169 if (stmt.o2.u1 == stmt.o1.u1 &&
3170 OPTS_OPTIMIZATION(OPTIM_PEEPHOLE))
3172 ++opts_optimizationcount[OPTIM_PEEPHOLE];
3177 code_push_statement(code, &stmt, instr->context);
3182 static bool gen_function_code(code_t *code, ir_function *self)
3185 prog_section_statement_t stmt, *retst;
3187 /* Starting from entry point, we generate blocks "as they come"
3188 * for now. Dead blocks will not be translated obviously.
3190 if (!vec_size(self->blocks)) {
3191 irerror(self->context, "Function '%s' declared without body.", self->name);
3195 block = self->blocks[0];
3196 if (block->generated)
3199 if (!gen_blocks_recursive(code, self, block)) {
3200 irerror(self->context, "failed to generate blocks for '%s'", self->name);
3204 /* code_write and qcvm -disasm need to know that the function ends here */
3205 retst = &vec_last(code->statements);
3206 if (OPTS_OPTIMIZATION(OPTIM_VOID_RETURN) &&
3207 self->outtype == TYPE_VOID &&
3208 retst->opcode == INSTR_RETURN &&
3209 !retst->o1.u1 && !retst->o2.u1 && !retst->o3.u1)
3211 retst->opcode = INSTR_DONE;
3212 ++opts_optimizationcount[OPTIM_VOID_RETURN];
3216 stmt.opcode = INSTR_DONE;
3220 last.line = vec_last(code->linenums);
3221 last.column = vec_last(code->columnnums);
3223 code_push_statement(code, &stmt, last);
3228 static qcint_t ir_builder_filestring(ir_builder *ir, const char *filename)
3230 /* NOTE: filename pointers are copied, we never strdup them,
3231 * thus we can use pointer-comparison to find the string.
3236 for (i = 0; i < vec_size(ir->filenames); ++i) {
3237 if (ir->filenames[i] == filename)
3238 return ir->filestrings[i];
3241 str = code_genstring(ir->code, filename);
3242 vec_push(ir->filenames, filename);
3243 vec_push(ir->filestrings, str);
3247 static bool gen_global_function(ir_builder *ir, ir_value *global)
3249 prog_section_function_t fun;
3254 if (!global->hasvalue || (!global->constval.vfunc))
3256 irerror(global->context, "Invalid state of function-global: not constant: %s", global->name);
3260 irfun = global->constval.vfunc;
3262 fun.name = global->code.name;
3263 fun.file = ir_builder_filestring(ir, global->context.file);
3264 fun.profile = 0; /* always 0 */
3265 fun.nargs = vec_size(irfun->params);
3269 for (i = 0;i < 8; ++i) {
3270 if ((int32_t)i >= fun.nargs)
3273 fun.argsize[i] = type_sizeof_[irfun->params[i]];
3277 fun.locals = irfun->allocated_locals;
3280 fun.entry = irfun->builtin+1;
3282 irfun->code_function_def = vec_size(ir->code->functions);
3283 fun.entry = vec_size(ir->code->statements);
3286 vec_push(ir->code->functions, fun);
3290 static ir_value* ir_gen_extparam_proto(ir_builder *ir)
3295 util_snprintf(name, sizeof(name), "EXTPARM#%i", (int)(vec_size(ir->extparam_protos)));
3296 global = ir_value_var(name, store_global, TYPE_VECTOR);
3298 vec_push(ir->extparam_protos, global);
3302 static void ir_gen_extparam(ir_builder *ir)
3304 prog_section_def_t def;
3307 if (vec_size(ir->extparam_protos) < vec_size(ir->extparams)+1)
3308 global = ir_gen_extparam_proto(ir);
3310 global = ir->extparam_protos[vec_size(ir->extparams)];
3312 def.name = code_genstring(ir->code, global->name);
3313 def.type = TYPE_VECTOR;
3314 def.offset = vec_size(ir->code->globals);
3316 vec_push(ir->code->defs, def);
3318 ir_value_code_setaddr(global, def.offset);
3320 vec_push(ir->code->globals, 0);
3321 vec_push(ir->code->globals, 0);
3322 vec_push(ir->code->globals, 0);
3324 vec_push(ir->extparams, global);
3327 static bool gen_function_extparam_copy(code_t *code, ir_function *self)
3329 size_t i, ext, numparams;
3331 ir_builder *ir = self->owner;
3333 prog_section_statement_t stmt;
3335 numparams = vec_size(self->params);
3339 stmt.opcode = INSTR_STORE_F;
3341 for (i = 8; i < numparams; ++i) {
3343 if (ext >= vec_size(ir->extparams))
3344 ir_gen_extparam(ir);
3346 ep = ir->extparams[ext];
3348 stmt.opcode = type_store_instr[self->locals[i]->vtype];
3349 if (self->locals[i]->vtype == TYPE_FIELD &&
3350 self->locals[i]->fieldtype == TYPE_VECTOR)
3352 stmt.opcode = INSTR_STORE_V;
3354 stmt.o1.u1 = ir_value_code_addr(ep);
3355 stmt.o2.u1 = ir_value_code_addr(self->locals[i]);
3356 code_push_statement(code, &stmt, self->context);
3362 static bool gen_function_varargs_copy(code_t *code, ir_function *self)
3364 size_t i, ext, numparams, maxparams;
3366 ir_builder *ir = self->owner;
3368 prog_section_statement_t stmt;
3370 numparams = vec_size(self->params);
3374 stmt.opcode = INSTR_STORE_V;
3376 maxparams = numparams + self->max_varargs;
3377 for (i = numparams; i < maxparams; ++i) {
3379 stmt.o1.u1 = OFS_PARM0 + 3*i;
3380 stmt.o2.u1 = ir_value_code_addr(self->locals[i]);
3381 code_push_statement(code, &stmt, self->context);
3385 while (ext >= vec_size(ir->extparams))
3386 ir_gen_extparam(ir);
3388 ep = ir->extparams[ext];
3390 stmt.o1.u1 = ir_value_code_addr(ep);
3391 stmt.o2.u1 = ir_value_code_addr(self->locals[i]);
3392 code_push_statement(code, &stmt, self->context);
3398 static bool gen_function_locals(ir_builder *ir, ir_value *global)
3400 prog_section_function_t *def;
3403 uint32_t firstlocal, firstglobal;
3405 irfun = global->constval.vfunc;
3406 def = ir->code->functions + irfun->code_function_def;
3408 if (OPTS_OPTION_BOOL(OPTION_G) ||
3409 !OPTS_OPTIMIZATION(OPTIM_OVERLAP_LOCALS) ||
3410 (irfun->flags & IR_FLAG_MASK_NO_OVERLAP))
3412 firstlocal = def->firstlocal = vec_size(ir->code->globals);
3414 firstlocal = def->firstlocal = ir->first_common_local;
3415 ++opts_optimizationcount[OPTIM_OVERLAP_LOCALS];
3418 firstglobal = (OPTS_OPTIMIZATION(OPTIM_GLOBAL_TEMPS) ? ir->first_common_globaltemp : firstlocal);
3420 for (i = vec_size(ir->code->globals); i < firstlocal + irfun->allocated_locals; ++i)
3421 vec_push(ir->code->globals, 0);
3422 for (i = 0; i < vec_size(irfun->locals); ++i) {
3423 ir_value *v = irfun->locals[i];
3424 if (v->locked || !OPTS_OPTIMIZATION(OPTIM_GLOBAL_TEMPS)) {
3425 ir_value_code_setaddr(v, firstlocal + v->code.local);
3426 if (!ir_builder_gen_global(ir, irfun->locals[i], true)) {
3427 irerror(irfun->locals[i]->context, "failed to generate local %s", irfun->locals[i]->name);
3432 ir_value_code_setaddr(v, firstglobal + v->code.local);
3434 for (i = 0; i < vec_size(irfun->values); ++i)
3436 ir_value *v = irfun->values[i];
3440 ir_value_code_setaddr(v, firstlocal + v->code.local);
3442 ir_value_code_setaddr(v, firstglobal + v->code.local);
3447 static bool gen_global_function_code(ir_builder *ir, ir_value *global)
3449 prog_section_function_t *fundef;
3454 irfun = global->constval.vfunc;
3456 if (global->cvq == CV_NONE) {
3457 irwarning(global->context, WARN_IMPLICIT_FUNCTION_POINTER,
3458 "function `%s` has no body and in QC implicitly becomes a function-pointer", global->name);
3460 /* this was a function pointer, don't generate code for those */
3467 if (irfun->code_function_def < 0) {
3468 irerror(irfun->context, "`%s`: IR global wasn't generated, failed to access function-def", irfun->name);
3471 fundef = &ir->code->functions[irfun->code_function_def];
3473 fundef->entry = vec_size(ir->code->statements);
3474 if (!gen_function_locals(ir, global)) {
3475 irerror(irfun->context, "Failed to generate locals for function %s", irfun->name);
3478 if (!gen_function_extparam_copy(ir->code, irfun)) {
3479 irerror(irfun->context, "Failed to generate extparam-copy code for function %s", irfun->name);
3482 if (irfun->max_varargs && !gen_function_varargs_copy(ir->code, irfun)) {
3483 irerror(irfun->context, "Failed to generate vararg-copy code for function %s", irfun->name);
3486 if (!gen_function_code(ir->code, irfun)) {
3487 irerror(irfun->context, "Failed to generate code for function %s", irfun->name);
3493 static void gen_vector_defs(code_t *code, prog_section_def_t def, const char *name)
3498 if (!name || name[0] == '#' || OPTS_FLAG(SINGLE_VECTOR_DEFS))
3501 def.type = TYPE_FLOAT;
3505 component = (char*)mem_a(len+3);
3506 memcpy(component, name, len);
3508 component[len-0] = 0;
3509 component[len-2] = '_';
3511 component[len-1] = 'x';
3513 for (i = 0; i < 3; ++i) {
3514 def.name = code_genstring(code, component);
3515 vec_push(code->defs, def);
3523 static void gen_vector_fields(code_t *code, prog_section_field_t fld, const char *name)
3528 if (!name || OPTS_FLAG(SINGLE_VECTOR_DEFS))
3531 fld.type = TYPE_FLOAT;
3535 component = (char*)mem_a(len+3);
3536 memcpy(component, name, len);
3538 component[len-0] = 0;
3539 component[len-2] = '_';
3541 component[len-1] = 'x';
3543 for (i = 0; i < 3; ++i) {
3544 fld.name = code_genstring(code, component);
3545 vec_push(code->fields, fld);
3553 static bool ir_builder_gen_global(ir_builder *self, ir_value *global, bool islocal)
3557 prog_section_def_t def;
3558 bool pushdef = opts.optimizeoff;
3560 def.type = global->vtype;
3561 def.offset = vec_size(self->code->globals);
3563 if (OPTS_OPTION_BOOL(OPTION_G) || !islocal)
3567 if (OPTS_OPTIMIZATION(OPTIM_STRIP_CONSTANT_NAMES) &&
3568 !(global->flags & IR_FLAG_INCLUDE_DEF) &&
3569 (global->name[0] == '#' || global->cvq == CV_CONST))
3575 if (global->name[0] == '#') {
3576 if (!self->str_immediate)
3577 self->str_immediate = code_genstring(self->code, "IMMEDIATE");
3578 def.name = global->code.name = self->str_immediate;
3581 def.name = global->code.name = code_genstring(self->code, global->name);
3586 def.offset = ir_value_code_addr(global);
3587 vec_push(self->code->defs, def);
3588 if (global->vtype == TYPE_VECTOR)
3589 gen_vector_defs(self->code, def, global->name);
3590 else if (global->vtype == TYPE_FIELD && global->fieldtype == TYPE_VECTOR)
3591 gen_vector_defs(self->code, def, global->name);
3598 switch (global->vtype)
3601 if (!strcmp(global->name, "end_sys_globals")) {
3602 /* TODO: remember this point... all the defs before this one
3603 * should be checksummed and added to progdefs.h when we generate it.
3606 else if (!strcmp(global->name, "end_sys_fields")) {
3607 /* TODO: same as above but for entity-fields rather than globsl
3611 irwarning(global->context, WARN_VOID_VARIABLES, "unrecognized variable of type void `%s`",
3613 /* I'd argue setting it to 0 is sufficient, but maybe some depend on knowing how far
3614 * the system fields actually go? Though the engine knows this anyway...
3615 * Maybe this could be an -foption
3616 * fteqcc creates data for end_sys_* - of size 1, so let's do the same
3618 ir_value_code_setaddr(global, vec_size(self->code->globals));
3619 vec_push(self->code->globals, 0);
3621 if (pushdef) vec_push(self->code->defs, def);
3624 if (pushdef) vec_push(self->code->defs, def);
3625 return gen_global_pointer(self->code, global);
3628 vec_push(self->code->defs, def);
3629 if (global->fieldtype == TYPE_VECTOR)
3630 gen_vector_defs(self->code, def, global->name);
3632 return gen_global_field(self->code, global);
3637 ir_value_code_setaddr(global, vec_size(self->code->globals));
3638 if (global->hasvalue) {
3639 iptr = (int32_t*)&global->constval.ivec[0];
3640 vec_push(self->code->globals, *iptr);
3642 vec_push(self->code->globals, 0);
3644 if (!islocal && global->cvq != CV_CONST)
3645 def.type |= DEF_SAVEGLOBAL;
3646 if (pushdef) vec_push(self->code->defs, def);
3648 return global->code.globaladdr >= 0;
3652 ir_value_code_setaddr(global, vec_size(self->code->globals));
3653 if (global->hasvalue) {
3654 uint32_t load = code_genstring(self->code, global->constval.vstring);
3655 vec_push(self->code->globals, load);
3657 vec_push(self->code->globals, 0);
3659 if (!islocal && global->cvq != CV_CONST)
3660 def.type |= DEF_SAVEGLOBAL;
3661 if (pushdef) vec_push(self->code->defs, def);
3662 return global->code.globaladdr >= 0;
3667 ir_value_code_setaddr(global, vec_size(self->code->globals));
3668 if (global->hasvalue) {
3669 iptr = (int32_t*)&global->constval.ivec[0];
3670 vec_push(self->code->globals, iptr[0]);
3671 if (global->code.globaladdr < 0)
3673 for (d = 1; d < type_sizeof_[global->vtype]; ++d) {
3674 vec_push(self->code->globals, iptr[d]);
3677 vec_push(self->code->globals, 0);
3678 if (global->code.globaladdr < 0)
3680 for (d = 1; d < type_sizeof_[global->vtype]; ++d) {
3681 vec_push(self->code->globals, 0);
3684 if (!islocal && global->cvq != CV_CONST)
3685 def.type |= DEF_SAVEGLOBAL;
3688 vec_push(self->code->defs, def);
3689 def.type &= ~DEF_SAVEGLOBAL;
3690 gen_vector_defs(self->code, def, global->name);
3692 return global->code.globaladdr >= 0;
3695 ir_value_code_setaddr(global, vec_size(self->code->globals));
3696 if (!global->hasvalue) {
3697 vec_push(self->code->globals, 0);
3698 if (global->code.globaladdr < 0)
3701 vec_push(self->code->globals, vec_size(self->code->functions));
3702 if (!gen_global_function(self, global))
3705 if (!islocal && global->cvq != CV_CONST)
3706 def.type |= DEF_SAVEGLOBAL;
3707 if (pushdef) vec_push(self->code->defs, def);
3710 /* assume biggest type */
3711 ir_value_code_setaddr(global, vec_size(self->code->globals));
3712 vec_push(self->code->globals, 0);
3713 for (i = 1; i < type_sizeof_[TYPE_VARIANT]; ++i)
3714 vec_push(self->code->globals, 0);
3717 /* refuse to create 'void' type or any other fancy business. */
3718 irerror(global->context, "Invalid type for global variable `%s`: %s",
3719 global->name, type_name[global->vtype]);
3724 static GMQCC_INLINE void ir_builder_prepare_field(code_t *code, ir_value *field)
3726 field->code.fieldaddr = code_alloc_field(code, type_sizeof_[field->fieldtype]);
3729 static bool ir_builder_gen_field(ir_builder *self, ir_value *field)
3731 prog_section_def_t def;
3732 prog_section_field_t fld;
3736 def.type = (uint16_t)field->vtype;
3737 def.offset = (uint16_t)vec_size(self->code->globals);
3739 /* create a global named the same as the field */
3740 if (OPTS_OPTION_U32(OPTION_STANDARD) == COMPILER_GMQCC) {
3741 /* in our standard, the global gets a dot prefix */
3742 size_t len = strlen(field->name);
3745 /* we really don't want to have to allocate this, and 1024
3746 * bytes is more than enough for a variable/field name
3748 if (len+2 >= sizeof(name)) {
3749 irerror(field->context, "invalid field name size: %u", (unsigned int)len);
3754 memcpy(name+1, field->name, len); /* no strncpy - we used strlen above */
3757 def.name = code_genstring(self->code, name);
3758 fld.name = def.name + 1; /* we reuse that string table entry */
3760 /* in plain QC, there cannot be a global with the same name,
3761 * and so we also name the global the same.
3762 * FIXME: fteqcc should create a global as well
3763 * check if it actually uses the same name. Probably does
3765 def.name = code_genstring(self->code, field->name);
3766 fld.name = def.name;
3769 field->code.name = def.name;
3771 vec_push(self->code->defs, def);
3773 fld.type = field->fieldtype;
3775 if (fld.type == TYPE_VOID) {
3776 irerror(field->context, "field is missing a type: %s - don't know its size", field->name);
3780 fld.offset = field->code.fieldaddr;
3782 vec_push(self->code->fields, fld);
3784 ir_value_code_setaddr(field, vec_size(self->code->globals));
3785 vec_push(self->code->globals, fld.offset);
3786 if (fld.type == TYPE_VECTOR) {
3787 vec_push(self->code->globals, fld.offset+1);
3788 vec_push(self->code->globals, fld.offset+2);
3791 if (field->fieldtype == TYPE_VECTOR) {
3792 gen_vector_defs (self->code, def, field->name);
3793 gen_vector_fields(self->code, fld, field->name);
3796 return field->code.globaladdr >= 0;
3799 bool ir_builder_generate(ir_builder *self, const char *filename)
3801 prog_section_statement_t stmt;
3803 char *lnofile = NULL;
3805 for (i = 0; i < vec_size(self->fields); ++i)
3807 ir_builder_prepare_field(self->code, self->fields[i]);
3810 for (i = 0; i < vec_size(self->globals); ++i)
3812 if (!ir_builder_gen_global(self, self->globals[i], false)) {
3815 if (self->globals[i]->vtype == TYPE_FUNCTION) {
3816 ir_function *func = self->globals[i]->constval.vfunc;
3817 if (func && self->max_locals < func->allocated_locals &&
3818 !(func->flags & IR_FLAG_MASK_NO_OVERLAP))
3820 self->max_locals = func->allocated_locals;
3822 if (func && self->max_globaltemps < func->globaltemps)
3823 self->max_globaltemps = func->globaltemps;
3827 for (i = 0; i < vec_size(self->fields); ++i)
3829 if (!ir_builder_gen_field(self, self->fields[i])) {
3835 ir_value_code_setaddr(self->nil, vec_size(self->code->globals));
3836 vec_push(self->code->globals, 0);
3837 vec_push(self->code->globals, 0);
3838 vec_push(self->code->globals, 0);
3840 /* generate virtual-instruction temps */
3841 for (i = 0; i < IR_MAX_VINSTR_TEMPS; ++i) {
3842 ir_value_code_setaddr(self->vinstr_temp[i], vec_size(self->code->globals));
3843 vec_push(self->code->globals, 0);
3844 vec_push(self->code->globals, 0);
3845 vec_push(self->code->globals, 0);
3848 /* generate global temps */
3849 self->first_common_globaltemp = vec_size(self->code->globals);
3850 for (i = 0; i < self->max_globaltemps; ++i) {
3851 vec_push(self->code->globals, 0);
3853 /* generate common locals */
3854 self->first_common_local = vec_size(self->code->globals);
3855 for (i = 0; i < self->max_locals; ++i) {
3856 vec_push(self->code->globals, 0);
3859 /* generate function code */
3860 for (i = 0; i < vec_size(self->globals); ++i)
3862 if (self->globals[i]->vtype == TYPE_FUNCTION) {
3863 if (!gen_global_function_code(self, self->globals[i])) {
3869 if (vec_size(self->code->globals) >= 65536) {
3870 irerror(vec_last(self->globals)->context, "This progs file would require more globals than the metadata can handle. Bailing out.");
3874 /* DP errors if the last instruction is not an INSTR_DONE. */
3875 if (vec_last(self->code->statements).opcode != INSTR_DONE)
3879 stmt.opcode = INSTR_DONE;
3883 last.line = vec_last(self->code->linenums);
3884 last.column = vec_last(self->code->columnnums);
3886 code_push_statement(self->code, &stmt, last);
3889 if (OPTS_OPTION_BOOL(OPTION_PP_ONLY))
3892 if (vec_size(self->code->statements) != vec_size(self->code->linenums)) {
3893 con_err("Linecounter wrong: %lu != %lu\n",
3894 (unsigned long)vec_size(self->code->statements),
3895 (unsigned long)vec_size(self->code->linenums));
3896 } else if (OPTS_FLAG(LNO)) {
3898 size_t filelen = strlen(filename);
3900 memcpy(vec_add(lnofile, filelen+1), filename, filelen+1);
3901 dot = strrchr(lnofile, '.');
3905 vec_shrinkto(lnofile, dot - lnofile);
3907 memcpy(vec_add(lnofile, 5), ".lno", 5);
3910 if (!code_write(self->code, filename, lnofile)) {
3919 /***********************************************************************
3920 *IR DEBUG Dump functions...
3923 #define IND_BUFSZ 1024
3926 # define strncat(dst, src, sz) strncat_s(dst, sz, src, _TRUNCATE)
3929 static const char *qc_opname(int op)
3931 if (op < 0) return "<INVALID>";
3932 if (op < VINSTR_END)
3933 return util_instr_str[op];
3935 case VINSTR_END: return "END";
3936 case VINSTR_PHI: return "PHI";
3937 case VINSTR_JUMP: return "JUMP";
3938 case VINSTR_COND: return "COND";
3939 case VINSTR_BITXOR: return "BITXOR";
3940 case VINSTR_BITAND_V: return "BITAND_V";
3941 case VINSTR_BITOR_V: return "BITOR_V";
3942 case VINSTR_BITXOR_V: return "BITXOR_V";
3943 case VINSTR_BITAND_VF: return "BITAND_VF";
3944 case VINSTR_BITOR_VF: return "BITOR_VF";
3945 case VINSTR_BITXOR_VF: return "BITXOR_VF";
3946 default: return "<UNK>";
3950 void ir_builder_dump(ir_builder *b, int (*oprintf)(const char*, ...))
3953 char indent[IND_BUFSZ];
3957 oprintf("module %s\n", b->name);
3958 for (i = 0; i < vec_size(b->globals); ++i)
3961 if (b->globals[i]->hasvalue)
3962 oprintf("%s = ", b->globals[i]->name);
3963 ir_value_dump(b->globals[i], oprintf);
3966 for (i = 0; i < vec_size(b->functions); ++i)
3967 ir_function_dump(b->functions[i], indent, oprintf);
3968 oprintf("endmodule %s\n", b->name);
3971 static const char *storenames[] = {
3972 "[global]", "[local]", "[param]", "[value]", "[return]"
3975 void ir_function_dump(ir_function *f, char *ind,
3976 int (*oprintf)(const char*, ...))
3979 if (f->builtin != 0) {
3980 oprintf("%sfunction %s = builtin %i\n", ind, f->name, -f->builtin);
3983 oprintf("%sfunction %s\n", ind, f->name);
3984 strncat(ind, "\t", IND_BUFSZ-1);
3985 if (vec_size(f->locals))
3987 oprintf("%s%i locals:\n", ind, (int)vec_size(f->locals));
3988 for (i = 0; i < vec_size(f->locals); ++i) {
3989 oprintf("%s\t", ind);
3990 ir_value_dump(f->locals[i], oprintf);
3994 oprintf("%sliferanges:\n", ind);
3995 for (i = 0; i < vec_size(f->locals); ++i) {
3996 const char *attr = "";
3998 ir_value *v = f->locals[i];
3999 if (v->unique_life && v->locked)
4000 attr = "unique,locked ";
4001 else if (v->unique_life)
4005 oprintf("%s\t%s: %s %s %s%s@%i ", ind, v->name, type_name[v->vtype],
4006 storenames[v->store],
4007 attr, (v->callparam ? "callparam " : ""),
4008 (int)v->code.local);
4011 for (l = 0; l < vec_size(v->life); ++l) {
4012 oprintf("[%i,%i] ", v->life[l].start, v->life[l].end);
4015 for (m = 0; m < 3; ++m) {
4016 ir_value *vm = v->members[m];
4019 oprintf("%s\t%s: @%i ", ind, vm->name, (int)vm->code.local);
4020 for (l = 0; l < vec_size(vm->life); ++l) {
4021 oprintf("[%i,%i] ", vm->life[l].start, vm->life[l].end);
4026 for (i = 0; i < vec_size(f->values); ++i) {
4027 const char *attr = "";
4029 ir_value *v = f->values[i];
4030 if (v->unique_life && v->locked)
4031 attr = "unique,locked ";
4032 else if (v->unique_life)
4036 oprintf("%s\t%s: %s %s %s%s@%i ", ind, v->name, type_name[v->vtype],
4037 storenames[v->store],
4038 attr, (v->callparam ? "callparam " : ""),
4039 (int)v->code.local);
4042 for (l = 0; l < vec_size(v->life); ++l) {
4043 oprintf("[%i,%i] ", v->life[l].start, v->life[l].end);
4046 for (m = 0; m < 3; ++m) {
4047 ir_value *vm = v->members[m];
4050 if (vm->unique_life && vm->locked)
4051 attr = "unique,locked ";
4052 else if (vm->unique_life)
4054 else if (vm->locked)
4056 oprintf("%s\t%s: %s@%i ", ind, vm->name, attr, (int)vm->code.local);
4057 for (l = 0; l < vec_size(vm->life); ++l) {
4058 oprintf("[%i,%i] ", vm->life[l].start, vm->life[l].end);
4063 if (vec_size(f->blocks))
4065 oprintf("%slife passes: %i\n", ind, (int)f->run_id);
4066 for (i = 0; i < vec_size(f->blocks); ++i) {
4067 ir_block_dump(f->blocks[i], ind, oprintf);
4071 ind[strlen(ind)-1] = 0;
4072 oprintf("%sendfunction %s\n", ind, f->name);
4075 void ir_block_dump(ir_block* b, char *ind,
4076 int (*oprintf)(const char*, ...))
4079 oprintf("%s:%s\n", ind, b->label);
4080 strncat(ind, "\t", IND_BUFSZ-1);
4082 if (b->instr && b->instr[0])
4083 oprintf("%s (%i) [entry]\n", ind, (int)(b->instr[0]->eid-1));
4084 for (i = 0; i < vec_size(b->instr); ++i)
4085 ir_instr_dump(b->instr[i], ind, oprintf);
4086 ind[strlen(ind)-1] = 0;
4089 static void dump_phi(ir_instr *in, int (*oprintf)(const char*, ...))
4092 oprintf("%s <- phi ", in->_ops[0]->name);
4093 for (i = 0; i < vec_size(in->phi); ++i)
4095 oprintf("([%s] : %s) ", in->phi[i].from->label,
4096 in->phi[i].value->name);
4101 void ir_instr_dump(ir_instr *in, char *ind,
4102 int (*oprintf)(const char*, ...))
4105 const char *comma = NULL;
4107 oprintf("%s (%i) ", ind, (int)in->eid);
4109 if (in->opcode == VINSTR_PHI) {
4110 dump_phi(in, oprintf);
4114 strncat(ind, "\t", IND_BUFSZ-1);
4116 if (in->_ops[0] && (in->_ops[1] || in->_ops[2])) {
4117 ir_value_dump(in->_ops[0], oprintf);
4118 if (in->_ops[1] || in->_ops[2])
4121 if (in->opcode == INSTR_CALL0 || in->opcode == VINSTR_NRCALL) {
4122 oprintf("CALL%i\t", vec_size(in->params));
4124 oprintf("%s\t", qc_opname(in->opcode));
4126 if (in->_ops[0] && !(in->_ops[1] || in->_ops[2])) {
4127 ir_value_dump(in->_ops[0], oprintf);
4132 for (i = 1; i != 3; ++i) {
4136 ir_value_dump(in->_ops[i], oprintf);
4144 oprintf("[%s]", in->bops[0]->label);
4148 oprintf("%s[%s]", comma, in->bops[1]->label);
4149 if (vec_size(in->params)) {
4150 oprintf("\tparams: ");
4151 for (i = 0; i != vec_size(in->params); ++i) {
4152 oprintf("%s, ", in->params[i]->name);
4156 ind[strlen(ind)-1] = 0;
4159 static void ir_value_dump_string(const char *str, int (*oprintf)(const char*, ...))
4162 for (; *str; ++str) {
4164 case '\n': oprintf("\\n"); break;
4165 case '\r': oprintf("\\r"); break;
4166 case '\t': oprintf("\\t"); break;
4167 case '\v': oprintf("\\v"); break;
4168 case '\f': oprintf("\\f"); break;
4169 case '\b': oprintf("\\b"); break;
4170 case '\a': oprintf("\\a"); break;
4171 case '\\': oprintf("\\\\"); break;
4172 case '"': oprintf("\\\""); break;
4173 default: oprintf("%c", *str); break;
4179 void ir_value_dump(ir_value* v, int (*oprintf)(const char*, ...))
4188 oprintf("fn:%s", v->name);
4191 oprintf("%g", v->constval.vfloat);
4194 oprintf("'%g %g %g'",
4197 v->constval.vvec.z);
4200 oprintf("(entity)");
4203 ir_value_dump_string(v->constval.vstring, oprintf);
4207 oprintf("%i", v->constval.vint);
4212 v->constval.vpointer->name);
4216 oprintf("%s", v->name);
4220 void ir_value_dump_life(const ir_value *self, int (*oprintf)(const char*,...))
4223 oprintf("Life of %12s:", self->name);
4224 for (i = 0; i < vec_size(self->life); ++i)
4226 oprintf(" + [%i, %i]\n", self->life[i].start, self->life[i].end);