]> git.xonotic.org Git - xonotic/gmqcc.git/blob - ir.c
the IR won't create globals of the same name - make names starting with # an exception
[xonotic/gmqcc.git] / ir.c
1 /*
2  * Copyright (C) 2012
3  *     Wolfgang Bumiller
4  *
5  * Permission is hereby granted, free of charge, to any person obtaining a copy of
6  * this software and associated documentation files (the "Software"), to deal in
7  * the Software without restriction, including without limitation the rights to
8  * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
9  * of the Software, and to permit persons to whom the Software is furnished to do
10  * so, subject to the following conditions:
11  *
12  * The above copyright notice and this permission notice shall be included in all
13  * copies or substantial portions of the Software.
14  *
15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21  * SOFTWARE.
22  */
23 #include <stdlib.h>
24 #include <string.h>
25 #include "gmqcc.h"
26 #include "ir.h"
27
28 /***********************************************************************
29  * Type sizes used at multiple points in the IR codegen
30  */
31
32 const char *type_name[TYPE_COUNT] = {
33     "void",
34     "string",
35     "float",
36     "vector",
37     "entity",
38     "field",
39     "function",
40     "pointer",
41 #if 0
42     "integer",
43 #endif
44     "quaternion",
45     "matrix",
46     "variant"
47 };
48
49 size_t type_sizeof[TYPE_COUNT] = {
50     1, /* TYPE_VOID     */
51     1, /* TYPE_STRING   */
52     1, /* TYPE_FLOAT    */
53     3, /* TYPE_VECTOR   */
54     1, /* TYPE_ENTITY   */
55     1, /* TYPE_FIELD    */
56     1, /* TYPE_FUNCTION */
57     1, /* TYPE_POINTER  */
58 #if 0
59     1, /* TYPE_INTEGER  */
60 #endif
61     4, /* TYPE_QUATERNION */
62     16, /* TYPE_MATRIX */
63     16, /* TYPE_VARIANT  */
64 };
65
66 uint16_t type_store_instr[TYPE_COUNT] = {
67     INSTR_STORE_F, /* should use I when having integer support */
68     INSTR_STORE_S,
69     INSTR_STORE_F,
70     INSTR_STORE_V,
71     INSTR_STORE_ENT,
72     INSTR_STORE_FLD,
73     INSTR_STORE_FNC,
74     INSTR_STORE_ENT, /* should use I */
75 #if 0
76     INSTR_STORE_I, /* integer type */
77 #endif
78     INSTR_STORE_Q,
79     INSTR_STORE_M,
80
81     INSTR_STORE_M, /* variant, should never be accessed */
82 };
83
84 uint16_t type_storep_instr[TYPE_COUNT] = {
85     INSTR_STOREP_F, /* should use I when having integer support */
86     INSTR_STOREP_S,
87     INSTR_STOREP_F,
88     INSTR_STOREP_V,
89     INSTR_STOREP_ENT,
90     INSTR_STOREP_FLD,
91     INSTR_STOREP_FNC,
92     INSTR_STOREP_ENT, /* should use I */
93 #if 0
94     INSTR_STOREP_ENT, /* integer type */
95 #endif
96     INSTR_STOREP_Q,
97     INSTR_STOREP_M,
98
99     INSTR_STOREP_M, /* variant, should never be accessed */
100 };
101
102 MEM_VEC_FUNCTIONS(ir_value_vector, ir_value*, v)
103
104 /***********************************************************************
105  *IR Builder
106  */
107
108 ir_builder* ir_builder_new(const char *modulename)
109 {
110     ir_builder* self;
111
112     self = (ir_builder*)mem_a(sizeof(*self));
113     if (!self)
114         return NULL;
115
116     MEM_VECTOR_INIT(self, functions);
117     MEM_VECTOR_INIT(self, globals);
118     self->name = NULL;
119     if (!ir_builder_set_name(self, modulename)) {
120         mem_d(self);
121         return NULL;
122     }
123
124     /* globals which always exist */
125
126     /* for now we give it a vector size */
127     ir_builder_create_global(self, "OFS_RETURN", TYPE_VARIANT);
128
129     return self;
130 }
131
132 MEM_VEC_FUNCTIONS(ir_builder, ir_value*, globals)
133 MEM_VEC_FUNCTIONS(ir_builder, ir_function*, functions)
134
135 void ir_builder_delete(ir_builder* self)
136 {
137     size_t i;
138     mem_d((void*)self->name);
139     for (i = 0; i != self->functions_count; ++i) {
140         ir_function_delete(self->functions[i]);
141     }
142     MEM_VECTOR_CLEAR(self, functions);
143     for (i = 0; i != self->globals_count; ++i) {
144         ir_value_delete(self->globals[i]);
145     }
146     MEM_VECTOR_CLEAR(self, globals);
147     mem_d(self);
148 }
149
150 bool ir_builder_set_name(ir_builder *self, const char *name)
151 {
152     if (self->name)
153         mem_d((void*)self->name);
154     self->name = util_strdup(name);
155     return !!self->name;
156 }
157
158 ir_function* ir_builder_get_function(ir_builder *self, const char *name)
159 {
160     size_t i;
161     for (i = 0; i < self->functions_count; ++i) {
162         if (!strcmp(name, self->functions[i]->name))
163             return self->functions[i];
164     }
165     return NULL;
166 }
167
168 ir_function* ir_builder_create_function(ir_builder *self, const char *name, int outtype)
169 {
170     ir_function *fn = ir_builder_get_function(self, name);
171     if (fn) {
172         return NULL;
173     }
174
175     fn = ir_function_new(self, outtype);
176     if (!ir_function_set_name(fn, name) ||
177         !ir_builder_functions_add(self, fn) )
178     {
179         ir_function_delete(fn);
180         return NULL;
181     }
182
183     fn->value = ir_builder_create_global(self, fn->name, TYPE_FUNCTION);
184     if (!fn->value) {
185         ir_function_delete(fn);
186         return NULL;
187     }
188
189     fn->value->isconst = true;
190     fn->value->outtype = outtype;
191     fn->value->constval.vfunc = fn;
192     fn->value->context = fn->context;
193
194     return fn;
195 }
196
197 ir_value* ir_builder_get_global(ir_builder *self, const char *name)
198 {
199     size_t i;
200     for (i = 0; i < self->globals_count; ++i) {
201         if (!strcmp(self->globals[i]->name, name))
202             return self->globals[i];
203     }
204     return NULL;
205 }
206
207 ir_value* ir_builder_create_global(ir_builder *self, const char *name, int vtype)
208 {
209     ir_value *ve;
210
211     if (name && name[0] != '#')
212     {
213         ve = ir_builder_get_global(self, name);
214         if (ve) {
215             return NULL;
216         }
217     }
218
219     ve = ir_value_var(name, store_global, vtype);
220     if (!ir_builder_globals_add(self, ve)) {
221         ir_value_delete(ve);
222         return NULL;
223     }
224     return ve;
225 }
226
227 /***********************************************************************
228  *IR Function
229  */
230
231 bool ir_function_naive_phi(ir_function*);
232 void ir_function_enumerate(ir_function*);
233 bool ir_function_calculate_liferanges(ir_function*);
234 bool ir_function_allocate_locals(ir_function*);
235
236 ir_function* ir_function_new(ir_builder* owner, int outtype)
237 {
238     ir_function *self;
239     self = (ir_function*)mem_a(sizeof(*self));
240
241     if (!self)
242         return NULL;
243
244     self->name = NULL;
245     if (!ir_function_set_name(self, "<@unnamed>")) {
246         mem_d(self);
247         return NULL;
248     }
249     self->owner = owner;
250     self->context.file = "<@no context>";
251     self->context.line = 0;
252     self->outtype = outtype;
253     self->value = NULL;
254     self->builtin = 0;
255     MEM_VECTOR_INIT(self, params);
256     MEM_VECTOR_INIT(self, blocks);
257     MEM_VECTOR_INIT(self, values);
258     MEM_VECTOR_INIT(self, locals);
259
260     self->run_id = 0;
261     return self;
262 }
263 MEM_VEC_FUNCTIONS(ir_function, ir_value*, values)
264 MEM_VEC_FUNCTIONS(ir_function, ir_block*, blocks)
265 MEM_VEC_FUNCTIONS(ir_function, ir_value*, locals)
266 MEM_VEC_FUNCTIONS(ir_function, int,       params)
267
268 bool ir_function_set_name(ir_function *self, const char *name)
269 {
270     if (self->name)
271         mem_d((void*)self->name);
272     self->name = util_strdup(name);
273     return !!self->name;
274 }
275
276 void ir_function_delete(ir_function *self)
277 {
278     size_t i;
279     mem_d((void*)self->name);
280
281     for (i = 0; i != self->blocks_count; ++i)
282         ir_block_delete(self->blocks[i]);
283     MEM_VECTOR_CLEAR(self, blocks);
284
285     MEM_VECTOR_CLEAR(self, params);
286
287     for (i = 0; i != self->values_count; ++i)
288         ir_value_delete(self->values[i]);
289     MEM_VECTOR_CLEAR(self, values);
290
291     for (i = 0; i != self->locals_count; ++i)
292         ir_value_delete(self->locals[i]);
293     MEM_VECTOR_CLEAR(self, locals);
294
295     /* self->value is deleted by the builder */
296
297     mem_d(self);
298 }
299
300 bool GMQCC_WARN ir_function_collect_value(ir_function *self, ir_value *v)
301 {
302     return ir_function_values_add(self, v);
303 }
304
305 ir_block* ir_function_create_block(ir_function *self, const char *label)
306 {
307     ir_block* bn = ir_block_new(self, label);
308     memcpy(&bn->context, &self->context, sizeof(self->context));
309     if (!ir_function_blocks_add(self, bn)) {
310         ir_block_delete(bn);
311         return NULL;
312     }
313     return bn;
314 }
315
316 bool ir_function_finalize(ir_function *self)
317 {
318     if (self->builtin)
319         return true;
320
321     if (!ir_function_naive_phi(self))
322         return false;
323
324     ir_function_enumerate(self);
325
326     if (!ir_function_calculate_liferanges(self))
327         return false;
328
329     if (!ir_function_allocate_locals(self))
330         return false;
331     return true;
332 }
333
334 ir_value* ir_function_get_local(ir_function *self, const char *name)
335 {
336     size_t i;
337     for (i = 0; i < self->locals_count; ++i) {
338         if (!strcmp(self->locals[i]->name, name))
339             return self->locals[i];
340     }
341     return NULL;
342 }
343
344 ir_value* ir_function_create_local(ir_function *self, const char *name, int vtype)
345 {
346     ir_value *ve = ir_function_get_local(self, name);
347     if (ve) {
348         return NULL;
349     }
350
351     ve = ir_value_var(name, store_local, vtype);
352     if (!ir_function_locals_add(self, ve)) {
353         ir_value_delete(ve);
354         return NULL;
355     }
356     return ve;
357 }
358
359 /***********************************************************************
360  *IR Block
361  */
362
363 ir_block* ir_block_new(ir_function* owner, const char *name)
364 {
365     ir_block *self;
366     self = (ir_block*)mem_a(sizeof(*self));
367     if (!self)
368         return NULL;
369
370     memset(self, 0, sizeof(*self));
371
372     self->label = NULL;
373     if (!ir_block_set_label(self, name)) {
374         mem_d(self);
375         return NULL;
376     }
377     self->owner = owner;
378     self->context.file = "<@no context>";
379     self->context.line = 0;
380     self->final = false;
381     MEM_VECTOR_INIT(self, instr);
382     MEM_VECTOR_INIT(self, entries);
383     MEM_VECTOR_INIT(self, exits);
384
385     self->eid = 0;
386     self->is_return = false;
387     self->run_id = 0;
388     MEM_VECTOR_INIT(self, living);
389
390     self->generated = false;
391
392     return self;
393 }
394 MEM_VEC_FUNCTIONS(ir_block, ir_instr*, instr)
395 MEM_VEC_FUNCTIONS_ALL(ir_block, ir_block*, entries)
396 MEM_VEC_FUNCTIONS_ALL(ir_block, ir_block*, exits)
397 MEM_VEC_FUNCTIONS_ALL(ir_block, ir_value*, living)
398
399 void ir_block_delete(ir_block* self)
400 {
401     size_t i;
402     mem_d(self->label);
403     for (i = 0; i != self->instr_count; ++i)
404         ir_instr_delete(self->instr[i]);
405     MEM_VECTOR_CLEAR(self, instr);
406     MEM_VECTOR_CLEAR(self, entries);
407     MEM_VECTOR_CLEAR(self, exits);
408     MEM_VECTOR_CLEAR(self, living);
409     mem_d(self);
410 }
411
412 bool ir_block_set_label(ir_block *self, const char *name)
413 {
414     if (self->label)
415         mem_d((void*)self->label);
416     self->label = util_strdup(name);
417     return !!self->label;
418 }
419
420 /***********************************************************************
421  *IR Instructions
422  */
423
424 ir_instr* ir_instr_new(ir_block* owner, int op)
425 {
426     ir_instr *self;
427     self = (ir_instr*)mem_a(sizeof(*self));
428     if (!self)
429         return NULL;
430
431     self->owner = owner;
432     self->context.file = "<@no context>";
433     self->context.line = 0;
434     self->opcode = op;
435     self->_ops[0] = NULL;
436     self->_ops[1] = NULL;
437     self->_ops[2] = NULL;
438     self->bops[0] = NULL;
439     self->bops[1] = NULL;
440     MEM_VECTOR_INIT(self, phi);
441     MEM_VECTOR_INIT(self, params);
442
443     self->eid = 0;
444     return self;
445 }
446 MEM_VEC_FUNCTIONS(ir_instr, ir_phi_entry_t, phi)
447 MEM_VEC_FUNCTIONS(ir_instr, ir_value*, params)
448
449 void ir_instr_delete(ir_instr *self)
450 {
451     size_t i;
452     /* The following calls can only delete from
453      * vectors, we still want to delete this instruction
454      * so ignore the return value. Since with the warn_unused_result attribute
455      * gcc doesn't care about an explicit: (void)foo(); to ignore the result,
456      * I have to improvise here and use if(foo());
457      */
458     for (i = 0; i < self->phi_count; ++i) {
459         size_t idx;
460         if (ir_value_writes_find(self->phi[i].value, self, &idx))
461             if (ir_value_writes_remove(self->phi[i].value, idx)) GMQCC_SUPPRESS_EMPTY_BODY;
462         if (ir_value_reads_find(self->phi[i].value, self, &idx))
463             if (ir_value_reads_remove (self->phi[i].value, idx)) GMQCC_SUPPRESS_EMPTY_BODY;
464     }
465     MEM_VECTOR_CLEAR(self, phi);
466     for (i = 0; i < self->params_count; ++i) {
467         size_t idx;
468         if (ir_value_writes_find(self->params[i], self, &idx))
469             if (ir_value_writes_remove(self->params[i], idx)) GMQCC_SUPPRESS_EMPTY_BODY;
470         if (ir_value_reads_find(self->params[i], self, &idx))
471             if (ir_value_reads_remove (self->params[i], idx)) GMQCC_SUPPRESS_EMPTY_BODY;
472     }
473     MEM_VECTOR_CLEAR(self, params);
474     if (ir_instr_op(self, 0, NULL, false)) GMQCC_SUPPRESS_EMPTY_BODY;
475     if (ir_instr_op(self, 1, NULL, false)) GMQCC_SUPPRESS_EMPTY_BODY;
476     if (ir_instr_op(self, 2, NULL, false)) GMQCC_SUPPRESS_EMPTY_BODY;
477     mem_d(self);
478 }
479
480 bool ir_instr_op(ir_instr *self, int op, ir_value *v, bool writing)
481 {
482     if (self->_ops[op]) {
483         size_t idx;
484         if (writing && ir_value_writes_find(self->_ops[op], self, &idx))
485         {
486             if (!ir_value_writes_remove(self->_ops[op], idx))
487                 return false;
488         }
489         else if (ir_value_reads_find(self->_ops[op], self, &idx))
490         {
491             if (!ir_value_reads_remove(self->_ops[op], idx))
492                 return false;
493         }
494     }
495     if (v) {
496         if (writing) {
497             if (!ir_value_writes_add(v, self))
498                 return false;
499         } else {
500             if (!ir_value_reads_add(v, self))
501                 return false;
502         }
503     }
504     self->_ops[op] = v;
505     return true;
506 }
507
508 /***********************************************************************
509  *IR Value
510  */
511
512 ir_value* ir_value_var(const char *name, int storetype, int vtype)
513 {
514     ir_value *self;
515     self = (ir_value*)mem_a(sizeof(*self));
516     self->vtype = vtype;
517     self->fieldtype = TYPE_VOID;
518     self->outtype = TYPE_VOID;
519     self->store = storetype;
520     MEM_VECTOR_INIT(self, reads);
521     MEM_VECTOR_INIT(self, writes);
522     self->isconst = false;
523     self->context.file = "<@no context>";
524     self->context.line = 0;
525     self->name = NULL;
526     ir_value_set_name(self, name);
527
528     memset(&self->constval, 0, sizeof(self->constval));
529     memset(&self->code,     0, sizeof(self->code));
530
531     MEM_VECTOR_INIT(self, life);
532     return self;
533 }
534 MEM_VEC_FUNCTIONS(ir_value, ir_life_entry_t, life)
535 MEM_VEC_FUNCTIONS_ALL(ir_value, ir_instr*, reads)
536 MEM_VEC_FUNCTIONS_ALL(ir_value, ir_instr*, writes)
537
538 ir_value* ir_value_out(ir_function *owner, const char *name, int storetype, int vtype)
539 {
540     ir_value *v = ir_value_var(name, storetype, vtype);
541     if (!v)
542         return NULL;
543     if (!ir_function_collect_value(owner, v))
544     {
545         ir_value_delete(v);
546         return NULL;
547     }
548     return v;
549 }
550
551 void ir_value_delete(ir_value* self)
552 {
553     if (self->name)
554         mem_d((void*)self->name);
555     if (self->isconst)
556     {
557         if (self->vtype == TYPE_STRING)
558             mem_d((void*)self->constval.vstring);
559     }
560     MEM_VECTOR_CLEAR(self, reads);
561     MEM_VECTOR_CLEAR(self, writes);
562     MEM_VECTOR_CLEAR(self, life);
563     mem_d(self);
564 }
565
566 void ir_value_set_name(ir_value *self, const char *name)
567 {
568     if (self->name)
569         mem_d((void*)self->name);
570     self->name = util_strdup(name);
571 }
572
573 bool ir_value_set_float(ir_value *self, float f)
574 {
575     if (self->vtype != TYPE_FLOAT)
576         return false;
577     self->constval.vfloat = f;
578     self->isconst = true;
579     return true;
580 }
581
582 bool ir_value_set_func(ir_value *self, int f)
583 {
584     if (self->vtype != TYPE_FUNCTION)
585         return false;
586     self->constval.vint = f;
587     self->isconst = true;
588     return true;
589 }
590
591 bool ir_value_set_vector(ir_value *self, vector v)
592 {
593     if (self->vtype != TYPE_VECTOR)
594         return false;
595     self->constval.vvec = v;
596     self->isconst = true;
597     return true;
598 }
599
600 bool ir_value_set_quaternion(ir_value *self, quaternion v)
601 {
602     if (self->vtype != TYPE_QUATERNION)
603         return false;
604     memcpy(&self->constval.vquat, v, sizeof(self->constval.vquat));
605     self->isconst = true;
606     return true;
607 }
608
609 bool ir_value_set_matrix(ir_value *self, matrix v)
610 {
611     if (self->vtype != TYPE_MATRIX)
612         return false;
613     memcpy(&self->constval.vmat, v, sizeof(self->constval.vmat));
614     self->isconst = true;
615     return true;
616 }
617
618 bool ir_value_set_string(ir_value *self, const char *str)
619 {
620     if (self->vtype != TYPE_STRING)
621         return false;
622     self->constval.vstring = util_strdup(str);
623     self->isconst = true;
624     return true;
625 }
626
627 #if 0
628 bool ir_value_set_int(ir_value *self, int i)
629 {
630     if (self->vtype != TYPE_INTEGER)
631         return false;
632     self->constval.vint = i;
633     self->isconst = true;
634     return true;
635 }
636 #endif
637
638 bool ir_value_lives(ir_value *self, size_t at)
639 {
640     size_t i;
641     for (i = 0; i < self->life_count; ++i)
642     {
643         ir_life_entry_t *life = &self->life[i];
644         if (life->start <= at && at <= life->end)
645             return true;
646         if (life->start > at) /* since it's ordered */
647             return false;
648     }
649     return false;
650 }
651
652 bool ir_value_life_insert(ir_value *self, size_t idx, ir_life_entry_t e)
653 {
654     size_t k;
655     if (!ir_value_life_add(self, e)) /* naive... */
656         return false;
657     for (k = self->life_count-1; k > idx; --k)
658         self->life[k] = self->life[k-1];
659     self->life[idx] = e;
660     return true;
661 }
662
663 bool ir_value_life_merge(ir_value *self, size_t s)
664 {
665     size_t i;
666     ir_life_entry_t *life = NULL;
667     ir_life_entry_t *before = NULL;
668     ir_life_entry_t new_entry;
669
670     /* Find the first range >= s */
671     for (i = 0; i < self->life_count; ++i)
672     {
673         before = life;
674         life = &self->life[i];
675         if (life->start > s)
676             break;
677     }
678     /* nothing found? append */
679     if (i == self->life_count) {
680         ir_life_entry_t e;
681         if (life && life->end+1 == s)
682         {
683             /* previous life range can be merged in */
684             life->end++;
685             return true;
686         }
687         if (life && life->end >= s)
688             return false;
689         e.start = e.end = s;
690         if (!ir_value_life_add(self, e))
691             return false; /* failing */
692         return true;
693     }
694     /* found */
695     if (before)
696     {
697         if (before->end + 1 == s &&
698             life->start - 1 == s)
699         {
700             /* merge */
701             before->end = life->end;
702             if (!ir_value_life_remove(self, i))
703                 return false; /* failing */
704             return true;
705         }
706         if (before->end + 1 == s)
707         {
708             /* extend before */
709             before->end++;
710             return true;
711         }
712         /* already contained */
713         if (before->end >= s)
714             return false;
715     }
716     /* extend */
717     if (life->start - 1 == s)
718     {
719         life->start--;
720         return true;
721     }
722     /* insert a new entry */
723     new_entry.start = new_entry.end = s;
724     return ir_value_life_insert(self, i, new_entry);
725 }
726
727 bool ir_value_life_merge_into(ir_value *self, const ir_value *other)
728 {
729     size_t i, myi;
730
731     if (!other->life_count)
732         return true;
733
734     if (!self->life_count) {
735         for (i = 0; i < other->life_count; ++i) {
736             if (!ir_value_life_add(self, other->life[i]))
737                 return false;
738         }
739         return true;
740     }
741
742     myi = 0;
743     for (i = 0; i < other->life_count; ++i)
744     {
745         const ir_life_entry_t *life = &other->life[i];
746         while (true)
747         {
748             ir_life_entry_t *entry = &self->life[myi];
749
750             if (life->end+1 < entry->start)
751             {
752                 /* adding an interval before entry */
753                 if (!ir_value_life_insert(self, myi, *life))
754                     return false;
755                 ++myi;
756                 break;
757             }
758
759             if (life->start <  entry->start &&
760                 life->end   >= entry->start)
761             {
762                 /* starts earlier and overlaps */
763                 entry->start = life->start;
764             }
765
766             if (life->end     >  entry->end &&
767                 life->start-1 <= entry->end)
768             {
769                 /* ends later and overlaps */
770                 entry->end = life->end;
771             }
772
773             /* see if our change combines it with the next ranges */
774             while (myi+1 < self->life_count &&
775                    entry->end+1 >= self->life[1+myi].start)
776             {
777                 /* overlaps with (myi+1) */
778                 if (entry->end < self->life[1+myi].end)
779                     entry->end = self->life[1+myi].end;
780                 if (!ir_value_life_remove(self, myi+1))
781                     return false;
782                 entry = &self->life[myi];
783             }
784
785             /* see if we're after the entry */
786             if (life->start > entry->end)
787             {
788                 ++myi;
789                 /* append if we're at the end */
790                 if (myi >= self->life_count) {
791                     if (!ir_value_life_add(self, *life))
792                         return false;
793                     break;
794                 }
795                 /* otherweise check the next range */
796                 continue;
797             }
798             break;
799         }
800     }
801     return true;
802 }
803
804 bool ir_values_overlap(const ir_value *a, const ir_value *b)
805 {
806     /* For any life entry in A see if it overlaps with
807      * any life entry in B.
808      * Note that the life entries are orderes, so we can make a
809      * more efficient algorithm there than naively translating the
810      * statement above.
811      */
812
813     ir_life_entry_t *la, *lb, *enda, *endb;
814
815     /* first of all, if either has no life range, they cannot clash */
816     if (!a->life_count || !b->life_count)
817         return false;
818
819     la = a->life;
820     lb = b->life;
821     enda = la + a->life_count;
822     endb = lb + b->life_count;
823     while (true)
824     {
825         /* check if the entries overlap, for that,
826          * both must start before the other one ends.
827          */
828 #if defined(LIFE_RANGE_WITHOUT_LAST_READ)
829         if (la->start <= lb->end &&
830             lb->start <= la->end)
831 #else
832         if (la->start <  lb->end &&
833             lb->start <  la->end)
834 #endif
835         {
836             return true;
837         }
838
839         /* entries are ordered
840          * one entry is earlier than the other
841          * that earlier entry will be moved forward
842          */
843         if (la->start < lb->start)
844         {
845             /* order: A B, move A forward
846              * check if we hit the end with A
847              */
848             if (++la == enda)
849                 break;
850         }
851         else if (lb->start < la->start)
852         {
853             /* order: B A, move B forward
854              * check if we hit the end with B
855              */
856             if (++lb == endb)
857                 break;
858         }
859     }
860     return false;
861 }
862
863 /***********************************************************************
864  *IR main operations
865  */
866
867 bool ir_block_create_store_op(ir_block *self, int op, ir_value *target, ir_value *what)
868 {
869     if (target->store == store_value) {
870         fprintf(stderr, "cannot store to an SSA value\n");
871         fprintf(stderr, "trying to store: %s <- %s\n", target->name, what->name);
872         return false;
873     } else {
874         ir_instr *in = ir_instr_new(self, op);
875         if (!in)
876             return false;
877         if (!ir_instr_op(in, 0, target, true) ||
878             !ir_instr_op(in, 1, what, false)  ||
879             !ir_block_instr_add(self, in) )
880         {
881             return false;
882         }
883         return true;
884     }
885 }
886
887 bool ir_block_create_store(ir_block *self, ir_value *target, ir_value *what)
888 {
889     int op = 0;
890     int vtype;
891     if (target->vtype == TYPE_VARIANT)
892         vtype = what->vtype;
893     else
894         vtype = target->vtype;
895
896 #if 0
897     if      (vtype == TYPE_FLOAT   && what->vtype == TYPE_INTEGER)
898         op = INSTR_CONV_ITOF;
899     else if (vtype == TYPE_INTEGER && what->vtype == TYPE_FLOAT)
900         op = INSTR_CONV_FTOI;
901 #endif
902         op = type_store_instr[vtype];
903
904     return ir_block_create_store_op(self, op, target, what);
905 }
906
907 bool ir_block_create_storep(ir_block *self, ir_value *target, ir_value *what)
908 {
909     int op = 0;
910     int vtype;
911
912     if (target->vtype != TYPE_POINTER)
913         return false;
914
915     /* storing using pointer - target is a pointer, type must be
916      * inferred from source
917      */
918     vtype = what->vtype;
919
920     op = type_storep_instr[vtype];
921     return ir_block_create_store_op(self, op, target, what);
922 }
923
924 bool ir_block_create_return(ir_block *self, ir_value *v)
925 {
926     ir_instr *in;
927     if (self->final) {
928         fprintf(stderr, "block already ended (%s)\n", self->label);
929         return false;
930     }
931     self->final = true;
932     self->is_return = true;
933     in = ir_instr_new(self, INSTR_RETURN);
934     if (!in)
935         return false;
936
937     if (!ir_instr_op(in, 0, v, false) ||
938         !ir_block_instr_add(self, in) )
939     {
940         return false;
941     }
942     return true;
943 }
944
945 bool ir_block_create_if(ir_block *self, ir_value *v,
946                         ir_block *ontrue, ir_block *onfalse)
947 {
948     ir_instr *in;
949     if (self->final) {
950         fprintf(stderr, "block already ended (%s)\n", self->label);
951         return false;
952     }
953     self->final = true;
954     /*in = ir_instr_new(self, (v->vtype == TYPE_STRING ? INSTR_IF_S : INSTR_IF_F));*/
955     in = ir_instr_new(self, VINSTR_COND);
956     if (!in)
957         return false;
958
959     if (!ir_instr_op(in, 0, v, false)) {
960         ir_instr_delete(in);
961         return false;
962     }
963
964     in->bops[0] = ontrue;
965     in->bops[1] = onfalse;
966
967     if (!ir_block_instr_add(self, in))
968         return false;
969
970     if (!ir_block_exits_add(self, ontrue)    ||
971         !ir_block_exits_add(self, onfalse)   ||
972         !ir_block_entries_add(ontrue, self)  ||
973         !ir_block_entries_add(onfalse, self) )
974     {
975         return false;
976     }
977     return true;
978 }
979
980 bool ir_block_create_jump(ir_block *self, ir_block *to)
981 {
982     ir_instr *in;
983     if (self->final) {
984         fprintf(stderr, "block already ended (%s)\n", self->label);
985         return false;
986     }
987     self->final = true;
988     in = ir_instr_new(self, VINSTR_JUMP);
989     if (!in)
990         return false;
991
992     in->bops[0] = to;
993     if (!ir_block_instr_add(self, in))
994         return false;
995
996     if (!ir_block_exits_add(self, to) ||
997         !ir_block_entries_add(to, self) )
998     {
999         return false;
1000     }
1001     return true;
1002 }
1003
1004 bool ir_block_create_goto(ir_block *self, ir_block *to)
1005 {
1006     ir_instr *in;
1007     if (self->final) {
1008         fprintf(stderr, "block already ended (%s)\n", self->label);
1009         return false;
1010     }
1011     self->final = true;
1012     in = ir_instr_new(self, INSTR_GOTO);
1013     if (!in)
1014         return false;
1015
1016     in->bops[0] = to;
1017     if (!ir_block_instr_add(self, in))
1018         return false;
1019
1020     if (!ir_block_exits_add(self, to) ||
1021         !ir_block_entries_add(to, self) )
1022     {
1023         return false;
1024     }
1025     return true;
1026 }
1027
1028 ir_instr* ir_block_create_phi(ir_block *self, const char *label, int ot)
1029 {
1030     ir_value *out;
1031     ir_instr *in;
1032     in = ir_instr_new(self, VINSTR_PHI);
1033     if (!in)
1034         return NULL;
1035     out = ir_value_out(self->owner, label, store_value, ot);
1036     if (!out) {
1037         ir_instr_delete(in);
1038         return NULL;
1039     }
1040     if (!ir_instr_op(in, 0, out, true)) {
1041         ir_instr_delete(in);
1042         ir_value_delete(out);
1043         return NULL;
1044     }
1045     if (!ir_block_instr_add(self, in)) {
1046         ir_instr_delete(in);
1047         ir_value_delete(out);
1048         return NULL;
1049     }
1050     return in;
1051 }
1052
1053 ir_value* ir_phi_value(ir_instr *self)
1054 {
1055     return self->_ops[0];
1056 }
1057
1058 bool ir_phi_add(ir_instr* self, ir_block *b, ir_value *v)
1059 {
1060     ir_phi_entry_t pe;
1061
1062     if (!ir_block_entries_find(self->owner, b, NULL)) {
1063         /* Must not be possible to cause this, otherwise the AST
1064          * is doing something wrong.
1065          */
1066         fprintf(stderr, "Invalid entry block for PHI\n");
1067         abort();
1068     }
1069
1070     pe.value = v;
1071     pe.from = b;
1072     if (!ir_value_reads_add(v, self))
1073         return false;
1074     return ir_instr_phi_add(self, pe);
1075 }
1076
1077 /* call related code */
1078 ir_instr* ir_block_create_call(ir_block *self, const char *label, ir_value *func)
1079 {
1080     ir_value *out;
1081     ir_instr *in;
1082     in = ir_instr_new(self, INSTR_CALL0);
1083     if (!in)
1084         return NULL;
1085     out = ir_value_out(self->owner, label, store_return, func->outtype);
1086     if (!out) {
1087         ir_instr_delete(in);
1088         return NULL;
1089     }
1090     if (!ir_instr_op(in, 0, out, true) ||
1091         !ir_instr_op(in, 1, func, false) ||
1092         !ir_block_instr_add(self, in))
1093     {
1094         ir_instr_delete(in);
1095         ir_value_delete(out);
1096         return NULL;
1097     }
1098     return in;
1099 }
1100
1101 ir_value* ir_call_value(ir_instr *self)
1102 {
1103     return self->_ops[0];
1104 }
1105
1106 bool ir_call_param(ir_instr* self, ir_value *v)
1107 {
1108     if (!ir_instr_params_add(self, v))
1109         return false;
1110     if (!ir_value_reads_add(v, self)) {
1111         if (!ir_instr_params_remove(self, self->params_count-1))
1112             GMQCC_SUPPRESS_EMPTY_BODY;
1113         return false;
1114     }
1115     return true;
1116 }
1117
1118 /* binary op related code */
1119
1120 ir_value* ir_block_create_binop(ir_block *self,
1121                                 const char *label, int opcode,
1122                                 ir_value *left, ir_value *right)
1123 {
1124     int ot = TYPE_VOID;
1125     switch (opcode) {
1126         case INSTR_ADD_F:
1127         case INSTR_SUB_F:
1128         case INSTR_DIV_F:
1129         case INSTR_MUL_F:
1130         case INSTR_MUL_V:
1131         case INSTR_AND:
1132         case INSTR_OR:
1133 #if 0
1134         case INSTR_AND_I:
1135         case INSTR_AND_IF:
1136         case INSTR_AND_FI:
1137         case INSTR_OR_I:
1138         case INSTR_OR_IF:
1139         case INSTR_OR_FI:
1140 #endif
1141         case INSTR_BITAND:
1142         case INSTR_BITOR:
1143 #if 0
1144         case INSTR_SUB_S: /* -- offset of string as float */
1145         case INSTR_MUL_IF:
1146         case INSTR_MUL_FI:
1147         case INSTR_DIV_IF:
1148         case INSTR_DIV_FI:
1149         case INSTR_BITOR_IF:
1150         case INSTR_BITOR_FI:
1151         case INSTR_BITAND_FI:
1152         case INSTR_BITAND_IF:
1153         case INSTR_EQ_I:
1154         case INSTR_NE_I:
1155 #endif
1156             ot = TYPE_FLOAT;
1157             break;
1158 #if 0
1159         case INSTR_ADD_I:
1160         case INSTR_ADD_IF:
1161         case INSTR_ADD_FI:
1162         case INSTR_SUB_I:
1163         case INSTR_SUB_FI:
1164         case INSTR_SUB_IF:
1165         case INSTR_MUL_I:
1166         case INSTR_DIV_I:
1167         case INSTR_BITAND_I:
1168         case INSTR_BITOR_I:
1169         case INSTR_XOR_I:
1170         case INSTR_RSHIFT_I:
1171         case INSTR_LSHIFT_I:
1172             ot = TYPE_INTEGER;
1173             break;
1174 #endif
1175         case INSTR_ADD_V:
1176         case INSTR_SUB_V:
1177         case INSTR_MUL_VF:
1178 #if 0
1179         case INSTR_DIV_VF:
1180         case INSTR_MUL_IV:
1181         case INSTR_MUL_VI:
1182 #endif
1183             ot = TYPE_VECTOR;
1184             break;
1185 #if 0
1186         case INSTR_ADD_SF:
1187             ot = TYPE_POINTER;
1188             break;
1189 #endif
1190         default:
1191             /* ranges: */
1192             /* boolean operations result in floats */
1193             if (opcode >= INSTR_EQ_F && opcode <= INSTR_GT)
1194                 ot = TYPE_FLOAT;
1195             else if (opcode >= INSTR_LE && opcode <= INSTR_GT)
1196                 ot = TYPE_FLOAT;
1197 #if 0
1198             else if (opcode >= INSTR_LE_I && opcode <= INSTR_EQ_FI)
1199                 ot = TYPE_FLOAT;
1200 #endif
1201             break;
1202     };
1203     if (ot == TYPE_VOID) {
1204         /* The AST or parser were supposed to check this! */
1205         return NULL;
1206     }
1207
1208     return ir_block_create_general_instr(self, label, opcode, left, right, ot);
1209 }
1210
1211 ir_value* ir_block_create_general_instr(ir_block *self, const char *label,
1212                                         int op, ir_value *a, ir_value *b, int outype)
1213 {
1214     ir_instr *instr;
1215     ir_value *out;
1216
1217     out = ir_value_out(self->owner, label, store_value, outype);
1218     if (!out)
1219         return NULL;
1220
1221     instr = ir_instr_new(self, op);
1222     if (!instr) {
1223         ir_value_delete(out);
1224         return NULL;
1225     }
1226
1227     if (!ir_instr_op(instr, 0, out, true) ||
1228         !ir_instr_op(instr, 1, a, false) ||
1229         !ir_instr_op(instr, 2, b, false) )
1230     {
1231         goto on_error;
1232     }
1233
1234     if (!ir_block_instr_add(self, instr))
1235         goto on_error;
1236
1237     return out;
1238 on_error:
1239     ir_instr_delete(instr);
1240     ir_value_delete(out);
1241     return NULL;
1242 }
1243
1244 ir_value* ir_block_create_fieldaddress(ir_block *self, const char *label, ir_value *ent, ir_value *field)
1245 {
1246     /* Support for various pointer types todo if so desired */
1247     if (ent->vtype != TYPE_ENTITY)
1248         return NULL;
1249
1250     if (field->vtype != TYPE_FIELD)
1251         return NULL;
1252
1253     return ir_block_create_general_instr(self, label, INSTR_ADDRESS, ent, field, TYPE_POINTER);
1254 }
1255
1256 ir_value* ir_block_create_load_from_ent(ir_block *self, const char *label, ir_value *ent, ir_value *field, int outype)
1257 {
1258     int op;
1259     if (ent->vtype != TYPE_ENTITY)
1260         return NULL;
1261
1262     /* at some point we could redirect for TYPE_POINTER... but that could lead to carelessness */
1263     if (field->vtype != TYPE_FIELD)
1264         return NULL;
1265
1266     switch (outype)
1267     {
1268         case TYPE_FLOAT:   op = INSTR_LOAD_F;   break;
1269         case TYPE_VECTOR:  op = INSTR_LOAD_V;   break;
1270         case TYPE_STRING:  op = INSTR_LOAD_S;   break;
1271         case TYPE_FIELD:   op = INSTR_LOAD_FLD; break;
1272         case TYPE_ENTITY:  op = INSTR_LOAD_ENT; break;
1273 #if 0
1274         case TYPE_POINTER: op = INSTR_LOAD_I;   break;
1275         case TYPE_INTEGER: op = INSTR_LOAD_I;   break;
1276 #endif
1277         case TYPE_QUATERNION: op = INSTR_LOAD_Q; break;
1278         case TYPE_MATRIX:     op = INSTR_LOAD_M; break;
1279         default:
1280             return NULL;
1281     }
1282
1283     return ir_block_create_general_instr(self, label, op, ent, field, outype);
1284 }
1285
1286 ir_value* ir_block_create_add(ir_block *self,
1287                               const char *label,
1288                               ir_value *left, ir_value *right)
1289 {
1290     int op = 0;
1291     int l = left->vtype;
1292     int r = right->vtype;
1293     if (l == r) {
1294         switch (l) {
1295             default:
1296                 return NULL;
1297             case TYPE_FLOAT:
1298                 op = INSTR_ADD_F;
1299                 break;
1300 #if 0
1301             case TYPE_INTEGER:
1302                 op = INSTR_ADD_I;
1303                 break;
1304 #endif
1305             case TYPE_VECTOR:
1306                 op = INSTR_ADD_V;
1307                 break;
1308         }
1309     } else {
1310 #if 0
1311         if ( (l == TYPE_FLOAT && r == TYPE_INTEGER) )
1312             op = INSTR_ADD_FI;
1313         else if ( (l == TYPE_INTEGER && r == TYPE_FLOAT) )
1314             op = INSTR_ADD_IF;
1315         else
1316 #endif
1317             return NULL;
1318     }
1319     return ir_block_create_binop(self, label, op, left, right);
1320 }
1321
1322 ir_value* ir_block_create_sub(ir_block *self,
1323                               const char *label,
1324                               ir_value *left, ir_value *right)
1325 {
1326     int op = 0;
1327     int l = left->vtype;
1328     int r = right->vtype;
1329     if (l == r) {
1330
1331         switch (l) {
1332             default:
1333                 return NULL;
1334             case TYPE_FLOAT:
1335                 op = INSTR_SUB_F;
1336                 break;
1337 #if 0
1338             case TYPE_INTEGER:
1339                 op = INSTR_SUB_I;
1340                 break;
1341 #endif
1342             case TYPE_VECTOR:
1343                 op = INSTR_SUB_V;
1344                 break;
1345         }
1346     } else {
1347 #if 0
1348         if ( (l == TYPE_FLOAT && r == TYPE_INTEGER) )
1349             op = INSTR_SUB_FI;
1350         else if ( (l == TYPE_INTEGER && r == TYPE_FLOAT) )
1351             op = INSTR_SUB_IF;
1352         else
1353 #endif
1354             return NULL;
1355     }
1356     return ir_block_create_binop(self, label, op, left, right);
1357 }
1358
1359 ir_value* ir_block_create_mul(ir_block *self,
1360                               const char *label,
1361                               ir_value *left, ir_value *right)
1362 {
1363     int op = 0;
1364     int l = left->vtype;
1365     int r = right->vtype;
1366     if (l == r) {
1367
1368         switch (l) {
1369             default:
1370                 return NULL;
1371             case TYPE_FLOAT:
1372                 op = INSTR_MUL_F;
1373                 break;
1374 #if 0
1375             case TYPE_INTEGER:
1376                 op = INSTR_MUL_I;
1377                 break;
1378 #endif
1379             case TYPE_VECTOR:
1380                 op = INSTR_MUL_V;
1381                 break;
1382             case TYPE_QUATERNION:
1383                 op = INSTR_MUL_Q;
1384                 break;
1385             case TYPE_MATRIX:
1386                 op = INSTR_MUL_M;
1387                 break;
1388         }
1389     } else {
1390         if ( (l == TYPE_VECTOR && r == TYPE_FLOAT) )
1391             op = INSTR_MUL_VF;
1392         else if ( (l == TYPE_FLOAT && r == TYPE_VECTOR) )
1393             op = INSTR_MUL_FV;
1394         else if ( (l == TYPE_QUATERNION && r == TYPE_FLOAT) )
1395             op = INSTR_MUL_QF;
1396         else if ( (l == TYPE_MATRIX && r == TYPE_FLOAT) )
1397             op = INSTR_MUL_MF;
1398 #if 0
1399         else if ( (l == TYPE_VECTOR && r == TYPE_INTEGER) )
1400             op = INSTR_MUL_VI;
1401         else if ( (l == TYPE_INTEGER && r == TYPE_VECTOR) )
1402             op = INSTR_MUL_IV;
1403         else if ( (l == TYPE_FLOAT && r == TYPE_INTEGER) )
1404             op = INSTR_MUL_FI;
1405         else if ( (l == TYPE_INTEGER && r == TYPE_FLOAT) )
1406             op = INSTR_MUL_IF;
1407 #endif
1408         else
1409             return NULL;
1410     }
1411     return ir_block_create_binop(self, label, op, left, right);
1412 }
1413
1414 ir_value* ir_block_create_div(ir_block *self,
1415                               const char *label,
1416                               ir_value *left, ir_value *right)
1417 {
1418     int op = 0;
1419     int l = left->vtype;
1420     int r = right->vtype;
1421     if (l == r) {
1422
1423         switch (l) {
1424             default:
1425                 return NULL;
1426             case TYPE_FLOAT:
1427                 op = INSTR_DIV_F;
1428                 break;
1429 #if 0
1430             case TYPE_INTEGER:
1431                 op = INSTR_DIV_I;
1432                 break;
1433 #endif
1434         }
1435     } else {
1436 #if 0
1437         if ( (l == TYPE_VECTOR && r == TYPE_FLOAT) )
1438             op = INSTR_DIV_VF;
1439         else if ( (l == TYPE_FLOAT && r == TYPE_INTEGER) )
1440             op = INSTR_DIV_FI;
1441         else if ( (l == TYPE_INTEGER && r == TYPE_FLOAT) )
1442             op = INSTR_DIV_IF;
1443         else
1444 #endif
1445             return NULL;
1446     }
1447     return ir_block_create_binop(self, label, op, left, right);
1448 }
1449
1450 /* PHI resolving breaks the SSA, and must thus be the last
1451  * step before life-range calculation.
1452  */
1453
1454 static bool ir_block_naive_phi(ir_block *self);
1455 bool ir_function_naive_phi(ir_function *self)
1456 {
1457     size_t i;
1458
1459     for (i = 0; i < self->blocks_count; ++i)
1460     {
1461         if (!ir_block_naive_phi(self->blocks[i]))
1462             return false;
1463     }
1464     return true;
1465 }
1466
1467 static bool ir_naive_phi_emit_store(ir_block *block, size_t iid, ir_value *old, ir_value *what)
1468 {
1469     ir_instr *instr;
1470     size_t i;
1471
1472     /* create a store */
1473     if (!ir_block_create_store(block, old, what))
1474         return false;
1475
1476     /* we now move it up */
1477     instr = block->instr[block->instr_count-1];
1478     for (i = block->instr_count; i > iid; --i)
1479         block->instr[i] = block->instr[i-1];
1480     block->instr[i] = instr;
1481
1482     return true;
1483 }
1484
1485 static bool ir_block_naive_phi(ir_block *self)
1486 {
1487     size_t i, p, w;
1488     /* FIXME: optionally, create_phi can add the phis
1489      * to a list so we don't need to loop through blocks
1490      * - anyway: "don't optimize YET"
1491      */
1492     for (i = 0; i < self->instr_count; ++i)
1493     {
1494         ir_instr *instr = self->instr[i];
1495         if (instr->opcode != VINSTR_PHI)
1496             continue;
1497
1498         if (!ir_block_instr_remove(self, i))
1499             return false;
1500         --i; /* NOTE: i+1 below */
1501
1502         for (p = 0; p < instr->phi_count; ++p)
1503         {
1504             ir_value *v = instr->phi[p].value;
1505             for (w = 0; w < v->writes_count; ++w) {
1506                 ir_value *old;
1507
1508                 if (!v->writes[w]->_ops[0])
1509                     continue;
1510
1511                 /* When the write was to a global, we have to emit a mov */
1512                 old = v->writes[w]->_ops[0];
1513
1514                 /* The original instruction now writes to the PHI target local */
1515                 if (v->writes[w]->_ops[0] == v)
1516                     v->writes[w]->_ops[0] = instr->_ops[0];
1517
1518                 if (old->store != store_value && old->store != store_local)
1519                 {
1520                     /* If it originally wrote to a global we need to store the value
1521                      * there as welli
1522                      */
1523                     if (!ir_naive_phi_emit_store(self, i+1, old, v))
1524                         return false;
1525                     if (i+1 < self->instr_count)
1526                         instr = self->instr[i+1];
1527                     else
1528                         instr = NULL;
1529                     /* In case I forget and access instr later, it'll be NULL
1530                      * when it's a problem, to make sure we crash, rather than accessing
1531                      * invalid data.
1532                      */
1533                 }
1534                 else
1535                 {
1536                     /* If it didn't, we can replace all reads by the phi target now. */
1537                     size_t r;
1538                     for (r = 0; r < old->reads_count; ++r)
1539                     {
1540                         size_t op;
1541                         ir_instr *ri = old->reads[r];
1542                         for (op = 0; op < ri->phi_count; ++op) {
1543                             if (ri->phi[op].value == old)
1544                                 ri->phi[op].value = v;
1545                         }
1546                         for (op = 0; op < 3; ++op) {
1547                             if (ri->_ops[op] == old)
1548                                 ri->_ops[op] = v;
1549                         }
1550                     }
1551                 }
1552             }
1553         }
1554         ir_instr_delete(instr);
1555     }
1556     return true;
1557 }
1558
1559 /***********************************************************************
1560  *IR Temp allocation code
1561  * Propagating value life ranges by walking through the function backwards
1562  * until no more changes are made.
1563  * In theory this should happen once more than once for every nested loop
1564  * level.
1565  * Though this implementation might run an additional time for if nests.
1566  */
1567
1568 typedef struct
1569 {
1570     ir_value* *v;
1571     size_t    v_count;
1572     size_t    v_alloc;
1573 } new_reads_t;
1574 MEM_VEC_FUNCTIONS_ALL(new_reads_t, ir_value*, v)
1575
1576 /* Enumerate instructions used by value's life-ranges
1577  */
1578 static void ir_block_enumerate(ir_block *self, size_t *_eid)
1579 {
1580     size_t i;
1581     size_t eid = *_eid;
1582     for (i = 0; i < self->instr_count; ++i)
1583     {
1584         self->instr[i]->eid = eid++;
1585     }
1586     *_eid = eid;
1587 }
1588
1589 /* Enumerate blocks and instructions.
1590  * The block-enumeration is unordered!
1591  * We do not really use the block enumreation, however
1592  * the instruction enumeration is important for life-ranges.
1593  */
1594 void ir_function_enumerate(ir_function *self)
1595 {
1596     size_t i;
1597     size_t instruction_id = 0;
1598     for (i = 0; i < self->blocks_count; ++i)
1599     {
1600         self->blocks[i]->eid = i;
1601         self->blocks[i]->run_id = 0;
1602         ir_block_enumerate(self->blocks[i], &instruction_id);
1603     }
1604 }
1605
1606 static bool ir_block_life_propagate(ir_block *b, ir_block *prev, bool *changed);
1607 bool ir_function_calculate_liferanges(ir_function *self)
1608 {
1609     size_t i;
1610     bool changed;
1611
1612     do {
1613         self->run_id++;
1614         changed = false;
1615         for (i = 0; i != self->blocks_count; ++i)
1616         {
1617             if (self->blocks[i]->is_return)
1618             {
1619                 if (!ir_block_life_propagate(self->blocks[i], NULL, &changed))
1620                     return false;
1621             }
1622         }
1623     } while (changed);
1624     return true;
1625 }
1626
1627 /* Local-value allocator
1628  * After finishing creating the liferange of all values used in a function
1629  * we can allocate their global-positions.
1630  * This is the counterpart to register-allocation in register machines.
1631  */
1632 typedef struct {
1633     MEM_VECTOR_MAKE(ir_value*, locals);
1634     MEM_VECTOR_MAKE(size_t,    sizes);
1635     MEM_VECTOR_MAKE(size_t,    positions);
1636 } function_allocator;
1637 MEM_VEC_FUNCTIONS(function_allocator, ir_value*, locals)
1638 MEM_VEC_FUNCTIONS(function_allocator, size_t,    sizes)
1639 MEM_VEC_FUNCTIONS(function_allocator, size_t,    positions)
1640
1641 static bool function_allocator_alloc(function_allocator *alloc, const ir_value *var)
1642 {
1643     ir_value *slot;
1644     size_t vsize = type_sizeof[var->vtype];
1645
1646     slot = ir_value_var("reg", store_global, var->vtype);
1647     if (!slot)
1648         return false;
1649
1650     if (!ir_value_life_merge_into(slot, var))
1651         goto localerror;
1652
1653     if (!function_allocator_locals_add(alloc, slot))
1654         goto localerror;
1655
1656     if (!function_allocator_sizes_add(alloc, vsize))
1657         goto localerror;
1658
1659     return true;
1660
1661 localerror:
1662     ir_value_delete(slot);
1663     return false;
1664 }
1665
1666 bool ir_function_allocate_locals(ir_function *self)
1667 {
1668     size_t i, a;
1669     bool   retval = true;
1670     size_t pos;
1671
1672     ir_value *slot;
1673     const ir_value *v;
1674
1675     function_allocator alloc;
1676
1677     if (!self->locals_count)
1678         return true;
1679
1680     MEM_VECTOR_INIT(&alloc, locals);
1681     MEM_VECTOR_INIT(&alloc, sizes);
1682     MEM_VECTOR_INIT(&alloc, positions);
1683
1684     for (i = 0; i < self->locals_count; ++i)
1685     {
1686         if (!function_allocator_alloc(&alloc, self->locals[i]))
1687             goto error;
1688     }
1689
1690     /* Allocate a slot for any value that still exists */
1691     for (i = 0; i < self->values_count; ++i)
1692     {
1693         v = self->values[i];
1694
1695         if (!v->life_count)
1696             continue;
1697
1698         for (a = 0; a < alloc.locals_count; ++a)
1699         {
1700             slot = alloc.locals[a];
1701
1702             if (ir_values_overlap(v, slot))
1703                 continue;
1704
1705             if (!ir_value_life_merge_into(slot, v))
1706                 goto error;
1707
1708             /* adjust size for this slot */
1709             if (alloc.sizes[a] < type_sizeof[v->vtype])
1710                 alloc.sizes[a] = type_sizeof[v->vtype];
1711
1712             self->values[i]->code.local = a;
1713             break;
1714         }
1715         if (a >= alloc.locals_count) {
1716             self->values[i]->code.local = alloc.locals_count;
1717             if (!function_allocator_alloc(&alloc, v))
1718                 goto error;
1719         }
1720     }
1721
1722     /* Adjust slot positions based on sizes */
1723     if (!function_allocator_positions_add(&alloc, 0))
1724         goto error;
1725
1726     if (alloc.sizes_count)
1727         pos = alloc.positions[0] + alloc.sizes[0];
1728     else
1729         pos = 0;
1730     for (i = 1; i < alloc.sizes_count; ++i)
1731     {
1732         pos = alloc.positions[i-1] + alloc.sizes[i-1];
1733         if (!function_allocator_positions_add(&alloc, pos))
1734             goto error;
1735     }
1736
1737     self->allocated_locals = pos + alloc.sizes[alloc.sizes_count-1];
1738
1739     /* Take over the actual slot positions */
1740     for (i = 0; i < self->values_count; ++i)
1741         self->values[i]->code.local = alloc.positions[self->values[i]->code.local];
1742
1743     goto cleanup;
1744
1745 error:
1746     retval = false;
1747 cleanup:
1748     for (i = 0; i < alloc.locals_count; ++i)
1749         ir_value_delete(alloc.locals[i]);
1750     MEM_VECTOR_CLEAR(&alloc, locals);
1751     MEM_VECTOR_CLEAR(&alloc, sizes);
1752     MEM_VECTOR_CLEAR(&alloc, positions);
1753     return retval;
1754 }
1755
1756 /* Get information about which operand
1757  * is read from, or written to.
1758  */
1759 static void ir_op_read_write(int op, size_t *read, size_t *write)
1760 {
1761     switch (op)
1762     {
1763     case VINSTR_JUMP:
1764     case INSTR_GOTO:
1765         *write = 0;
1766         *read = 0;
1767         break;
1768     case INSTR_IF:
1769     case INSTR_IFNOT:
1770 #if 0
1771     case INSTR_IF_S:
1772     case INSTR_IFNOT_S:
1773 #endif
1774     case INSTR_RETURN:
1775     case VINSTR_COND:
1776         *write = 0;
1777         *read = 1;
1778         break;
1779     default:
1780         *write = 1;
1781         *read = 6;
1782         break;
1783     };
1784 }
1785
1786 static bool ir_block_living_add_instr(ir_block *self, size_t eid)
1787 {
1788     size_t i;
1789     bool changed = false;
1790     bool tempbool;
1791     for (i = 0; i != self->living_count; ++i)
1792     {
1793         tempbool = ir_value_life_merge(self->living[i], eid);
1794         /* debug
1795         if (tempbool)
1796             fprintf(stderr, "block_living_add_instr() value instruction added %s: %i\n", self->living[i]->_name, (int)eid);
1797         */
1798         changed = changed || tempbool;
1799     }
1800     return changed;
1801 }
1802
1803 static bool ir_block_life_prop_previous(ir_block* self, ir_block *prev, bool *changed)
1804 {
1805     size_t i;
1806     /* values which have been read in a previous iteration are now
1807      * in the "living" array even if the previous block doesn't use them.
1808      * So we have to remove whatever does not exist in the previous block.
1809      * They will be re-added on-read, but the liferange merge won't cause
1810      * a change.
1811      */
1812     for (i = 0; i < self->living_count; ++i)
1813     {
1814         if (!ir_block_living_find(prev, self->living[i], NULL)) {
1815             if (!ir_block_living_remove(self, i))
1816                 return false;
1817             --i;
1818         }
1819     }
1820
1821     /* Whatever the previous block still has in its living set
1822      * must now be added to ours as well.
1823      */
1824     for (i = 0; i < prev->living_count; ++i)
1825     {
1826         if (ir_block_living_find(self, prev->living[i], NULL))
1827             continue;
1828         if (!ir_block_living_add(self, prev->living[i]))
1829             return false;
1830         /*
1831         printf("%s got from prev: %s\n", self->label, prev->living[i]->_name);
1832         */
1833     }
1834     return true;
1835 }
1836
1837 static bool ir_block_life_propagate(ir_block *self, ir_block *prev, bool *changed)
1838 {
1839     ir_instr *instr;
1840     ir_value *value;
1841     bool  tempbool;
1842     size_t i, o, p;
1843     /* bitmasks which operands are read from or written to */
1844     size_t read, write;
1845 #if defined(LIFE_RANGE_WITHOUT_LAST_READ)
1846     size_t rd;
1847     new_reads_t new_reads;
1848 #endif
1849     char dbg_ind[16] = { '#', '0' };
1850     (void)dbg_ind;
1851
1852 #if defined(LIFE_RANGE_WITHOUT_LAST_READ)
1853     MEM_VECTOR_INIT(&new_reads, v);
1854 #endif
1855
1856     if (prev)
1857     {
1858         if (!ir_block_life_prop_previous(self, prev, changed))
1859             return false;
1860     }
1861
1862     i = self->instr_count;
1863     while (i)
1864     { --i;
1865         instr = self->instr[i];
1866
1867         /* PHI operands are always read operands */
1868         for (p = 0; p < instr->phi_count; ++p)
1869         {
1870             value = instr->phi[p].value;
1871 #if ! defined(LIFE_RANGE_WITHOUT_LAST_READ)
1872             if (!ir_block_living_find(self, value, NULL) &&
1873                 !ir_block_living_add(self, value))
1874             {
1875                 goto on_error;
1876             }
1877 #else
1878             if (!new_reads_t_v_find(&new_reads, value, NULL))
1879             {
1880                 if (!new_reads_t_v_add(&new_reads, value))
1881                     goto on_error;
1882             }
1883 #endif
1884         }
1885
1886         /* See which operands are read and write operands */
1887         ir_op_read_write(instr->opcode, &read, &write);
1888
1889         /* Go through the 3 main operands */
1890         for (o = 0; o < 3; ++o)
1891         {
1892             if (!instr->_ops[o]) /* no such operand */
1893                 continue;
1894
1895             value = instr->_ops[o];
1896
1897             /* We only care about locals */
1898             if (value->store != store_value &&
1899                 value->store != store_local)
1900                 continue;
1901
1902             /* read operands */
1903             if (read & (1<<o))
1904             {
1905 #if ! defined(LIFE_RANGE_WITHOUT_LAST_READ)
1906                 if (!ir_block_living_find(self, value, NULL) &&
1907                     !ir_block_living_add(self, value))
1908                 {
1909                     goto on_error;
1910                 }
1911 #else
1912                 /* fprintf(stderr, "read: %s\n", value->_name); */
1913                 if (!new_reads_t_v_find(&new_reads, value, NULL))
1914                 {
1915                     if (!new_reads_t_v_add(&new_reads, value))
1916                         goto on_error;
1917                 }
1918 #endif
1919             }
1920
1921             /* write operands */
1922             /* When we write to a local, we consider it "dead" for the
1923              * remaining upper part of the function, since in SSA a value
1924              * can only be written once (== created)
1925              */
1926             if (write & (1<<o))
1927             {
1928                 size_t idx;
1929                 bool in_living = ir_block_living_find(self, value, &idx);
1930 #if defined(LIFE_RANGE_WITHOUT_LAST_READ)
1931                 size_t readidx;
1932                 bool in_reads = new_reads_t_v_find(&new_reads, value, &readidx);
1933                 if (!in_living && !in_reads)
1934 #else
1935                 if (!in_living)
1936 #endif
1937                 {
1938                     /* If the value isn't alive it hasn't been read before... */
1939                     /* TODO: See if the warning can be emitted during parsing or AST processing
1940                      * otherwise have warning printed here.
1941                      * IF printing a warning here: include filecontext_t,
1942                      * and make sure it's only printed once
1943                      * since this function is run multiple times.
1944                      */
1945                     /* For now: debug info: */
1946                     fprintf(stderr, "Value only written %s\n", value->name);
1947                     tempbool = ir_value_life_merge(value, instr->eid);
1948                     *changed = *changed || tempbool;
1949                     /*
1950                     ir_instr_dump(instr, dbg_ind, printf);
1951                     abort();
1952                     */
1953                 } else {
1954                     /* since 'living' won't contain it
1955                      * anymore, merge the value, since
1956                      * (A) doesn't.
1957                      */
1958                     tempbool = ir_value_life_merge(value, instr->eid);
1959                     /*
1960                     if (tempbool)
1961                         fprintf(stderr, "value added id %s %i\n", value->name, (int)instr->eid);
1962                     */
1963                     *changed = *changed || tempbool;
1964                     /* Then remove */
1965 #if ! defined(LIFE_RANGE_WITHOUT_LAST_READ)
1966                     if (!ir_block_living_remove(self, idx))
1967                         goto on_error;
1968 #else
1969                     if (in_reads)
1970                     {
1971                         if (!new_reads_t_v_remove(&new_reads, readidx))
1972                             goto on_error;
1973                     }
1974 #endif
1975                 }
1976             }
1977         }
1978         /* (A) */
1979         tempbool = ir_block_living_add_instr(self, instr->eid);
1980         /*fprintf(stderr, "living added values\n");*/
1981         *changed = *changed || tempbool;
1982
1983 #if defined(LIFE_RANGE_WITHOUT_LAST_READ)
1984         /* new reads: */
1985         for (rd = 0; rd < new_reads.v_count; ++rd)
1986         {
1987             if (!ir_block_living_find(self, new_reads.v[rd], NULL)) {
1988                 if (!ir_block_living_add(self, new_reads.v[rd]))
1989                     goto on_error;
1990             }
1991             if (!i && !self->entries_count) {
1992                 /* fix the top */
1993                 *changed = *changed || ir_value_life_merge(new_reads.v[rd], instr->eid);
1994             }
1995         }
1996         MEM_VECTOR_CLEAR(&new_reads, v);
1997 #endif
1998     }
1999
2000     if (self->run_id == self->owner->run_id)
2001         return true;
2002
2003     self->run_id = self->owner->run_id;
2004
2005     for (i = 0; i < self->entries_count; ++i)
2006     {
2007         ir_block *entry = self->entries[i];
2008         ir_block_life_propagate(entry, self, changed);
2009     }
2010
2011     return true;
2012 on_error:
2013 #if defined(LIFE_RANGE_WITHOUT_LAST_READ)
2014     MEM_VECTOR_CLEAR(&new_reads, v);
2015 #endif
2016     return false;
2017 }
2018
2019 /***********************************************************************
2020  *IR Code-Generation
2021  *
2022  * Since the IR has the convention of putting 'write' operands
2023  * at the beginning, we have to rotate the operands of instructions
2024  * properly in order to generate valid QCVM code.
2025  *
2026  * Having destinations at a fixed position is more convenient. In QC
2027  * this is *mostly* OPC,  but FTE adds at least 2 instructions which
2028  * read from from OPA,  and store to OPB rather than OPC.   Which is
2029  * partially the reason why the implementation of these instructions
2030  * in darkplaces has been delayed for so long.
2031  *
2032  * Breaking conventions is annoying...
2033  */
2034 static bool ir_builder_gen_global(ir_builder *self, ir_value *global);
2035
2036 static bool gen_global_field(ir_value *global)
2037 {
2038     if (global->isconst)
2039     {
2040         ir_value *fld = global->constval.vpointer;
2041         if (!fld) {
2042             printf("Invalid field constant with no field: %s\n", global->name);
2043             return false;
2044         }
2045
2046         /* Now, in this case, a relocation would be impossible to code
2047          * since it looks like this:
2048          * .vector v = origin;     <- parse error, wtf is 'origin'?
2049          * .vector origin;
2050          *
2051          * But we will need a general relocation support later anyway
2052          * for functions... might as well support that here.
2053          */
2054         if (!fld->code.globaladdr) {
2055             printf("FIXME: Relocation support\n");
2056             return false;
2057         }
2058
2059         /* copy the field's value */
2060         global->code.globaladdr = code_globals_add(code_globals_data[fld->code.globaladdr]);
2061     }
2062     else
2063     {
2064         prog_section_field fld;
2065
2066         fld.name = global->code.name;
2067         fld.offset = code_fields_elements;
2068         fld.type = global->fieldtype;
2069
2070         if (fld.type == TYPE_VOID) {
2071             printf("Field is missing a type: %s\n", global->name);
2072             return false;
2073         }
2074
2075         if (code_fields_add(fld) < 0)
2076             return false;
2077
2078         global->code.globaladdr = code_globals_add(fld.offset);
2079     }
2080     if (global->code.globaladdr < 0)
2081         return false;
2082     return true;
2083 }
2084
2085 static bool gen_global_pointer(ir_value *global)
2086 {
2087     if (global->isconst)
2088     {
2089         ir_value *target = global->constval.vpointer;
2090         if (!target) {
2091             printf("Invalid pointer constant: %s\n", global->name);
2092             /* NULL pointers are pointing to the NULL constant, which also
2093              * sits at address 0, but still has an ir_value for itself.
2094              */
2095             return false;
2096         }
2097
2098         /* Here, relocations ARE possible - in fteqcc-enhanced-qc:
2099          * void() foo; <- proto
2100          * void() *fooptr = &foo;
2101          * void() foo = { code }
2102          */
2103         if (!target->code.globaladdr) {
2104             /* FIXME: Check for the constant nullptr ir_value!
2105              * because then code.globaladdr being 0 is valid.
2106              */
2107             printf("FIXME: Relocation support\n");
2108             return false;
2109         }
2110
2111         global->code.globaladdr = code_globals_add(target->code.globaladdr);
2112     }
2113     else
2114     {
2115         global->code.globaladdr = code_globals_add(0);
2116     }
2117     if (global->code.globaladdr < 0)
2118         return false;
2119     return true;
2120 }
2121
2122 static bool gen_blocks_recursive(ir_function *func, ir_block *block)
2123 {
2124     prog_section_statement stmt;
2125     ir_instr *instr;
2126     ir_block *target;
2127     ir_block *ontrue;
2128     ir_block *onfalse;
2129     size_t    stidx;
2130     size_t    i;
2131
2132 tailcall:
2133     block->generated = true;
2134     block->code_start = code_statements_elements;
2135     for (i = 0; i < block->instr_count; ++i)
2136     {
2137         instr = block->instr[i];
2138
2139         if (instr->opcode == VINSTR_PHI) {
2140             printf("cannot generate virtual instruction (phi)\n");
2141             return false;
2142         }
2143
2144         if (instr->opcode == VINSTR_JUMP) {
2145             target = instr->bops[0];
2146             /* for uncoditional jumps, if the target hasn't been generated
2147              * yet, we generate them right here.
2148              */
2149             if (!target->generated) {
2150                 block = target;
2151                 goto tailcall;
2152             }
2153
2154             /* otherwise we generate a jump instruction */
2155             stmt.opcode = INSTR_GOTO;
2156             stmt.o1.s1 = (target->code_start) - code_statements_elements;
2157             stmt.o2.s1 = 0;
2158             stmt.o3.s1 = 0;
2159             if (code_statements_add(stmt) < 0)
2160                 return false;
2161
2162             /* no further instructions can be in this block */
2163             return true;
2164         }
2165
2166         if (instr->opcode == VINSTR_COND) {
2167             ontrue  = instr->bops[0];
2168             onfalse = instr->bops[1];
2169             /* TODO: have the AST signal which block should
2170              * come first: eg. optimize IFs without ELSE...
2171              */
2172
2173             stmt.o1.u1 = instr->_ops[0]->code.globaladdr;
2174             stmt.o2.u1 = 0;
2175             stmt.o3.s1 = 0;
2176
2177             if (ontrue->generated) {
2178                 stmt.opcode = INSTR_IF;
2179                 stmt.o2.s1 = (ontrue->code_start-1) - code_statements_elements;
2180                 if (code_statements_add(stmt) < 0)
2181                     return false;
2182             }
2183             if (onfalse->generated) {
2184                 stmt.opcode = INSTR_IFNOT;
2185                 stmt.o2.s1 = (onfalse->code_start-1) - code_statements_elements;
2186                 if (code_statements_add(stmt) < 0)
2187                     return false;
2188             }
2189             if (!ontrue->generated) {
2190                 if (onfalse->generated) {
2191                     block = ontrue;
2192                     goto tailcall;
2193                 }
2194             }
2195             if (!onfalse->generated) {
2196                 if (ontrue->generated) {
2197                     block = onfalse;
2198                     goto tailcall;
2199                 }
2200             }
2201             /* neither ontrue nor onfalse exist */
2202             stmt.opcode = INSTR_IFNOT;
2203             stidx = code_statements_elements;
2204             if (code_statements_add(stmt) < 0)
2205                 return false;
2206             /* on false we jump, so add ontrue-path */
2207             if (!gen_blocks_recursive(func, ontrue))
2208                 return false;
2209             /* fixup the jump address */
2210             code_statements_data[stidx].o2.s1 = code_statements_elements - stidx;
2211             /* generate onfalse path */
2212             if (onfalse->generated) {
2213                 /* fixup the jump address */
2214                 code_statements_data[stidx].o2.s1 = (onfalse->code_start) - (stidx);
2215                 /* may have been generated in the previous recursive call */
2216                 stmt.opcode = INSTR_GOTO;
2217                 stmt.o1.s1 = (onfalse->code_start) - code_statements_elements;
2218                 stmt.o2.s1 = 0;
2219                 stmt.o3.s1 = 0;
2220                 return (code_statements_add(stmt) >= 0);
2221             }
2222             /* if not, generate now */
2223             block = onfalse;
2224             goto tailcall;
2225         }
2226
2227         if (instr->opcode >= INSTR_CALL0 && instr->opcode <= INSTR_CALL8) {
2228             /* Trivial call translation:
2229              * copy all params to OFS_PARM*
2230              * if the output's storetype is not store_return,
2231              * add append a STORE instruction!
2232              *
2233              * NOTES on how to do it better without much trouble:
2234              * -) The liferanges!
2235              *      Simply check the liferange of all parameters for
2236              *      other CALLs. For each param with no CALL in its
2237              *      liferange, we can store it in an OFS_PARM at
2238              *      generation already. This would even include later
2239              *      reuse.... probably... :)
2240              */
2241             size_t p;
2242             ir_value *retvalue;
2243
2244             for (p = 0; p < instr->params_count; ++p)
2245             {
2246                 ir_value *param = instr->params[p];
2247
2248                 stmt.opcode = INSTR_STORE_F;
2249                 stmt.o3.u1 = 0;
2250
2251                 stmt.opcode = type_store_instr[param->vtype];
2252                 stmt.o1.u1 = param->code.globaladdr;
2253                 stmt.o2.u1 = OFS_PARM0 + 3 * p;
2254                 if (code_statements_add(stmt) < 0)
2255                     return false;
2256             }
2257             stmt.opcode = INSTR_CALL0 + instr->params_count;
2258             if (stmt.opcode > INSTR_CALL8)
2259                 stmt.opcode = INSTR_CALL8;
2260             stmt.o1.u1 = instr->_ops[1]->code.globaladdr;
2261             stmt.o2.u1 = 0;
2262             stmt.o3.u1 = 0;
2263             if (code_statements_add(stmt) < 0)
2264                 return false;
2265
2266             retvalue = instr->_ops[0];
2267             if (retvalue && retvalue->store != store_return && retvalue->life_count)
2268             {
2269                 /* not to be kept in OFS_RETURN */
2270                 stmt.opcode = type_store_instr[retvalue->vtype];
2271                 stmt.o1.u1 = OFS_RETURN;
2272                 stmt.o2.u1 = retvalue->code.globaladdr;
2273                 stmt.o3.u1 = 0;
2274                 if (code_statements_add(stmt) < 0)
2275                     return false;
2276             }
2277             continue;
2278         }
2279
2280         if (instr->opcode == INSTR_STATE) {
2281             printf("TODO: state instruction\n");
2282             return false;
2283         }
2284
2285         stmt.opcode = instr->opcode;
2286         stmt.o1.u1 = 0;
2287         stmt.o2.u1 = 0;
2288         stmt.o3.u1 = 0;
2289
2290         /* This is the general order of operands */
2291         if (instr->_ops[0])
2292             stmt.o3.u1 = instr->_ops[0]->code.globaladdr;
2293
2294         if (instr->_ops[1])
2295             stmt.o1.u1 = instr->_ops[1]->code.globaladdr;
2296
2297         if (instr->_ops[2])
2298             stmt.o2.u1 = instr->_ops[2]->code.globaladdr;
2299
2300         if (stmt.opcode == INSTR_RETURN || stmt.opcode == INSTR_DONE)
2301         {
2302             stmt.o1.u1 = stmt.o3.u1;
2303             stmt.o3.u1 = 0;
2304         }
2305         else if ((stmt.opcode >= INSTR_STORE_F    &&
2306                   stmt.opcode <= INSTR_STORE_FNC)    ||
2307                  (stmt.opcode >= INSTR_NOT_F      &&
2308                   stmt.opcode <= INSTR_NOT_FNC))
2309         {
2310             /* 2-operand instructions with A -> B */
2311             stmt.o2.u1 = stmt.o3.u1;
2312             stmt.o3.u1 = 0;
2313         }
2314
2315         if (code_statements_add(stmt) < 0)
2316             return false;
2317     }
2318     return true;
2319 }
2320
2321 static bool gen_function_code(ir_function *self)
2322 {
2323     ir_block *block;
2324     prog_section_statement stmt;
2325
2326     /* Starting from entry point, we generate blocks "as they come"
2327      * for now. Dead blocks will not be translated obviously.
2328      */
2329     if (!self->blocks_count) {
2330         printf("Function '%s' declared without body.\n", self->name);
2331         return false;
2332     }
2333
2334     block = self->blocks[0];
2335     if (block->generated)
2336         return true;
2337
2338     if (!gen_blocks_recursive(self, block)) {
2339         printf("failed to generate blocks for '%s'\n", self->name);
2340         return false;
2341     }
2342
2343     /* otherwise code_write crashes since it debug-prints functions until AINSTR_END */
2344     stmt.opcode = AINSTR_END;
2345     stmt.o1.u1 = 0;
2346     stmt.o2.u1 = 0;
2347     stmt.o3.u1 = 0;
2348     if (code_statements_add(stmt) < 0)
2349         return false;
2350     return true;
2351 }
2352
2353 static bool gen_global_function(ir_builder *ir, ir_value *global)
2354 {
2355     prog_section_function fun;
2356     ir_function          *irfun;
2357
2358     size_t i;
2359     size_t local_var_end;
2360
2361     if (!global->isconst || (!global->constval.vfunc))
2362     {
2363         printf("Invalid state of function-global: not constant: %s\n", global->name);
2364         return false;
2365     }
2366
2367     irfun = global->constval.vfunc;
2368
2369     fun.name    = global->code.name;
2370     fun.file    = code_cachedstring(global->context.file);
2371     fun.profile = 0; /* always 0 */
2372     fun.nargs   = irfun->params_count;
2373
2374     for (i = 0;i < 8; ++i) {
2375         if (i >= fun.nargs)
2376             fun.argsize[i] = 0;
2377         else
2378             fun.argsize[i] = type_sizeof[irfun->params[i]];
2379     }
2380
2381     fun.firstlocal = code_globals_elements;
2382     fun.locals     = irfun->allocated_locals + irfun->locals_count;
2383
2384     local_var_end = 0;
2385     for (i = 0; i < irfun->locals_count; ++i) {
2386         if (!ir_builder_gen_global(ir, irfun->locals[i])) {
2387             printf("Failed to generate global %s\n", irfun->locals[i]->name);
2388             return false;
2389         }
2390     }
2391     if (irfun->locals_count) {
2392         ir_value *last = irfun->locals[irfun->locals_count-1];
2393         local_var_end = last->code.globaladdr;
2394         local_var_end += type_sizeof[last->vtype];
2395     }
2396     for (i = 0; i < irfun->values_count; ++i)
2397     {
2398         /* generate code.globaladdr for ssa values */
2399         ir_value *v = irfun->values[i];
2400         v->code.globaladdr = local_var_end + v->code.local;
2401     }
2402     for (i = 0; i < irfun->locals_count; ++i) {
2403         /* fill the locals with zeros */
2404         code_globals_add(0);
2405     }
2406
2407     if (irfun->builtin)
2408         fun.entry = irfun->builtin;
2409     else {
2410         fun.entry = code_statements_elements;
2411         if (!gen_function_code(irfun)) {
2412             printf("Failed to generate code for function %s\n", irfun->name);
2413             return false;
2414         }
2415     }
2416
2417     return (code_functions_add(fun) >= 0);
2418 }
2419
2420 static bool ir_builder_gen_global(ir_builder *self, ir_value *global)
2421 {
2422     int32_t         *iptr;
2423     prog_section_def def;
2424
2425     def.type   = global->vtype;
2426     def.offset = code_globals_elements;
2427     def.name   = global->code.name       = code_genstring(global->name);
2428
2429     switch (global->vtype)
2430     {
2431     case TYPE_POINTER:
2432         if (code_defs_add(def) < 0)
2433             return false;
2434         return gen_global_pointer(global);
2435     case TYPE_FIELD:
2436         if (code_defs_add(def) < 0)
2437             return false;
2438         return gen_global_field(global);
2439     case TYPE_ENTITY:
2440         /* fall through */
2441     case TYPE_FLOAT:
2442     {
2443         if (code_defs_add(def) < 0)
2444             return false;
2445
2446         if (global->isconst) {
2447             iptr = (int32_t*)&global->constval.vfloat;
2448             global->code.globaladdr = code_globals_add(*iptr);
2449         } else
2450             global->code.globaladdr = code_globals_add(0);
2451
2452         return global->code.globaladdr >= 0;
2453     }
2454     case TYPE_STRING:
2455     {
2456         if (code_defs_add(def) < 0)
2457             return false;
2458         if (global->isconst)
2459             global->code.globaladdr = code_globals_add(code_cachedstring(global->constval.vstring));
2460         else
2461             global->code.globaladdr = code_globals_add(0);
2462         return global->code.globaladdr >= 0;
2463     }
2464     case TYPE_VECTOR:
2465     case TYPE_QUATERNION:
2466     case TYPE_MATRIX:
2467     {
2468         size_t d;
2469         if (code_defs_add(def) < 0)
2470             return false;
2471
2472         if (global->isconst) {
2473             iptr = (int32_t*)&global->constval.vvec;
2474             global->code.globaladdr = code_globals_add(iptr[0]);
2475             if (global->code.globaladdr < 0)
2476                 return false;
2477             for (d = 1; d < type_sizeof[global->vtype]; ++d)
2478             {
2479                 if (code_globals_add(iptr[d]) < 0)
2480                     return false;
2481             }
2482         } else {
2483             global->code.globaladdr = code_globals_add(0);
2484             if (global->code.globaladdr < 0)
2485                 return false;
2486             for (d = 1; d < type_sizeof[global->vtype]; ++d)
2487             {
2488                 if (code_globals_add(0) < 0)
2489                     return false;
2490             }
2491         }
2492         return global->code.globaladdr >= 0;
2493     }
2494     case TYPE_FUNCTION:
2495         if (code_defs_add(def) < 0)
2496             return false;
2497         global->code.globaladdr = code_globals_elements;
2498         code_globals_add(code_functions_elements);
2499         return gen_global_function(self, global);
2500     case TYPE_VARIANT:
2501         /* assume biggest type */
2502             global->code.globaladdr = code_globals_add(0);
2503             code_globals_add(0);
2504             code_globals_add(0);
2505             return true;
2506     default:
2507         /* refuse to create 'void' type or any other fancy business. */
2508         printf("Invalid type for global variable %s\n", global->name);
2509         return false;
2510     }
2511 }
2512
2513 bool ir_builder_generate(ir_builder *self, const char *filename)
2514 {
2515     size_t i;
2516
2517     code_init();
2518
2519     for (i = 0; i < self->globals_count; ++i)
2520     {
2521         if (!ir_builder_gen_global(self, self->globals[i])) {
2522             return false;
2523         }
2524     }
2525
2526     printf("writing '%s'...\n", filename);
2527     return code_write(filename);
2528 }
2529
2530 /***********************************************************************
2531  *IR DEBUG Dump functions...
2532  */
2533
2534 #define IND_BUFSZ 1024
2535
2536 const char *qc_opname(int op)
2537 {
2538     if (op < 0) return "<INVALID>";
2539     if (op < ( sizeof(asm_instr) / sizeof(asm_instr[0]) ))
2540         return asm_instr[op].m;
2541     switch (op) {
2542         case VINSTR_PHI:  return "PHI";
2543         case VINSTR_JUMP: return "JUMP";
2544         case VINSTR_COND: return "COND";
2545         default:          return "<UNK>";
2546     }
2547 }
2548
2549 void ir_builder_dump(ir_builder *b, int (*oprintf)(const char*, ...))
2550 {
2551         size_t i;
2552         char indent[IND_BUFSZ];
2553         indent[0] = '\t';
2554         indent[1] = 0;
2555
2556         oprintf("module %s\n", b->name);
2557         for (i = 0; i < b->globals_count; ++i)
2558         {
2559                 oprintf("global ");
2560                 if (b->globals[i]->isconst)
2561                         oprintf("%s = ", b->globals[i]->name);
2562                 ir_value_dump(b->globals[i], oprintf);
2563                 oprintf("\n");
2564         }
2565         for (i = 0; i < b->functions_count; ++i)
2566                 ir_function_dump(b->functions[i], indent, oprintf);
2567         oprintf("endmodule %s\n", b->name);
2568 }
2569
2570 void ir_function_dump(ir_function *f, char *ind,
2571                       int (*oprintf)(const char*, ...))
2572 {
2573         size_t i;
2574         if (f->builtin != 0) {
2575             oprintf("%sfunction %s = builtin %i\n", ind, f->name, -f->builtin);
2576             return;
2577         }
2578         oprintf("%sfunction %s\n", ind, f->name);
2579         strncat(ind, "\t", IND_BUFSZ);
2580         if (f->locals_count)
2581         {
2582                 oprintf("%s%i locals:\n", ind, (int)f->locals_count);
2583                 for (i = 0; i < f->locals_count; ++i) {
2584                         oprintf("%s\t", ind);
2585                         ir_value_dump(f->locals[i], oprintf);
2586                         oprintf("\n");
2587                 }
2588         }
2589         if (f->blocks_count)
2590         {
2591                 oprintf("%slife passes (check): %i\n", ind, (int)f->run_id);
2592                 for (i = 0; i < f->blocks_count; ++i) {
2593                     if (f->blocks[i]->run_id != f->run_id) {
2594                         oprintf("%slife pass check fail! %i != %i\n", ind, (int)f->blocks[i]->run_id, (int)f->run_id);
2595                     }
2596                         ir_block_dump(f->blocks[i], ind, oprintf);
2597                 }
2598
2599         }
2600         ind[strlen(ind)-1] = 0;
2601         oprintf("%sendfunction %s\n", ind, f->name);
2602 }
2603
2604 void ir_block_dump(ir_block* b, char *ind,
2605                    int (*oprintf)(const char*, ...))
2606 {
2607         size_t i;
2608         oprintf("%s:%s\n", ind, b->label);
2609         strncat(ind, "\t", IND_BUFSZ);
2610
2611         for (i = 0; i < b->instr_count; ++i)
2612                 ir_instr_dump(b->instr[i], ind, oprintf);
2613         ind[strlen(ind)-1] = 0;
2614 }
2615
2616 void dump_phi(ir_instr *in, char *ind,
2617               int (*oprintf)(const char*, ...))
2618 {
2619         size_t i;
2620         oprintf("%s <- phi ", in->_ops[0]->name);
2621         for (i = 0; i < in->phi_count; ++i)
2622         {
2623                 oprintf("([%s] : %s) ", in->phi[i].from->label,
2624                                         in->phi[i].value->name);
2625         }
2626         oprintf("\n");
2627 }
2628
2629 void ir_instr_dump(ir_instr *in, char *ind,
2630                        int (*oprintf)(const char*, ...))
2631 {
2632         size_t i;
2633         const char *comma = NULL;
2634
2635         oprintf("%s (%i) ", ind, (int)in->eid);
2636
2637         if (in->opcode == VINSTR_PHI) {
2638                 dump_phi(in, ind, oprintf);
2639                 return;
2640         }
2641
2642         strncat(ind, "\t", IND_BUFSZ);
2643
2644         if (in->_ops[0] && (in->_ops[1] || in->_ops[2])) {
2645                 ir_value_dump(in->_ops[0], oprintf);
2646                 if (in->_ops[1] || in->_ops[2])
2647                         oprintf(" <- ");
2648         }
2649         oprintf("%s\t", qc_opname(in->opcode));
2650         if (in->_ops[0] && !(in->_ops[1] || in->_ops[2])) {
2651                 ir_value_dump(in->_ops[0], oprintf);
2652                 comma = ",\t";
2653         }
2654         else
2655         {
2656                 for (i = 1; i != 3; ++i) {
2657                         if (in->_ops[i]) {
2658                                 if (comma)
2659                                         oprintf(comma);
2660                                 ir_value_dump(in->_ops[i], oprintf);
2661                                 comma = ",\t";
2662                         }
2663                 }
2664         }
2665         if (in->bops[0]) {
2666                 if (comma)
2667                         oprintf(comma);
2668                 oprintf("[%s]", in->bops[0]->label);
2669                 comma = ",\t";
2670         }
2671         if (in->bops[1])
2672                 oprintf("%s[%s]", comma, in->bops[1]->label);
2673         oprintf("\n");
2674         ind[strlen(ind)-1] = 0;
2675 }
2676
2677 void ir_value_dump(ir_value* v, int (*oprintf)(const char*, ...))
2678 {
2679         if (v->isconst) {
2680                 switch (v->vtype) {
2681                     default:
2682                         case TYPE_VOID:
2683                                 oprintf("(void)");
2684                                 break;
2685                         case TYPE_FLOAT:
2686                                 oprintf("%g", v->constval.vfloat);
2687                                 break;
2688                         case TYPE_VECTOR:
2689                                 oprintf("'%g %g %g'",
2690                                         v->constval.vvec.x,
2691                                         v->constval.vvec.y,
2692                                         v->constval.vvec.z);
2693                                 break;
2694                         case TYPE_ENTITY:
2695                                 oprintf("(entity)");
2696                                 break;
2697                         case TYPE_STRING:
2698                                 oprintf("\"%s\"", v->constval.vstring);
2699                                 break;
2700 #if 0
2701                         case TYPE_INTEGER:
2702                                 oprintf("%i", v->constval.vint);
2703                                 break;
2704 #endif
2705                         case TYPE_POINTER:
2706                                 oprintf("&%s",
2707                                         v->constval.vpointer->name);
2708                                 break;
2709                 }
2710         } else {
2711                 oprintf("%s", v->name);
2712         }
2713 }
2714
2715 void ir_value_dump_life(ir_value *self, int (*oprintf)(const char*,...))
2716 {
2717         size_t i;
2718         oprintf("Life of %s:\n", self->name);
2719         for (i = 0; i < self->life_count; ++i)
2720         {
2721                 oprintf(" + [%i, %i]\n", self->life[i].start, self->life[i].end);
2722         }
2723 }