Work in progress constant-folding rewrite.
[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 "ast.h"
25 #include "parser.h"
26
27 #define FOLD_STRING_UNTRANSLATE_HTSIZE 1024
28 #define FOLD_STRING_DOTRANSLATE_HTSIZE 1024
29
30 /*
31  * There is two stages to constant folding in GMQCC: there is the parse
32  * stage constant folding, where, witht he help of the AST, operator
33  * usages can be constant folded. Then there is the constant folding
34  * in the IR for things like eliding if statements, can occur.
35  * 
36  * This file is thus, split into two parts.
37  */
38 ast_expression **fold_const_values = NULL;
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 isfloat(X)     (((ast_expression*)(X))->vtype == TYPE_FLOAT  && fold_possible(X))
47 #define isvector(X)    (((ast_expression*)(X))->vtype == TYPE_VECTOR && fold_possible(X))
48 #define isstring(S)    (((ast_expression*)(X))->vtype == TYPE_STRING && fold_possible(X))
49 #define isfloats(X,Y)  (isfloat (X) && isfloat(Y))
50 #define isvectors(X,Y) (isvector(X) && isvector(Y))
51 #define isstrings(X,Y) (isstring(X) && isstring(Y))
52
53 /*
54  * Implementation of basic vector math for vec3_t, for trivial constant
55  * folding.
56  * 
57  * TODO: gcc/clang hinting for autovectorization
58  */
59 static GMQCC_INLINE vec3_t vec3_add(vec3_t a, vec3_t b) {
60     vec3_t out;
61     out.x = a.x + b.x;
62     out.y = a.y + b.y;
63     out.z = a.z + b.z;
64     return out;
65 }
66
67 static GMQCC_INLINE vec3_t vec3_sub(vec3_t a, vec3_t b) {
68     vec3_t out;
69     out.x = a.x + b.x;
70     out.y = a.y + b.y;
71     out.z = a.z + b.z;
72     return out;
73 }
74
75 static GMQCC_INLINE vec3_t vec3_not(vec3_t a) {
76     vec3_t out;
77     out.x = !a.x;
78     out.y = !a.y;
79     out.z = !a.z;
80     return out;
81 }
82
83 static GMQCC_INLINE vec3_t vec3_neg(vec3_t a) {
84     vec3_t out;
85     out.x = -a.x;
86     out.y = -a.y;
87     out.z = -a.z;
88     return out;
89 }
90
91 static GMQCC_INLINE vec3_t vec3_xor(vec3_t a, vec3_t b) {
92     vec3_t out;
93     out.x = (qcfloat_t)((qcint_t)a.x ^ (qcint_t)b.x);
94     out.y = (qcfloat_t)((qcint_t)a.y ^ (qcint_t)b.y);
95     out.z = (qcfloat_t)((qcint_t)a.z ^ (qcint_t)b.z);
96     return out;
97 }
98
99 static GMQCC_INLINE vec3_t vec3_xorvf(vec3_t a, qcfloat_t b) {
100     vec3_t out;
101     out.x = (qcfloat_t)((qcint_t)a.x ^ (qcint_t)b);
102     out.y = (qcfloat_t)((qcint_t)a.y ^ (qcint_t)b);
103     out.z = (qcfloat_t)((qcint_t)a.z ^ (qcint_t)b);
104     return out;
105 }
106
107 #if 0
108 static GMQCC_INLINE qcfloat_t vec3_mulvv(vec3_t a, vec3_t b) {
109     return (a.x * b.x + a.y * b.y + a.z * b.z);
110 }
111 #endif
112
113 static GMQCC_INLINE vec3_t vec3_mulvf(vec3_t a, qcfloat_t b) {
114     vec3_t out;
115     out.x = a.x * b;
116     out.y = a.y * b;
117     out.z = a.z * b;
118     return out;
119 }
120
121 static GMQCC_INLINE bool vec3_cmp(vec3_t a, vec3_t b) {
122     return a.x == b.x &&
123            a.y == b.y &&
124            a.z == b.z;
125 }
126
127 static GMQCC_INLINE vec3_t vec3_create(float x, float y, float z) {
128     vec3_t out;
129     out.x = x;
130     out.y = y;
131     out.z = z;
132     return out;
133 }
134
135
136 static GMQCC_INLINE float fold_immvalue_float(ast_value *expr) {
137     return expr->constval.vfloat;
138 }
139 static GMQCC_INLINE vec3_t fold_immvalue_vector(ast_value *expr) {
140     return expr->constval.vvec;
141 }
142 #if 0
143 static GMQCC_INLINE const char *fold_immvalue_string(ast_value *expr) {
144     return expr->constval.vstring;
145 }
146 #endif
147
148
149 fold_t *fold_init(parser_t *parser) {
150     fold_t *fold                 = (fold_t*)mem_a(sizeof(fold_t));
151     fold->parser                 = parser;
152     fold->imm_float              = NULL;
153     fold->imm_vector             = NULL;
154     fold->imm_string             = NULL;
155     fold->imm_string_untranslate = util_htnew(FOLD_STRING_UNTRANSLATE_HTSIZE);
156     fold->imm_string_dotranslate = util_htnew(FOLD_STRING_DOTRANSLATE_HTSIZE);
157
158     /*
159      * prime the tables with common constant values at constant
160      * locations.
161      */
162     (void)fold_constgen_float (fold,  0.0f);
163     (void)fold_constgen_float (fold,  1.0f);
164     (void)fold_constgen_float (fold, -1.0f);
165
166     (void)fold_constgen_vector(fold, vec3_create(0.0f, 0.0f, 0.0f));
167
168     return fold;
169 }
170
171 bool fold_generate(fold_t *fold, ir_builder *ir) {
172     /* generate globals for immediate folded values */
173     size_t     i;
174     ast_value *cur;
175
176     for (i = 0; i < vec_size(fold->imm_float);   ++i)
177         if (!ast_global_codegen ((cur = fold->imm_float[i]), ir, false)) goto err;
178     for (i = 0; i < vec_size(fold->imm_vector);  ++i)
179         if (!ast_global_codegen((cur = fold->imm_vector[i]), ir, false)) goto err;
180     for (i = 0; i < vec_size(fold->imm_string);  ++i)
181         if (!ast_global_codegen((cur = fold->imm_string[i]), ir, false)) goto err;
182
183     return true;
184
185 err:
186     con_out("failed to generate global %s\n", cur->name);
187     ir_builder_delete(ir);
188     return false;
189 }
190
191 void fold_cleanup(fold_t *fold) {
192     size_t i;
193
194     for (i = 0; i < vec_size(fold->imm_float);  ++i) ast_delete(fold->imm_float[i]);
195     for (i = 0; i < vec_size(fold->imm_vector); ++i) ast_delete(fold->imm_vector[i]);
196     for (i = 0; i < vec_size(fold->imm_string); ++i) ast_delete(fold->imm_string[i]);
197
198     vec_free(fold->imm_float);
199     vec_free(fold->imm_vector);
200     vec_free(fold->imm_string);
201
202     util_htdel(fold->imm_string_untranslate);
203     util_htdel(fold->imm_string_dotranslate);
204
205     mem_d(fold);
206 }
207
208 static lex_ctx_t fold_ctx(fold_t *fold) {
209     lex_ctx_t ctx;
210     if (fold->parser->lex)
211         return parser_ctx(fold->parser);
212
213     memset(&ctx, 0, sizeof(ctx));
214     return ctx;
215 }
216
217 ast_expression *fold_constgen_float(fold_t *fold, qcfloat_t value) {
218     ast_value  *out = NULL;
219     size_t      i;
220
221     for (i = 0; i < vec_size(fold->imm_float); i++) {
222         if (fold->imm_float[i]->constval.vfloat == value)
223             return (ast_expression*)fold->imm_float[i];
224     }
225
226     out                  = ast_value_new(fold_ctx(fold), "#IMMEDIATE", TYPE_FLOAT);
227     out->cvq             = CV_CONST;
228     out->hasvalue        = true;
229     out->constval.vfloat = value;
230
231     vec_push(fold->imm_float, out);
232
233     return (ast_expression*)out;
234 }
235
236 ast_expression *fold_constgen_vector(fold_t *fold, vec3_t value) {
237     ast_value *out;
238     size_t     i;
239
240     for (i = 0; i < vec_size(fold->imm_vector); i++) {
241         if (vec3_cmp(fold->imm_vector[i]->constval.vvec, value))
242             return (ast_expression*)fold->imm_vector[i];
243     }
244
245     out                = ast_value_new(fold_ctx(fold), "#IMMEDIATE", TYPE_VECTOR);
246     out->cvq           = CV_CONST;
247     out->hasvalue      = true;
248     out->constval.vvec = value;
249
250     vec_push(fold->imm_vector, out);
251
252     return (ast_expression*)out;
253 }
254
255 ast_expression *fold_constgen_string(fold_t *fold, const char *str, bool translate) {
256     hash_table_t *table = (translate) ? fold->imm_string_untranslate : fold->imm_string_dotranslate;
257     ast_value    *out   = NULL;
258     size_t        hash  = util_hthash(table, str);
259
260     if ((out = (ast_value*)util_htgeth(table, str, hash)))
261         return (ast_expression*)out;
262
263     if (translate) {
264         char name[32];
265         util_snprintf(name, sizeof(name), "dotranslate_%lu", (unsigned long)(fold->parser->translated++));
266         out                    = ast_value_new(parser_ctx(fold->parser), name, TYPE_STRING);
267         out->expression.flags |= AST_FLAG_INCLUDE_DEF; /* def needs to be included for translatables */
268     } else
269         out                    = ast_value_new(fold_ctx(fold), "#IMMEDIATE", TYPE_STRING);
270
271     out->cvq              = CV_CONST;
272     out->hasvalue         = true;
273     out->isimm            = true;
274     out->constval.vstring = parser_strdup(str);
275
276     vec_push(fold->imm_string, out);
277     util_htseth(table, str, hash, out);
278
279     return (ast_expression*)out;
280 }
281
282 ast_expression *fold_op(fold_t *fold, const oper_info *info, ast_expression **opexprs) {
283     ast_value *a = (ast_value*)opexprs[0];
284     ast_value *b = (ast_value*)opexprs[1];
285     ast_value *c = (ast_value*)opexprs[2];
286
287     /* can a fold operation be applied to this operator usage? */
288     if (!info->folds)
289         return NULL;
290
291     switch(info->operands) {
292         case 3: if(!c) return NULL;
293         case 2: if(!b) return NULL;
294     }
295
296     switch(info->id) {
297         case opid2('-', 'P'):
298             return isfloat (a)             ? fold_constgen_float (fold, fold_immvalue_float(a))
299                  : isvector(a)             ? fold_constgen_vector(fold, vec3_neg(fold_immvalue_vector(a)))
300                  : NULL;
301         case opid2('!', 'P'):
302             return isfloat (a)             ? fold_constgen_float (fold, !fold_immvalue_float(a))
303                  : isvector(a)             ? fold_constgen_vector(fold, vec3_not(fold_immvalue_vector(a)))
304                  : NULL;
305         case opid1('+'):
306             return isfloats(a,b)           ? fold_constgen_float (fold, fold_immvalue_float(a) + fold_immvalue_float(b))
307                  : isvectors(a,b)          ? fold_constgen_vector(fold, vec3_add(fold_immvalue_vector(a), fold_immvalue_vector(b)))
308                  : NULL;
309         case opid1('-'):
310             return isfloats(a,b)           ? fold_constgen_float (fold, fold_immvalue_float(a) - fold_immvalue_float(b))
311                  : isvectors(a,b)          ? fold_constgen_vector(fold, vec3_sub(fold_immvalue_vector(a), fold_immvalue_vector(b)))
312                  : NULL;
313         case opid1('*'):
314             if (isfloat(a))
315                 return isvector(b) ? fold_constgen_vector(fold, vec3_mulvf(fold_immvalue_vector(b), fold_immvalue_float(a)))
316                                    : fold_constgen_float (fold, fold_immvalue_float(a) * fold_immvalue_float(b));
317             return NULL;
318         case opid1('/'):
319             return isfloats(a,b)           ? fold_constgen_float (fold, fold_immvalue_float(a) / fold_immvalue_float(b))
320                  : isvector(a)&&isfloat(b) ? fold_constgen_vector(fold, vec3_mulvf(fold_immvalue_vector(a), 1.0f / fold_immvalue_float(b)))
321                  : NULL;
322         case opid1('%'):
323             return isfloats(a,b)           ? fold_constgen_float (fold, (qcfloat_t)(((qcint_t)fold_immvalue_float(a)) % ((qcint_t)fold_immvalue_float(b))))
324                  : NULL;
325         case opid1('|'):
326             return isfloats(a,b)           ? fold_constgen_float (fold, (qcfloat_t)(((qcint_t)fold_immvalue_float(a)) | ((qcint_t)fold_immvalue_float(b))))
327                  : NULL;
328         case opid1('&'):
329             return isfloats(a,b)           ? fold_constgen_float (fold, (qcfloat_t)(((qcint_t)fold_immvalue_float(a)) & ((qcint_t)fold_immvalue_float(b))))
330                  : NULL;
331         case opid1('^'):
332             return isfloats(a,b)           ? fold_constgen_float (fold, (qcfloat_t)(((qcint_t)fold_immvalue_float(a)) ^ ((qcint_t)fold_immvalue_float(b))))
333                  : isvectors(a,b)          ? fold_constgen_vector(fold, vec3_xor  (fold_immvalue_vector(a), fold_immvalue_vector(b)))
334                  : isvector(a)&&isfloat(b) ? fold_constgen_vector(fold, vec3_xorvf(fold_immvalue_vector(a), fold_immvalue_float (b)))
335                  : NULL;
336         case opid2('<','<'):
337             return isfloats(a,b)           ? fold_constgen_float (fold, (qcfloat_t)(((qcuint_t)(fold_immvalue_float(a)) << ((qcuint_t)fold_immvalue_float(b)))))
338                  : NULL;
339         case opid2('>','>'):
340             return isfloats(a,b)           ? fold_constgen_float (fold, (qcfloat_t)(((qcuint_t)(fold_immvalue_float(a)) >> ((qcuint_t)fold_immvalue_float(b)))))
341                  : NULL;
342         case opid2('|','|'):     return NULL;
343         case opid2('&','&'):     return NULL;
344         case opid2('?',':'):     return NULL;
345         case opid2('*','*'):     return NULL;
346         case opid3('<','=','>'): return NULL;
347         case opid2('!','='):
348             return isfloats(a,b)           ? fold_constgen_float (fold, fold_immvalue_float(a) != fold_immvalue_float(b))
349                  : NULL;
350         case opid2('=','='):
351             return isfloats(a,b)           ? fold_constgen_float (fold, fold_immvalue_float(a) == fold_immvalue_float(b))
352                  : NULL;
353         case opid2('~','P'):
354             return isfloat(a)              ? fold_constgen_float (fold, ~(qcint_t)fold_immvalue_float(a))
355                  : NULL;
356             break;
357     }
358     return NULL;
359 }