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