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