]> git.xonotic.org Git - xonotic/gmqcc.git/blob - fold.c
Perliminary work in arithmetic exception handling for vector operations in constant...
[xonotic/gmqcc.git] / fold.c
1 /*
2  * Copyright (C) 2012, 2013, 2014
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  * The constant folder is also responsible for validating if the constant
34  * expressions produce valid results. We cannot trust the FPU control
35  * unit for these exceptions because setting FPU control words might not
36  * work. Systems can set and enforce FPU modes of operation. It's also valid
37  * for libc's to simply ignore FPU exceptions. For instance ARM CPUs in
38  * glibc. We implement some trivial and IEE 754 conformant functions which
39  * emulate those operations. This is an entierly optional compiler feature
40  * which shouldn't be enabled for anything other than performing strict
41  * passes on constant expressions since it's quite slow.
42  */
43 typedef uint32_t sfloat_t;
44
45 typedef union {
46     qcfloat_t f;
47     sfloat_t  s;
48 } sfloat_cast_t;
49
50 typedef enum {
51     SFLOAT_INVALID   = 1,
52     SFLOAT_DIVBYZERO = 4,
53     SFLOAT_OVERFLOW  = 8,
54     SFLOAT_UNDERFLOW = 16,
55     SFLOAT_INEXACT   = 32
56 } sfloat_exceptionflags_t;
57
58 typedef enum {
59     SFLOAT_ROUND_NEAREST_EVEN,
60     SFLOAT_ROUND_DOWN,
61     SFLOAT_ROUND_UP,
62     SFLOAT_ROUND_TO_ZERO
63 } sfloat_roundingmode_t;
64
65 typedef enum {
66     SFLOAT_TAFTER,
67     SFLOAT_TBEFORE
68 } sfloat_tdetect_t;
69
70 typedef struct {
71     sfloat_roundingmode_t   roundingmode;
72     sfloat_exceptionflags_t exceptionflags;
73     sfloat_tdetect_t        tiny;
74 } sfloat_state_t;
75
76 /* Count of leading zero bits before the most-significand 1 bit. */
77 #ifdef _MSC_VER
78 /* MSVC has an intrinsic for this */
79     static GMQCC_INLINE uint32_t sfloat_clz(uint32_t x) {
80         int r = 0;
81         _BitScanForward(&r, x);
82         return r;
83     }
84 #   define SFLOAT_CLZ(X, SUB) \
85         (sfloat_clz((X)) - (SUB))
86 #elif defined(__GNUC__) || defined(__CLANG__)
87 /* Clang and GCC have a builtin for this */
88 #   define SFLOAT_CLZ(X, SUB) \
89         (__builtin_clz((X)) - (SUB))
90 #else
91 /* Native fallback */
92     static GMQCC_INLINE uint32_t sfloat_popcnt(uint32_t x) {
93         x -= ((x >> 1) & 0x55555555);
94         x  = (((x >> 2) & 0x33333333) + (x & 0x33333333));
95         x  = (((x >> 4) + x) & 0x0F0F0F0F);
96         x += x >> 8;
97         x += x >> 16;
98         return x & 0x0000003F;
99     }
100     static GMQCC_INLINE uint32_t sfloat_clz(uint32_t x) {
101         x |= (x >> 1);
102         x |= (x >> 2);
103         x |= (x >> 4);
104         x |= (x >> 8);
105         x |= (x >> 16);
106         return 32 - sfloat_popcnt(x);
107     }
108 #   define SFLOAT_CLZ(X, SUB) \
109         (sfloat_clz((X) - (SUB)))
110 #endif
111
112 /* The value of a NaN */
113 #define SFLOAT_NAN 0xFFC00000
114 /* Test if NaN */
115 #define SFLOAT_ISNAN(A) \
116     (0xFF000000 < (uint32_t)((A) << 1))
117 /* Test if signaling NaN */
118 #define SFLOAT_ISSNAN(A) \
119     (((((A) >> 22) & 0x1FF) == 0x1FE) && ((A) & 0x003FFFFF))
120 /* Raise exception */
121 #define SFLOAT_RAISE(STATE, FLAGS) \
122     ((STATE)->exceptionflags |= (FLAGS))
123 /*
124  * Shifts `A' right `COUNT' bits. Non-zero bits are stored in LSB. Size
125  * sets the arbitrarly-large limit.
126  */
127 #define SFLOAT_SHIFT(SIZE, A, COUNT, Z)                                      \
128     *(Z) = ((COUNT) == 0)                                                    \
129         ? 1                                                                  \
130         : (((COUNT) < (SIZE))                                                \
131             ? ((A) >> (COUNT)) | (((A) << ((-(COUNT)) & ((SIZE) - 1))) != 0) \
132             : ((A) != 0))
133 /* Extract fractional component */
134 #define SFLOAT_EXTRACT_FRAC(X) \
135     ((uint32_t)((X) & 0x007FFFFF))
136 /* Extract exponent component */
137 #define SFLOAT_EXTRACT_EXP(X) \
138     ((int16_t)((X) >> 23) & 0xFF)
139 /* Extract sign bit */
140 #define SFLOAT_EXTRACT_SIGN(X) \
141     ((X) >> 31)
142 /* Normalize a subnormal */
143 #define SFLOAT_SUBNORMALIZE(SA, Z, SZ) \
144     (void)(*(SZ) = (SA) << SFLOAT_CLZ((SA), 8), *(SZ) = 1 - SFLOAT_CLZ((SA), 8))
145 /*
146  * Pack sign, exponent and significand and produce a float.
147  *
148  * Integer portions of the significand are added to the exponent. The
149  * exponent input should be one less than the result exponent whenever
150  * the significand is normalized since normalized significand will
151  * always have an integer portion of value one.
152  */
153 #define SFLOAT_PACK(SIGN, EXP, SIG) \
154     (sfloat_t)((((uint32_t)(SIGN)) << 31) + (((uint32_t)(EXP)) << 23) + (SIG))
155
156 /* Calculate NaN. If either operands are signaling then raise invalid */
157 static sfloat_t sfloat_propagate_nan(sfloat_state_t *state, sfloat_t a, sfloat_t b) {
158     bool isnan_a  = SFLOAT_ISNAN(a);
159     bool issnan_a = SFLOAT_ISSNAN(a);
160     bool isnan_b  = SFLOAT_ISNAN(b);
161     bool issnan_b = SFLOAT_ISSNAN(b);
162
163     a |= 0x00400000;
164     b |= 0x00400000;
165
166     if (issnan_a | issnan_b)
167         SFLOAT_RAISE(state, SFLOAT_INEXACT);
168     if (issnan_a) {
169         if (issnan_b)
170             goto larger;
171         return isnan_b ? b : a;
172     } else if (isnan_a) {
173         if (issnan_b | !isnan_b)
174             return a;
175 larger:
176         if ((uint32_t)(a << 1) < (uint32_t)(b << 1)) return b;
177         if ((uint32_t)(b << 1) < (uint32_t)(a << 1)) return a;
178         return (a < b) ? a : b;
179     }
180     return b;
181 }
182
183 /* Round and pack */
184 static sfloat_t SFLOAT_PACK_round(sfloat_state_t *state, bool sign_z, int16_t exp_z, uint32_t sig_z) {
185     sfloat_roundingmode_t mode      = state->roundingmode;
186     bool                  even      = !!(mode == SFLOAT_ROUND_NEAREST_EVEN);
187     unsigned char         increment = 0x40;
188     unsigned char         bits      = sig_z & 0x7F;
189
190     if (!even) {
191         if (mode == SFLOAT_ROUND_TO_ZERO)
192             increment = 0;
193         else {
194             increment = 0x7F;
195             if (sign_z) {
196                 if (mode == SFLOAT_ROUND_UP)
197                     increment = 0;
198             } else {
199                 if (mode == SFLOAT_ROUND_DOWN)
200                     increment = 0;
201             }
202         }
203     }
204
205     if (0xFD <= (uint16_t)exp_z) {
206         if ((0xFD < exp_z) || ((exp_z == 0xFD) && ((int32_t)(sig_z + increment) < 0))) {
207             SFLOAT_RAISE(state, SFLOAT_OVERFLOW | SFLOAT_INEXACT);
208             return SFLOAT_PACK(sign_z, 0xFF, 0) - (increment == 0);
209         }
210         if (exp_z < 0) {
211             /* Check for underflow */
212             bool tiny = (state->tiny == SFLOAT_TBEFORE) || (exp_z < -1) || (sig_z + increment < 0x80000000);
213             SFLOAT_SHIFT(32, sig_z, -exp_z, &sig_z);
214             exp_z = 0;
215             bits = sig_z & 0x7F;
216             if (tiny && bits)
217                 SFLOAT_RAISE(state, SFLOAT_UNDERFLOW);
218         }
219     }
220
221     /*
222      * Significand has point between bits 30 and 29, 7 bits to the left of
223      * the usual place. This shifted significand has to be normalized
224      * or smaller, if it isn't the exponent must be zero, in which case
225      * no rounding occurs since the result will be a subnormal.
226      */
227     if (bits)
228         SFLOAT_RAISE(state, SFLOAT_INEXACT);
229     sig_z = (sig_z + increment) >> 7;
230     sig_z &= ~(((bits ^ 0x40) == 0) & even);
231     if (sig_z == 0)
232         exp_z = 0;
233     return SFLOAT_PACK(sign_z, exp_z, sig_z);
234 }
235
236 /* Normalized round and pack */
237 static sfloat_t SFLOAT_PACK_normal(sfloat_state_t *state, bool sign_z, int16_t exp_z, uint32_t sig_z) {
238     unsigned char c = SFLOAT_CLZ(sig_z, 1);
239     return SFLOAT_PACK_round(state, sign_z, exp_z - c, sig_z << c);
240 }
241
242 static sfloat_t sfloat_add_impl(sfloat_state_t *state, sfloat_t a, sfloat_t b, bool sign_z) {
243     int16_t  exp_a = SFLOAT_EXTRACT_EXP(a);
244     int16_t  exp_b = SFLOAT_EXTRACT_EXP(b);
245     int16_t  exp_z = 0;
246     int16_t  exp_d = exp_a - exp_b;
247     uint32_t sig_a = SFLOAT_EXTRACT_FRAC(a) << 6;
248     uint32_t sig_b = SFLOAT_EXTRACT_FRAC(b) << 6;
249     uint32_t sig_z = 0;
250
251     if (0 < exp_d) {
252         if (exp_a == 0xFF)
253             return sig_a ? sfloat_propagate_nan(state, a, b) : a;
254         if (exp_b == 0)
255             --exp_d;
256         else
257             sig_b |= 0x20000000;
258         SFLOAT_SHIFT(32, sig_b, exp_d, &sig_b);
259         exp_z = exp_a;
260     } else if (exp_d < 0) {
261         if (exp_b == 0xFF)
262             return sig_b ? sfloat_propagate_nan(state, a, b) : SFLOAT_PACK(sign_z, 0xFF, 0);
263         if (exp_a == 0)
264             ++exp_d;
265         else
266             sig_a |= 0x20000000;
267         SFLOAT_SHIFT(32, sig_a, -exp_d, &sig_a);
268         exp_z = exp_b;
269     } else {
270         if (exp_a == 0xFF)
271             return (sig_a | sig_b) ? sfloat_propagate_nan(state, a, b) : a;
272         if (exp_a == 0)
273             return SFLOAT_PACK(sign_z, 0, (sig_a + sig_b) >> 6);
274         sig_z = 0x40000000 + sig_a + sig_b;
275         exp_z = exp_a;
276         goto end;
277     }
278     sig_a |= 0x20000000;
279     sig_z = (sig_a + sig_b) << 1;
280     --exp_z;
281     if ((int32_t)sig_z < 0) {
282         sig_z = sig_a + sig_b;
283         ++exp_z;
284     }
285 end:
286     return SFLOAT_PACK_round(state, sign_z, exp_z, sig_z);
287 }
288
289 static sfloat_t sfloat_sub_impl(sfloat_state_t *state, sfloat_t a, sfloat_t b, bool sign_z) {
290     int16_t  exp_a = SFLOAT_EXTRACT_EXP(a);
291     int16_t  exp_b = SFLOAT_EXTRACT_EXP(b);
292     int16_t  exp_z = 0;
293     int16_t  exp_d = exp_a - exp_b;
294     uint32_t sig_a = SFLOAT_EXTRACT_FRAC(a) << 7;
295     uint32_t sig_b = SFLOAT_EXTRACT_FRAC(b) << 7;
296     uint32_t sig_z = 0;
297
298     if (0 < exp_d) goto exp_greater_a;
299     if (exp_d < 0) goto exp_greater_b;
300
301     if (exp_a == 0xFF) {
302         if (sig_a | sig_b)
303             return sfloat_propagate_nan(state, a, b);
304         SFLOAT_RAISE(state, SFLOAT_INVALID);
305         return SFLOAT_NAN;
306     }
307
308     if (exp_a == 0)
309         exp_a = exp_b = 1;
310
311     if (sig_b < sig_a) goto greater_a;
312     if (sig_a < sig_b) goto greater_b;
313
314     return SFLOAT_PACK(state->roundingmode == SFLOAT_ROUND_DOWN, 0, 0);
315
316 exp_greater_b:
317     if (exp_b == 0xFF)
318         return (sig_b) ? sfloat_propagate_nan(state, a, b) : SFLOAT_PACK(sign_z ^ 1, 0xFF, 0);
319     if (exp_a == 0)
320         ++exp_d;
321     else
322         sig_a |= 0x40000000;
323     SFLOAT_SHIFT(32, sig_a, -exp_d, &sig_a);
324     sig_b |= 0x40000000;
325 greater_b:
326     sig_z = sig_b - sig_a;
327     exp_z = exp_b;
328     sign_z ^= 1;
329     goto end;
330
331 exp_greater_a:
332     if (exp_a == 0xFF)
333         return (sig_a) ? sfloat_propagate_nan(state, a, b) : a;
334     if (exp_b == 0)
335         --exp_d;
336     else
337         sig_b |= 0x40000000;
338     SFLOAT_SHIFT(32, sig_b, exp_d, &sig_b);
339     sig_a |= 0x40000000;
340 greater_a:
341     sig_z = sig_a - sig_b;
342     exp_z = exp_a;
343
344 end:
345     --exp_z;
346     return SFLOAT_PACK_normal(state, sign_z, exp_z, sig_z);
347 }
348
349 static GMQCC_INLINE sfloat_t sfloat_add(sfloat_state_t *state, sfloat_t a, sfloat_t b) {
350     bool sign_a = SFLOAT_EXTRACT_SIGN(a);
351     bool sign_b = SFLOAT_EXTRACT_SIGN(b);
352     return (sign_a == sign_b) ? sfloat_add_impl(state, a, b, sign_a)
353                               : sfloat_sub_impl(state, a, b, sign_a);
354 }
355
356 static GMQCC_INLINE sfloat_t sfloat_sub(sfloat_state_t *state, sfloat_t a, sfloat_t b) {
357     bool sign_a = SFLOAT_EXTRACT_SIGN(a);
358     bool sign_b = SFLOAT_EXTRACT_SIGN(b);
359     return (sign_a == sign_b) ? sfloat_sub_impl(state, a, b, sign_a)
360                               : sfloat_add_impl(state, a, b, sign_a);
361 }
362
363 static sfloat_t sfloat_mul(sfloat_state_t *state, sfloat_t a, sfloat_t b) {
364     int16_t  exp_a   = SFLOAT_EXTRACT_EXP(a);
365     int16_t  exp_b   = SFLOAT_EXTRACT_EXP(b);
366     int16_t  exp_z   = 0;
367     uint32_t sig_a   = SFLOAT_EXTRACT_FRAC(a);
368     uint32_t sig_b   = SFLOAT_EXTRACT_FRAC(b);
369     uint32_t sig_z   = 0;
370     uint64_t sig_z64 = 0;
371     bool     sign_a  = SFLOAT_EXTRACT_SIGN(a);
372     bool     sign_b  = SFLOAT_EXTRACT_SIGN(b);
373     bool     sign_z  = sign_a ^ sign_b;
374
375     if (exp_a == 0xFF) {
376         if (sig_a || ((exp_b == 0xFF) && sig_b))
377             return sfloat_propagate_nan(state, a, b);
378         if ((exp_b | sig_b) == 0) {
379             SFLOAT_RAISE(state, SFLOAT_INVALID);
380             return SFLOAT_NAN;
381         }
382         return SFLOAT_PACK(sign_z, 0xFF, 0);
383     }
384     if (exp_b == 0xFF) {
385         if (sig_b)
386             return sfloat_propagate_nan(state, a, b);
387         if ((exp_a | sig_a) == 0) {
388             SFLOAT_RAISE(state, SFLOAT_INVALID);
389             return SFLOAT_NAN;
390         }
391         return SFLOAT_PACK(sign_z, 0xFF, 0);
392     }
393     if (exp_a == 0) {
394         if (sig_a == 0)
395             return SFLOAT_PACK(sign_z, 0, 0);
396         SFLOAT_SUBNORMALIZE(sig_a, &exp_a, &sig_a);
397     }
398     if (exp_b == 0) {
399         if (sig_b == 0)
400             return SFLOAT_PACK(sign_z, 0, 0);
401         SFLOAT_SUBNORMALIZE(sig_b, &exp_b, &sig_b);
402     }
403     exp_z = exp_a + exp_b - 0x7F;
404     sig_a = (sig_a | 0x00800000) << 7;
405     sig_b = (sig_b | 0x00800000) << 8;
406     SFLOAT_SHIFT(64, ((uint64_t)sig_a) * sig_b, 32, &sig_z64);
407     sig_z = sig_z64;
408     if (0 <= (int32_t)(sig_z << 1)) {
409         sig_z <<= 1;
410         --exp_z;
411     }
412     return SFLOAT_PACK_round(state, sign_z, exp_z, sig_z);
413 }
414
415 static sfloat_t sfloat_div(sfloat_state_t *state, sfloat_t a, sfloat_t b) {
416     int16_t  exp_a   = SFLOAT_EXTRACT_EXP(a);
417     int16_t  exp_b   = SFLOAT_EXTRACT_EXP(b);
418     int16_t  exp_z   = 0;
419     uint32_t sig_a   = SFLOAT_EXTRACT_FRAC(a);
420     uint32_t sig_b   = SFLOAT_EXTRACT_FRAC(b);
421     uint32_t sig_z   = 0;
422     bool     sign_a  = SFLOAT_EXTRACT_SIGN(a);
423     bool     sign_b  = SFLOAT_EXTRACT_SIGN(b);
424     bool     sign_z  = sign_a ^ sign_b;
425
426     if (exp_a == 0xFF) {
427         if (sig_a)
428             return sfloat_propagate_nan(state, a, b);
429         if (exp_b == 0xFF) {
430             if (sig_b)
431                 return sfloat_propagate_nan(state, a, b);
432             SFLOAT_RAISE(state, SFLOAT_INVALID);
433             return SFLOAT_NAN;
434         }
435         return SFLOAT_PACK(sign_z, 0xFF, 0);
436     }
437     if (exp_b == 0xFF)
438         return (sig_b) ? sfloat_propagate_nan(state, a, b) : SFLOAT_PACK(sign_z, 0, 0);
439     if (exp_b == 0) {
440         if (sig_b == 0) {
441             if ((exp_a | sig_a) == 0) {
442                 SFLOAT_RAISE(state, SFLOAT_INVALID);
443                 return SFLOAT_NAN;
444             }
445             SFLOAT_RAISE(state, SFLOAT_DIVBYZERO);
446             return SFLOAT_PACK(sign_z, 0xFF, 0);
447         }
448         SFLOAT_SUBNORMALIZE(sig_b, &exp_b, &sig_b);
449     }
450     if (exp_a == 0) {
451         if (sig_a == 0)
452             return SFLOAT_PACK(sign_z, 0, 0);
453         SFLOAT_SUBNORMALIZE(sig_a, &exp_a, &sig_a);
454     }
455     exp_z = exp_a - exp_b + 0x7D;
456     sig_a = (sig_a | 0x00800000) << 7;
457     sig_b = (sig_b | 0x00800000) << 8;
458     if (sig_b <= (sig_a + sig_a)) {
459         sig_a >>= 1;
460         ++exp_z;
461     }
462     sig_z = (((uint64_t)sig_a) << 32) / sig_b;
463     if ((sig_z & 0x3F) == 0)
464         sig_z |= ((uint64_t)sig_b * sig_z != ((uint64_t)sig_a) << 32);
465     return SFLOAT_PACK_round(state, sign_z, exp_z, sig_z);
466 }
467
468 static GMQCC_INLINE void sfloat_check(lex_ctx_t ctx, sfloat_state_t *state, const char *vec) {
469     /* Exception comes from vector component */
470     if (vec) {
471         if (state->exceptionflags & SFLOAT_DIVBYZERO)
472             compile_error(ctx, "division by zero in `%s' component", vec);
473         if (state->exceptionflags & SFLOAT_INVALID)
474             compile_error(ctx, "undefined (inf) in `%s' component", vec);
475         if (state->exceptionflags & SFLOAT_OVERFLOW)
476             compile_error(ctx, "arithmetic overflow in `%s' component", vec);
477         if (state->exceptionflags & SFLOAT_UNDERFLOW)
478             compile_error(ctx, "arithmetic underflow in `%s' component", vec);
479             return;
480     }
481     if (state->exceptionflags & SFLOAT_DIVBYZERO)
482         compile_error(ctx, "division by zero");
483     if (state->exceptionflags & SFLOAT_INVALID)
484         compile_error(ctx, "undefined (inf)");
485     if (state->exceptionflags & SFLOAT_OVERFLOW)
486         compile_error(ctx, "arithmetic overflow");
487     if (state->exceptionflags & SFLOAT_UNDERFLOW)
488         compile_error(ctx, "arithmetic underflow");
489 }
490
491 /*
492  * There is two stages to constant folding in GMQCC: there is the parse
493  * stage constant folding, where, witht he help of the AST, operator
494  * usages can be constant folded. Then there is the constant folding
495  * in the IR for things like eliding if statements, can occur.
496  *
497  * This file is thus, split into two parts.
498  */
499
500 #define isfloat(X)      (((ast_expression*)(X))->vtype == TYPE_FLOAT)
501 #define isvector(X)     (((ast_expression*)(X))->vtype == TYPE_VECTOR)
502 #define isstring(X)     (((ast_expression*)(X))->vtype == TYPE_STRING)
503 #define isfloats(X,Y)   (isfloat  (X) && isfloat (Y))
504
505 /*
506  * Implementation of basic vector math for vec3_t, for trivial constant
507  * folding.
508  *
509  * TODO: gcc/clang hinting for autovectorization
510  */
511 typedef enum {
512     VEC_COMP_X = 1 << 0,
513     VEC_COMP_Y = 1 << 1,
514     VEC_COMP_Z = 1 << 2
515 } vec3_comp_t;
516
517 typedef struct {
518     sfloat_cast_t x;
519     sfloat_cast_t y;
520     sfloat_cast_t z;
521 } vec3_soft_t;
522
523 typedef struct {
524     vec3_comp_t    faults;
525     sfloat_state_t state[3];
526 } vec3_soft_state_t;
527
528 static GMQCC_INLINE vec3_soft_t vec3_soft_convert(vec3_t vec) {
529     vec3_soft_t soft;
530     soft.x.f = vec.x;
531     soft.y.f = vec.y;
532     soft.z.f = vec.z;
533     return soft;
534 }
535
536 static GMQCC_INLINE bool vec3_soft_exception(vec3_soft_state_t *vstate, size_t index) {
537     sfloat_exceptionflags_t flags = vstate->state[index].exceptionflags;
538     if (flags & SFLOAT_DIVBYZERO) return true;
539     if (flags & SFLOAT_INVALID)   return true;
540     if (flags & SFLOAT_OVERFLOW)  return true;
541     if (flags & SFLOAT_UNDERFLOW) return true;
542     return false;
543 }
544
545 static GMQCC_INLINE void vec3_soft_eval(vec3_soft_state_t *state,
546                                         sfloat_t         (*callback)(sfloat_state_t *, sfloat_t, sfloat_t),
547                                         vec3_t             a,
548                                         vec3_t             b)
549 {
550     vec3_soft_t sa = vec3_soft_convert(a);
551     vec3_soft_t sb = vec3_soft_convert(b);
552     callback(&state->state[0], sa.x.s, sb.x.s);
553     if (vec3_soft_exception(state, 0)) state->faults |= VEC_COMP_X;
554     callback(&state->state[1], sa.y.s, sb.y.s);
555     if (vec3_soft_exception(state, 1)) state->faults |= VEC_COMP_Y;
556     callback(&state->state[2], sa.z.s, sb.z.s);
557     if (vec3_soft_exception(state, 2)) state->faults |= VEC_COMP_Z;
558 }
559
560 static GMQCC_INLINE void vec3_check_except(vec3_t     a,
561                                            vec3_t     b,
562                                            lex_ctx_t  ctx,
563                                            sfloat_t (*callback)(sfloat_state_t *, sfloat_t, sfloat_t))
564 {
565     vec3_soft_state_t state;
566     vec3_soft_eval(&state, callback, a, b);
567     if (state.faults & VEC_COMP_X) sfloat_check(ctx, &state.state[0], "x");
568     if (state.faults & VEC_COMP_Y) sfloat_check(ctx, &state.state[1], "y");
569     if (state.faults & VEC_COMP_Z) sfloat_check(ctx, &state.state[2], "z");
570 }
571
572 static GMQCC_INLINE vec3_t vec3_add(lex_ctx_t ctx, vec3_t a, vec3_t b) {
573     vec3_t out;
574     vec3_check_except(a, b, ctx, &sfloat_add);
575     out.x = a.x + b.x;
576     out.y = a.y + b.y;
577     out.z = a.z + b.z;
578     return out;
579 }
580
581 static GMQCC_INLINE vec3_t vec3_sub(lex_ctx_t ctx, vec3_t a, vec3_t b) {
582     vec3_t out;
583     vec3_check_except(a, b, ctx, &sfloat_sub);
584     out.x = a.x - b.x;
585     out.y = a.y - b.y;
586     out.z = a.z - b.z;
587     return out;
588 }
589
590 static GMQCC_INLINE vec3_t vec3_neg(vec3_t a) {
591     vec3_t out;
592     out.x = -a.x;
593     out.y = -a.y;
594     out.z = -a.z;
595     return out;
596 }
597
598 static GMQCC_INLINE vec3_t vec3_or(vec3_t a, vec3_t b) {
599     vec3_t out;
600     out.x = (qcfloat_t)(((qcint_t)a.x) | ((qcint_t)b.x));
601     out.y = (qcfloat_t)(((qcint_t)a.y) | ((qcint_t)b.y));
602     out.z = (qcfloat_t)(((qcint_t)a.z) | ((qcint_t)b.z));
603     return out;
604 }
605
606 static GMQCC_INLINE vec3_t vec3_orvf(vec3_t a, qcfloat_t b) {
607     vec3_t out;
608     out.x = (qcfloat_t)(((qcint_t)a.x) | ((qcint_t)b));
609     out.y = (qcfloat_t)(((qcint_t)a.y) | ((qcint_t)b));
610     out.z = (qcfloat_t)(((qcint_t)a.z) | ((qcint_t)b));
611     return out;
612 }
613
614 static GMQCC_INLINE vec3_t vec3_and(vec3_t a, vec3_t b) {
615     vec3_t out;
616     out.x = (qcfloat_t)(((qcint_t)a.x) & ((qcint_t)b.x));
617     out.y = (qcfloat_t)(((qcint_t)a.y) & ((qcint_t)b.y));
618     out.z = (qcfloat_t)(((qcint_t)a.z) & ((qcint_t)b.z));
619     return out;
620 }
621
622 static GMQCC_INLINE vec3_t vec3_andvf(vec3_t a, qcfloat_t b) {
623     vec3_t out;
624     out.x = (qcfloat_t)(((qcint_t)a.x) & ((qcint_t)b));
625     out.y = (qcfloat_t)(((qcint_t)a.y) & ((qcint_t)b));
626     out.z = (qcfloat_t)(((qcint_t)a.z) & ((qcint_t)b));
627     return out;
628 }
629
630 static GMQCC_INLINE vec3_t vec3_xor(vec3_t a, vec3_t b) {
631     vec3_t out;
632     out.x = (qcfloat_t)(((qcint_t)a.x) ^ ((qcint_t)b.x));
633     out.y = (qcfloat_t)(((qcint_t)a.y) ^ ((qcint_t)b.y));
634     out.z = (qcfloat_t)(((qcint_t)a.z) ^ ((qcint_t)b.z));
635     return out;
636 }
637
638 static GMQCC_INLINE vec3_t vec3_xorvf(vec3_t a, qcfloat_t b) {
639     vec3_t out;
640     out.x = (qcfloat_t)(((qcint_t)a.x) ^ ((qcint_t)b));
641     out.y = (qcfloat_t)(((qcint_t)a.y) ^ ((qcint_t)b));
642     out.z = (qcfloat_t)(((qcint_t)a.z) ^ ((qcint_t)b));
643     return out;
644 }
645
646 static GMQCC_INLINE vec3_t vec3_not(vec3_t a) {
647     vec3_t out;
648     out.x = -1-a.x;
649     out.y = -1-a.y;
650     out.z = -1-a.z;
651     return out;
652 }
653
654 static GMQCC_INLINE qcfloat_t vec3_mulvv(vec3_t a, vec3_t b) {
655     return (a.x * b.x + a.y * b.y + a.z * b.z);
656 }
657
658 static GMQCC_INLINE vec3_t vec3_mulvf(vec3_t a, qcfloat_t b) {
659     vec3_t out;
660     out.x = a.x * b;
661     out.y = a.y * b;
662     out.z = a.z * b;
663     return out;
664 }
665
666 static GMQCC_INLINE bool vec3_cmp(vec3_t a, vec3_t b) {
667     return a.x == b.x &&
668            a.y == b.y &&
669            a.z == b.z;
670 }
671
672 static GMQCC_INLINE vec3_t vec3_create(float x, float y, float z) {
673     vec3_t out;
674     out.x = x;
675     out.y = y;
676     out.z = z;
677     return out;
678 }
679
680 static GMQCC_INLINE qcfloat_t vec3_notf(vec3_t a) {
681     return (!a.x && !a.y && !a.z);
682 }
683
684 static GMQCC_INLINE bool vec3_pbool(vec3_t a) {
685     return (a.x || a.y || a.z);
686 }
687
688 static GMQCC_INLINE vec3_t vec3_cross(vec3_t a, vec3_t b) {
689     vec3_t out;
690     out.x = a.y * b.z - a.z * b.y;
691     out.y = a.z * b.x - a.x * b.z;
692     out.z = a.x * b.y - a.y * b.x;
693     return out;
694 }
695
696 static lex_ctx_t fold_ctx(fold_t *fold) {
697     lex_ctx_t ctx;
698     if (fold->parser->lex)
699         return parser_ctx(fold->parser);
700
701     memset(&ctx, 0, sizeof(ctx));
702     return ctx;
703 }
704
705 static GMQCC_INLINE bool fold_immediate_true(fold_t *fold, ast_value *v) {
706     switch (v->expression.vtype) {
707         case TYPE_FLOAT:
708             return !!v->constval.vfloat;
709         case TYPE_INTEGER:
710             return !!v->constval.vint;
711         case TYPE_VECTOR:
712             if (OPTS_FLAG(CORRECT_LOGIC))
713                 return vec3_pbool(v->constval.vvec);
714             return !!(v->constval.vvec.x);
715         case TYPE_STRING:
716             if (!v->constval.vstring)
717                 return false;
718             if (OPTS_FLAG(TRUE_EMPTY_STRINGS))
719                 return true;
720             return !!v->constval.vstring[0];
721         default:
722             compile_error(fold_ctx(fold), "internal error: fold_immediate_true on invalid type");
723             break;
724     }
725     return !!v->constval.vfunc;
726 }
727
728 /* Handy macros to determine if an ast_value can be constant folded. */
729 #define fold_can_1(X)  \
730     (ast_istype(((ast_expression*)(X)), ast_value) && (X)->hasvalue && ((X)->cvq == CV_CONST) && \
731                 ((ast_expression*)(X))->vtype != TYPE_FUNCTION)
732
733 #define fold_can_2(X, Y) (fold_can_1(X) && fold_can_1(Y))
734
735 #define fold_immvalue_float(E)  ((E)->constval.vfloat)
736 #define fold_immvalue_vector(E) ((E)->constval.vvec)
737 #define fold_immvalue_string(E) ((E)->constval.vstring)
738
739 fold_t *fold_init(parser_t *parser) {
740     fold_t *fold                 = (fold_t*)mem_a(sizeof(fold_t));
741     fold->parser                 = parser;
742     fold->imm_float              = NULL;
743     fold->imm_vector             = NULL;
744     fold->imm_string             = NULL;
745     fold->imm_string_untranslate = util_htnew(FOLD_STRING_UNTRANSLATE_HTSIZE);
746     fold->imm_string_dotranslate = util_htnew(FOLD_STRING_DOTRANSLATE_HTSIZE);
747
748     /*
749      * prime the tables with common constant values at constant
750      * locations.
751      */
752     (void)fold_constgen_float (fold,  0.0f, false);
753     (void)fold_constgen_float (fold,  1.0f, false);
754     (void)fold_constgen_float (fold, -1.0f, false);
755     (void)fold_constgen_float (fold,  2.0f, false);
756
757     (void)fold_constgen_vector(fold, vec3_create(0.0f, 0.0f, 0.0f));
758     (void)fold_constgen_vector(fold, vec3_create(-1.0f, -1.0f, -1.0f));
759
760     return fold;
761 }
762
763 bool fold_generate(fold_t *fold, ir_builder *ir) {
764     /* generate globals for immediate folded values */
765     size_t     i;
766     ast_value *cur;
767
768     for (i = 0; i < vec_size(fold->imm_float);   ++i)
769         if (!ast_global_codegen ((cur = fold->imm_float[i]), ir, false)) goto err;
770     for (i = 0; i < vec_size(fold->imm_vector);  ++i)
771         if (!ast_global_codegen((cur = fold->imm_vector[i]), ir, false)) goto err;
772     for (i = 0; i < vec_size(fold->imm_string);  ++i)
773         if (!ast_global_codegen((cur = fold->imm_string[i]), ir, false)) goto err;
774
775     return true;
776
777 err:
778     con_out("failed to generate global %s\n", cur->name);
779     ir_builder_delete(ir);
780     return false;
781 }
782
783 void fold_cleanup(fold_t *fold) {
784     size_t i;
785
786     for (i = 0; i < vec_size(fold->imm_float);  ++i) ast_delete(fold->imm_float[i]);
787     for (i = 0; i < vec_size(fold->imm_vector); ++i) ast_delete(fold->imm_vector[i]);
788     for (i = 0; i < vec_size(fold->imm_string); ++i) ast_delete(fold->imm_string[i]);
789
790     vec_free(fold->imm_float);
791     vec_free(fold->imm_vector);
792     vec_free(fold->imm_string);
793
794     util_htdel(fold->imm_string_untranslate);
795     util_htdel(fold->imm_string_dotranslate);
796
797     mem_d(fold);
798 }
799
800 ast_expression *fold_constgen_float(fold_t *fold, qcfloat_t value, bool inexact) {
801     ast_value  *out = NULL;
802     size_t      i;
803
804     for (i = 0; i < vec_size(fold->imm_float); i++) {
805         if (!memcmp(&fold->imm_float[i]->constval.vfloat, &value, sizeof(qcfloat_t)))
806             return (ast_expression*)fold->imm_float[i];
807     }
808
809     out                  = ast_value_new(fold_ctx(fold), "#IMMEDIATE", TYPE_FLOAT);
810     out->cvq             = CV_CONST;
811     out->hasvalue        = true;
812     out->inexact         = inexact;
813     out->constval.vfloat = value;
814
815     vec_push(fold->imm_float, out);
816
817     return (ast_expression*)out;
818 }
819
820 ast_expression *fold_constgen_vector(fold_t *fold, vec3_t value) {
821     ast_value *out;
822     size_t     i;
823
824     for (i = 0; i < vec_size(fold->imm_vector); i++) {
825         if (vec3_cmp(fold->imm_vector[i]->constval.vvec, value))
826             return (ast_expression*)fold->imm_vector[i];
827     }
828
829     out                = ast_value_new(fold_ctx(fold), "#IMMEDIATE", TYPE_VECTOR);
830     out->cvq           = CV_CONST;
831     out->hasvalue      = true;
832     out->constval.vvec = value;
833
834     vec_push(fold->imm_vector, out);
835
836     return (ast_expression*)out;
837 }
838
839 ast_expression *fold_constgen_string(fold_t *fold, const char *str, bool translate) {
840     hash_table_t *table = (translate) ? fold->imm_string_untranslate : fold->imm_string_dotranslate;
841     ast_value    *out   = NULL;
842     size_t        hash  = util_hthash(table, str);
843
844     if ((out = (ast_value*)util_htgeth(table, str, hash)))
845         return (ast_expression*)out;
846
847     if (translate) {
848         char name[32];
849         util_snprintf(name, sizeof(name), "dotranslate_%lu", (unsigned long)(fold->parser->translated++));
850         out                    = ast_value_new(parser_ctx(fold->parser), name, TYPE_STRING);
851         out->expression.flags |= AST_FLAG_INCLUDE_DEF; /* def needs to be included for translatables */
852     } else
853         out                    = ast_value_new(fold_ctx(fold), "#IMMEDIATE", TYPE_STRING);
854
855     out->cvq              = CV_CONST;
856     out->hasvalue         = true;
857     out->isimm            = true;
858     out->constval.vstring = parser_strdup(str);
859
860     vec_push(fold->imm_string, out);
861     util_htseth(table, str, hash, out);
862
863     return (ast_expression*)out;
864 }
865
866
867 static GMQCC_INLINE ast_expression *fold_op_mul_vec(fold_t *fold, vec3_t vec, ast_value *sel, const char *set) {
868     /*
869      * vector-component constant folding works by matching the component sets
870      * to eliminate expensive operations on whole-vectors (3 components at runtime).
871      * to achive this effect in a clean manner this function generalizes the
872      * values through the use of a set paramater, which is used as an indexing method
873      * for creating the elided ast binary expression.
874      *
875      * Consider 'n 0 0' where y, and z need to be tested for 0, and x is
876      * used as the value in a binary operation generating an INSTR_MUL instruction,
877      * to acomplish the indexing of the correct component value we use set[0], set[1], set[2]
878      * as x, y, z, where the values of those operations return 'x', 'y', 'z'. Because
879      * of how ASCII works we can easily deliniate:
880      * vec.z is the same as set[2]-'x' for when set[2] is 'z', 'z'-'x' results in a
881      * literal value of 2, using this 2, we know that taking the address of vec->x (float)
882      * and indxing it with this literal will yeild the immediate address of that component
883      *
884      * Of course more work needs to be done to generate the correct index for the ast_member_new
885      * call, which is no problem: set[0]-'x' suffices that job.
886      */
887     qcfloat_t x = (&vec.x)[set[0]-'x'];
888     qcfloat_t y = (&vec.x)[set[1]-'x'];
889     qcfloat_t z = (&vec.x)[set[2]-'x'];
890
891     if (!y && !z) {
892         ast_expression *out;
893         ++opts_optimizationcount[OPTIM_VECTOR_COMPONENTS];
894         out                        = (ast_expression*)ast_member_new(fold_ctx(fold), (ast_expression*)sel, set[0]-'x', NULL);
895         out->node.keep             = false;
896         ((ast_member*)out)->rvalue = true;
897         if (x != -1.0f)
898             return (ast_expression*)ast_binary_new(fold_ctx(fold), INSTR_MUL_F, fold_constgen_float(fold, x, false), out);
899     }
900     return NULL;
901 }
902
903
904 static GMQCC_INLINE ast_expression *fold_op_neg(fold_t *fold, ast_value *a) {
905     if (isfloat(a)) {
906         if (fold_can_1(a))
907             return fold_constgen_float(fold, -fold_immvalue_float(a), false);
908     } else if (isvector(a)) {
909         if (fold_can_1(a))
910             return fold_constgen_vector(fold, vec3_neg(fold_immvalue_vector(a)));
911     }
912     return NULL;
913 }
914
915 static GMQCC_INLINE ast_expression *fold_op_not(fold_t *fold, ast_value *a) {
916     if (isfloat(a)) {
917         if (fold_can_1(a))
918             return fold_constgen_float(fold, !fold_immvalue_float(a), false);
919     } else if (isvector(a)) {
920         if (fold_can_1(a))
921             return fold_constgen_float(fold, vec3_notf(fold_immvalue_vector(a)), false);
922     } else if (isstring(a)) {
923         if (fold_can_1(a)) {
924             if (OPTS_FLAG(TRUE_EMPTY_STRINGS))
925                 return fold_constgen_float(fold, !fold_immvalue_string(a), false);
926             else
927                 return fold_constgen_float(fold, !fold_immvalue_string(a) || !*fold_immvalue_string(a), false);
928         }
929     }
930     return NULL;
931 }
932
933 static bool fold_check_except_float(sfloat_t (*callback)(sfloat_state_t *, sfloat_t, sfloat_t),
934                                     fold_t    *fold,
935                                     ast_value *a,
936                                     ast_value *b)
937 {
938     sfloat_state_t s;
939     sfloat_cast_t ca;
940     sfloat_cast_t cb;
941
942     if (!OPTS_FLAG(ARITHMETIC_EXCEPTIONS) && !OPTS_WARN(WARN_INEXACT_COMPARES))
943         return false;
944
945     s.roundingmode   = SFLOAT_ROUND_NEAREST_EVEN;
946     s.tiny           = SFLOAT_TBEFORE;
947     s.exceptionflags = 0;
948     ca.f             = fold_immvalue_float(a);
949     cb.f             = fold_immvalue_float(b);
950
951     callback(&s, ca.s, cb.s);
952     if (s.exceptionflags == 0)
953         return false;
954
955     if (!OPTS_FLAG(ARITHMETIC_EXCEPTIONS))
956         goto inexact_possible;
957
958     sfloat_check(fold_ctx(fold), &s, NULL);
959
960 inexact_possible:
961     return s.exceptionflags & SFLOAT_INEXACT;
962 }
963
964 static bool fold_check_inexact_float(fold_t *fold, ast_value *a, ast_value *b) {
965     lex_ctx_t ctx = fold_ctx(fold);
966     if (!OPTS_WARN(WARN_INEXACT_COMPARES))
967         return false;
968     if (!a->inexact && !b->inexact)
969         return false;
970     return compile_warning(ctx, WARN_INEXACT_COMPARES, "inexact value in comparison");
971 }
972
973 static GMQCC_INLINE ast_expression *fold_op_add(fold_t *fold, ast_value *a, ast_value *b) {
974     if (isfloat(a)) {
975         if (fold_can_2(a, b)) {
976             bool inexact = fold_check_except_float(&sfloat_add, fold, a, b);
977             return fold_constgen_float(fold, fold_immvalue_float(a) + fold_immvalue_float(b), inexact);
978         }
979     } else if (isvector(a)) {
980         if (fold_can_2(a, b))
981             return fold_constgen_vector(fold, vec3_add(fold_ctx(fold),
982                                                        fold_immvalue_vector(a),
983                                                        fold_immvalue_vector(b)));
984     }
985     return NULL;
986 }
987
988 static GMQCC_INLINE ast_expression *fold_op_sub(fold_t *fold, ast_value *a, ast_value *b) {
989     if (isfloat(a)) {
990         if (fold_can_2(a, b)) {
991             bool inexact = fold_check_except_float(&sfloat_sub, fold, a, b);
992             return fold_constgen_float(fold, fold_immvalue_float(a) - fold_immvalue_float(b), inexact);
993         }
994     } else if (isvector(a)) {
995         if (fold_can_2(a, b))
996             return fold_constgen_vector(fold, vec3_sub(fold_ctx(fold),
997                                                        fold_immvalue_vector(a),
998                                                        fold_immvalue_vector(b)));
999     }
1000     return NULL;
1001 }
1002
1003 static GMQCC_INLINE ast_expression *fold_op_mul(fold_t *fold, ast_value *a, ast_value *b) {
1004     if (isfloat(a)) {
1005         if (isvector(b)) {
1006             if (fold_can_2(a, b))
1007                 return fold_constgen_vector(fold, vec3_mulvf(fold_immvalue_vector(b), fold_immvalue_float(a)));
1008         } else {
1009             if (fold_can_2(a, b)) {
1010                 bool inexact = fold_check_except_float(&sfloat_mul, fold, a, b);
1011                 return fold_constgen_float(fold, fold_immvalue_float(a) * fold_immvalue_float(b), inexact);
1012             }
1013         }
1014     } else if (isvector(a)) {
1015         if (isfloat(b)) {
1016             if (fold_can_2(a, b))
1017                 return fold_constgen_vector(fold, vec3_mulvf(fold_immvalue_vector(a), fold_immvalue_float(b)));
1018         } else {
1019             if (fold_can_2(a, b)) {
1020                 return fold_constgen_float(fold, vec3_mulvv(fold_immvalue_vector(a), fold_immvalue_vector(b)), false);
1021             } else if (OPTS_OPTIMIZATION(OPTIM_VECTOR_COMPONENTS) && fold_can_1(a)) {
1022                 ast_expression *out;
1023                 if ((out = fold_op_mul_vec(fold, fold_immvalue_vector(a), b, "xyz"))) return out;
1024                 if ((out = fold_op_mul_vec(fold, fold_immvalue_vector(a), b, "yxz"))) return out;
1025                 if ((out = fold_op_mul_vec(fold, fold_immvalue_vector(a), b, "zxy"))) return out;
1026             } else if (OPTS_OPTIMIZATION(OPTIM_VECTOR_COMPONENTS) && fold_can_1(b)) {
1027                 ast_expression *out;
1028                 if ((out = fold_op_mul_vec(fold, fold_immvalue_vector(b), a, "xyz"))) return out;
1029                 if ((out = fold_op_mul_vec(fold, fold_immvalue_vector(b), a, "yxz"))) return out;
1030                 if ((out = fold_op_mul_vec(fold, fold_immvalue_vector(b), a, "zxy"))) return out;
1031             }
1032         }
1033     }
1034     return NULL;
1035 }
1036
1037 static GMQCC_INLINE ast_expression *fold_op_div(fold_t *fold, ast_value *a, ast_value *b) {
1038     if (isfloat(a)) {
1039         if (fold_can_2(a, b)) {
1040             bool inexact = fold_check_except_float(&sfloat_div, fold, a, b);
1041             return fold_constgen_float(fold, fold_immvalue_float(a) / fold_immvalue_float(b), inexact);
1042         } else if (fold_can_1(b)) {
1043             return (ast_expression*)ast_binary_new(
1044                 fold_ctx(fold),
1045                 INSTR_MUL_F,
1046                 (ast_expression*)a,
1047                 fold_constgen_float(fold, 1.0f / fold_immvalue_float(b), false)
1048             );
1049         }
1050     } else if (isvector(a)) {
1051         if (fold_can_2(a, b)) {
1052             return fold_constgen_vector(fold, vec3_mulvf(fold_immvalue_vector(a), 1.0f / fold_immvalue_float(b)));
1053         } else {
1054             return (ast_expression*)ast_binary_new(
1055                 fold_ctx(fold),
1056                 INSTR_MUL_VF,
1057                 (ast_expression*)a,
1058                 (fold_can_1(b))
1059                     ? (ast_expression*)fold_constgen_float(fold, 1.0f / fold_immvalue_float(b), false)
1060                     : (ast_expression*)ast_binary_new(
1061                                             fold_ctx(fold),
1062                                             INSTR_DIV_F,
1063                                             (ast_expression*)fold->imm_float[1],
1064                                             (ast_expression*)b
1065                     )
1066             );
1067         }
1068     }
1069     return NULL;
1070 }
1071
1072 static GMQCC_INLINE ast_expression *fold_op_mod(fold_t *fold, ast_value *a, ast_value *b) {
1073     return (fold_can_2(a, b))
1074                 ? fold_constgen_float(fold, fmod(fold_immvalue_float(a), fold_immvalue_float(b)), false)
1075                 : NULL;
1076 }
1077
1078 static GMQCC_INLINE ast_expression *fold_op_bor(fold_t *fold, ast_value *a, ast_value *b) {
1079     if (isfloat(a)) {
1080         if (fold_can_2(a, b))
1081             return fold_constgen_float(fold, (qcfloat_t)(((qcint_t)fold_immvalue_float(a)) | ((qcint_t)fold_immvalue_float(b))), false);
1082     } else {
1083         if (isvector(b)) {
1084             if (fold_can_2(a, b))
1085                 return fold_constgen_vector(fold, vec3_or(fold_immvalue_vector(a), fold_immvalue_vector(b)));
1086         } else {
1087             if (fold_can_2(a, b))
1088                 return fold_constgen_vector(fold, vec3_orvf(fold_immvalue_vector(a), fold_immvalue_float(b)));
1089         }
1090     }
1091     return NULL;
1092 }
1093
1094 static GMQCC_INLINE ast_expression *fold_op_band(fold_t *fold, ast_value *a, ast_value *b) {
1095     if (isfloat(a)) {
1096         if (fold_can_2(a, b))
1097             return fold_constgen_float(fold, (qcfloat_t)(((qcint_t)fold_immvalue_float(a)) & ((qcint_t)fold_immvalue_float(b))), false);
1098     } else {
1099         if (isvector(b)) {
1100             if (fold_can_2(a, b))
1101                 return fold_constgen_vector(fold, vec3_and(fold_immvalue_vector(a), fold_immvalue_vector(b)));
1102         } else {
1103             if (fold_can_2(a, b))
1104                 return fold_constgen_vector(fold, vec3_andvf(fold_immvalue_vector(a), fold_immvalue_float(b)));
1105         }
1106     }
1107     return NULL;
1108 }
1109
1110 static GMQCC_INLINE ast_expression *fold_op_xor(fold_t *fold, ast_value *a, ast_value *b) {
1111     if (isfloat(a)) {
1112         if (fold_can_2(a, b))
1113             return fold_constgen_float(fold, (qcfloat_t)(((qcint_t)fold_immvalue_float(a)) ^ ((qcint_t)fold_immvalue_float(b))), false);
1114     } else {
1115         if (fold_can_2(a, b)) {
1116             if (isvector(b))
1117                 return fold_constgen_vector(fold, vec3_xor(fold_immvalue_vector(a), fold_immvalue_vector(b)));
1118             else
1119                 return fold_constgen_vector(fold, vec3_xorvf(fold_immvalue_vector(a), fold_immvalue_float(b)));
1120         }
1121     }
1122     return NULL;
1123 }
1124
1125 static GMQCC_INLINE ast_expression *fold_op_lshift(fold_t *fold, ast_value *a, ast_value *b) {
1126     if (fold_can_2(a, b) && isfloats(a, b))
1127         return fold_constgen_float(fold, (qcfloat_t)floorf(fold_immvalue_float(a) * powf(2.0f, fold_immvalue_float(b))), false);
1128     return NULL;
1129 }
1130
1131 static GMQCC_INLINE ast_expression *fold_op_rshift(fold_t *fold, ast_value *a, ast_value *b) {
1132     if (fold_can_2(a, b) && isfloats(a, b))
1133         return fold_constgen_float(fold, (qcfloat_t)floorf(fold_immvalue_float(a) / powf(2.0f, fold_immvalue_float(b))), false);
1134     return NULL;
1135 }
1136
1137 static GMQCC_INLINE ast_expression *fold_op_andor(fold_t *fold, ast_value *a, ast_value *b, float expr) {
1138     if (fold_can_2(a, b)) {
1139         if (OPTS_FLAG(PERL_LOGIC)) {
1140             if (expr)
1141                 return (fold_immediate_true(fold, a)) ? (ast_expression*)a : (ast_expression*)b;
1142             else
1143                 return (fold_immediate_true(fold, a)) ? (ast_expression*)b : (ast_expression*)a;
1144         } else {
1145             return fold_constgen_float (
1146                 fold,
1147                 ((expr) ? (fold_immediate_true(fold, a) || fold_immediate_true(fold, b))
1148                         : (fold_immediate_true(fold, a) && fold_immediate_true(fold, b)))
1149                             ? 1
1150                             : 0,
1151                 false
1152             );
1153         }
1154     }
1155     return NULL;
1156 }
1157
1158 static GMQCC_INLINE ast_expression *fold_op_tern(fold_t *fold, ast_value *a, ast_value *b, ast_value *c) {
1159     if (fold_can_1(a)) {
1160         return fold_immediate_true(fold, a)
1161                     ? (ast_expression*)b
1162                     : (ast_expression*)c;
1163     }
1164     return NULL;
1165 }
1166
1167 static GMQCC_INLINE ast_expression *fold_op_exp(fold_t *fold, ast_value *a, ast_value *b) {
1168     if (fold_can_2(a, b))
1169         return fold_constgen_float(fold, (qcfloat_t)powf(fold_immvalue_float(a), fold_immvalue_float(b)), false);
1170     return NULL;
1171 }
1172
1173 static GMQCC_INLINE ast_expression *fold_op_lteqgt(fold_t *fold, ast_value *a, ast_value *b) {
1174     if (fold_can_2(a,b)) {
1175         fold_check_inexact_float(fold, a, b);
1176         if (fold_immvalue_float(a) <  fold_immvalue_float(b)) return (ast_expression*)fold->imm_float[2];
1177         if (fold_immvalue_float(a) == fold_immvalue_float(b)) return (ast_expression*)fold->imm_float[0];
1178         if (fold_immvalue_float(a) >  fold_immvalue_float(b)) return (ast_expression*)fold->imm_float[1];
1179     }
1180     return NULL;
1181 }
1182
1183 static GMQCC_INLINE ast_expression *fold_op_ltgt(fold_t *fold, ast_value *a, ast_value *b, bool lt) {
1184     if (fold_can_2(a, b)) {
1185         fold_check_inexact_float(fold, a, b);
1186         return (lt) ? (ast_expression*)fold->imm_float[!!(fold_immvalue_float(a) < fold_immvalue_float(b))]
1187                     : (ast_expression*)fold->imm_float[!!(fold_immvalue_float(a) > fold_immvalue_float(b))];
1188     }
1189     return NULL;
1190 }
1191
1192 static GMQCC_INLINE ast_expression *fold_op_cmp(fold_t *fold, ast_value *a, ast_value *b, bool ne) {
1193     if (fold_can_2(a, b)) {
1194         if (isfloat(a) && isfloat(b)) {
1195             float la = fold_immvalue_float(a);
1196             float lb = fold_immvalue_float(b);
1197             fold_check_inexact_float(fold, a, b);
1198             return (ast_expression*)fold->imm_float[!(ne ? la == lb : la != lb)];
1199         } if (isvector(a) && isvector(b)) {
1200             vec3_t la = fold_immvalue_vector(a);
1201             vec3_t lb = fold_immvalue_vector(b);
1202             return (ast_expression*)fold->imm_float[!(ne ? vec3_cmp(la, lb) : !vec3_cmp(la, lb))];
1203         }
1204     }
1205     return NULL;
1206 }
1207
1208 static GMQCC_INLINE ast_expression *fold_op_bnot(fold_t *fold, ast_value *a) {
1209     if (isfloat(a)) {
1210         if (fold_can_1(a))
1211             return fold_constgen_float(fold, -1-fold_immvalue_float(a), false);
1212     } else {
1213         if (isvector(a)) {
1214             if (fold_can_1(a))
1215                 return fold_constgen_vector(fold, vec3_not(fold_immvalue_vector(a)));
1216         }
1217     }
1218     return NULL;
1219 }
1220
1221 static GMQCC_INLINE ast_expression *fold_op_cross(fold_t *fold, ast_value *a, ast_value *b) {
1222     if (fold_can_2(a, b))
1223         return fold_constgen_vector(fold, vec3_cross(fold_immvalue_vector(a), fold_immvalue_vector(b)));
1224     return NULL;
1225 }
1226
1227 ast_expression *fold_op(fold_t *fold, const oper_info *info, ast_expression **opexprs) {
1228     ast_value      *a = (ast_value*)opexprs[0];
1229     ast_value      *b = (ast_value*)opexprs[1];
1230     ast_value      *c = (ast_value*)opexprs[2];
1231     ast_expression *e = NULL;
1232
1233     /* can a fold operation be applied to this operator usage? */
1234     if (!info->folds)
1235         return NULL;
1236
1237     switch(info->operands) {
1238         case 3: if(!c) return NULL;
1239         case 2: if(!b) return NULL;
1240         case 1:
1241         if(!a) {
1242             compile_error(fold_ctx(fold), "internal error: fold_op no operands to fold\n");
1243             return NULL;
1244         }
1245     }
1246
1247     /*
1248      * we could use a boolean and default case but ironically gcc produces
1249      * invalid broken assembly from that operation. clang/tcc get it right,
1250      * but interestingly ignore compiling this to a jump-table when I do that,
1251      * this happens to be the most efficent method, since you have per-level
1252      * granularity on the pointer check happening only for the case you check
1253      * it in. Opposed to the default method which would involve a boolean and
1254      * pointer check after wards.
1255      */
1256     #define fold_op_case(ARGS, ARGS_OPID, OP, ARGS_FOLD)    \
1257         case opid##ARGS ARGS_OPID:                          \
1258             if ((e = fold_op_##OP ARGS_FOLD)) {             \
1259                 ++opts_optimizationcount[OPTIM_CONST_FOLD]; \
1260             }                                               \
1261             return e
1262
1263     switch(info->id) {
1264         fold_op_case(2, ('-', 'P'),    neg,    (fold, a));
1265         fold_op_case(2, ('!', 'P'),    not,    (fold, a));
1266         fold_op_case(1, ('+'),         add,    (fold, a, b));
1267         fold_op_case(1, ('-'),         sub,    (fold, a, b));
1268         fold_op_case(1, ('*'),         mul,    (fold, a, b));
1269         fold_op_case(1, ('/'),         div,    (fold, a, b));
1270         fold_op_case(1, ('%'),         mod,    (fold, a, b));
1271         fold_op_case(1, ('|'),         bor,    (fold, a, b));
1272         fold_op_case(1, ('&'),         band,   (fold, a, b));
1273         fold_op_case(1, ('^'),         xor,    (fold, a, b));
1274         fold_op_case(1, ('<'),         ltgt,   (fold, a, b, true));
1275         fold_op_case(1, ('>'),         ltgt,   (fold, a, b, false));
1276         fold_op_case(2, ('<', '<'),    lshift, (fold, a, b));
1277         fold_op_case(2, ('>', '>'),    rshift, (fold, a, b));
1278         fold_op_case(2, ('|', '|'),    andor,  (fold, a, b, true));
1279         fold_op_case(2, ('&', '&'),    andor,  (fold, a, b, false));
1280         fold_op_case(2, ('?', ':'),    tern,   (fold, a, b, c));
1281         fold_op_case(2, ('*', '*'),    exp,    (fold, a, b));
1282         fold_op_case(3, ('<','=','>'), lteqgt, (fold, a, b));
1283         fold_op_case(2, ('!', '='),    cmp,    (fold, a, b, true));
1284         fold_op_case(2, ('=', '='),    cmp,    (fold, a, b, false));
1285         fold_op_case(2, ('~', 'P'),    bnot,   (fold, a));
1286         fold_op_case(2, ('>', '<'),    cross,  (fold, a, b));
1287     }
1288     #undef fold_op_case
1289     compile_error(fold_ctx(fold), "internal error: attempted to constant-fold for unsupported operator");
1290     return NULL;
1291 }
1292
1293 /*
1294  * Constant folding for compiler intrinsics, simaler approach to operator
1295  * folding, primarly: individual functions for each intrinsics to fold,
1296  * and a generic selection function.
1297  */
1298 static GMQCC_INLINE ast_expression *fold_intrin_isfinite(fold_t *fold, ast_value *a) {
1299     return fold_constgen_float(fold, isfinite(fold_immvalue_float(a)), false);
1300 }
1301 static GMQCC_INLINE ast_expression *fold_intrin_isinf(fold_t *fold, ast_value *a) {
1302     return fold_constgen_float(fold, isinf(fold_immvalue_float(a)), false);
1303 }
1304 static GMQCC_INLINE ast_expression *fold_intrin_isnan(fold_t *fold, ast_value *a) {
1305     return fold_constgen_float(fold, isnan(fold_immvalue_float(a)), false);
1306 }
1307 static GMQCC_INLINE ast_expression *fold_intrin_isnormal(fold_t *fold, ast_value *a) {
1308     return fold_constgen_float(fold, isnormal(fold_immvalue_float(a)), false);
1309 }
1310 static GMQCC_INLINE ast_expression *fold_intrin_signbit(fold_t *fold, ast_value *a) {
1311     return fold_constgen_float(fold, signbit(fold_immvalue_float(a)), false);
1312 }
1313 static GMQCC_INLINE ast_expression *fold_intirn_acosh(fold_t *fold, ast_value *a) {
1314     return fold_constgen_float(fold, acoshf(fold_immvalue_float(a)), false);
1315 }
1316 static GMQCC_INLINE ast_expression *fold_intrin_asinh(fold_t *fold, ast_value *a) {
1317     return fold_constgen_float(fold, asinhf(fold_immvalue_float(a)), false);
1318 }
1319 static GMQCC_INLINE ast_expression *fold_intrin_atanh(fold_t *fold, ast_value *a) {
1320     return fold_constgen_float(fold, (float)atanh(fold_immvalue_float(a)), false);
1321 }
1322 static GMQCC_INLINE ast_expression *fold_intrin_exp(fold_t *fold, ast_value *a) {
1323     return fold_constgen_float(fold, expf(fold_immvalue_float(a)), false);
1324 }
1325 static GMQCC_INLINE ast_expression *fold_intrin_exp2(fold_t *fold, ast_value *a) {
1326     return fold_constgen_float(fold, exp2f(fold_immvalue_float(a)), false);
1327 }
1328 static GMQCC_INLINE ast_expression *fold_intrin_expm1(fold_t *fold, ast_value *a) {
1329     return fold_constgen_float(fold, expm1f(fold_immvalue_float(a)), false);
1330 }
1331 static GMQCC_INLINE ast_expression *fold_intrin_mod(fold_t *fold, ast_value *lhs, ast_value *rhs) {
1332     return fold_constgen_float(fold, fmodf(fold_immvalue_float(lhs), fold_immvalue_float(rhs)), false);
1333 }
1334 static GMQCC_INLINE ast_expression *fold_intrin_pow(fold_t *fold, ast_value *lhs, ast_value *rhs) {
1335     return fold_constgen_float(fold, powf(fold_immvalue_float(lhs), fold_immvalue_float(rhs)), false);
1336 }
1337 static GMQCC_INLINE ast_expression *fold_intrin_fabs(fold_t *fold, ast_value *a) {
1338     return fold_constgen_float(fold, fabsf(fold_immvalue_float(a)), false);
1339 }
1340
1341
1342 ast_expression *fold_intrin(fold_t *fold, const char *intrin, ast_expression **arg) {
1343     ast_expression *ret = NULL;
1344     ast_value      *a   = (ast_value*)arg[0];
1345     ast_value      *b   = (ast_value*)arg[1];
1346
1347     if (!strcmp(intrin, "isfinite")) ret = fold_intrin_isfinite(fold, a);
1348     if (!strcmp(intrin, "isinf"))    ret = fold_intrin_isinf(fold, a);
1349     if (!strcmp(intrin, "isnan"))    ret = fold_intrin_isnan(fold, a);
1350     if (!strcmp(intrin, "isnormal")) ret = fold_intrin_isnormal(fold, a);
1351     if (!strcmp(intrin, "signbit"))  ret = fold_intrin_signbit(fold, a);
1352     if (!strcmp(intrin, "acosh"))    ret = fold_intirn_acosh(fold, a);
1353     if (!strcmp(intrin, "asinh"))    ret = fold_intrin_asinh(fold, a);
1354     if (!strcmp(intrin, "atanh"))    ret = fold_intrin_atanh(fold, a);
1355     if (!strcmp(intrin, "exp"))      ret = fold_intrin_exp(fold, a);
1356     if (!strcmp(intrin, "exp2"))     ret = fold_intrin_exp2(fold, a);
1357     if (!strcmp(intrin, "expm1"))    ret = fold_intrin_expm1(fold, a);
1358     if (!strcmp(intrin, "mod"))      ret = fold_intrin_mod(fold, a, b);
1359     if (!strcmp(intrin, "pow"))      ret = fold_intrin_pow(fold, a, b);
1360     if (!strcmp(intrin, "fabs"))     ret = fold_intrin_fabs(fold, a);
1361
1362     if (ret)
1363         ++opts_optimizationcount[OPTIM_CONST_FOLD];
1364
1365     return ret;
1366 }
1367
1368 /*
1369  * These are all the actual constant folding methods that happen in between
1370  * the AST/IR stage of the compiler , i.e eliminating branches for const
1371  * expressions, which is the only supported thing so far. We undefine the
1372  * testing macros here because an ir_value is differant than an ast_value.
1373  */
1374 #undef expect
1375 #undef isfloat
1376 #undef isstring
1377 #undef isvector
1378 #undef fold_immvalue_float
1379 #undef fold_immvalue_string
1380 #undef fold_immvalue_vector
1381 #undef fold_can_1
1382 #undef fold_can_2
1383
1384 #define isfloat(X)              ((X)->vtype == TYPE_FLOAT)
1385 /*#define isstring(X)             ((X)->vtype == TYPE_STRING)*/
1386 /*#define isvector(X)             ((X)->vtype == TYPE_VECTOR)*/
1387 #define fold_immvalue_float(X)  ((X)->constval.vfloat)
1388 #define fold_immvalue_vector(X) ((X)->constval.vvec)
1389 /*#define fold_immvalue_string(X) ((X)->constval.vstring)*/
1390 #define fold_can_1(X)           ((X)->hasvalue && (X)->cvq == CV_CONST)
1391 /*#define fold_can_2(X,Y)         (fold_can_1(X) && fold_can_1(Y))*/
1392
1393 static ast_expression *fold_superfluous(ast_expression *left, ast_expression *right, int op) {
1394     ast_expression *swapped = NULL; /* using this as bool */
1395     ast_value *load;
1396
1397     if (!ast_istype(right, ast_value) || !fold_can_1((load = (ast_value*)right))) {
1398         swapped = left;
1399         left    = right;
1400         right   = swapped;
1401     }
1402
1403     if (!ast_istype(right, ast_value) || !fold_can_1((load = (ast_value*)right)))
1404         return NULL;
1405
1406     switch (op) {
1407         case INSTR_DIV_F:
1408             if (swapped)
1409                 return NULL;
1410         case INSTR_MUL_F:
1411             if (fold_immvalue_float(load) == 1.0f) {
1412                 ++opts_optimizationcount[OPTIM_PEEPHOLE];
1413                 ast_unref(right);
1414                 return left;
1415             }
1416             break;
1417
1418
1419         case INSTR_SUB_F:
1420             if (swapped)
1421                 return NULL;
1422         case INSTR_ADD_F:
1423             if (fold_immvalue_float(load) == 0.0f) {
1424                 ++opts_optimizationcount[OPTIM_PEEPHOLE];
1425                 ast_unref(right);
1426                 return left;
1427             }
1428             break;
1429
1430         case INSTR_MUL_V:
1431             if (vec3_cmp(fold_immvalue_vector(load), vec3_create(1, 1, 1))) {
1432                 ++opts_optimizationcount[OPTIM_PEEPHOLE];
1433                 ast_unref(right);
1434                 return left;
1435             }
1436             break;
1437
1438         case INSTR_SUB_V:
1439             if (swapped)
1440                 return NULL;
1441         case INSTR_ADD_V:
1442             if (vec3_cmp(fold_immvalue_vector(load), vec3_create(0, 0, 0))) {
1443                 ++opts_optimizationcount[OPTIM_PEEPHOLE];
1444                 ast_unref(right);
1445                 return left;
1446             }
1447             break;
1448     }
1449
1450     return NULL;
1451 }
1452
1453 ast_expression *fold_binary(lex_ctx_t ctx, int op, ast_expression *left, ast_expression *right) {
1454     ast_expression *ret = fold_superfluous(left, right, op);
1455     if (ret)
1456         return ret;
1457     return (ast_expression*)ast_binary_new(ctx, op, left, right);
1458 }
1459
1460 static GMQCC_INLINE int fold_cond(ir_value *condval, ast_function *func, ast_ifthen *branch) {
1461     if (isfloat(condval) && fold_can_1(condval) && OPTS_OPTIMIZATION(OPTIM_CONST_FOLD_DCE)) {
1462         ast_expression_codegen *cgen;
1463         ir_block               *elide;
1464         ir_value               *dummy;
1465         bool                    istrue  = (fold_immvalue_float(condval) != 0.0f && branch->on_true);
1466         bool                    isfalse = (fold_immvalue_float(condval) == 0.0f && branch->on_false);
1467         ast_expression         *path    = (istrue)  ? branch->on_true  :
1468                                           (isfalse) ? branch->on_false : NULL;
1469         if (!path) {
1470             /*
1471              * no path to take implies that the evaluation is if(0) and there
1472              * is no else block. so eliminate all the code.
1473              */
1474             ++opts_optimizationcount[OPTIM_CONST_FOLD_DCE];
1475             return true;
1476         }
1477
1478         if (!(elide = ir_function_create_block(ast_ctx(branch), func->ir_func, ast_function_label(func, ((istrue) ? "ontrue" : "onfalse")))))
1479             return false;
1480         if (!(*(cgen = path->codegen))((ast_expression*)path, func, false, &dummy))
1481             return false;
1482         if (!ir_block_create_jump(func->curblock, ast_ctx(branch), elide))
1483             return false;
1484         /*
1485          * now the branch has been eliminated and the correct block for the constant evaluation
1486          * is expanded into the current block for the function.
1487          */
1488         func->curblock = elide;
1489         ++opts_optimizationcount[OPTIM_CONST_FOLD_DCE];
1490         return true;
1491     }
1492     return -1; /* nothing done */
1493 }
1494
1495 int fold_cond_ternary(ir_value *condval, ast_function *func, ast_ternary *branch) {
1496     return fold_cond(condval, func, (ast_ifthen*)branch);
1497 }
1498
1499 int fold_cond_ifthen(ir_value *condval, ast_function *func, ast_ifthen *branch) {
1500     return fold_cond(condval, func, branch);
1501 }