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), sampler_array(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_array(array), 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), sampler_array(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 (t->sampler_array) ? TEXTURE_1D_ARRAY_INDEX : TEXTURE_1D_INDEX;
 140    case GLSL_SAMPLER_DIM_2D:
 141       return (t->sampler_array) ? TEXTURE_2D_ARRAY_INDEX : 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    case GLSL_SAMPLER_DIM_RECT:
 147       return TEXTURE_RECT_INDEX;
 148    case GLSL_SAMPLER_DIM_BUF:
 149       assert(!"FINISHME: Implement ARB_texture_buffer_object");
 150       return TEXTURE_BUFFER_INDEX;
 151    case GLSL_SAMPLER_DIM_EXTERNAL:
 152       return TEXTURE_EXTERNAL_INDEX;
 153    default:
 154       assert(!"Should not get here.");
 155       return TEXTURE_BUFFER_INDEX;
 156    }
 157 }
 158
 159 void
 160 glsl_type::generate_100ES_types(glsl_symbol_table *symtab)
 161 {
 162    add_types_to_symbol_table(symtab, builtin_core_types,
 163                              Elements(builtin_core_types),
 164                              false);
 165    add_types_to_symbol_table(symtab, builtin_structure_types,
 166                              Elements(builtin_structure_types),
 167                              false);
 168    add_types_to_symbol_table(symtab, void_type, 1, false);
 169 }
 170
 171 void
 172 glsl_type::generate_110_types(glsl_symbol_table *symtab)
 173 {
 174    generate_100ES_types(symtab);
 175
 176    add_types_to_symbol_table(symtab, builtin_110_types,
 177                              Elements(builtin_110_types),
 178                              false);
 179    add_types_to_symbol_table(symtab, &_sampler3D_type, 1, false);
 180    add_types_to_symbol_table(symtab, builtin_110_deprecated_structure_types,
 181                              Elements(builtin_110_deprecated_structure_types),
 182                              false);
 183 }
 184
 185
 186 void
 187 glsl_type::generate_120_types(glsl_symbol_table *symtab)
 188 {
 189    generate_110_types(symtab);
 190
 191    add_types_to_symbol_table(symtab, builtin_120_types,
 192                              Elements(builtin_120_types), false);
 193 }
 194
 195
 196 void
 197 glsl_type::generate_130_types(glsl_symbol_table *symtab)
 198 {
 199    generate_120_types(symtab);
 200
 201    add_types_to_symbol_table(symtab, builtin_130_types,
 202                              Elements(builtin_130_types), false);
 203    generate_EXT_texture_array_types(symtab, false);
 204 }
 205
 206
 207 void
 208 glsl_type::generate_ARB_texture_rectangle_types(glsl_symbol_table *symtab,
 209                                                 bool warn)
 210 {
 211    add_types_to_symbol_table(symtab, builtin_ARB_texture_rectangle_types,
 212                              Elements(builtin_ARB_texture_rectangle_types),
 213                              warn);
 214 }
 215
 216
 217 void
 218 glsl_type::generate_EXT_texture_array_types(glsl_symbol_table *symtab,
 219                                             bool warn)
 220 {
 221    add_types_to_symbol_table(symtab, builtin_EXT_texture_array_types,
 222                              Elements(builtin_EXT_texture_array_types),
 223                              warn);
 224 }
 225
 226
 227 void
 228 glsl_type::generate_OES_texture_3D_types(glsl_symbol_table *symtab, bool warn)
 229 {
 230    add_types_to_symbol_table(symtab, &_sampler3D_type, 1, warn);
 231 }
 232
 233
 234 void
 235 glsl_type::generate_OES_EGL_image_external_types(glsl_symbol_table *symtab,
 236                                                  bool warn)
 237 {
 238    add_types_to_symbol_table(symtab, builtin_OES_EGL_image_external_types,
 239                              Elements(builtin_OES_EGL_image_external_types),
 240                              warn);
 241 }
 242
 243 void
 244 _mesa_glsl_initialize_types(struct _mesa_glsl_parse_state *state)
 245 {
 246    switch (state->language_version) {
 247    case 100:
 248       assert(state->es_shader);
 249       glsl_type::generate_100ES_types(state->symbols);
 250       break;
 251    case 110:
 252       glsl_type::generate_110_types(state->symbols);
 253       break;
 254    case 120:
 255       glsl_type::generate_120_types(state->symbols);
 256       break;
 257    case 130:
 258       glsl_type::generate_130_types(state->symbols);
 259       break;
 260    case 140:
 261       glsl_type::generate_130_types(state->symbols);
 262       break;
 263    default:
 264       /* error */
 265       break;
 266    }
 267
 268    if (state->ARB_texture_rectangle_enable) {
 269       glsl_type::generate_ARB_texture_rectangle_types(state->symbols,
 270                                            state->ARB_texture_rectangle_warn);
 271    }
 272    if (state->OES_texture_3D_enable && state->language_version == 100) {
 273       glsl_type::generate_OES_texture_3D_types(state->symbols,
 274                                                state->OES_texture_3D_warn);
 275    }
 276
 277    if (state->EXT_texture_array_enable && state->language_version < 130) {
 278       // These are already included in 130; don't create twice.
 279       glsl_type::generate_EXT_texture_array_types(state->symbols,
 280                                        state->EXT_texture_array_warn);
 281    }
 282
 283    /* We cannot check for language_version == 100 here because we need the
 284     * types to support fixed-function program generation.  But this is fine
 285     * since the extension is never enabled for OpenGL contexts.
 286     */
 287    if (state->OES_EGL_image_external_enable) {
 288       glsl_type::generate_OES_EGL_image_external_types(state->symbols,
 289                                                state->OES_EGL_image_external_warn);
 290    }
 291 }
 292
 293
 294 const glsl_type *glsl_type::get_base_type() const
 295 {
 296    switch (base_type) {
 297    case GLSL_TYPE_UINT:
 298       return uint_type;
 299    case GLSL_TYPE_INT:
 300       return int_type;
 301    case GLSL_TYPE_FLOAT:
 302       return float_type;
 303    case GLSL_TYPE_BOOL:
 304       return bool_type;
 305    default:
 306       return error_type;
 307    }
 308 }
 309
 310
 311 const glsl_type *glsl_type::get_scalar_type() const
 312 {
 313    const glsl_type *type = this;
 314
 315    /* Handle arrays */
 316    while (type->base_type == GLSL_TYPE_ARRAY)
 317       type = type->fields.array;
 318
 319    /* Handle vectors and matrices */
 320    switch (type->base_type) {
 321    case GLSL_TYPE_UINT:
 322       return uint_type;
 323    case GLSL_TYPE_INT:
 324       return int_type;
 325    case GLSL_TYPE_FLOAT:
 326       return float_type;
 327    default:
 328       /* Handle everything else */
 329       return type;
 330    }
 331 }
 332
 333
 334 void
 335 _mesa_glsl_release_types(void)
 336 {
 337    if (glsl_type::array_types != NULL) {
 338       hash_table_dtor(glsl_type::array_types);
 339       glsl_type::array_types = NULL;
 340    }
 341
 342    if (glsl_type::record_types != NULL) {
 343       hash_table_dtor(glsl_type::record_types);
 344       glsl_type::record_types = NULL;
 345    }
 346 }
 347
 348
 349 glsl_type::glsl_type(const glsl_type *array, unsigned length) :
 350    base_type(GLSL_TYPE_ARRAY),
 351    sampler_dimensionality(0), sampler_shadow(0), sampler_array(0),
 352    sampler_type(0),
 353    vector_elements(0), matrix_columns(0),
 354    name(NULL), length(length)
 355 {
 356    this->fields.array = array;
 357    /* Inherit the gl type of the base. The GL type is used for
 358     * uniform/statevar handling in Mesa and the arrayness of the type
 359     * is represented by the size rather than the type.
 360     */
 361    this->gl_type = array->gl_type;
 362
 363    /* Allow a maximum of 10 characters for the array size.  This is enough
 364     * for 32-bits of ~0.  The extra 3 are for the '[', ']', and terminating
 365     * NUL.
 366     */
 367    const unsigned name_length = strlen(array->name) + 10 + 3;
 368    char *const n = (char *) ralloc_size(this->mem_ctx, name_length);
 369
 370    if (length == 0)
 371       snprintf(n, name_length, "%s[]", array->name);
 372    else
 373       snprintf(n, name_length, "%s[%u]", array->name, length);
 374
 375    this->name = n;
 376 }
 377
 378
 379 const glsl_type *
 380 glsl_type::get_instance(unsigned base_type, unsigned rows, unsigned columns)
 381 {
 382    if (base_type == GLSL_TYPE_VOID)
 383       return void_type;
 384
 385    if ((rows < 1) || (rows > 4) || (columns < 1) || (columns > 4))
 386       return error_type;
 387
 388    /* Treat GLSL vectors as Nx1 matrices.
 389     */
 390    if (columns == 1) {
 391       switch (base_type) {
 392       case GLSL_TYPE_UINT:
 393          return uint_type + (rows - 1);
 394       case GLSL_TYPE_INT:
 395          return int_type + (rows - 1);
 396       case GLSL_TYPE_FLOAT:
 397          return float_type + (rows - 1);
 398       case GLSL_TYPE_BOOL:
 399          return bool_type + (rows - 1);
 400       default:
 401          return error_type;
 402       }
 403    } else {
 404       if ((base_type != GLSL_TYPE_FLOAT) || (rows == 1))
 405          return error_type;
 406
 407       /* GLSL matrix types are named mat{COLUMNS}x{ROWS}.  Only the following
 408        * combinations are valid:
 409        *
 410        *   1 2 3 4
 411        * 1
 412        * 2   x x x
 413        * 3   x x x
 414        * 4   x x x
 415        */
 416 #define IDX(c,r) (((c-1)*3) + (r-1))
 417
 418       switch (IDX(columns, rows)) {
 419       case IDX(2,2): return mat2_type;
 420       case IDX(2,3): return mat2x3_type;
 421       case IDX(2,4): return mat2x4_type;
 422       case IDX(3,2): return mat3x2_type;
 423       case IDX(3,3): return mat3_type;
 424       case IDX(3,4): return mat3x4_type;
 425       case IDX(4,2): return mat4x2_type;
 426       case IDX(4,3): return mat4x3_type;
 427       case IDX(4,4): return mat4_type;
 428       default: return error_type;
 429       }
 430    }
 431
 432    assert(!"Should not get here.");
 433    return error_type;
 434 }
 435
 436
 437 const glsl_type *
 438 glsl_type::get_array_instance(const glsl_type *base, unsigned array_size)
 439 {
 440
 441    if (array_types == NULL) {
 442       array_types = hash_table_ctor(64, hash_table_string_hash,
 443                                     hash_table_string_compare);
 444    }
 445
 446    /* Generate a name using the base type pointer in the key.  This is
 447     * done because the name of the base type may not be unique across
 448     * shaders.  For example, two shaders may have different record types
 449     * named 'foo'.
 450     */
 451    char key[128];
 452    snprintf(key, sizeof(key), "%p[%u]", (void *) base, array_size);
 453
 454    const glsl_type *t = (glsl_type *) hash_table_find(array_types, key);
 455    if (t == NULL) {
 456       t = new glsl_type(base, array_size);
 457
 458       hash_table_insert(array_types, (void *) t, ralloc_strdup(mem_ctx, key));
 459    }
 460
 461    assert(t->base_type == GLSL_TYPE_ARRAY);
 462    assert(t->length == array_size);
 463    assert(t->fields.array == base);
 464
 465    return t;
 466 }
 467
 468
 469 int
 470 glsl_type::record_key_compare(const void *a, const void *b)
 471 {
 472    const glsl_type *const key1 = (glsl_type *) a;
 473    const glsl_type *const key2 = (glsl_type *) b;
 474
 475    /* Return zero is the types match (there is zero difference) or non-zero
 476     * otherwise.
 477     */
 478    if (strcmp(key1->name, key2->name) != 0)
 479       return 1;
 480
 481    if (key1->length != key2->length)
 482       return 1;
 483
 484    for (unsigned i = 0; i < key1->length; i++) {
 485       if (key1->fields.structure[i].type != key2->fields.structure[i].type)
 486          return 1;
 487       if (strcmp(key1->fields.structure[i].name,
 488                  key2->fields.structure[i].name) != 0)
 489          return 1;
 490    }
 491
 492    return 0;
 493 }
 494
 495
 496 unsigned
 497 glsl_type::record_key_hash(const void *a)
 498 {
 499    const glsl_type *const key = (glsl_type *) a;
 500    char hash_key[128];
 501    unsigned size = 0;
 502
 503    size = snprintf(hash_key, sizeof(hash_key), "%08x", key->length);
 504
 505    for (unsigned i = 0; i < key->length; i++) {
 506       if (size >= sizeof(hash_key))
 507          break;
 508
 509       size += snprintf(& hash_key[size], sizeof(hash_key) - size,
 510                        "%p", (void *) key->fields.structure[i].type);
 511    }
 512
 513    return hash_table_string_hash(& hash_key);
 514 }
 515
 516
 517 const glsl_type *
 518 glsl_type::get_record_instance(const glsl_struct_field *fields,
 519                                unsigned num_fields,
 520                                const char *name)
 521 {
 522    const glsl_type key(fields, num_fields, name);
 523
 524    if (record_types == NULL) {
 525       record_types = hash_table_ctor(64, record_key_hash, record_key_compare);
 526    }
 527
 528    const glsl_type *t = (glsl_type *) hash_table_find(record_types, & key);
 529    if (t == NULL) {
 530       t = new glsl_type(fields, num_fields, name);
 531
 532       hash_table_insert(record_types, (void *) t, t);
 533    }
 534
 535    assert(t->base_type == GLSL_TYPE_STRUCT);
 536    assert(t->length == num_fields);
 537    assert(strcmp(t->name, name) == 0);
 538
 539    return t;
 540 }
 541
 542
 543 const glsl_type *
 544 glsl_type::field_type(const char *name) const
 545 {
 546    if (this->base_type != GLSL_TYPE_STRUCT)
 547       return error_type;
 548
 549    for (unsigned i = 0; i < this->length; i++) {
 550       if (strcmp(name, this->fields.structure[i].name) == 0)
 551          return this->fields.structure[i].type;
 552    }
 553
 554    return error_type;
 555 }
 556
 557
 558 int
 559 glsl_type::field_index(const char *name) const
 560 {
 561    if (this->base_type != GLSL_TYPE_STRUCT)
 562       return -1;
 563
 564    for (unsigned i = 0; i < this->length; i++) {
 565       if (strcmp(name, this->fields.structure[i].name) == 0)
 566          return i;
 567    }
 568
 569    return -1;
 570 }
 571
 572
 573 unsigned
 574 glsl_type::component_slots() const
 575 {
 576    switch (this->base_type) {
 577    case GLSL_TYPE_UINT:
 578    case GLSL_TYPE_INT:
 579    case GLSL_TYPE_FLOAT:
 580    case GLSL_TYPE_BOOL:
 581       return this->components();
 582
 583    case GLSL_TYPE_STRUCT: {
 584       unsigned size = 0;
 585
 586       for (unsigned i = 0; i < this->length; i++)
 587          size += this->fields.structure[i].type->component_slots();
 588
 589       return size;
 590    }
 591
 592    case GLSL_TYPE_ARRAY:
 593       return this->length * this->fields.array->component_slots();
 594
 595    default:
 596       return 0;
 597    }
 598 }
 599
 600 bool
 601 glsl_type::can_implicitly_convert_to(const glsl_type *desired) const
 602 {
 603    if (this == desired)
 604       return true;
 605
 606    /* There is no conversion among matrix types. */
 607    if (this->matrix_columns > 1 || desired->matrix_columns > 1)
 608       return false;
 609
 610    /* int and uint can be converted to float. */
 611    return desired->is_float()
 612           && this->is_integer()
 613           && this->vector_elements == desired->vector_elements;
 614 }