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