glsl_types.cpp revision 3645b77b7162913b504a49fc42d785fde27df3f3
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" 31extern "C" { 32#include "program/hash_table.h" 33} 34 35hash_table *glsl_type::array_types = NULL; 36hash_table *glsl_type::record_types = NULL; 37void *glsl_type::mem_ctx = NULL; 38 39void 40glsl_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 48glsl_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 66glsl_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 81glsl_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 102static void 103add_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 114bool 115glsl_type::contains_sampler() const 116{ 117 if (this->is_array()) { 118 return this->fields.array->contains_sampler(); 119 } else if (this->is_record()) { 120 for (unsigned int i = 0; i < this->length; i++) { 121 if (this->fields.structure[i].type->contains_sampler()) 122 return true; 123 } 124 return false; 125 } else { 126 return this->is_sampler(); 127 } 128} 129 130gl_texture_index 131glsl_type::sampler_index() const 132{ 133 const glsl_type *const t = (this->is_array()) ? this->fields.array : this; 134 135 assert(t->is_sampler()); 136 137 switch (t->sampler_dimensionality) { 138 case GLSL_SAMPLER_DIM_1D: 139 return (t->sampler_array) ? TEXTURE_1D_ARRAY_INDEX : TEXTURE_1D_INDEX; 140 case GLSL_SAMPLER_DIM_2D: 141 return (t->sampler_array) ? TEXTURE_2D_ARRAY_INDEX : TEXTURE_2D_INDEX; 142 case GLSL_SAMPLER_DIM_3D: 143 return TEXTURE_3D_INDEX; 144 case GLSL_SAMPLER_DIM_CUBE: 145 return TEXTURE_CUBE_INDEX; 146 case GLSL_SAMPLER_DIM_RECT: 147 return TEXTURE_RECT_INDEX; 148 case GLSL_SAMPLER_DIM_BUF: 149 assert(!"FINISHME: Implement ARB_texture_buffer_object"); 150 return TEXTURE_BUFFER_INDEX; 151 case GLSL_SAMPLER_DIM_EXTERNAL: 152 return TEXTURE_EXTERNAL_INDEX; 153 default: 154 assert(!"Should not get here."); 155 return TEXTURE_BUFFER_INDEX; 156 } 157} 158 159void 160glsl_type::generate_100ES_types(glsl_symbol_table *symtab) 161{ 162 add_types_to_symbol_table(symtab, builtin_core_types, 163 Elements(builtin_core_types), 164 false); 165 add_types_to_symbol_table(symtab, builtin_structure_types, 166 Elements(builtin_structure_types), 167 false); 168 add_types_to_symbol_table(symtab, void_type, 1, false); 169} 170 171void 172glsl_type::generate_110_types(glsl_symbol_table *symtab) 173{ 174 generate_100ES_types(symtab); 175 176 add_types_to_symbol_table(symtab, builtin_110_types, 177 Elements(builtin_110_types), 178 false); 179 add_types_to_symbol_table(symtab, &_sampler3D_type, 1, false); 180 add_types_to_symbol_table(symtab, builtin_110_deprecated_structure_types, 181 Elements(builtin_110_deprecated_structure_types), 182 false); 183} 184 185 186void 187glsl_type::generate_120_types(glsl_symbol_table *symtab) 188{ 189 generate_110_types(symtab); 190 191 add_types_to_symbol_table(symtab, builtin_120_types, 192 Elements(builtin_120_types), false); 193} 194 195 196void 197glsl_type::generate_130_types(glsl_symbol_table *symtab) 198{ 199 generate_120_types(symtab); 200 201 add_types_to_symbol_table(symtab, builtin_130_types, 202 Elements(builtin_130_types), false); 203 generate_EXT_texture_array_types(symtab, false); 204} 205 206 207void 208glsl_type::generate_140_types(glsl_symbol_table *symtab) 209{ 210 generate_130_types(symtab); 211 212 add_types_to_symbol_table(symtab, builtin_140_types, 213 Elements(builtin_140_types), false); 214} 215 216 217void 218glsl_type::generate_ARB_texture_rectangle_types(glsl_symbol_table *symtab, 219 bool warn) 220{ 221 add_types_to_symbol_table(symtab, builtin_ARB_texture_rectangle_types, 222 Elements(builtin_ARB_texture_rectangle_types), 223 warn); 224} 225 226 227void 228glsl_type::generate_EXT_texture_array_types(glsl_symbol_table *symtab, 229 bool warn) 230{ 231 add_types_to_symbol_table(symtab, builtin_EXT_texture_array_types, 232 Elements(builtin_EXT_texture_array_types), 233 warn); 234} 235 236 237void 238glsl_type::generate_OES_texture_3D_types(glsl_symbol_table *symtab, bool warn) 239{ 240 add_types_to_symbol_table(symtab, &_sampler3D_type, 1, warn); 241} 242 243 244void 245glsl_type::generate_OES_EGL_image_external_types(glsl_symbol_table *symtab, 246 bool warn) 247{ 248 add_types_to_symbol_table(symtab, builtin_OES_EGL_image_external_types, 249 Elements(builtin_OES_EGL_image_external_types), 250 warn); 251} 252 253void 254_mesa_glsl_initialize_types(struct _mesa_glsl_parse_state *state) 255{ 256 switch (state->language_version) { 257 case 100: 258 assert(state->es_shader); 259 glsl_type::generate_100ES_types(state->symbols); 260 break; 261 case 110: 262 glsl_type::generate_110_types(state->symbols); 263 break; 264 case 120: 265 glsl_type::generate_120_types(state->symbols); 266 break; 267 case 130: 268 glsl_type::generate_130_types(state->symbols); 269 break; 270 case 140: 271 glsl_type::generate_140_types(state->symbols); 272 break; 273 default: 274 /* error */ 275 break; 276 } 277 278 if (state->ARB_texture_rectangle_enable || 279 state->language_version >= 140) { 280 glsl_type::generate_ARB_texture_rectangle_types(state->symbols, 281 state->ARB_texture_rectangle_warn); 282 } 283 if (state->OES_texture_3D_enable && state->language_version == 100) { 284 glsl_type::generate_OES_texture_3D_types(state->symbols, 285 state->OES_texture_3D_warn); 286 } 287 288 if (state->EXT_texture_array_enable && state->language_version < 130) { 289 // These are already included in 130; don't create twice. 290 glsl_type::generate_EXT_texture_array_types(state->symbols, 291 state->EXT_texture_array_warn); 292 } 293 294 /* We cannot check for language_version == 100 here because we need the 295 * types to support fixed-function program generation. But this is fine 296 * since the extension is never enabled for OpenGL contexts. 297 */ 298 if (state->OES_EGL_image_external_enable) { 299 glsl_type::generate_OES_EGL_image_external_types(state->symbols, 300 state->OES_EGL_image_external_warn); 301 } 302} 303 304 305const glsl_type *glsl_type::get_base_type() const 306{ 307 switch (base_type) { 308 case GLSL_TYPE_UINT: 309 return uint_type; 310 case GLSL_TYPE_INT: 311 return int_type; 312 case GLSL_TYPE_FLOAT: 313 return float_type; 314 case GLSL_TYPE_BOOL: 315 return bool_type; 316 default: 317 return error_type; 318 } 319} 320 321 322const glsl_type *glsl_type::get_scalar_type() const 323{ 324 const glsl_type *type = this; 325 326 /* Handle arrays */ 327 while (type->base_type == GLSL_TYPE_ARRAY) 328 type = type->fields.array; 329 330 /* Handle vectors and matrices */ 331 switch (type->base_type) { 332 case GLSL_TYPE_UINT: 333 return uint_type; 334 case GLSL_TYPE_INT: 335 return int_type; 336 case GLSL_TYPE_FLOAT: 337 return float_type; 338 default: 339 /* Handle everything else */ 340 return type; 341 } 342} 343 344 345void 346_mesa_glsl_release_types(void) 347{ 348 if (glsl_type::array_types != NULL) { 349 hash_table_dtor(glsl_type::array_types); 350 glsl_type::array_types = NULL; 351 } 352 353 if (glsl_type::record_types != NULL) { 354 hash_table_dtor(glsl_type::record_types); 355 glsl_type::record_types = NULL; 356 } 357} 358 359 360glsl_type::glsl_type(const glsl_type *array, unsigned length) : 361 base_type(GLSL_TYPE_ARRAY), 362 sampler_dimensionality(0), sampler_shadow(0), sampler_array(0), 363 sampler_type(0), 364 vector_elements(0), matrix_columns(0), 365 name(NULL), length(length) 366{ 367 this->fields.array = array; 368 /* Inherit the gl type of the base. The GL type is used for 369 * uniform/statevar handling in Mesa and the arrayness of the type 370 * is represented by the size rather than the type. 371 */ 372 this->gl_type = array->gl_type; 373 374 /* Allow a maximum of 10 characters for the array size. This is enough 375 * for 32-bits of ~0. The extra 3 are for the '[', ']', and terminating 376 * NUL. 377 */ 378 const unsigned name_length = strlen(array->name) + 10 + 3; 379 char *const n = (char *) ralloc_size(this->mem_ctx, name_length); 380 381 if (length == 0) 382 snprintf(n, name_length, "%s[]", array->name); 383 else 384 snprintf(n, name_length, "%s[%u]", array->name, length); 385 386 this->name = n; 387} 388 389 390const glsl_type * 391glsl_type::get_instance(unsigned base_type, unsigned rows, unsigned columns) 392{ 393 if (base_type == GLSL_TYPE_VOID) 394 return void_type; 395 396 if ((rows < 1) || (rows > 4) || (columns < 1) || (columns > 4)) 397 return error_type; 398 399 /* Treat GLSL vectors as Nx1 matrices. 400 */ 401 if (columns == 1) { 402 switch (base_type) { 403 case GLSL_TYPE_UINT: 404 return uint_type + (rows - 1); 405 case GLSL_TYPE_INT: 406 return int_type + (rows - 1); 407 case GLSL_TYPE_FLOAT: 408 return float_type + (rows - 1); 409 case GLSL_TYPE_BOOL: 410 return bool_type + (rows - 1); 411 default: 412 return error_type; 413 } 414 } else { 415 if ((base_type != GLSL_TYPE_FLOAT) || (rows == 1)) 416 return error_type; 417 418 /* GLSL matrix types are named mat{COLUMNS}x{ROWS}. Only the following 419 * combinations are valid: 420 * 421 * 1 2 3 4 422 * 1 423 * 2 x x x 424 * 3 x x x 425 * 4 x x x 426 */ 427#define IDX(c,r) (((c-1)*3) + (r-1)) 428 429 switch (IDX(columns, rows)) { 430 case IDX(2,2): return mat2_type; 431 case IDX(2,3): return mat2x3_type; 432 case IDX(2,4): return mat2x4_type; 433 case IDX(3,2): return mat3x2_type; 434 case IDX(3,3): return mat3_type; 435 case IDX(3,4): return mat3x4_type; 436 case IDX(4,2): return mat4x2_type; 437 case IDX(4,3): return mat4x3_type; 438 case IDX(4,4): return mat4_type; 439 default: return error_type; 440 } 441 } 442 443 assert(!"Should not get here."); 444 return error_type; 445} 446 447 448const glsl_type * 449glsl_type::get_array_instance(const glsl_type *base, unsigned array_size) 450{ 451 452 if (array_types == NULL) { 453 array_types = hash_table_ctor(64, hash_table_string_hash, 454 hash_table_string_compare); 455 } 456 457 /* Generate a name using the base type pointer in the key. This is 458 * done because the name of the base type may not be unique across 459 * shaders. For example, two shaders may have different record types 460 * named 'foo'. 461 */ 462 char key[128]; 463 snprintf(key, sizeof(key), "%p[%u]", (void *) base, array_size); 464 465 const glsl_type *t = (glsl_type *) hash_table_find(array_types, key); 466 if (t == NULL) { 467 t = new glsl_type(base, array_size); 468 469 hash_table_insert(array_types, (void *) t, ralloc_strdup(mem_ctx, key)); 470 } 471 472 assert(t->base_type == GLSL_TYPE_ARRAY); 473 assert(t->length == array_size); 474 assert(t->fields.array == base); 475 476 return t; 477} 478 479 480int 481glsl_type::record_key_compare(const void *a, const void *b) 482{ 483 const glsl_type *const key1 = (glsl_type *) a; 484 const glsl_type *const key2 = (glsl_type *) b; 485 486 /* Return zero is the types match (there is zero difference) or non-zero 487 * otherwise. 488 */ 489 if (strcmp(key1->name, key2->name) != 0) 490 return 1; 491 492 if (key1->length != key2->length) 493 return 1; 494 495 for (unsigned i = 0; i < key1->length; i++) { 496 if (key1->fields.structure[i].type != key2->fields.structure[i].type) 497 return 1; 498 if (strcmp(key1->fields.structure[i].name, 499 key2->fields.structure[i].name) != 0) 500 return 1; 501 } 502 503 return 0; 504} 505 506 507unsigned 508glsl_type::record_key_hash(const void *a) 509{ 510 const glsl_type *const key = (glsl_type *) a; 511 char hash_key[128]; 512 unsigned size = 0; 513 514 size = snprintf(hash_key, sizeof(hash_key), "%08x", key->length); 515 516 for (unsigned i = 0; i < key->length; i++) { 517 if (size >= sizeof(hash_key)) 518 break; 519 520 size += snprintf(& hash_key[size], sizeof(hash_key) - size, 521 "%p", (void *) key->fields.structure[i].type); 522 } 523 524 return hash_table_string_hash(& hash_key); 525} 526 527 528const glsl_type * 529glsl_type::get_record_instance(const glsl_struct_field *fields, 530 unsigned num_fields, 531 const char *name) 532{ 533 const glsl_type key(fields, num_fields, name); 534 535 if (record_types == NULL) { 536 record_types = hash_table_ctor(64, record_key_hash, record_key_compare); 537 } 538 539 const glsl_type *t = (glsl_type *) hash_table_find(record_types, & key); 540 if (t == NULL) { 541 t = new glsl_type(fields, num_fields, name); 542 543 hash_table_insert(record_types, (void *) t, t); 544 } 545 546 assert(t->base_type == GLSL_TYPE_STRUCT); 547 assert(t->length == num_fields); 548 assert(strcmp(t->name, name) == 0); 549 550 return t; 551} 552 553 554const glsl_type * 555glsl_type::field_type(const char *name) const 556{ 557 if (this->base_type != GLSL_TYPE_STRUCT) 558 return error_type; 559 560 for (unsigned i = 0; i < this->length; i++) { 561 if (strcmp(name, this->fields.structure[i].name) == 0) 562 return this->fields.structure[i].type; 563 } 564 565 return error_type; 566} 567 568 569int 570glsl_type::field_index(const char *name) const 571{ 572 if (this->base_type != GLSL_TYPE_STRUCT) 573 return -1; 574 575 for (unsigned i = 0; i < this->length; i++) { 576 if (strcmp(name, this->fields.structure[i].name) == 0) 577 return i; 578 } 579 580 return -1; 581} 582 583 584unsigned 585glsl_type::component_slots() const 586{ 587 switch (this->base_type) { 588 case GLSL_TYPE_UINT: 589 case GLSL_TYPE_INT: 590 case GLSL_TYPE_FLOAT: 591 case GLSL_TYPE_BOOL: 592 return this->components(); 593 594 case GLSL_TYPE_STRUCT: { 595 unsigned size = 0; 596 597 for (unsigned i = 0; i < this->length; i++) 598 size += this->fields.structure[i].type->component_slots(); 599 600 return size; 601 } 602 603 case GLSL_TYPE_ARRAY: 604 return this->length * this->fields.array->component_slots(); 605 606 default: 607 return 0; 608 } 609} 610 611bool 612glsl_type::can_implicitly_convert_to(const glsl_type *desired) const 613{ 614 if (this == desired) 615 return true; 616 617 /* There is no conversion among matrix types. */ 618 if (this->matrix_columns > 1 || desired->matrix_columns > 1) 619 return false; 620 621 /* int and uint can be converted to float. */ 622 return desired->is_float() 623 && this->is_integer() 624 && this->vector_elements == desired->vector_elements; 625} 626