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