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 glsl_type::glsl_type(GLenum gl_type,
  39                      unsigned base_type, unsigned vector_elements,
  40                      unsigned matrix_columns, const char *name) :
  41    gl_type(gl_type),
  42    base_type(base_type),
  43    sampler_dimensionality(0), sampler_shadow(0), sampler_array(0),
  44    sampler_type(0),
  45    vector_elements(vector_elements), matrix_columns(matrix_columns),
  46    name(name),
  47    length(0)
  48 {
  49    /* Neither dimension is zero or both dimensions are zero.
  50     */
  51    assert((vector_elements == 0) == (matrix_columns == 0));
  52    memset(& fields, 0, sizeof(fields));
  53 }
  54
  55 glsl_type::glsl_type(GLenum gl_type,
  56                      enum glsl_sampler_dim dim, bool shadow, bool array,
  57                      unsigned type, const char *name) :
  58    gl_type(gl_type),
  59    base_type(GLSL_TYPE_SAMPLER),
  60    sampler_dimensionality(dim), sampler_shadow(shadow),
  61    sampler_array(array), sampler_type(type),
  62    vector_elements(0), matrix_columns(0),
  63    name(name),
  64    length(0)
  65 {
  66    memset(& fields, 0, sizeof(fields));
  67 }
  68
  69 glsl_type::glsl_type(const glsl_struct_field *fields, unsigned num_fields,
  70                      const char *name) :
  71    base_type(GLSL_TYPE_STRUCT),
  72    sampler_dimensionality(0), sampler_shadow(0), sampler_array(0),
  73    sampler_type(0),
  74    vector_elements(0), matrix_columns(0),
  75    name(name),
  76    length(num_fields)
  77 {
  78    unsigned int i;
  79
  80    if (glsl_type::ctx == NULL) {
  81       glsl_type::ctx = talloc_init("glsl_type");
  82       assert(glsl_type::ctx != NULL);
  83    }
  84
  85    this->fields.structure = talloc_array(glsl_type::ctx,
  86                                          glsl_struct_field, length);
  87    for (i = 0; i < length; i++) {
  88       this->fields.structure[i].type = fields[i].type;
  89       this->fields.structure[i].name = talloc_strdup(this->fields.structure,
  90                                                      fields[i].name);
  91    }
  92 }
  93
  94 static void
  95 add_types_to_symbol_table(glsl_symbol_table *symtab,
  96                           const struct glsl_type *types,
  97                           unsigned num_types, bool warn)
  98 {
  99    (void) warn;
 100
 101    for (unsigned i = 0; i < num_types; i++) {
 102       symtab->add_type(types[i].name, & types[i]);
 103    }
 104 }
 105
 106
 107 void
 108 glsl_type::generate_110_types(glsl_symbol_table *symtab)
 109 {
 110    add_types_to_symbol_table(symtab, builtin_core_types,
 111                              Elements(builtin_core_types),
 112                              false);
 113    add_types_to_symbol_table(symtab, builtin_structure_types,
 114                              Elements(builtin_structure_types),
 115                              false);
 116    add_types_to_symbol_table(symtab, builtin_110_deprecated_structure_types,
 117                              Elements(builtin_110_deprecated_structure_types),
 118                              false);
 119    add_types_to_symbol_table(symtab, & void_type, 1, false);
 120 }
 121
 122
 123 void
 124 glsl_type::generate_120_types(glsl_symbol_table *symtab)
 125 {
 126    generate_110_types(symtab);
 127
 128    add_types_to_symbol_table(symtab, builtin_120_types,
 129                              Elements(builtin_120_types), false);
 130 }
 131
 132
 133 void
 134 glsl_type::generate_130_types(glsl_symbol_table *symtab)
 135 {
 136    generate_120_types(symtab);
 137
 138    add_types_to_symbol_table(symtab, builtin_130_types,
 139                              Elements(builtin_130_types), false);
 140 }
 141
 142
 143 void
 144 glsl_type::generate_ARB_texture_rectangle_types(glsl_symbol_table *symtab,
 145                                                 bool warn)
 146 {
 147    add_types_to_symbol_table(symtab, builtin_ARB_texture_rectangle_types,
 148                              Elements(builtin_ARB_texture_rectangle_types),
 149                              warn);
 150 }
 151
 152
 153 void
 154 glsl_type::generate_EXT_texture_array_types(glsl_symbol_table *symtab,
 155                                             bool warn)
 156 {
 157    add_types_to_symbol_table(symtab, builtin_EXT_texture_array_types,
 158                              Elements(builtin_EXT_texture_array_types),
 159                              warn);
 160 }
 161
 162
 163 void
 164 _mesa_glsl_initialize_types(struct _mesa_glsl_parse_state *state)
 165 {
 166    switch (state->language_version) {
 167    case 110:
 168       glsl_type::generate_110_types(state->symbols);
 169       break;
 170    case 120:
 171       glsl_type::generate_120_types(state->symbols);
 172       break;
 173    case 130:
 174       glsl_type::generate_130_types(state->symbols);
 175       break;
 176    default:
 177       /* error */
 178       break;
 179    }
 180
 181    if (state->ARB_texture_rectangle_enable) {
 182       glsl_type::generate_ARB_texture_rectangle_types(state->symbols,
 183                                            state->ARB_texture_rectangle_warn);
 184    }
 185
 186    if (state->EXT_texture_array_enable && state->language_version < 130) {
 187       // These are already included in 130; don't create twice.
 188       glsl_type::generate_EXT_texture_array_types(state->symbols,
 189                                        state->EXT_texture_array_warn);
 190    }
 191 }
 192
 193
 194 const glsl_type *glsl_type::get_base_type() const
 195 {
 196    switch (base_type) {
 197    case GLSL_TYPE_UINT:
 198       return uint_type;
 199    case GLSL_TYPE_INT:
 200       return int_type;
 201    case GLSL_TYPE_FLOAT:
 202       return float_type;
 203    case GLSL_TYPE_BOOL:
 204       return bool_type;
 205    default:
 206       return error_type;
 207    }
 208 }
 209
 210
 211 void
 212 _mesa_glsl_release_types(void)
 213 {
 214    if (glsl_type::array_types != NULL) {
 215       hash_table_dtor(glsl_type::array_types);
 216       glsl_type::array_types = NULL;
 217    }
 218
 219    if (glsl_type::record_types != NULL) {
 220       hash_table_dtor(glsl_type::record_types);
 221       glsl_type::record_types = NULL;
 222    }
 223
 224    if (glsl_type::ctx != NULL) {
 225       talloc_free(glsl_type::ctx);
 226       glsl_type::ctx = NULL;
 227    }
 228 }
 229
 230
 231 ir_function *
 232 glsl_type::generate_constructor(glsl_symbol_table *symtab) const
 233 {
 234    void *ctx = symtab;
 235
 236    /* Generate the function name and add it to the symbol table.
 237     */
 238    ir_function *const f = new(ctx) ir_function(name);
 239
 240    bool added = symtab->add_function(name, f);
 241    assert(added);
 242
 243    ir_function_signature *const sig = new(ctx) ir_function_signature(this);
 244    f->add_signature(sig);
 245
 246    ir_variable **declarations =
 247       (ir_variable **) malloc(sizeof(ir_variable *) * this->length);
 248    for (unsigned i = 0; i < length; i++) {
 249       char *const param_name = (char *) malloc(10);
 250
 251       snprintf(param_name, 10, "p%08X", i);
 252
 253       ir_variable *var = (this->base_type == GLSL_TYPE_ARRAY)
 254          ? new(ctx) ir_variable(fields.array, param_name, ir_var_in)
 255          : new(ctx) ir_variable(fields.structure[i].type, param_name, ir_var_in);
 256
 257       declarations[i] = var;
 258       sig->parameters.push_tail(var);
 259    }
 260
 261    /* Generate the body of the constructor.  The body assigns each of the
 262     * parameters to a portion of a local variable called __retval that has
 263     * the same type as the constructor.  After initializing __retval,
 264     * __retval is returned.
 265     */
 266    ir_variable *retval = new(ctx) ir_variable(this, "__retval", ir_var_auto);
 267    sig->body.push_tail(retval);
 268
 269    for (unsigned i = 0; i < length; i++) {
 270       ir_dereference *const lhs = (this->base_type == GLSL_TYPE_ARRAY)
 271          ? (ir_dereference *) new(ctx) ir_dereference_array(retval,
 272                                                             new(ctx) ir_constant(i))
 273          : (ir_dereference *) new(ctx) ir_dereference_record(retval,
 274                                                              fields.structure[i].name);
 275
 276       ir_dereference *const rhs = new(ctx) ir_dereference_variable(declarations[i]);
 277       ir_instruction *const assign = new(ctx) ir_assignment(lhs, rhs, NULL);
 278
 279       sig->body.push_tail(assign);
 280    }
 281
 282    free(declarations);
 283
 284    ir_dereference *const retref = new(ctx) ir_dereference_variable(retval);
 285    ir_instruction *const inst = new(ctx) ir_return(retref);
 286    sig->body.push_tail(inst);
 287
 288    return f;
 289 }
 290
 291
 292 glsl_type::glsl_type(const glsl_type *array, unsigned length) :
 293    base_type(GLSL_TYPE_ARRAY),
 294    sampler_dimensionality(0), sampler_shadow(0), sampler_array(0),
 295    sampler_type(0),
 296    vector_elements(0), matrix_columns(0),
 297    name(NULL), length(length)
 298 {
 299    this->fields.array = array;
 300    /* Inherit the gl type of the base. The GL type is used for
 301     * uniform/statevar handling in Mesa and the arrayness of the type
 302     * is represented by the size rather than the type.
 303     */
 304    this->gl_type = array->gl_type;
 305
 306    /* Allow a maximum of 10 characters for the array size.  This is enough
 307     * for 32-bits of ~0.  The extra 3 are for the '[', ']', and terminating
 308     * NUL.
 309     */
 310    const unsigned name_length = strlen(array->name) + 10 + 3;
 311    char *const n = (char *) talloc_size(this->ctx, name_length);
 312
 313    if (length == 0)
 314       snprintf(n, name_length, "%s[]", array->name);
 315    else
 316       snprintf(n, name_length, "%s[%u]", array->name, length);
 317
 318    this->name = n;
 319 }
 320
 321
 322 const glsl_type *
 323 glsl_type::get_instance(unsigned base_type, unsigned rows, unsigned columns)
 324 {
 325    if (base_type == GLSL_TYPE_VOID)
 326       return &void_type;
 327
 328    if ((rows < 1) || (rows > 4) || (columns < 1) || (columns > 4))
 329       return error_type;
 330
 331    /* Treat GLSL vectors as Nx1 matrices.
 332     */
 333    if (columns == 1) {
 334       switch (base_type) {
 335       case GLSL_TYPE_UINT:
 336          return uint_type + (rows - 1);
 337       case GLSL_TYPE_INT:
 338          return int_type + (rows - 1);
 339       case GLSL_TYPE_FLOAT:
 340          return float_type + (rows - 1);
 341       case GLSL_TYPE_BOOL:
 342          return bool_type + (rows - 1);
 343       default:
 344          return error_type;
 345       }
 346    } else {
 347       if ((base_type != GLSL_TYPE_FLOAT) || (rows == 1))
 348          return error_type;
 349
 350       /* GLSL matrix types are named mat{COLUMNS}x{ROWS}.  Only the following
 351        * combinations are valid:
 352        *
 353        *   1 2 3 4
 354        * 1
 355        * 2   x x x
 356        * 3   x x x
 357        * 4   x x x
 358        */
 359 #define IDX(c,r) (((c-1)*3) + (r-1))
 360
 361       switch (IDX(columns, rows)) {
 362       case IDX(2,2): return mat2_type;
 363       case IDX(2,3): return mat2x3_type;
 364       case IDX(2,4): return mat2x4_type;
 365       case IDX(3,2): return mat3x2_type;
 366       case IDX(3,3): return mat3_type;
 367       case IDX(3,4): return mat3x4_type;
 368       case IDX(4,2): return mat4x2_type;
 369       case IDX(4,3): return mat4x3_type;
 370       case IDX(4,4): return mat4_type;
 371       default: return error_type;
 372       }
 373    }
 374
 375    assert(!"Should not get here.");
 376    return error_type;
 377 }
 378
 379
 380 int
 381 glsl_type::array_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    return ((key1->fields.array == key2->fields.array)
 390            && (key1->length == key2->length)) ? 0 : 1;
 391 }
 392
 393
 394 unsigned
 395 glsl_type::array_key_hash(const void *a)
 396 {
 397    const glsl_type *const key = (glsl_type *) a;
 398
 399    const struct {
 400       const glsl_type *t;
 401       unsigned l;
 402       char nul;
 403    } hash_key = {
 404       key->fields.array,
 405       key->length,
 406       '\0'
 407    };
 408
 409    return hash_table_string_hash(& hash_key);
 410 }
 411
 412
 413 const glsl_type *
 414 glsl_type::get_array_instance(const glsl_type *base, unsigned array_size)
 415 {
 416    const glsl_type key(base, array_size);
 417
 418    if (array_types == NULL) {
 419       array_types = hash_table_ctor(64, array_key_hash, array_key_compare);
 420    }
 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, t);
 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", 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 }