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