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 _mesa_glsl_initialize_types(struct _mesa_glsl_parse_state *state)
 207 {
 208    switch (state->language_version) {
 209    case 100:
 210       assert(state->es_shader);
 211       glsl_type::generate_100ES_types(state->symbols);
 212       break;
 213    case 110:
 214       glsl_type::generate_110_types(state->symbols);
 215       break;
 216    case 120:
 217       glsl_type::generate_120_types(state->symbols);
 218       break;
 219    case 130:
 220       glsl_type::generate_130_types(state->symbols);
 221       break;
 222    default:
 223       /* error */
 224       break;
 225    }
 226
 227    if (state->ARB_texture_rectangle_enable) {
 228       glsl_type::generate_ARB_texture_rectangle_types(state->symbols,
 229                                            state->ARB_texture_rectangle_warn);
 230    }
 231    if (state->OES_texture_3D_enable && state->language_version == 100) {
 232       glsl_type::generate_OES_texture_3D_types(state->symbols,
 233                                                state->OES_texture_3D_warn);
 234    }
 235
 236    if (state->EXT_texture_array_enable && state->language_version < 130) {
 237       // These are already included in 130; don't create twice.
 238       glsl_type::generate_EXT_texture_array_types(state->symbols,
 239                                        state->EXT_texture_array_warn);
 240    }
 241 }
 242
 243
 244 const glsl_type *glsl_type::get_base_type() const
 245 {
 246    switch (base_type) {
 247    case GLSL_TYPE_UINT:
 248       return uint_type;
 249    case GLSL_TYPE_INT:
 250       return int_type;
 251    case GLSL_TYPE_FLOAT:
 252       return float_type;
 253    case GLSL_TYPE_BOOL:
 254       return bool_type;
 255    default:
 256       return error_type;
 257    }
 258 }
 259
 260
 261 void
 262 _mesa_glsl_release_types(void)
 263 {
 264    if (glsl_type::array_types != NULL) {
 265       hash_table_dtor(glsl_type::array_types);
 266       glsl_type::array_types = NULL;
 267    }
 268
 269    if (glsl_type::record_types != NULL) {
 270       hash_table_dtor(glsl_type::record_types);
 271       glsl_type::record_types = NULL;
 272    }
 273 }
 274
 275
 276 glsl_type::glsl_type(const glsl_type *array, unsigned length) :
 277    base_type(GLSL_TYPE_ARRAY),
 278    sampler_dimensionality(0), sampler_shadow(0), sampler_array(0),
 279    sampler_type(0),
 280    vector_elements(0), matrix_columns(0),
 281    name(NULL), length(length)
 282 {
 283    this->fields.array = array;
 284    /* Inherit the gl type of the base. The GL type is used for
 285     * uniform/statevar handling in Mesa and the arrayness of the type
 286     * is represented by the size rather than the type.
 287     */
 288    this->gl_type = array->gl_type;
 289
 290    /* Allow a maximum of 10 characters for the array size.  This is enough
 291     * for 32-bits of ~0.  The extra 3 are for the '[', ']', and terminating
 292     * NUL.
 293     */
 294    const unsigned name_length = strlen(array->name) + 10 + 3;
 295    char *const n = (char *) ralloc_size(this->mem_ctx, name_length);
 296
 297    if (length == 0)
 298       snprintf(n, name_length, "%s[]", array->name);
 299    else
 300       snprintf(n, name_length, "%s[%u]", array->name, length);
 301
 302    this->name = n;
 303 }
 304
 305
 306 const glsl_type *
 307 glsl_type::get_instance(unsigned base_type, unsigned rows, unsigned columns)
 308 {
 309    if (base_type == GLSL_TYPE_VOID)
 310       return void_type;
 311
 312    if ((rows < 1) || (rows > 4) || (columns < 1) || (columns > 4))
 313       return error_type;
 314
 315    /* Treat GLSL vectors as Nx1 matrices.
 316     */
 317    if (columns == 1) {
 318       switch (base_type) {
 319       case GLSL_TYPE_UINT:
 320          return uint_type + (rows - 1);
 321       case GLSL_TYPE_INT:
 322          return int_type + (rows - 1);
 323       case GLSL_TYPE_FLOAT:
 324          return float_type + (rows - 1);
 325       case GLSL_TYPE_BOOL:
 326          return bool_type + (rows - 1);
 327       default:
 328          return error_type;
 329       }
 330    } else {
 331       if ((base_type != GLSL_TYPE_FLOAT) || (rows == 1))
 332          return error_type;
 333
 334       /* GLSL matrix types are named mat{COLUMNS}x{ROWS}.  Only the following
 335        * combinations are valid:
 336        *
 337        *   1 2 3 4
 338        * 1
 339        * 2   x x x
 340        * 3   x x x
 341        * 4   x x x
 342        */
 343 #define IDX(c,r) (((c-1)*3) + (r-1))
 344
 345       switch (IDX(columns, rows)) {
 346       case IDX(2,2): return mat2_type;
 347       case IDX(2,3): return mat2x3_type;
 348       case IDX(2,4): return mat2x4_type;
 349       case IDX(3,2): return mat3x2_type;
 350       case IDX(3,3): return mat3_type;
 351       case IDX(3,4): return mat3x4_type;
 352       case IDX(4,2): return mat4x2_type;
 353       case IDX(4,3): return mat4x3_type;
 354       case IDX(4,4): return mat4_type;
 355       default: return error_type;
 356       }
 357    }
 358
 359    assert(!"Should not get here.");
 360    return error_type;
 361 }
 362
 363
 364 const glsl_type *
 365 glsl_type::get_array_instance(const glsl_type *base, unsigned array_size)
 366 {
 367
 368    if (array_types == NULL) {
 369       array_types = hash_table_ctor(64, hash_table_string_hash,
 370                                     hash_table_string_compare);
 371    }
 372
 373    /* Generate a name using the base type pointer in the key.  This is
 374     * done because the name of the base type may not be unique across
 375     * shaders.  For example, two shaders may have different record types
 376     * named 'foo'.
 377     */
 378    char key[128];
 379    snprintf(key, sizeof(key), "%p[%u]", (void *) base, array_size);
 380
 381    const glsl_type *t = (glsl_type *) hash_table_find(array_types, key);
 382    if (t == NULL) {
 383       t = new glsl_type(base, array_size);
 384
 385       hash_table_insert(array_types, (void *) t, ralloc_strdup(mem_ctx, key));
 386    }
 387
 388    assert(t->base_type == GLSL_TYPE_ARRAY);
 389    assert(t->length == array_size);
 390    assert(t->fields.array == base);
 391
 392    return t;
 393 }
 394
 395
 396 int
 397 glsl_type::record_key_compare(const void *a, const void *b)
 398 {
 399    const glsl_type *const key1 = (glsl_type *) a;
 400    const glsl_type *const key2 = (glsl_type *) b;
 401
 402    /* Return zero is the types match (there is zero difference) or non-zero
 403     * otherwise.
 404     */
 405    if (strcmp(key1->name, key2->name) != 0)
 406       return 1;
 407
 408    if (key1->length != key2->length)
 409       return 1;
 410
 411    for (unsigned i = 0; i < key1->length; i++) {
 412       if (key1->fields.structure[i].type != key2->fields.structure[i].type)
 413          return 1;
 414       if (strcmp(key1->fields.structure[i].name,
 415                  key2->fields.structure[i].name) != 0)
 416          return 1;
 417    }
 418
 419    return 0;
 420 }
 421
 422
 423 unsigned
 424 glsl_type::record_key_hash(const void *a)
 425 {
 426    const glsl_type *const key = (glsl_type *) a;
 427    char hash_key[128];
 428    unsigned size = 0;
 429
 430    size = snprintf(hash_key, sizeof(hash_key), "%08x", key->length);
 431
 432    for (unsigned i = 0; i < key->length; i++) {
 433       if (size >= sizeof(hash_key))
 434          break;
 435
 436       size += snprintf(& hash_key[size], sizeof(hash_key) - size,
 437                        "%p", (void *) key->fields.structure[i].type);
 438    }
 439
 440    return hash_table_string_hash(& hash_key);
 441 }
 442
 443
 444 const glsl_type *
 445 glsl_type::get_record_instance(const glsl_struct_field *fields,
 446                                unsigned num_fields,
 447                                const char *name)
 448 {
 449    const glsl_type key(fields, num_fields, name);
 450
 451    if (record_types == NULL) {
 452       record_types = hash_table_ctor(64, record_key_hash, record_key_compare);
 453    }
 454
 455    const glsl_type *t = (glsl_type *) hash_table_find(record_types, & key);
 456    if (t == NULL) {
 457       t = new glsl_type(fields, num_fields, name);
 458
 459       hash_table_insert(record_types, (void *) t, t);
 460    }
 461
 462    assert(t->base_type == GLSL_TYPE_STRUCT);
 463    assert(t->length == num_fields);
 464    assert(strcmp(t->name, name) == 0);
 465
 466    return t;
 467 }
 468
 469
 470 const glsl_type *
 471 glsl_type::field_type(const char *name) const
 472 {
 473    if (this->base_type != GLSL_TYPE_STRUCT)
 474       return error_type;
 475
 476    for (unsigned i = 0; i < this->length; i++) {
 477       if (strcmp(name, this->fields.structure[i].name) == 0)
 478          return this->fields.structure[i].type;
 479    }
 480
 481    return error_type;
 482 }
 483
 484
 485 int
 486 glsl_type::field_index(const char *name) const
 487 {
 488    if (this->base_type != GLSL_TYPE_STRUCT)
 489       return -1;
 490
 491    for (unsigned i = 0; i < this->length; i++) {
 492       if (strcmp(name, this->fields.structure[i].name) == 0)
 493          return i;
 494    }
 495
 496    return -1;
 497 }
 498
 499
 500 unsigned
 501 glsl_type::component_slots() const
 502 {
 503    switch (this->base_type) {
 504    case GLSL_TYPE_UINT:
 505    case GLSL_TYPE_INT:
 506    case GLSL_TYPE_FLOAT:
 507    case GLSL_TYPE_BOOL:
 508       return this->components();
 509
 510    case GLSL_TYPE_STRUCT: {
 511       unsigned size = 0;
 512
 513       for (unsigned i = 0; i < this->length; i++)
 514          size += this->fields.structure[i].type->component_slots();
 515
 516       return size;
 517    }
 518
 519    case GLSL_TYPE_ARRAY:
 520       return this->length * this->fields.array->component_slots();
 521
 522    default:
 523       return 0;
 524    }
 525 }
 526
 527 bool
 528 glsl_type::can_implicitly_convert_to(const glsl_type *desired) const
 529 {
 530    if (this == desired)
 531       return true;
 532
 533    /* There is no conversion among matrix types. */
 534    if (this->matrix_columns > 1 || desired->matrix_columns > 1)
 535       return false;
 536
 537    /* int and uint can be converted to float. */
 538    return desired->is_float()
 539           && this->is_integer()
 540           && this->vector_elements == desired->vector_elements;
 541 }