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