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