folding for lteqgt (less than equal to or greater than) operator a.k.a <=> which...
[xonotic/gmqcc.git] / fold.c
1 /*
2  * Copyright (C) 2012, 2013
3  *     Dale Weiler
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 <string.h>
24 #include <math.h>
25
26 #include "ast.h"
27 #include "parser.h"
28
29 #define FOLD_STRING_UNTRANSLATE_HTSIZE 1024
30 #define FOLD_STRING_DOTRANSLATE_HTSIZE 1024
31
32 /*
33  * There is two stages to constant folding in GMQCC: there is the parse
34  * stage constant folding, where, witht he help of the AST, operator
35  * usages can be constant folded. Then there is the constant folding
36  * in the IR for things like eliding if statements, can occur.
37  * 
38  * This file is thus, split into two parts.
39  */
40 static GMQCC_INLINE bool fold_possible(const ast_value *val) {
41     return  ast_istype((ast_expression*)val, ast_value) &&
42             val->hasvalue && (val->cvq == CV_CONST)     &&
43             ((ast_expression*)val)->vtype != TYPE_FUNCTION; /* why not for functions? */
44 }
45
46 #define isfloatonly(X)  (((ast_expression*)(X))->vtype == TYPE_FLOAT)
47 #define isvectoronly(X) (((ast_expression*)(X))->vtype == TYPE_VECTOR)
48 #define isstringonly(X) (((ast_expression*)(X))->vtype == TYPE_STRING)
49 #define isfloat(X)      (isfloatonly (X) && fold_possible(X))
50 #define isvector(X)     (isvectoronly(X) && fold_possible(X))
51 #define isstring(X)     (isstringonly(X) && fold_possible(X))
52 #define isfloats(X,Y)   (isfloat     (X) && isfloat (Y))
53 #define isvectors(X,Y)  (isvector    (X) && isvector(Y))
54 /*#define isstrings(X,Y)  (isstring    (X) && isstring(Y))*/
55
56 /*
57  * Implementation of basic vector math for vec3_t, for trivial constant
58  * folding.
59  * 
60  * TODO: gcc/clang hinting for autovectorization
61  */
62 static GMQCC_INLINE vec3_t vec3_add(vec3_t a, vec3_t b) {
63     vec3_t out;
64     out.x = a.x + b.x;
65     out.y = a.y + b.y;
66     out.z = a.z + b.z;
67     return out;
68 }
69
70 static GMQCC_INLINE vec3_t vec3_sub(vec3_t a, vec3_t b) {
71     vec3_t out;
72     out.x = a.x + b.x;
73     out.y = a.y + b.y;
74     out.z = a.z + b.z;
75     return out;
76 }
77
78 static GMQCC_INLINE vec3_t vec3_not(vec3_t a) {
79     vec3_t out;
80     out.x = !a.x;
81     out.y = !a.y;
82     out.z = !a.z;
83     return out;
84 }
85
86 static GMQCC_INLINE vec3_t vec3_neg(vec3_t a) {
87     vec3_t out;
88     out.x = -a.x;
89     out.y = -a.y;
90     out.z = -a.z;
91     return out;
92 }
93
94 static GMQCC_INLINE vec3_t vec3_xor(vec3_t a, vec3_t b) {
95     vec3_t out;
96     out.x = (qcfloat_t)((qcint_t)a.x ^ (qcint_t)b.x);
97     out.y = (qcfloat_t)((qcint_t)a.y ^ (qcint_t)b.y);
98     out.z = (qcfloat_t)((qcint_t)a.z ^ (qcint_t)b.z);
99     return out;
100 }
101
102 static GMQCC_INLINE vec3_t vec3_xorvf(vec3_t a, qcfloat_t b) {
103     vec3_t out;
104     out.x = (qcfloat_t)((qcint_t)a.x ^ (qcint_t)b);
105     out.y = (qcfloat_t)((qcint_t)a.y ^ (qcint_t)b);
106     out.z = (qcfloat_t)((qcint_t)a.z ^ (qcint_t)b);
107     return out;
108 }
109
110 static GMQCC_INLINE qcfloat_t vec3_mulvv(vec3_t a, vec3_t b) {
111     return (a.x * b.x + a.y * b.y + a.z * b.z);
112 }
113
114 static GMQCC_INLINE vec3_t vec3_mulvf(vec3_t a, qcfloat_t b) {
115     vec3_t out;
116     out.x = a.x * b;
117     out.y = a.y * b;
118     out.z = a.z * b;
119     return out;
120 }
121
122 static GMQCC_INLINE bool vec3_cmp(vec3_t a, vec3_t b) {
123     return a.x == b.x &&
124            a.y == b.y &&
125            a.z == b.z;
126 }
127
128 static GMQCC_INLINE vec3_t vec3_create(float x, float y, float z) {
129     vec3_t out;
130     out.x = x;
131     out.y = y;
132     out.z = z;
133     return out;
134 }
135
136 static GMQCC_INLINE bool vec3_pbool(vec3_t a) {
137     return (a.x && a.y && a.z);
138 }
139
140 #define fold_immvalue_float(E)  ((E)->constval.vfloat)
141 #define fold_immvalue_vector(E) ((E)->constval.vvec)
142 #define fold_immvalue_string(E) ((E)->constval.vstring)
143
144 fold_t *fold_init(parser_t *parser) {
145     fold_t *fold                 = (fold_t*)mem_a(sizeof(fold_t));
146     fold->parser                 = parser;
147     fold->imm_float              = NULL;
148     fold->imm_vector             = NULL;
149     fold->imm_string             = NULL;
150     fold->imm_string_untranslate = util_htnew(FOLD_STRING_UNTRANSLATE_HTSIZE);
151     fold->imm_string_dotranslate = util_htnew(FOLD_STRING_DOTRANSLATE_HTSIZE);
152
153     /*
154      * prime the tables with common constant values at constant
155      * locations.
156      */
157     (void)fold_constgen_float (fold,  0.0f);
158     (void)fold_constgen_float (fold,  1.0f);
159     (void)fold_constgen_float (fold, -1.0f);
160
161     (void)fold_constgen_vector(fold, vec3_create(0.0f, 0.0f, 0.0f));
162
163     return fold;
164 }
165
166 bool fold_generate(fold_t *fold, ir_builder *ir) {
167     /* generate globals for immediate folded values */
168     size_t     i;
169     ast_value *cur;
170
171     for (i = 0; i < vec_size(fold->imm_float);   ++i)
172         if (!ast_global_codegen ((cur = fold->imm_float[i]), ir, false)) goto err;
173     for (i = 0; i < vec_size(fold->imm_vector);  ++i)
174         if (!ast_global_codegen((cur = fold->imm_vector[i]), ir, false)) goto err;
175     for (i = 0; i < vec_size(fold->imm_string);  ++i)
176         if (!ast_global_codegen((cur = fold->imm_string[i]), ir, false)) goto err;
177
178     return true;
179
180 err:
181     con_out("failed to generate global %s\n", cur->name);
182     ir_builder_delete(ir);
183     return false;
184 }
185
186 void fold_cleanup(fold_t *fold) {
187     size_t i;
188
189     for (i = 0; i < vec_size(fold->imm_float);  ++i) ast_delete(fold->imm_float[i]);
190     for (i = 0; i < vec_size(fold->imm_vector); ++i) ast_delete(fold->imm_vector[i]);
191     for (i = 0; i < vec_size(fold->imm_string); ++i) ast_delete(fold->imm_string[i]);
192
193     vec_free(fold->imm_float);
194     vec_free(fold->imm_vector);
195     vec_free(fold->imm_string);
196
197     util_htdel(fold->imm_string_untranslate);
198     util_htdel(fold->imm_string_dotranslate);
199
200     mem_d(fold);
201 }
202
203 static lex_ctx_t fold_ctx(fold_t *fold) {
204     lex_ctx_t ctx;
205     if (fold->parser->lex)
206         return parser_ctx(fold->parser);
207
208     memset(&ctx, 0, sizeof(ctx));
209     return ctx;
210 }
211
212 ast_expression *fold_constgen_float(fold_t *fold, qcfloat_t value) {
213     ast_value  *out = NULL;
214     size_t      i;
215
216     for (i = 0; i < vec_size(fold->imm_float); i++) {
217         if (fold->imm_float[i]->constval.vfloat == value)
218             return (ast_expression*)fold->imm_float[i];
219     }
220
221     out                  = ast_value_new(fold_ctx(fold), "#IMMEDIATE", TYPE_FLOAT);
222     out->cvq             = CV_CONST;
223     out->hasvalue        = true;
224     out->constval.vfloat = value;
225
226     vec_push(fold->imm_float, out);
227
228     return (ast_expression*)out;
229 }
230
231 ast_expression *fold_constgen_vector(fold_t *fold, vec3_t value) {
232     ast_value *out;
233     size_t     i;
234
235     for (i = 0; i < vec_size(fold->imm_vector); i++) {
236         if (vec3_cmp(fold->imm_vector[i]->constval.vvec, value))
237             return (ast_expression*)fold->imm_vector[i];
238     }
239
240     out                = ast_value_new(fold_ctx(fold), "#IMMEDIATE", TYPE_VECTOR);
241     out->cvq           = CV_CONST;
242     out->hasvalue      = true;
243     out->constval.vvec = value;
244
245     vec_push(fold->imm_vector, out);
246
247     return (ast_expression*)out;
248 }
249
250 ast_expression *fold_constgen_string(fold_t *fold, const char *str, bool translate) {
251     hash_table_t *table = (translate) ? fold->imm_string_untranslate : fold->imm_string_dotranslate;
252     ast_value    *out   = NULL;
253     size_t        hash  = util_hthash(table, str);
254
255     if ((out = (ast_value*)util_htgeth(table, str, hash)))
256         return (ast_expression*)out;
257
258     if (translate) {
259         char name[32];
260         util_snprintf(name, sizeof(name), "dotranslate_%lu", (unsigned long)(fold->parser->translated++));
261         out                    = ast_value_new(parser_ctx(fold->parser), name, TYPE_STRING);
262         out->expression.flags |= AST_FLAG_INCLUDE_DEF; /* def needs to be included for translatables */
263     } else
264         out                    = ast_value_new(fold_ctx(fold), "#IMMEDIATE", TYPE_STRING);
265
266     out->cvq              = CV_CONST;
267     out->hasvalue         = true;
268     out->isimm            = true;
269     out->constval.vstring = parser_strdup(str);
270
271     vec_push(fold->imm_string, out);
272     util_htseth(table, str, hash, out);
273
274     return (ast_expression*)out;
275 }
276
277 static GMQCC_INLINE ast_expression *fold_op_mul_vec(fold_t *fold, vec3_t *vec, ast_value *sel, const char *set) {
278     /*
279      * vector-component constant folding works by matching the component sets
280      * to eliminate expensive operations on whole-vectors (3 components at runtime).
281      * to achive this effect in a clean manner this function generalizes the 
282      * values through the use of a set paramater, which is used as an indexing method
283      * for creating the elided ast binary expression.
284      *
285      * Consider 'n 0 0' where y, and z need to be tested for 0, and x is
286      * used as the value in a binary operation generating an INSTR_MUL instruction
287      * to acomplish the indexing of the correct component value we use set[0], set[1], set[2]
288      * as x, y, z, where the values of those operations return 'x', 'y', 'z'. Because
289      * of how ASCII works we can easily deliniate:
290      * vec.z is the same as set[2]-'x' for when set[2] is 'z', 'z'-'x' results in a
291      * literal value of 2, using this 2, we know that taking the address of vec->x (float)
292      * and indxing it with this literal will yeild the immediate address of that component
293      * 
294      * Of course more work needs to be done to generate the correct index for the ast_member_new
295      * call, which is no problem: set[0]-'x' suffices that job.
296      */
297     qcfloat_t x = (&vec->x)[set[0]-'x'];
298     qcfloat_t y = (&vec->x)[set[1]-'x'];
299     qcfloat_t z = (&vec->x)[set[2]-'x'];
300
301     if (!y && !z) {
302         ast_expression *out;
303         ++opts_optimizationcount[OPTIM_VECTOR_COMPONENTS];
304         out                        = (ast_expression*)ast_member_new(fold_ctx(fold), (ast_expression*)sel, set[0]-'x', NULL);
305         out->node.keep             = false;
306         ((ast_member*)out)->rvalue = true;
307         if (!x != -1)
308             return (ast_expression*)ast_binary_new(fold_ctx(fold), INSTR_MUL_F, fold_constgen_float(fold, x), out);
309     }
310
311     return NULL;
312 }
313
314
315 static GMQCC_INLINE ast_expression *fold_op_mul(fold_t *fold, ast_value *a, ast_value *b) {
316     if (isfloatonly(a)) {
317         return (fold_possible(a) && fold_possible(b))
318                     ? fold_constgen_vector(fold, vec3_mulvf(fold_immvalue_vector(b), fold_immvalue_float(a))) /* a=float,  b=vector */
319                     : NULL;                                                                                   /* cannot fold them   */
320     } else if (isfloats(a, b)) {
321         return fold_constgen_float(fold, fold_immvalue_float(a) * fold_immvalue_float(b));                    /* a=float,  b=float  */
322     } else if (isvectoronly(a)) {
323         if (isfloat(b) && fold_possible(a))
324             return fold_constgen_vector(fold, vec3_mulvf(fold_immvalue_vector(a), fold_immvalue_float(b)));   /* a=vector, b=float  */
325         else if (isvector(b)) {
326             /*
327              * if we made it here the two ast values are both vectors. However because vectors are represented as
328              * three float values, constant folding can still occur within reason of the individual const-qualification
329              * of the components the vector is composed of.
330              */
331             if (fold_possible(a) && fold_possible(b))
332                 return fold_constgen_float(fold, vec3_mulvv(fold_immvalue_vector(a), fold_immvalue_vector(b)));
333             else if (OPTS_OPTIMIZATION(OPTIM_VECTOR_COMPONENTS) && fold_possible(a)) {
334                 vec3_t          vec = fold_immvalue_vector(a);
335                 ast_expression *out;
336                 if ((out = fold_op_mul_vec(fold, &vec, b, "xyz"))) return out;
337                 if ((out = fold_op_mul_vec(fold, &vec, b, "yxz"))) return out;
338                 if ((out = fold_op_mul_vec(fold, &vec, b, "zxy"))) return out;
339                 return NULL;
340             } else if (OPTS_OPTIMIZATION(OPTIM_VECTOR_COMPONENTS) && fold_possible(b)) {
341                 vec3_t          vec = fold_immvalue_vector(b);
342                 ast_expression *out;
343                 if ((out = fold_op_mul_vec(fold, &vec, a, "xyz"))) return out;
344                 if ((out = fold_op_mul_vec(fold, &vec, a, "yxz"))) return out;
345                 if ((out = fold_op_mul_vec(fold, &vec, a, "zxy"))) return out;
346                 return NULL;
347             }
348         }
349     }
350     return NULL;
351 }
352
353 static GMQCC_INLINE bool fold_immediate_true(fold_t *fold, ast_value *v) {
354     switch (v->expression.vtype) {
355         case TYPE_FLOAT:   return !!v->constval.vfloat;
356         case TYPE_INTEGER: return !!v->constval.vint;
357         case TYPE_VECTOR:  return OPTS_FLAG(CORRECT_LOGIC) ? vec3_pbool(v->constval.vvec) : !!v->constval.vvec.x;
358         case TYPE_STRING:
359             if (!v->constval.vstring)
360                 return false;
361             if (OPTS_FLAG(TRUE_EMPTY_STRINGS))
362                 return true;
363             return !!v->constval.vstring[0];
364         default:
365             compile_error(fold_ctx(fold), "internal error: fold_immediate_true on invalid type");
366             break;
367     }
368     return !!v->constval.vfunc;
369 }
370
371 static GMQCC_INLINE ast_expression *fold_op_div(fold_t *fold, ast_value *a, ast_value *b) {
372     if (isfloatonly(a)) {
373         return (fold_possible(a) && fold_possible(b))
374                     ? fold_constgen_float(fold, fold_immvalue_float(a) / fold_immvalue_float(b))
375                     : NULL;
376     }
377
378     if (isvectoronly(a)) {
379         if (fold_possible(a) && fold_possible(b))
380             return fold_constgen_vector(fold, vec3_mulvf(fold_immvalue_vector(a), 1.0f / fold_immvalue_float(b)));
381         else if (fold_possible(b))
382             return fold_constgen_float (fold, 1.0f / fold_immvalue_float(b));
383     }
384     return NULL;
385 }
386
387 static GMQCC_INLINE ast_expression *fold_op_andor(fold_t *fold, ast_value *a, ast_value *b, bool isor) {
388     if (fold_possible(a) && fold_possible(b)) {
389         if (OPTS_FLAG(PERL_LOGIC)) {
390             if (fold_immediate_true(fold, b))
391                 return (ast_expression*)b;
392         } else {
393             return ((isor) ? (fold_immediate_true(fold, a) || fold_immediate_true(fold, b))
394                            : (fold_immediate_true(fold, a) && fold_immediate_true(fold, b)))
395                                  ? (ast_expression*)fold->imm_float[1]  /* 1.0f */
396                                  : (ast_expression*)fold->imm_float[0]; /* 0.0f */
397         }
398     }
399     return NULL;
400 }
401
402 static GMQCC_INLINE ast_expression *fold_op_lteqgt(fold_t *fold, ast_value *a, ast_value *b) {
403     if (!isfloats(a, b))
404         return NULL;
405
406     if (fold_immvalue_float(a)  < fold_immvalue_float(b)) return (ast_expression*)fold->imm_float[2];/* -1 */
407     if (fold_immvalue_float(a) == fold_immvalue_float(b)) return (ast_expression*)fold->imm_float[0];/* 0  */
408     if (fold_immvalue_float(a)  > fold_immvalue_float(b)) return (ast_expression*)fold->imm_float[1];/* 1  */
409
410     return NULL;
411 }
412
413 ast_expression *fold_op(fold_t *fold, const oper_info *info, ast_expression **opexprs) {
414     ast_value *a = (ast_value*)opexprs[0];
415     ast_value *b = (ast_value*)opexprs[1];
416     ast_value *c = (ast_value*)opexprs[2];
417
418     /* can a fold operation be applied to this operator usage? */
419     if (!info->folds)
420         return NULL;
421
422     switch(info->operands) {
423         case 3: if(!c) return NULL;
424         case 2: if(!b) return NULL;
425     }
426
427     switch(info->id) {
428         case opid2('-', 'P'):
429             return isfloat (a)             ? fold_constgen_float (fold, fold_immvalue_float(a))
430                  : isvector(a)             ? fold_constgen_vector(fold, vec3_neg(fold_immvalue_vector(a)))
431                  : NULL;
432         case opid2('!', 'P'):
433             return isfloat (a)             ? fold_constgen_float (fold, !fold_immvalue_float(a))
434                  : isvector(a)             ? fold_constgen_vector(fold, vec3_not(fold_immvalue_vector(a)))
435                  : isstring(a)             ? fold_constgen_float (fold, !fold_immvalue_string(a) || OPTS_FLAG(TRUE_EMPTY_STRINGS) ? 0 : !*fold_immvalue_string(a))
436                  : NULL;
437         case opid1('+'):
438             return isfloats(a,b)           ? fold_constgen_float (fold, fold_immvalue_float(a) + fold_immvalue_float(b))
439                  : isvectors(a,b)          ? fold_constgen_vector(fold, vec3_add(fold_immvalue_vector(a), fold_immvalue_vector(b)))
440                  : NULL;
441         case opid1('-'):
442             return isfloats(a,b)           ? fold_constgen_float (fold, fold_immvalue_float(a) - fold_immvalue_float(b))
443                  : isvectors(a,b)          ? fold_constgen_vector(fold, vec3_sub(fold_immvalue_vector(a), fold_immvalue_vector(b)))
444                  : NULL;
445         case opid1('%'):
446             return isfloats(a,b)           ? fold_constgen_float (fold, (qcfloat_t)(((qcint_t)fold_immvalue_float(a)) % ((qcint_t)fold_immvalue_float(b))))
447                  : NULL;
448         case opid1('|'):
449             return isfloats(a,b)           ? fold_constgen_float (fold, (qcfloat_t)(((qcint_t)fold_immvalue_float(a)) | ((qcint_t)fold_immvalue_float(b))))
450                  : NULL;
451         case opid1('&'):
452             return isfloats(a,b)           ? fold_constgen_float (fold, (qcfloat_t)(((qcint_t)fold_immvalue_float(a)) & ((qcint_t)fold_immvalue_float(b))))
453                  : NULL;
454         case opid1('^'):
455             return isfloats(a,b)           ? fold_constgen_float (fold, (qcfloat_t)(((qcint_t)fold_immvalue_float(a)) ^ ((qcint_t)fold_immvalue_float(b))))
456                  : isvectors(a,b)          ? fold_constgen_vector(fold, vec3_xor  (fold_immvalue_vector(a), fold_immvalue_vector(b)))
457                  : isvector(a)&&isfloat(b) ? fold_constgen_vector(fold, vec3_xorvf(fold_immvalue_vector(a), fold_immvalue_float (b)))
458                  : NULL;
459         case opid2('<','<'):
460             return isfloats(a,b)           ? fold_constgen_float (fold, (qcfloat_t)(((qcuint_t)(fold_immvalue_float(a)) << ((qcuint_t)fold_immvalue_float(b)))))
461                  : NULL;
462         case opid2('>','>'):
463             return isfloats(a,b)           ? fold_constgen_float (fold, (qcfloat_t)(((qcuint_t)(fold_immvalue_float(a)) >> ((qcuint_t)fold_immvalue_float(b)))))
464                  : NULL;
465         case opid2('*','*'):
466             return isfloats(a,b)           ? fold_constgen_float (fold, (qcfloat_t)powf(fold_immvalue_float(a), fold_immvalue_float(b)))
467                  : NULL;
468         case opid2('!','='):
469             return isfloats(a,b)           ? fold_constgen_float (fold, fold_immvalue_float(a) != fold_immvalue_float(b))
470                  : NULL;
471         case opid2('=','='):
472             return isfloats(a,b)           ? fold_constgen_float (fold, fold_immvalue_float(a) == fold_immvalue_float(b))
473                  : NULL;
474         case opid2('~','P'):
475             return isfloat(a)              ? fold_constgen_float (fold, ~(qcint_t)fold_immvalue_float(a))
476                  : NULL;
477
478         case opid1('*'):         return fold_op_mul  (fold, a, b);
479         case opid1('/'):         return fold_op_div  (fold, a, b);
480         case opid2('|','|'):     return fold_op_andor(fold, a, b, true);
481         case opid2('&','&'):     return fold_op_andor(fold, a, b, false);
482         case opid3('<','=','>'): return fold_op_lteqgt(fold, a, b);
483         case opid2('?',':'):
484             /* TODO: seperate function for this case */
485             return NULL;
486     }
487     return NULL;
488 }