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 <cstdio>
  25 #include <stdlib.h>
  26 #include "main/compiler.h"
  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 "main/imports.h"
  33 #include "program/hash_table.h"
  34 }
  35
  36 hash_table *glsl_type::array_types = NULL;
  37 hash_table *glsl_type::record_types = NULL;
  38 void *glsl_type::mem_ctx = NULL;
  39
  40 void
  41 glsl_type::init_talloc_type_ctx(void)
  42 {
  43    if (glsl_type::mem_ctx == NULL) {
  44       glsl_type::mem_ctx = talloc_init("glsl_type");
  45       assert(glsl_type::mem_ctx != NULL);
  46    }
  47 }
  48
  49 glsl_type::glsl_type(GLenum gl_type,
  50                      unsigned base_type, unsigned vector_elements,
  51                      unsigned matrix_columns, const char *name) :
  52    gl_type(gl_type),
  53    base_type(base_type),
  54    sampler_dimensionality(0), sampler_shadow(0), sampler_array(0),
  55    sampler_type(0),
  56    vector_elements(vector_elements), matrix_columns(matrix_columns),
  57    length(0)
  58 {
  59    init_talloc_type_ctx();
  60    this->name = talloc_strdup(this->mem_ctx, name);
  61    /* Neither dimension is zero or both dimensions are zero.
  62     */
  63    assert((vector_elements == 0) == (matrix_columns == 0));
  64    memset(& fields, 0, sizeof(fields));
  65 }
  66
  67 glsl_type::glsl_type(GLenum gl_type,
  68                      enum glsl_sampler_dim dim, bool shadow, bool array,
  69                      unsigned type, const char *name) :
  70    gl_type(gl_type),
  71    base_type(GLSL_TYPE_SAMPLER),
  72    sampler_dimensionality(dim), sampler_shadow(shadow),
  73    sampler_array(array), sampler_type(type),
  74    vector_elements(0), matrix_columns(0),
  75    length(0)
  76 {
  77    init_talloc_type_ctx();
  78    this->name = talloc_strdup(this->mem_ctx, name);
  79    memset(& fields, 0, sizeof(fields));
  80 }
  81
  82 glsl_type::glsl_type(const glsl_struct_field *fields, unsigned num_fields,
  83                      const char *name) :
  84    base_type(GLSL_TYPE_STRUCT),
  85    sampler_dimensionality(0), sampler_shadow(0), sampler_array(0),
  86    sampler_type(0),
  87    vector_elements(0), matrix_columns(0),
  88    length(num_fields)
  89 {
  90    unsigned int i;
  91
  92    init_talloc_type_ctx();
  93    this->name = talloc_strdup(this->mem_ctx, name);
  94    this->fields.structure = talloc_array(this->mem_ctx,
  95                                          glsl_struct_field, length);
  96    for (i = 0; i < length; i++) {
  97       this->fields.structure[i].type = fields[i].type;
  98       this->fields.structure[i].name = talloc_strdup(this->fields.structure,
  99                                                      fields[i].name);
 100    }
 101 }
 102
 103 static void
 104 add_types_to_symbol_table(glsl_symbol_table *symtab,
 105                           const struct glsl_type *types,
 106                           unsigned num_types, bool warn)
 107 {
 108    (void) warn;
 109
 110    for (unsigned i = 0; i < num_types; i++) {
 111       symtab->add_type(types[i].name, & types[i]);
 112    }
 113 }
 114
 115
 116 void
 117 glsl_type::generate_110_types(glsl_symbol_table *symtab)
 118 {
 119    add_types_to_symbol_table(symtab, builtin_core_types,
 120                              Elements(builtin_core_types),
 121                              false);
 122    add_types_to_symbol_table(symtab, builtin_structure_types,
 123                              Elements(builtin_structure_types),
 124                              false);
 125    add_types_to_symbol_table(symtab, builtin_110_deprecated_structure_types,
 126                              Elements(builtin_110_deprecated_structure_types),
 127                              false);
 128    add_types_to_symbol_table(symtab, & void_type, 1, false);
 129 }
 130
 131
 132 void
 133 glsl_type::generate_120_types(glsl_symbol_table *symtab)
 134 {
 135    generate_110_types(symtab);
 136
 137    add_types_to_symbol_table(symtab, builtin_120_types,
 138                              Elements(builtin_120_types), false);
 139 }
 140
 141
 142 void
 143 glsl_type::generate_130_types(glsl_symbol_table *symtab)
 144 {
 145    generate_120_types(symtab);
 146
 147    add_types_to_symbol_table(symtab, builtin_130_types,
 148                              Elements(builtin_130_types), false);
 149    generate_EXT_texture_array_types(symtab, false);
 150 }
 151
 152
 153 void
 154 glsl_type::generate_ARB_texture_rectangle_types(glsl_symbol_table *symtab,
 155                                                 bool warn)
 156 {
 157    add_types_to_symbol_table(symtab, builtin_ARB_texture_rectangle_types,
 158                              Elements(builtin_ARB_texture_rectangle_types),
 159                              warn);
 160 }
 161
 162
 163 void
 164 glsl_type::generate_EXT_texture_array_types(glsl_symbol_table *symtab,
 165                                             bool warn)
 166 {
 167    add_types_to_symbol_table(symtab, builtin_EXT_texture_array_types,
 168                              Elements(builtin_EXT_texture_array_types),
 169                              warn);
 170 }
 171
 172
 173 void
 174 _mesa_glsl_initialize_types(struct _mesa_glsl_parse_state *state)
 175 {
 176    switch (state->language_version) {
 177    case 110:
 178       glsl_type::generate_110_types(state->symbols);
 179       break;
 180    case 120:
 181       glsl_type::generate_120_types(state->symbols);
 182       break;
 183    case 130:
 184       glsl_type::generate_130_types(state->symbols);
 185       break;
 186    default:
 187       /* error */
 188       break;
 189    }
 190
 191    if (state->ARB_texture_rectangle_enable) {
 192       glsl_type::generate_ARB_texture_rectangle_types(state->symbols,
 193                                            state->ARB_texture_rectangle_warn);
 194    }
 195
 196    if (state->EXT_texture_array_enable && state->language_version < 130) {
 197       // These are already included in 130; don't create twice.
 198       glsl_type::generate_EXT_texture_array_types(state->symbols,
 199                                        state->EXT_texture_array_warn);
 200    }
 201 }
 202
 203
 204 const glsl_type *glsl_type::get_base_type() const
 205 {
 206    switch (base_type) {
 207    case GLSL_TYPE_UINT:
 208       return uint_type;
 209    case GLSL_TYPE_INT:
 210       return int_type;
 211    case GLSL_TYPE_FLOAT:
 212       return float_type;
 213    case GLSL_TYPE_BOOL:
 214       return bool_type;
 215    default:
 216       return error_type;
 217    }
 218 }
 219
 220
 221 void
 222 _mesa_glsl_release_types(void)
 223 {
 224    if (glsl_type::array_types != NULL) {
 225       hash_table_dtor(glsl_type::array_types);
 226       glsl_type::array_types = NULL;
 227    }
 228
 229    if (glsl_type::record_types != NULL) {
 230       hash_table_dtor(glsl_type::record_types);
 231       glsl_type::record_types = NULL;
 232    }
 233
 234    if (glsl_type::mem_ctx != NULL) {
 235       talloc_free(glsl_type::mem_ctx);
 236       glsl_type::mem_ctx = NULL;
 237    }
 238 }
 239
 240
 241 ir_function *
 242 glsl_type::generate_constructor(glsl_symbol_table *symtab) const
 243 {
 244    void *ctx = symtab;
 245
 246    /* Generate the function name and add it to the symbol table.
 247     */
 248    ir_function *const f = new(ctx) ir_function(name);
 249
 250    bool added = symtab->add_function(name, f);
 251    assert(added);
 252
 253    ir_function_signature *const sig = new(ctx) ir_function_signature(this);
 254    f->add_signature(sig);
 255
 256    ir_variable **declarations =
 257       (ir_variable **) malloc(sizeof(ir_variable *) * this->length);
 258    for (unsigned i = 0; i < length; i++) {
 259       char *const param_name = (char *) malloc(10);
 260
 261       snprintf(param_name, 10, "p%08X", i);
 262
 263       ir_variable *var = (this->base_type == GLSL_TYPE_ARRAY)
 264          ? new(ctx) ir_variable(fields.array, param_name, ir_var_in)
 265          : new(ctx) ir_variable(fields.structure[i].type, param_name, ir_var_in);
 266
 267       declarations[i] = var;
 268       sig->parameters.push_tail(var);
 269    }
 270
 271    /* Generate the body of the constructor.  The body assigns each of the
 272     * parameters to a portion of a local variable called _ret_val that has
 273     * the same type as the constructor.  After initializing _ret_val,
 274     * _ret_val is returned.
 275     */
 276    ir_variable *retval = new(ctx) ir_variable(this, "_ret_val", ir_var_auto);
 277    sig->body.push_tail(retval);
 278
 279    for (unsigned i = 0; i < length; i++) {
 280       ir_dereference *const lhs = (this->base_type == GLSL_TYPE_ARRAY)
 281          ? (ir_dereference *) new(ctx) ir_dereference_array(retval,
 282                                                             new(ctx) ir_constant(i))
 283          : (ir_dereference *) new(ctx) ir_dereference_record(retval,
 284                                                              fields.structure[i].name);
 285
 286       ir_dereference *const rhs = new(ctx) ir_dereference_variable(declarations[i]);
 287       ir_instruction *const assign = new(ctx) ir_assignment(lhs, rhs, NULL);
 288
 289       sig->body.push_tail(assign);
 290    }
 291
 292    free(declarations);
 293
 294    ir_dereference *const retref = new(ctx) ir_dereference_variable(retval);
 295    ir_instruction *const inst = new(ctx) ir_return(retref);
 296    sig->body.push_tail(inst);
 297
 298    return f;
 299 }
 300
 301
 302 glsl_type::glsl_type(const glsl_type *array, unsigned length) :
 303    base_type(GLSL_TYPE_ARRAY),
 304    sampler_dimensionality(0), sampler_shadow(0), sampler_array(0),
 305    sampler_type(0),
 306    vector_elements(0), matrix_columns(0),
 307    name(NULL), length(length)
 308 {
 309    this->fields.array = array;
 310    /* Inherit the gl type of the base. The GL type is used for
 311     * uniform/statevar handling in Mesa and the arrayness of the type
 312     * is represented by the size rather than the type.
 313     */
 314    this->gl_type = array->gl_type;
 315
 316    /* Allow a maximum of 10 characters for the array size.  This is enough
 317     * for 32-bits of ~0.  The extra 3 are for the '[', ']', and terminating
 318     * NUL.
 319     */
 320    const unsigned name_length = strlen(array->name) + 10 + 3;
 321    char *const n = (char *) talloc_size(this->mem_ctx, name_length);
 322
 323    if (length == 0)
 324       snprintf(n, name_length, "%s[]", array->name);
 325    else
 326       snprintf(n, name_length, "%s[%u]", array->name, length);
 327
 328    this->name = n;
 329 }
 330
 331
 332 const glsl_type *
 333 glsl_type::get_instance(unsigned base_type, unsigned rows, unsigned columns)
 334 {
 335    if (base_type == GLSL_TYPE_VOID)
 336       return &void_type;
 337
 338    if ((rows < 1) || (rows > 4) || (columns < 1) || (columns > 4))
 339       return error_type;
 340
 341    /* Treat GLSL vectors as Nx1 matrices.
 342     */
 343    if (columns == 1) {
 344       switch (base_type) {
 345       case GLSL_TYPE_UINT:
 346          return uint_type + (rows - 1);
 347       case GLSL_TYPE_INT:
 348          return int_type + (rows - 1);
 349       case GLSL_TYPE_FLOAT:
 350          return float_type + (rows - 1);
 351       case GLSL_TYPE_BOOL:
 352          return bool_type + (rows - 1);
 353       default:
 354          return error_type;
 355       }
 356    } else {
 357       if ((base_type != GLSL_TYPE_FLOAT) || (rows == 1))
 358          return error_type;
 359
 360       /* GLSL matrix types are named mat{COLUMNS}x{ROWS}.  Only the following
 361        * combinations are valid:
 362        *
 363        *   1 2 3 4
 364        * 1
 365        * 2   x x x
 366        * 3   x x x
 367        * 4   x x x
 368        */
 369 #define IDX(c,r) (((c-1)*3) + (r-1))
 370
 371       switch (IDX(columns, rows)) {
 372       case IDX(2,2): return mat2_type;
 373       case IDX(2,3): return mat2x3_type;
 374       case IDX(2,4): return mat2x4_type;
 375       case IDX(3,2): return mat3x2_type;
 376       case IDX(3,3): return mat3_type;
 377       case IDX(3,4): return mat3x4_type;
 378       case IDX(4,2): return mat4x2_type;
 379       case IDX(4,3): return mat4x3_type;
 380       case IDX(4,4): return mat4_type;
 381       default: return error_type;
 382       }
 383    }
 384
 385    assert(!"Should not get here.");
 386    return error_type;
 387 }
 388
 389
 390 const glsl_type *
 391 glsl_type::get_array_instance(const glsl_type *base, unsigned array_size)
 392 {
 393
 394    if (array_types == NULL) {
 395       array_types = hash_table_ctor(64, hash_table_string_hash,
 396                                     hash_table_string_compare);
 397    }
 398
 399    /* Generate a name using the base type pointer in the key.  This is
 400     * done because the name of the base type may not be unique across
 401     * shaders.  For example, two shaders may have different record types
 402     * named 'foo'.
 403     */
 404    char key[128];
 405    snprintf(key, sizeof(key), "%p[%u]", (void *) base, array_size);
 406
 407    const glsl_type *t = (glsl_type *) hash_table_find(array_types, key);
 408    if (t == NULL) {
 409       t = new glsl_type(base, array_size);
 410
 411       hash_table_insert(array_types, (void *) t, talloc_strdup(mem_ctx, key));
 412    }
 413
 414    assert(t->base_type == GLSL_TYPE_ARRAY);
 415    assert(t->length == array_size);
 416    assert(t->fields.array == base);
 417
 418    return t;
 419 }
 420
 421
 422 int
 423 glsl_type::record_key_compare(const void *a, const void *b)
 424 {
 425    const glsl_type *const key1 = (glsl_type *) a;
 426    const glsl_type *const key2 = (glsl_type *) b;
 427
 428    /* Return zero is the types match (there is zero difference) or non-zero
 429     * otherwise.
 430     */
 431    if (strcmp(key1->name, key2->name) != 0)
 432       return 1;
 433
 434    if (key1->length != key2->length)
 435       return 1;
 436
 437    for (unsigned i = 0; i < key1->length; i++) {
 438       if (key1->fields.structure[i].type != key2->fields.structure[i].type)
 439          return 1;
 440       if (strcmp(key1->fields.structure[i].name,
 441                  key2->fields.structure[i].name) != 0)
 442          return 1;
 443    }
 444
 445    return 0;
 446 }
 447
 448
 449 unsigned
 450 glsl_type::record_key_hash(const void *a)
 451 {
 452    const glsl_type *const key = (glsl_type *) a;
 453    char hash_key[128];
 454    unsigned size = 0;
 455
 456    size = snprintf(hash_key, sizeof(hash_key), "%08x", key->length);
 457
 458    for (unsigned i = 0; i < key->length; i++) {
 459       if (size >= sizeof(hash_key))
 460          break;
 461
 462       size += snprintf(& hash_key[size], sizeof(hash_key) - size,
 463                        "%p", (void *) key->fields.structure[i].type);
 464    }
 465
 466    return hash_table_string_hash(& hash_key);
 467 }
 468
 469
 470 const glsl_type *
 471 glsl_type::get_record_instance(const glsl_struct_field *fields,
 472                                unsigned num_fields,
 473                                const char *name)
 474 {
 475    const glsl_type key(fields, num_fields, name);
 476
 477    if (record_types == NULL) {
 478       record_types = hash_table_ctor(64, record_key_hash, record_key_compare);
 479    }
 480
 481    const glsl_type *t = (glsl_type *) hash_table_find(record_types, & key);
 482    if (t == NULL) {
 483       t = new glsl_type(fields, num_fields, name);
 484
 485       hash_table_insert(record_types, (void *) t, t);
 486    }
 487
 488    assert(t->base_type == GLSL_TYPE_STRUCT);
 489    assert(t->length == num_fields);
 490    assert(strcmp(t->name, name) == 0);
 491
 492    return t;
 493 }
 494
 495
 496 const glsl_type *
 497 glsl_type::field_type(const char *name) const
 498 {
 499    if (this->base_type != GLSL_TYPE_STRUCT)
 500       return error_type;
 501
 502    for (unsigned i = 0; i < this->length; i++) {
 503       if (strcmp(name, this->fields.structure[i].name) == 0)
 504          return this->fields.structure[i].type;
 505    }
 506
 507    return error_type;
 508 }
 509
 510
 511 int
 512 glsl_type::field_index(const char *name) const
 513 {
 514    if (this->base_type != GLSL_TYPE_STRUCT)
 515       return -1;
 516
 517    for (unsigned i = 0; i < this->length; i++) {
 518       if (strcmp(name, this->fields.structure[i].name) == 0)
 519          return i;
 520    }
 521
 522    return -1;
 523 }
 524
 525
 526 unsigned
 527 glsl_type::component_slots() const
 528 {
 529    switch (this->base_type) {
 530    case GLSL_TYPE_UINT:
 531    case GLSL_TYPE_INT:
 532    case GLSL_TYPE_FLOAT:
 533    case GLSL_TYPE_BOOL:
 534       return this->components();
 535
 536    case GLSL_TYPE_STRUCT: {
 537       unsigned size = 0;
 538
 539       for (unsigned i = 0; i < this->length; i++)
 540          size += this->fields.structure[i].type->component_slots();
 541
 542       return size;
 543    }
 544
 545    case GLSL_TYPE_ARRAY:
 546       return this->length * this->fields.array->component_slots();
 547
 548    default:
 549       return 0;
 550    }
 551 }