src/compiler/glsl_types.h

   1 /* -*- c++ -*- */
   2 /*
   3  * Copyright © 2009 Intel Corporation
   4  *
   5  * Permission is hereby granted, free of charge, to any person obtaining a
   6  * copy of this software and associated documentation files (the "Software"),
   7  * to deal in the Software without restriction, including without limitation
   8  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
   9  * and/or sell copies of the Software, and to permit persons to whom the
  10  * Software is furnished to do so, subject to the following conditions:
  11  *
  12  * The above copyright notice and this permission notice (including the next
  13  * paragraph) shall be included in all copies or substantial portions of the
  14  * Software.
  15  *
  16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  19  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  21  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  22  * DEALINGS IN THE SOFTWARE.
  23  */
  24
  25 #pragma once
  26 #ifndef GLSL_TYPES_H
  27 #define GLSL_TYPES_H
  28
  29 #include <string.h>
  30 #include <assert.h>
  31
  32 #ifdef __cplusplus
  33 extern "C" {
  34 #endif
  35
  36 struct _mesa_glsl_parse_state;
  37 struct glsl_symbol_table;
  38
  39 extern void
  40 _mesa_glsl_initialize_types(struct _mesa_glsl_parse_state *state);
  41
  42 extern void
  43 _mesa_glsl_release_types(void);
  44
  45 #ifdef __cplusplus
  46 }
  47 #endif
  48
  49 enum glsl_base_type {
  50    GLSL_TYPE_UINT = 0,
  51    GLSL_TYPE_INT,
  52    GLSL_TYPE_FLOAT,
  53    GLSL_TYPE_DOUBLE,
  54    GLSL_TYPE_BOOL,
  55    GLSL_TYPE_SAMPLER,
  56    GLSL_TYPE_IMAGE,
  57    GLSL_TYPE_ATOMIC_UINT,
  58    GLSL_TYPE_STRUCT,
  59    GLSL_TYPE_FUNCTION,
  60    GLSL_TYPE_INTERFACE,
  61    GLSL_TYPE_ARRAY,
  62    GLSL_TYPE_VOID,
  63    GLSL_TYPE_SUBROUTINE,
  64    GLSL_TYPE_ERROR
  65 };
  66
  67 enum glsl_sampler_dim {
  68    GLSL_SAMPLER_DIM_1D = 0,
  69    GLSL_SAMPLER_DIM_2D,
  70    GLSL_SAMPLER_DIM_3D,
  71    GLSL_SAMPLER_DIM_CUBE,
  72    GLSL_SAMPLER_DIM_RECT,
  73    GLSL_SAMPLER_DIM_BUF,
  74    GLSL_SAMPLER_DIM_EXTERNAL,
  75    GLSL_SAMPLER_DIM_MS
  76 };
  77
  78 enum glsl_interface_packing {
  79    GLSL_INTERFACE_PACKING_STD140,
  80    GLSL_INTERFACE_PACKING_SHARED,
  81    GLSL_INTERFACE_PACKING_PACKED,
  82    GLSL_INTERFACE_PACKING_STD430
  83 };
  84
  85 enum glsl_matrix_layout {
  86    /**
  87     * The layout of the matrix is inherited from the object containing the
  88     * matrix (the top level structure or the uniform block).
  89     */
  90    GLSL_MATRIX_LAYOUT_INHERITED,
  91
  92    /**
  93     * Explicit column-major layout
  94     *
  95     * If a uniform block doesn't have an explicit layout set, it will default
  96     * to this layout.
  97     */
  98    GLSL_MATRIX_LAYOUT_COLUMN_MAJOR,
  99
 100    /**
 101     * Row-major layout
 102     */
 103    GLSL_MATRIX_LAYOUT_ROW_MAJOR
 104 };
 105
 106 enum {
 107    GLSL_PRECISION_NONE = 0,
 108    GLSL_PRECISION_HIGH,
 109    GLSL_PRECISION_MEDIUM,
 110    GLSL_PRECISION_LOW
 111 };
 112
 113 #ifdef __cplusplus
 114 #include "GL/gl.h"
 115 #include "util/ralloc.h"
 116 #include "main/mtypes.h" /* for gl_texture_index, C++'s enum rules are broken */
 117
 118 struct glsl_type {
 119    GLenum gl_type;
 120    glsl_base_type base_type;
 121
 122    unsigned sampler_dimensionality:3; /**< \see glsl_sampler_dim */
 123    unsigned sampler_shadow:1;
 124    unsigned sampler_array:1;
 125    unsigned sampler_type:2;    /**< Type of data returned using this
 126                                 * sampler or image.  Only \c
 127                                 * GLSL_TYPE_FLOAT, \c GLSL_TYPE_INT,
 128                                 * and \c GLSL_TYPE_UINT are valid.
 129                                 */
 130    unsigned interface_packing:2;
 131
 132    /* Callers of this ralloc-based new need not call delete. It's
 133     * easier to just ralloc_free 'mem_ctx' (or any of its ancestors). */
 134    static void* operator new(size_t size)
 135    {
 136       mtx_lock(&glsl_type::mutex);
 137
 138       /* mem_ctx should have been created by the static members */
 139       assert(glsl_type::mem_ctx != NULL);
 140
 141       void *type;
 142
 143       type = ralloc_size(glsl_type::mem_ctx, size);
 144       assert(type != NULL);
 145
 146       mtx_unlock(&glsl_type::mutex);
 147
 148       return type;
 149    }
 150
 151    /* If the user *does* call delete, that's OK, we will just
 152     * ralloc_free in that case. */
 153    static void operator delete(void *type)
 154    {
 155       mtx_lock(&glsl_type::mutex);
 156       ralloc_free(type);
 157       mtx_unlock(&glsl_type::mutex);
 158    }
 159
 160    /**
 161     * \name Vector and matrix element counts
 162     *
 163     * For scalars, each of these values will be 1.  For non-numeric types
 164     * these will be 0.
 165     */
 166    /*@{*/
 167    uint8_t vector_elements;    /**< 1, 2, 3, or 4 vector elements. */
 168    uint8_t matrix_columns;     /**< 1, 2, 3, or 4 matrix columns. */
 169    /*@}*/
 170
 171    /**
 172     * For \c GLSL_TYPE_ARRAY, this is the length of the array.  For
 173     * \c GLSL_TYPE_STRUCT or \c GLSL_TYPE_INTERFACE, it is the number of
 174     * elements in the structure and the number of values pointed to by
 175     * \c fields.structure (below).
 176     */
 177    unsigned length;
 178
 179    /**
 180     * Name of the data type
 181     *
 182     * Will never be \c NULL.
 183     */
 184    const char *name;
 185
 186    /**
 187     * Subtype of composite data types.
 188     */
 189    union {
 190       const struct glsl_type *array;            /**< Type of array elements. */
 191       struct glsl_function_param *parameters;   /**< Parameters to function. */
 192       struct glsl_struct_field *structure;      /**< List of struct fields. */
 193    } fields;
 194
 195    /**
 196     * \name Pointers to various public type singletons
 197     */
 198    /*@{*/
 199 #undef  DECL_TYPE
 200 #define DECL_TYPE(NAME, ...) \
 201    static const glsl_type *const NAME##_type;
 202 #undef  STRUCT_TYPE
 203 #define STRUCT_TYPE(NAME) \
 204    static const glsl_type *const struct_##NAME##_type;
 205 #include "compiler/builtin_type_macros.h"
 206    /*@}*/
 207
 208    /**
 209     * Convenience accessors for vector types (shorter than get_instance()).
 210     * @{
 211     */
 212    static const glsl_type *vec(unsigned components);
 213    static const glsl_type *dvec(unsigned components);
 214    static const glsl_type *ivec(unsigned components);
 215    static const glsl_type *uvec(unsigned components);
 216    static const glsl_type *bvec(unsigned components);
 217    /**@}*/
 218
 219    /**
 220     * For numeric and boolean derived types returns the basic scalar type
 221     *
 222     * If the type is a numeric or boolean scalar, vector, or matrix type,
 223     * this function gets the scalar type of the individual components.  For
 224     * all other types, including arrays of numeric or boolean types, the
 225     * error type is returned.
 226     */
 227    const glsl_type *get_base_type() const;
 228
 229    /**
 230     * Get the basic scalar type which this type aggregates.
 231     *
 232     * If the type is a numeric or boolean scalar, vector, or matrix, or an
 233     * array of any of those, this function gets the scalar type of the
 234     * individual components.  For structs and arrays of structs, this function
 235     * returns the struct type.  For samplers and arrays of samplers, this
 236     * function returns the sampler type.
 237     */
 238    const glsl_type *get_scalar_type() const;
 239
 240    /**
 241     * Get the instance of a built-in scalar, vector, or matrix type
 242     */
 243    static const glsl_type *get_instance(unsigned base_type, unsigned rows,
 244                                         unsigned columns);
 245
 246    /**
 247     * Get the instance of a sampler type
 248     */
 249    static const glsl_type *get_sampler_instance(enum glsl_sampler_dim dim,
 250                                                 bool shadow,
 251                                                 bool array,
 252                                                 glsl_base_type type);
 253
 254    static const glsl_type *get_image_instance(enum glsl_sampler_dim dim,
 255                                               bool array, glsl_base_type type);
 256
 257    /**
 258     * Get the instance of an array type
 259     */
 260    static const glsl_type *get_array_instance(const glsl_type *base,
 261                                               unsigned elements);
 262
 263    /**
 264     * Get the instance of a record type
 265     */
 266    static const glsl_type *get_record_instance(const glsl_struct_field *fields,
 267                                                unsigned num_fields,
 268                                                const char *name);
 269
 270    /**
 271     * Get the instance of an interface block type
 272     */
 273    static const glsl_type *get_interface_instance(const glsl_struct_field *fields,
 274                                                   unsigned num_fields,
 275                                                   enum glsl_interface_packing packing,
 276                                                   const char *block_name);
 277
 278    /**
 279     * Get the instance of an subroutine type
 280     */
 281    static const glsl_type *get_subroutine_instance(const char *subroutine_name);
 282
 283    /**
 284     * Get the instance of a function type
 285     */
 286    static const glsl_type *get_function_instance(const struct glsl_type *return_type,
 287                                                  const glsl_function_param *parameters,
 288                                                  unsigned num_params);
 289
 290    /**
 291     * Get the type resulting from a multiplication of \p type_a * \p type_b
 292     */
 293    static const glsl_type *get_mul_type(const glsl_type *type_a,
 294                                         const glsl_type *type_b);
 295
 296    /**
 297     * Query the total number of scalars that make up a scalar, vector or matrix
 298     */
 299    unsigned components() const
 300    {
 301       return vector_elements * matrix_columns;
 302    }
 303
 304    /**
 305     * Calculate the number of components slots required to hold this type
 306     *
 307     * This is used to determine how many uniform or varying locations a type
 308     * might occupy.
 309     */
 310    unsigned component_slots() const;
 311
 312    /**
 313     * Calculate offset between the base location of the struct in
 314     * uniform storage and a struct member.
 315     * For the initial call, length is the index of the member to find the
 316     * offset for.
 317     */
 318    unsigned record_location_offset(unsigned length) const;
 319
 320    /**
 321     * Calculate the number of unique values from glGetUniformLocation for the
 322     * elements of the type.
 323     *
 324     * This is used to allocate slots in the UniformRemapTable, the amount of
 325     * locations may not match with actual used storage space by the driver.
 326     */
 327    unsigned uniform_locations() const;
 328
 329    /**
 330     * Calculate the number of attribute slots required to hold this type
 331     *
 332     * This implements the language rules of GLSL 1.50 for counting the number
 333     * of slots used by a vertex attribute.  It also determines the number of
 334     * varying slots the type will use up in the absence of varying packing
 335     * (and thus, it can be used to measure the number of varying slots used by
 336     * the varyings that are generated by lower_packed_varyings).
 337     *
 338     * For vertex shader attributes - doubles only take one slot.
 339     * For inter-shader varyings - dvec3/dvec4 take two slots.
 340     */
 341    unsigned count_attribute_slots(bool vertex_input_slots) const;
 342
 343    /**
 344     * Alignment in bytes of the start of this type in a std140 uniform
 345     * block.
 346     */
 347    unsigned std140_base_alignment(bool row_major) const;
 348
 349    /** Size in bytes of this type in a std140 uniform block.
 350     *
 351     * Note that this is not GL_UNIFORM_SIZE (which is the number of
 352     * elements in the array)
 353     */
 354    unsigned std140_size(bool row_major) const;
 355
 356    /**
 357     * Alignment in bytes of the start of this type in a std430 shader
 358     * storage block.
 359     */
 360    unsigned std430_base_alignment(bool row_major) const;
 361
 362    /**
 363     * Calculate array stride in bytes of this type in a std430 shader storage
 364     * block.
 365     */
 366    unsigned std430_array_stride(bool row_major) const;
 367
 368    /**
 369     * Size in bytes of this type in a std430 shader storage block.
 370     *
 371     * Note that this is not GL_BUFFER_SIZE
 372     */
 373    unsigned std430_size(bool row_major) const;
 374
 375    /**
 376     * \brief Can this type be implicitly converted to another?
 377     *
 378     * \return True if the types are identical or if this type can be converted
 379     *         to \c desired according to Section 4.1.10 of the GLSL spec.
 380     *
 381     * \verbatim
 382     * From page 25 (31 of the pdf) of the GLSL 1.50 spec, Section 4.1.10
 383     * Implicit Conversions:
 384     *
 385     *     In some situations, an expression and its type will be implicitly
 386     *     converted to a different type. The following table shows all allowed
 387     *     implicit conversions:
 388     *
 389     *     Type of expression | Can be implicitly converted to
 390     *     --------------------------------------------------
 391     *     int                  float
 392     *     uint
 393     *
 394     *     ivec2                vec2
 395     *     uvec2
 396     *
 397     *     ivec3                vec3
 398     *     uvec3
 399     *
 400     *     ivec4                vec4
 401     *     uvec4
 402     *
 403     *     There are no implicit array or structure conversions. For example,
 404     *     an array of int cannot be implicitly converted to an array of float.
 405     *     There are no implicit conversions between signed and unsigned
 406     *     integers.
 407     * \endverbatim
 408     */
 409    bool can_implicitly_convert_to(const glsl_type *desired,
 410                                   _mesa_glsl_parse_state *state) const;
 411
 412    /**
 413     * Query whether or not a type is a scalar (non-vector and non-matrix).
 414     */
 415    bool is_scalar() const
 416    {
 417       return (vector_elements == 1)
 418          && (base_type >= GLSL_TYPE_UINT)
 419          && (base_type <= GLSL_TYPE_BOOL);
 420    }
 421
 422    /**
 423     * Query whether or not a type is a vector
 424     */
 425    bool is_vector() const
 426    {
 427       return (vector_elements > 1)
 428          && (matrix_columns == 1)
 429          && (base_type >= GLSL_TYPE_UINT)
 430          && (base_type <= GLSL_TYPE_BOOL);
 431    }
 432
 433    /**
 434     * Query whether or not a type is a matrix
 435     */
 436    bool is_matrix() const
 437    {
 438       /* GLSL only has float matrices. */
 439       return (matrix_columns > 1) && (base_type == GLSL_TYPE_FLOAT || base_type == GLSL_TYPE_DOUBLE);
 440    }
 441
 442    /**
 443     * Query whether or not a type is a non-array numeric type
 444     */
 445    bool is_numeric() const
 446    {
 447       return (base_type >= GLSL_TYPE_UINT) && (base_type <= GLSL_TYPE_DOUBLE);
 448    }
 449
 450    /**
 451     * Query whether or not a type is an integral type
 452     */
 453    bool is_integer() const
 454    {
 455       return (base_type == GLSL_TYPE_UINT) || (base_type == GLSL_TYPE_INT);
 456    }
 457
 458    /**
 459     * Query whether or not type is an integral type, or for struct and array
 460     * types, contains an integral type.
 461     */
 462    bool contains_integer() const;
 463
 464    /**
 465     * Query whether or not type is a double type, or for struct and array
 466     * types, contains a double type.
 467     */
 468    bool contains_double() const;
 469
 470    /**
 471     * Query whether or not a type is a float type
 472     */
 473    bool is_float() const
 474    {
 475       return base_type == GLSL_TYPE_FLOAT;
 476    }
 477
 478    /**
 479     * Query whether or not a type is a double type
 480     */
 481    bool is_double() const
 482    {
 483       return base_type == GLSL_TYPE_DOUBLE;
 484    }
 485
 486    /**
 487     * Query whether a double takes two slots.
 488     */
 489    bool is_dual_slot_double() const
 490    {
 491       return base_type == GLSL_TYPE_DOUBLE && vector_elements > 2;
 492    }
 493
 494    /**
 495     * Query whether or not a type is a non-array boolean type
 496     */
 497    bool is_boolean() const
 498    {
 499       return base_type == GLSL_TYPE_BOOL;
 500    }
 501
 502    /**
 503     * Query whether or not a type is a sampler
 504     */
 505    bool is_sampler() const
 506    {
 507       return base_type == GLSL_TYPE_SAMPLER;
 508    }
 509
 510    /**
 511     * Query whether or not type is a sampler, or for struct and array
 512     * types, contains a sampler.
 513     */
 514    bool contains_sampler() const;
 515
 516    /**
 517     * Get the Mesa texture target index for a sampler type.
 518     */
 519    gl_texture_index sampler_index() const;
 520
 521    /**
 522     * Query whether or not type is an image, or for struct and array
 523     * types, contains an image.
 524     */
 525    bool contains_image() const;
 526
 527    /**
 528     * Query whether or not a type is an image
 529     */
 530    bool is_image() const
 531    {
 532       return base_type == GLSL_TYPE_IMAGE;
 533    }
 534
 535    /**
 536     * Query whether or not a type is an array
 537     */
 538    bool is_array() const
 539    {
 540       return base_type == GLSL_TYPE_ARRAY;
 541    }
 542
 543    bool is_array_of_arrays() const
 544    {
 545       return is_array() && fields.array->is_array();
 546    }
 547
 548    /**
 549     * Query whether or not a type is a record
 550     */
 551    bool is_record() const
 552    {
 553       return base_type == GLSL_TYPE_STRUCT;
 554    }
 555
 556    /**
 557     * Query whether or not a type is an interface
 558     */
 559    bool is_interface() const
 560    {
 561       return base_type == GLSL_TYPE_INTERFACE;
 562    }
 563
 564    /**
 565     * Query whether or not a type is the void type singleton.
 566     */
 567    bool is_void() const
 568    {
 569       return base_type == GLSL_TYPE_VOID;
 570    }
 571
 572    /**
 573     * Query whether or not a type is the error type singleton.
 574     */
 575    bool is_error() const
 576    {
 577       return base_type == GLSL_TYPE_ERROR;
 578    }
 579
 580    /**
 581     * Query if a type is unnamed/anonymous (named by the parser)
 582     */
 583
 584    bool is_subroutine() const
 585    {
 586       return base_type == GLSL_TYPE_SUBROUTINE;
 587    }
 588    bool contains_subroutine() const;
 589
 590    bool is_anonymous() const
 591    {
 592       return !strncmp(name, "#anon", 5);
 593    }
 594
 595    /**
 596     * Get the type stripped of any arrays
 597     *
 598     * \return
 599     * Pointer to the type of elements of the first non-array type for array
 600     * types, or pointer to itself for non-array types.
 601     */
 602    const glsl_type *without_array() const
 603    {
 604       const glsl_type *t = this;
 605
 606       while (t->is_array())
 607          t = t->fields.array;
 608
 609       return t;
 610    }
 611
 612    /**
 613     * Return the total number of elements in an array including the elements
 614     * in arrays of arrays.
 615     */
 616    unsigned arrays_of_arrays_size() const
 617    {
 618       if (!is_array())
 619          return 0;
 620
 621       unsigned size = length;
 622       const glsl_type *base_type = fields.array;
 623
 624       while (base_type->is_array()) {
 625          size = size * base_type->length;
 626          base_type = base_type->fields.array;
 627       }
 628       return size;
 629    }
 630
 631    /**
 632     * Return the amount of atomic counter storage required for a type.
 633     */
 634    unsigned atomic_size() const
 635    {
 636       if (base_type == GLSL_TYPE_ATOMIC_UINT)
 637          return ATOMIC_COUNTER_SIZE;
 638       else if (is_array())
 639          return length * fields.array->atomic_size();
 640       else
 641          return 0;
 642    }
 643
 644    /**
 645     * Return whether a type contains any atomic counters.
 646     */
 647    bool contains_atomic() const
 648    {
 649       return atomic_size() > 0;
 650    }
 651
 652    /**
 653     * Return whether a type contains any opaque types.
 654     */
 655    bool contains_opaque() const;
 656
 657    /**
 658     * Query the full type of a matrix row
 659     *
 660     * \return
 661     * If the type is not a matrix, \c glsl_type::error_type is returned.
 662     * Otherwise a type matching the rows of the matrix is returned.
 663     */
 664    const glsl_type *row_type() const
 665    {
 666       return is_matrix()
 667          ? get_instance(base_type, matrix_columns, 1)
 668          : error_type;
 669    }
 670
 671    /**
 672     * Query the full type of a matrix column
 673     *
 674     * \return
 675     * If the type is not a matrix, \c glsl_type::error_type is returned.
 676     * Otherwise a type matching the columns of the matrix is returned.
 677     */
 678    const glsl_type *column_type() const
 679    {
 680       return is_matrix()
 681          ? get_instance(base_type, vector_elements, 1)
 682          : error_type;
 683    }
 684
 685    /**
 686     * Get the type of a structure field
 687     *
 688     * \return
 689     * Pointer to the type of the named field.  If the type is not a structure
 690     * or the named field does not exist, \c glsl_type::error_type is returned.
 691     */
 692    const glsl_type *field_type(const char *name) const;
 693
 694    /**
 695     * Get the location of a field within a record type
 696     */
 697    int field_index(const char *name) const;
 698
 699    /**
 700     * Query the number of elements in an array type
 701     *
 702     * \return
 703     * The number of elements in the array for array types or -1 for non-array
 704     * types.  If the number of elements in the array has not yet been declared,
 705     * zero is returned.
 706     */
 707    int array_size() const
 708    {
 709       return is_array() ? length : -1;
 710    }
 711
 712    /**
 713     * Query whether the array size for all dimensions has been declared.
 714     */
 715    bool is_unsized_array() const
 716    {
 717       return is_array() && length == 0;
 718    }
 719
 720    /**
 721     * Return the number of coordinate components needed for this
 722     * sampler or image type.
 723     *
 724     * This is based purely on the sampler's dimensionality.  For example, this
 725     * returns 1 for sampler1D, and 3 for sampler2DArray.
 726     *
 727     * Note that this is often different than actual coordinate type used in
 728     * a texturing built-in function, since those pack additional values (such
 729     * as the shadow comparitor or projector) into the coordinate type.
 730     */
 731    int coordinate_components() const;
 732
 733    /**
 734     * Compare a record type against another record type.
 735     *
 736     * This is useful for matching record types declared across shader stages.
 737     */
 738    bool record_compare(const glsl_type *b) const;
 739
 740 private:
 741
 742    static mtx_t mutex;
 743
 744    /**
 745     * ralloc context for all glsl_type allocations
 746     *
 747     * Set on the first call to \c glsl_type::new.
 748     */
 749    static void *mem_ctx;
 750
 751    void init_ralloc_type_ctx(void);
 752
 753    /** Constructor for vector and matrix types */
 754    glsl_type(GLenum gl_type,
 755              glsl_base_type base_type, unsigned vector_elements,
 756              unsigned matrix_columns, const char *name);
 757
 758    /** Constructor for sampler or image types */
 759    glsl_type(GLenum gl_type, glsl_base_type base_type,
 760              enum glsl_sampler_dim dim, bool shadow, bool array,
 761              unsigned type, const char *name);
 762
 763    /** Constructor for record types */
 764    glsl_type(const glsl_struct_field *fields, unsigned num_fields,
 765              const char *name);
 766
 767    /** Constructor for interface types */
 768    glsl_type(const glsl_struct_field *fields, unsigned num_fields,
 769              enum glsl_interface_packing packing, const char *name);
 770
 771    /** Constructor for interface types */
 772    glsl_type(const glsl_type *return_type,
 773              const glsl_function_param *params, unsigned num_params);
 774
 775    /** Constructor for array types */
 776    glsl_type(const glsl_type *array, unsigned length);
 777
 778    /** Constructor for subroutine types */
 779    glsl_type(const char *name);
 780
 781    /** Hash table containing the known array types. */
 782    static struct hash_table *array_types;
 783
 784    /** Hash table containing the known record types. */
 785    static struct hash_table *record_types;
 786
 787    /** Hash table containing the known interface types. */
 788    static struct hash_table *interface_types;
 789
 790    /** Hash table containing the known subroutine types. */
 791    static struct hash_table *subroutine_types;
 792
 793    /** Hash table containing the known function types. */
 794    static struct hash_table *function_types;
 795
 796    static bool record_key_compare(const void *a, const void *b);
 797    static unsigned record_key_hash(const void *key);
 798
 799    /**
 800     * \name Built-in type flyweights
 801     */
 802    /*@{*/
 803 #undef  DECL_TYPE
 804 #define DECL_TYPE(NAME, ...) static const glsl_type _##NAME##_type;
 805 #undef  STRUCT_TYPE
 806 #define STRUCT_TYPE(NAME)        static const glsl_type _struct_##NAME##_type;
 807 #include "compiler/builtin_type_macros.h"
 808    /*@}*/
 809
 810    /**
 811     * \name Friend functions.
 812     *
 813     * These functions are friends because they must have C linkage and the
 814     * need to call various private methods or access various private static
 815     * data.
 816     */
 817    /*@{*/
 818    friend void _mesa_glsl_initialize_types(struct _mesa_glsl_parse_state *);
 819    friend void _mesa_glsl_release_types(void);
 820    /*@}*/
 821 };
 822
 823 #undef DECL_TYPE
 824 #undef STRUCT_TYPE
 825 #endif /* __cplusplus */
 826
 827 struct glsl_struct_field {
 828    const struct glsl_type *type;
 829    const char *name;
 830
 831    /**
 832     * For interface blocks, gl_varying_slot corresponding to the input/output
 833     * if this is a built-in input/output (i.e. a member of the built-in
 834     * gl_PerVertex interface block); -1 otherwise.
 835     *
 836     * Ignored for structs.
 837     */
 838    int location;
 839
 840    /**
 841     * For interface blocks, the interpolation mode (as in
 842     * ir_variable::interpolation).  0 otherwise.
 843     */
 844    unsigned interpolation:2;
 845
 846    /**
 847     * For interface blocks, 1 if this variable uses centroid interpolation (as
 848     * in ir_variable::centroid).  0 otherwise.
 849     */
 850    unsigned centroid:1;
 851
 852    /**
 853     * For interface blocks, 1 if this variable uses sample interpolation (as
 854     * in ir_variable::sample). 0 otherwise.
 855     */
 856    unsigned sample:1;
 857
 858    /**
 859     * Layout of the matrix.  Uses glsl_matrix_layout values.
 860     */
 861    unsigned matrix_layout:2;
 862
 863    /**
 864     * For interface blocks, 1 if this variable is a per-patch input or output
 865     * (as in ir_variable::patch). 0 otherwise.
 866     */
 867    unsigned patch:1;
 868
 869    /**
 870     * Precision qualifier
 871     */
 872    unsigned precision:2;
 873
 874    /**
 875     * Image qualifiers, applicable to buffer variables defined in shader
 876     * storage buffer objects (SSBOs)
 877     */
 878    unsigned image_read_only:1;
 879    unsigned image_write_only:1;
 880    unsigned image_coherent:1;
 881    unsigned image_volatile:1;
 882    unsigned image_restrict:1;
 883
 884 #ifdef __cplusplus
 885    glsl_struct_field(const struct glsl_type *_type, const char *_name)
 886       : type(_type), name(_name), location(-1), interpolation(0), centroid(0),
 887         sample(0), matrix_layout(GLSL_MATRIX_LAYOUT_INHERITED), patch(0),
 888         precision(GLSL_PRECISION_NONE), image_read_only(0), image_write_only(0),
 889         image_coherent(0), image_volatile(0), image_restrict(0)
 890    {
 891       /* empty */
 892    }
 893
 894    glsl_struct_field()
 895    {
 896       /* empty */
 897    }
 898 #endif
 899 };
 900
 901 struct glsl_function_param {
 902    const struct glsl_type *type;
 903
 904    bool in;
 905    bool out;
 906 };
 907
 908 static inline unsigned int
 909 glsl_align(unsigned int a, unsigned int align)
 910 {
 911    return (a + align - 1) / align * align;
 912 }
 913
 914 #endif /* GLSL_TYPES_H */