reactos/dll/opengl/mesa/src/glsl/glsl_types.cpp

   1 /*
   2  * Copyright © 2009 Intel Corporation
   3  *
   4  * Permission is hereby granted, free of charge, to any person obtaining a
   5  * copy of this software and associated documentation files (the "Software"),
   6  * to deal in the Software without restriction, including without limitation
   7  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
   8  * and/or sell copies of the Software, and to permit persons to whom the
   9  * Software is furnished to do so, subject to the following conditions:
  10  *
  11  * The above copyright notice and this permission notice (including the next
  12  * paragraph) shall be included in all copies or substantial portions of the
  13  * 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
  18  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  19  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  20  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  21  * DEALINGS IN THE SOFTWARE.
  22  */
  23
  24 #include <stdio.h>
  25 #include <stdlib.h>
  26 #include "main/core.h" /* for Elements */
  27 #include "glsl_symbol_table.h"
  28 #include "glsl_parser_extras.h"
  29 #include "glsl_types.h"
  30 #include "builtin_types.h"
  31 extern "C" {
  32 #include "program/hash_table.h"
  33 }
  34
  35 hash_table *glsl_type::array_types = NULL;
  36 hash_table *glsl_type::record_types = NULL;
  37 void *glsl_type::mem_ctx = NULL;
  38
  39 void
  40 glsl_type::init_ralloc_type_ctx(void)
  41 {
  42    if (glsl_type::mem_ctx == NULL) {
  43       glsl_type::mem_ctx = ralloc_autofree_context();
  44       assert(glsl_type::mem_ctx != NULL);
  45    }
  46 }
  47
  48 glsl_type::glsl_type(GLenum gl_type,
  49                      glsl_base_type base_type, unsigned vector_elements,
  50                      unsigned matrix_columns, const char *name) :
  51    gl_type(gl_type),
  52    base_type(base_type),
  53    sampler_dimensionality(0), sampler_shadow(0),
  54    sampler_type(0),
  55    vector_elements(vector_elements), matrix_columns(matrix_columns),
  56    length(0)
  57 {
  58    init_ralloc_type_ctx();
  59    this->name = ralloc_strdup(this->mem_ctx, name);
  60    /* Neither dimension is zero or both dimensions are zero.
  61     */
  62    assert((vector_elements == 0) == (matrix_columns == 0));
  63    memset(& fields, 0, sizeof(fields));
  64 }
  65
  66 glsl_type::glsl_type(GLenum gl_type,
  67                      enum glsl_sampler_dim dim, bool shadow, bool array,
  68                      unsigned type, const char *name) :
  69    gl_type(gl_type),
  70    base_type(GLSL_TYPE_SAMPLER),
  71    sampler_dimensionality(dim), sampler_shadow(shadow),
  72    sampler_type(type),
  73    vector_elements(0), matrix_columns(0),
  74    length(0)
  75 {
  76    init_ralloc_type_ctx();
  77    this->name = ralloc_strdup(this->mem_ctx, name);
  78    memset(& fields, 0, sizeof(fields));
  79 }
  80
  81 glsl_type::glsl_type(const glsl_struct_field *fields, unsigned num_fields,
  82                      const char *name) :
  83    base_type(GLSL_TYPE_STRUCT),
  84    sampler_dimensionality(0), sampler_shadow(0),
  85    sampler_type(0),
  86    vector_elements(0), matrix_columns(0),
  87    length(num_fields)
  88 {
  89    unsigned int i;
  90
  91    init_ralloc_type_ctx();
  92    this->name = ralloc_strdup(this->mem_ctx, name);
  93    this->fields.structure = ralloc_array(this->mem_ctx,
  94                                          glsl_struct_field, length);
  95    for (i = 0; i < length; i++) {
  96       this->fields.structure[i].type = fields[i].type;
  97       this->fields.structure[i].name = ralloc_strdup(this->fields.structure,
  98                                                      fields[i].name);
  99    }
 100 }
 101
 102 static void
 103 add_types_to_symbol_table(glsl_symbol_table *symtab,
 104                           const struct glsl_type *types,
 105                           unsigned num_types, bool warn)
 106 {
 107    (void) warn;
 108
 109    for (unsigned i = 0; i < num_types; i++) {
 110       symtab->add_type(types[i].name, & types[i]);
 111    }
 112 }
 113
 114 bool
 115 glsl_type::contains_sampler() const
 116 {
 117    if (this->is_array()) {
 118       return this->fields.array->contains_sampler();
 119    } else if (this->is_record()) {
 120       for (unsigned int i = 0; i < this->length; i++) {
 121          if (this->fields.structure[i].type->contains_sampler())
 122             return true;
 123       }
 124       return false;
 125    } else {
 126       return this->is_sampler();
 127    }
 128 }
 129
 130 gl_texture_index
 131 glsl_type::sampler_index() const
 132 {
 133    const glsl_type *const t = (this->is_array()) ? this->fields.array : this;
 134
 135    assert(t->is_sampler());
 136
 137    switch (t->sampler_dimensionality) {
 138    case GLSL_SAMPLER_DIM_1D:
 139       return TEXTURE_1D_INDEX;
 140    case GLSL_SAMPLER_DIM_2D:
 141       return TEXTURE_2D_INDEX;
 142    case GLSL_SAMPLER_DIM_3D:
 143       return TEXTURE_3D_INDEX;
 144    case GLSL_SAMPLER_DIM_CUBE:
 145       return TEXTURE_CUBE_INDEX;
 146    default:
 147       assert(!"Should not get here.");
 148       return TEXTURE_2D_INDEX;
 149    }
 150 }
 151
 152 void
 153 glsl_type::generate_100ES_types(glsl_symbol_table *symtab)
 154 {
 155    add_types_to_symbol_table(symtab, builtin_core_types,
 156                              Elements(builtin_core_types),
 157                              false);
 158    add_types_to_symbol_table(symtab, builtin_structure_types,
 159                              Elements(builtin_structure_types),
 160                              false);
 161    add_types_to_symbol_table(symtab, void_type, 1, false);
 162 }
 163
 164 void
 165 glsl_type::generate_110_types(glsl_symbol_table *symtab)
 166 {
 167    generate_100ES_types(symtab);
 168
 169    add_types_to_symbol_table(symtab, builtin_110_types,
 170                              Elements(builtin_110_types),
 171                              false);
 172    add_types_to_symbol_table(symtab, &_sampler3D_type, 1, false);
 173    add_types_to_symbol_table(symtab, builtin_110_deprecated_structure_types,
 174                              Elements(builtin_110_deprecated_structure_types),
 175                              false);
 176 }
 177
 178
 179 void
 180 glsl_type::generate_120_types(glsl_symbol_table *symtab)
 181 {
 182    generate_110_types(symtab);
 183
 184    add_types_to_symbol_table(symtab, builtin_120_types,
 185                              Elements(builtin_120_types), false);
 186 }
 187
 188
 189 void
 190 glsl_type::generate_130_types(glsl_symbol_table *symtab)
 191 {
 192    generate_120_types(symtab);
 193
 194    add_types_to_symbol_table(symtab, builtin_130_types,
 195                              Elements(builtin_130_types), false);
 196 }
 197
 198
 199 void
 200 glsl_type::generate_OES_texture_3D_types(glsl_symbol_table *symtab, bool warn)
 201 {
 202    add_types_to_symbol_table(symtab, &_sampler3D_type, 1, warn);
 203 }
 204
 205 void
 206 _mesa_glsl_initialize_types(struct _mesa_glsl_parse_state *state)
 207 {
 208    switch (state->language_version) {
 209    case 110:
 210       glsl_type::generate_110_types(state->symbols);
 211       break;
 212    case 120:
 213       glsl_type::generate_120_types(state->symbols);
 214       break;
 215    case 130:
 216       glsl_type::generate_130_types(state->symbols);
 217       break;
 218    default:
 219       /* error */
 220       break;
 221    }
 222
 223    if (state->OES_texture_3D_enable && state->language_version == 100) {
 224       glsl_type::generate_OES_texture_3D_types(state->symbols,
 225                                                state->OES_texture_3D_warn);
 226    }
 227 }
 228
 229
 230 const glsl_type *glsl_type::get_base_type() const
 231 {
 232    switch (base_type) {
 233    case GLSL_TYPE_UINT:
 234       return uint_type;
 235    case GLSL_TYPE_INT:
 236       return int_type;
 237    case GLSL_TYPE_FLOAT:
 238       return float_type;
 239    case GLSL_TYPE_BOOL:
 240       return bool_type;
 241    default:
 242       return error_type;
 243    }
 244 }
 245
 246
 247 const glsl_type *glsl_type::get_scalar_type() const
 248 {
 249    const glsl_type *type = this;
 250
 251    /* Handle arrays */
 252    while (type->base_type == GLSL_TYPE_ARRAY)
 253       type = type->fields.array;
 254
 255    /* Handle vectors and matrices */
 256    switch (type->base_type) {
 257    case GLSL_TYPE_UINT:
 258       return uint_type;
 259    case GLSL_TYPE_INT:
 260       return int_type;
 261    case GLSL_TYPE_FLOAT:
 262       return float_type;
 263    default:
 264       /* Handle everything else */
 265       return type;
 266    }
 267 }
 268
 269
 270 void
 271 _mesa_glsl_release_types(void)
 272 {
 273    if (glsl_type::array_types != NULL) {
 274       hash_table_dtor(glsl_type::array_types);
 275       glsl_type::array_types = NULL;
 276    }
 277
 278    if (glsl_type::record_types != NULL) {
 279       hash_table_dtor(glsl_type::record_types);
 280       glsl_type::record_types = NULL;
 281    }
 282 }
 283
 284
 285 glsl_type::glsl_type(const glsl_type *array, unsigned length) :
 286    base_type(GLSL_TYPE_ARRAY),
 287    sampler_dimensionality(0), sampler_shadow(0),
 288    sampler_type(0),
 289    vector_elements(0), matrix_columns(0),
 290    name(NULL), length(length)
 291 {
 292    this->fields.array = array;
 293    /* Inherit the gl type of the base. The GL type is used for
 294     * uniform/statevar handling in Mesa and the arrayness of the type
 295     * is represented by the size rather than the type.
 296     */
 297    this->gl_type = array->gl_type;
 298
 299    /* Allow a maximum of 10 characters for the array size.  This is enough
 300     * for 32-bits of ~0.  The extra 3 are for the '[', ']', and terminating
 301     * NUL.
 302     */
 303    const unsigned name_length = strlen(array->name) + 10 + 3;
 304    char *const n = (char *) ralloc_size(this->mem_ctx, name_length);
 305
 306    if (length == 0)
 307       snprintf(n, name_length, "%s[]", array->name);
 308    else
 309       snprintf(n, name_length, "%s[%u]", array->name, length);
 310
 311    this->name = n;
 312 }
 313
 314
 315 const glsl_type *
 316 glsl_type::get_instance(unsigned base_type, unsigned rows, unsigned columns)
 317 {
 318    if (base_type == GLSL_TYPE_VOID)
 319       return void_type;
 320
 321    if ((rows < 1) || (rows > 4) || (columns < 1) || (columns > 4))
 322       return error_type;
 323
 324    /* Treat GLSL vectors as Nx1 matrices.
 325     */
 326    if (columns == 1) {
 327       switch (base_type) {
 328       case GLSL_TYPE_UINT:
 329          return uint_type + (rows - 1);
 330       case GLSL_TYPE_INT:
 331          return int_type + (rows - 1);
 332       case GLSL_TYPE_FLOAT:
 333          return float_type + (rows - 1);
 334       case GLSL_TYPE_BOOL:
 335          return bool_type + (rows - 1);
 336       default:
 337          return error_type;
 338       }
 339    } else {
 340       if ((base_type != GLSL_TYPE_FLOAT) || (rows == 1))
 341          return error_type;
 342
 343       /* GLSL matrix types are named mat{COLUMNS}x{ROWS}.  Only the following
 344        * combinations are valid:
 345        *
 346        *   1 2 3 4
 347        * 1
 348        * 2   x x x
 349        * 3   x x x
 350        * 4   x x x
 351        */
 352 #define IDX(c,r) (((c-1)*3) + (r-1))
 353
 354       switch (IDX(columns, rows)) {
 355       case IDX(2,2): return mat2_type;
 356       case IDX(2,3): return mat2x3_type;
 357       case IDX(2,4): return mat2x4_type;
 358       case IDX(3,2): return mat3x2_type;
 359       case IDX(3,3): return mat3_type;
 360       case IDX(3,4): return mat3x4_type;
 361       case IDX(4,2): return mat4x2_type;
 362       case IDX(4,3): return mat4x3_type;
 363       case IDX(4,4): return mat4_type;
 364       default: return error_type;
 365       }
 366    }
 367
 368    assert(!"Should not get here.");
 369    return error_type;
 370 }
 371
 372
 373 const glsl_type *
 374 glsl_type::get_array_instance(const glsl_type *base, unsigned array_size)
 375 {
 376
 377    if (array_types == NULL) {
 378       array_types = hash_table_ctor(64, hash_table_string_hash,
 379                                     hash_table_string_compare);
 380    }
 381
 382    /* Generate a name using the base type pointer in the key.  This is
 383     * done because the name of the base type may not be unique across
 384     * shaders.  For example, two shaders may have different record types
 385     * named 'foo'.
 386     */
 387    char key[128];
 388    snprintf(key, sizeof(key), "%p[%u]", (void *) base, array_size);
 389
 390    const glsl_type *t = (glsl_type *) hash_table_find(array_types, key);
 391    if (t == NULL) {
 392       t = new glsl_type(base, array_size);
 393
 394       hash_table_insert(array_types, (void *) t, ralloc_strdup(mem_ctx, key));
 395    }
 396
 397    assert(t->base_type == GLSL_TYPE_ARRAY);
 398    assert(t->length == array_size);
 399    assert(t->fields.array == base);
 400
 401    return t;
 402 }
 403
 404
 405 int
 406 glsl_type::record_key_compare(const void *a, const void *b)
 407 {
 408    const glsl_type *const key1 = (glsl_type *) a;
 409    const glsl_type *const key2 = (glsl_type *) b;
 410
 411    /* Return zero is the types match (there is zero difference) or non-zero
 412     * otherwise.
 413     */
 414    if (strcmp(key1->name, key2->name) != 0)
 415       return 1;
 416
 417    if (key1->length != key2->length)
 418       return 1;
 419
 420    for (unsigned i = 0; i < key1->length; i++) {
 421       if (key1->fields.structure[i].type != key2->fields.structure[i].type)
 422          return 1;
 423       if (strcmp(key1->fields.structure[i].name,
 424                  key2->fields.structure[i].name) != 0)
 425          return 1;
 426    }
 427
 428    return 0;
 429 }
 430
 431
 432 unsigned
 433 glsl_type::record_key_hash(const void *a)
 434 {
 435    const glsl_type *const key = (glsl_type *) a;
 436    char hash_key[128];
 437    unsigned size = 0;
 438
 439    size = snprintf(hash_key, sizeof(hash_key), "%08x", key->length);
 440
 441    for (unsigned i = 0; i < key->length; i++) {
 442       if (size >= sizeof(hash_key))
 443          break;
 444
 445       size += snprintf(& hash_key[size], sizeof(hash_key) - size,
 446                        "%p", (void *) key->fields.structure[i].type);
 447    }
 448
 449    return hash_table_string_hash(& hash_key);
 450 }
 451
 452
 453 const glsl_type *
 454 glsl_type::get_record_instance(const glsl_struct_field *fields,
 455                                unsigned num_fields,
 456                                const char *name)
 457 {
 458    const glsl_type key(fields, num_fields, name);
 459
 460    if (record_types == NULL) {
 461       record_types = hash_table_ctor(64, record_key_hash, record_key_compare);
 462    }
 463
 464    const glsl_type *t = (glsl_type *) hash_table_find(record_types, & key);
 465    if (t == NULL) {
 466       t = new glsl_type(fields, num_fields, name);
 467
 468       hash_table_insert(record_types, (void *) t, t);
 469    }
 470
 471    assert(t->base_type == GLSL_TYPE_STRUCT);
 472    assert(t->length == num_fields);
 473    assert(strcmp(t->name, name) == 0);
 474
 475    return t;
 476 }
 477
 478
 479 const glsl_type *
 480 glsl_type::field_type(const char *name) const
 481 {
 482    if (this->base_type != GLSL_TYPE_STRUCT)
 483       return error_type;
 484
 485    for (unsigned i = 0; i < this->length; i++) {
 486       if (strcmp(name, this->fields.structure[i].name) == 0)
 487          return this->fields.structure[i].type;
 488    }
 489
 490    return error_type;
 491 }
 492
 493
 494 int
 495 glsl_type::field_index(const char *name) const
 496 {
 497    if (this->base_type != GLSL_TYPE_STRUCT)
 498       return -1;
 499
 500    for (unsigned i = 0; i < this->length; i++) {
 501       if (strcmp(name, this->fields.structure[i].name) == 0)
 502          return i;
 503    }
 504
 505    return -1;
 506 }
 507
 508
 509 unsigned
 510 glsl_type::component_slots() const
 511 {
 512    switch (this->base_type) {
 513    case GLSL_TYPE_UINT:
 514    case GLSL_TYPE_INT:
 515    case GLSL_TYPE_FLOAT:
 516    case GLSL_TYPE_BOOL:
 517       return this->components();
 518
 519    case GLSL_TYPE_STRUCT: {
 520       unsigned size = 0;
 521
 522       for (unsigned i = 0; i < this->length; i++)
 523          size += this->fields.structure[i].type->component_slots();
 524
 525       return size;
 526    }
 527
 528    case GLSL_TYPE_ARRAY:
 529       return this->length * this->fields.array->component_slots();
 530
 531    default:
 532       return 0;
 533    }
 534 }
 535
 536 bool
 537 glsl_type::can_implicitly_convert_to(const glsl_type *desired) const
 538 {
 539    if (this == desired)
 540       return true;
 541
 542    /* There is no conversion among matrix types. */
 543    if (this->matrix_columns > 1 || desired->matrix_columns > 1)
 544       return false;
 545
 546    /* int and uint can be converted to float. */
 547    return desired->is_float()
 548           && this->is_integer()
 549           && this->vector_elements == desired->vector_elements;
 550 }