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_INTERFACE,
  60    GLSL_TYPE_ARRAY,
  61    GLSL_TYPE_VOID,
  62    GLSL_TYPE_SUBROUTINE,
  63    GLSL_TYPE_FUNCTION,
  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 sampled_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
 255    /**
 256     * Get the instance of an array type
 257     */
 258    static const glsl_type *get_array_instance(const glsl_type *base,
 259                                               unsigned elements);
 260
 261    /**
 262     * Get the instance of a record type
 263     */
 264    static const glsl_type *get_record_instance(const glsl_struct_field *fields,
 265                                                unsigned num_fields,
 266                                                const char *name);
 267
 268    /**
 269     * Get the instance of an interface block type
 270     */
 271    static const glsl_type *get_interface_instance(const glsl_struct_field *fields,
 272                                                   unsigned num_fields,
 273                                                   enum glsl_interface_packing packing,
 274                                                   const char *block_name);
 275
 276    /**
 277     * Get the instance of an subroutine type
 278     */
 279    static const glsl_type *get_subroutine_instance(const char *subroutine_name);
 280
 281    /**
 282     * Get the instance of a function type
 283     */
 284    static const glsl_type *get_function_instance(const struct glsl_type *return_type,
 285                                                  const glsl_function_param *parameters,
 286                                                  unsigned num_params);
 287
 288    /**
 289     * Get the type resulting from a multiplication of \p type_a * \p type_b
 290     */
 291    static const glsl_type *get_mul_type(const glsl_type *type_a,
 292                                         const glsl_type *type_b);
 293
 294    /**
 295     * Query the total number of scalars that make up a scalar, vector or matrix
 296     */
 297    unsigned components() const
 298    {
 299       return vector_elements * matrix_columns;
 300    }
 301
 302    /**
 303     * Calculate the number of components slots required to hold this type
 304     *
 305     * This is used to determine how many uniform or varying locations a type
 306     * might occupy.
 307     */
 308    unsigned component_slots() const;
 309
 310    /**
 311     * Calculate offset between the base location of the struct in
 312     * uniform storage and a struct member.
 313     * For the initial call, length is the index of the member to find the
 314     * offset for.
 315     */
 316    unsigned record_location_offset(unsigned length) const;
 317
 318    /**
 319     * Calculate the number of unique values from glGetUniformLocation for the
 320     * elements of the type.
 321     *
 322     * This is used to allocate slots in the UniformRemapTable, the amount of
 323     * locations may not match with actual used storage space by the driver.
 324     */
 325    unsigned uniform_locations() const;
 326
 327    /**
 328     * Calculate the number of attribute slots required to hold this type
 329     *
 330     * This implements the language rules of GLSL 1.50 for counting the number
 331     * of slots used by a vertex attribute.  It also determines the number of
 332     * varying slots the type will use up in the absence of varying packing
 333     * (and thus, it can be used to measure the number of varying slots used by
 334     * the varyings that are generated by lower_packed_varyings).
 335     *
 336     * For vertex shader attributes - doubles only take one slot.
 337     * For inter-shader varyings - dvec3/dvec4 take two slots.
 338     */
 339    unsigned count_attribute_slots(bool vertex_input_slots) const;
 340
 341    /**
 342     * Alignment in bytes of the start of this type in a std140 uniform
 343     * block.
 344     */
 345    unsigned std140_base_alignment(bool row_major) const;
 346
 347    /** Size in bytes of this type in a std140 uniform block.
 348     *
 349     * Note that this is not GL_UNIFORM_SIZE (which is the number of
 350     * elements in the array)
 351     */
 352    unsigned std140_size(bool row_major) const;
 353
 354    /**
 355     * Alignment in bytes of the start of this type in a std430 shader
 356     * storage block.
 357     */
 358    unsigned std430_base_alignment(bool row_major) const;
 359
 360    /**
 361     * Calculate array stride in bytes of this type in a std430 shader storage
 362     * block.
 363     */
 364    unsigned std430_array_stride(bool row_major) const;
 365
 366    /**
 367     * Size in bytes of this type in a std430 shader storage block.
 368     *
 369     * Note that this is not GL_BUFFER_SIZE
 370     */
 371    unsigned std430_size(bool row_major) const;
 372
 373    /**
 374     * \brief Can this type be implicitly converted to another?
 375     *
 376     * \return True if the types are identical or if this type can be converted
 377     *         to \c desired according to Section 4.1.10 of the GLSL spec.
 378     *
 379     * \verbatim
 380     * From page 25 (31 of the pdf) of the GLSL 1.50 spec, Section 4.1.10
 381     * Implicit Conversions:
 382     *
 383     *     In some situations, an expression and its type will be implicitly
 384     *     converted to a different type. The following table shows all allowed
 385     *     implicit conversions:
 386     *
 387     *     Type of expression | Can be implicitly converted to
 388     *     --------------------------------------------------
 389     *     int                  float
 390     *     uint
 391     *
 392     *     ivec2                vec2
 393     *     uvec2
 394     *
 395     *     ivec3                vec3
 396     *     uvec3
 397     *
 398     *     ivec4                vec4
 399     *     uvec4
 400     *
 401     *     There are no implicit array or structure conversions. For example,
 402     *     an array of int cannot be implicitly converted to an array of float.
 403     *     There are no implicit conversions between signed and unsigned
 404     *     integers.
 405     * \endverbatim
 406     */
 407    bool can_implicitly_convert_to(const glsl_type *desired,
 408                                   _mesa_glsl_parse_state *state) const;
 409
 410    /**
 411     * Query whether or not a type is a scalar (non-vector and non-matrix).
 412     */
 413    bool is_scalar() const
 414    {
 415       return (vector_elements == 1)
 416          && (base_type >= GLSL_TYPE_UINT)
 417          && (base_type <= GLSL_TYPE_BOOL);
 418    }
 419
 420    /**
 421     * Query whether or not a type is a vector
 422     */
 423    bool is_vector() const
 424    {
 425       return (vector_elements > 1)
 426          && (matrix_columns == 1)
 427          && (base_type >= GLSL_TYPE_UINT)
 428          && (base_type <= GLSL_TYPE_BOOL);
 429    }
 430
 431    /**
 432     * Query whether or not a type is a matrix
 433     */
 434    bool is_matrix() const
 435    {
 436       /* GLSL only has float matrices. */
 437       return (matrix_columns > 1) && (base_type == GLSL_TYPE_FLOAT || base_type == GLSL_TYPE_DOUBLE);
 438    }
 439
 440    /**
 441     * Query whether or not a type is a non-array numeric type
 442     */
 443    bool is_numeric() const
 444    {
 445       return (base_type >= GLSL_TYPE_UINT) && (base_type <= GLSL_TYPE_DOUBLE);
 446    }
 447
 448    /**
 449     * Query whether or not a type is an integral type
 450     */
 451    bool is_integer() const
 452    {
 453       return (base_type == GLSL_TYPE_UINT) || (base_type == GLSL_TYPE_INT);
 454    }
 455
 456    /**
 457     * Query whether or not type is an integral type, or for struct and array
 458     * types, contains an integral type.
 459     */
 460    bool contains_integer() const;
 461
 462    /**
 463     * Query whether or not type is a double type, or for struct and array
 464     * types, contains a double type.
 465     */
 466    bool contains_double() const;
 467
 468    /**
 469     * Query whether or not a type is a float type
 470     */
 471    bool is_float() const
 472    {
 473       return base_type == GLSL_TYPE_FLOAT;
 474    }
 475
 476    /**
 477     * Query whether or not a type is a double type
 478     */
 479    bool is_double() const
 480    {
 481       return base_type == GLSL_TYPE_DOUBLE;
 482    }
 483
 484    /**
 485     * Query whether a double takes two slots.
 486     */
 487    bool is_dual_slot_double() const
 488    {
 489       return base_type == GLSL_TYPE_DOUBLE && vector_elements > 2;
 490    }
 491
 492    /**
 493     * Query whether or not a type is a non-array boolean type
 494     */
 495    bool is_boolean() const
 496    {
 497       return base_type == GLSL_TYPE_BOOL;
 498    }
 499
 500    /**
 501     * Query whether or not a type is a sampler
 502     */
 503    bool is_sampler() const
 504    {
 505       return base_type == GLSL_TYPE_SAMPLER;
 506    }
 507
 508    /**
 509     * Query whether or not type is a sampler, or for struct and array
 510     * types, contains a sampler.
 511     */
 512    bool contains_sampler() const;
 513
 514    /**
 515     * Get the Mesa texture target index for a sampler type.
 516     */
 517    gl_texture_index sampler_index() const;
 518
 519    /**
 520     * Query whether or not type is an image, or for struct and array
 521     * types, contains an image.
 522     */
 523    bool contains_image() const;
 524
 525    /**
 526     * Query whether or not a type is an image
 527     */
 528    bool is_image() const
 529    {
 530       return base_type == GLSL_TYPE_IMAGE;
 531    }
 532
 533    /**
 534     * Query whether or not a type is an array
 535     */
 536    bool is_array() const
 537    {
 538       return base_type == GLSL_TYPE_ARRAY;
 539    }
 540
 541    bool is_array_of_arrays() const
 542    {
 543       return is_array() && fields.array->is_array();
 544    }
 545
 546    /**
 547     * Query whether or not a type is a record
 548     */
 549    bool is_record() const
 550    {
 551       return base_type == GLSL_TYPE_STRUCT;
 552    }
 553
 554    /**
 555     * Query whether or not a type is an interface
 556     */
 557    bool is_interface() const
 558    {
 559       return base_type == GLSL_TYPE_INTERFACE;
 560    }
 561
 562    /**
 563     * Query whether or not a type is the void type singleton.
 564     */
 565    bool is_void() const
 566    {
 567       return base_type == GLSL_TYPE_VOID;
 568    }
 569
 570    /**
 571     * Query whether or not a type is the error type singleton.
 572     */
 573    bool is_error() const
 574    {
 575       return base_type == GLSL_TYPE_ERROR;
 576    }
 577
 578    /**
 579     * Query if a type is unnamed/anonymous (named by the parser)
 580     */
 581
 582    bool is_subroutine() const
 583    {
 584       return base_type == GLSL_TYPE_SUBROUTINE;
 585    }
 586    bool contains_subroutine() const;
 587
 588    bool is_anonymous() const
 589    {
 590       return !strncmp(name, "#anon", 5);
 591    }
 592
 593    /**
 594     * Get the type stripped of any arrays
 595     *
 596     * \return
 597     * Pointer to the type of elements of the first non-array type for array
 598     * types, or pointer to itself for non-array types.
 599     */
 600    const glsl_type *without_array() const
 601    {
 602       const glsl_type *t = this;
 603
 604       while (t->is_array())
 605          t = t->fields.array;
 606
 607       return t;
 608    }
 609
 610    /**
 611     * Return the total number of elements in an array including the elements
 612     * in arrays of arrays.
 613     */
 614    unsigned arrays_of_arrays_size() const
 615    {
 616       if (!is_array())
 617          return 0;
 618
 619       unsigned size = length;
 620       const glsl_type *base_type = fields.array;
 621
 622       while (base_type->is_array()) {
 623          size = size * base_type->length;
 624          base_type = base_type->fields.array;
 625       }
 626       return size;
 627    }
 628
 629    /**
 630     * Return the amount of atomic counter storage required for a type.
 631     */
 632    unsigned atomic_size() const
 633    {
 634       if (base_type == GLSL_TYPE_ATOMIC_UINT)
 635          return ATOMIC_COUNTER_SIZE;
 636       else if (is_array())
 637          return length * fields.array->atomic_size();
 638       else
 639          return 0;
 640    }
 641
 642    /**
 643     * Return whether a type contains any atomic counters.
 644     */
 645    bool contains_atomic() const
 646    {
 647       return atomic_size() > 0;
 648    }
 649
 650    /**
 651     * Return whether a type contains any opaque types.
 652     */
 653    bool contains_opaque() const;
 654
 655    /**
 656     * Query the full type of a matrix row
 657     *
 658     * \return
 659     * If the type is not a matrix, \c glsl_type::error_type is returned.
 660     * Otherwise a type matching the rows of the matrix is returned.
 661     */
 662    const glsl_type *row_type() const
 663    {
 664       return is_matrix()
 665          ? get_instance(base_type, matrix_columns, 1)
 666          : error_type;
 667    }
 668
 669    /**
 670     * Query the full type of a matrix column
 671     *
 672     * \return
 673     * If the type is not a matrix, \c glsl_type::error_type is returned.
 674     * Otherwise a type matching the columns of the matrix is returned.
 675     */
 676    const glsl_type *column_type() const
 677    {
 678       return is_matrix()
 679          ? get_instance(base_type, vector_elements, 1)
 680          : error_type;
 681    }
 682
 683    /**
 684     * Get the type of a structure field
 685     *
 686     * \return
 687     * Pointer to the type of the named field.  If the type is not a structure
 688     * or the named field does not exist, \c glsl_type::error_type is returned.
 689     */
 690    const glsl_type *field_type(const char *name) const;
 691
 692    /**
 693     * Get the location of a field within a record type
 694     */
 695    int field_index(const char *name) const;
 696
 697    /**
 698     * Query the number of elements in an array type
 699     *
 700     * \return
 701     * The number of elements in the array for array types or -1 for non-array
 702     * types.  If the number of elements in the array has not yet been declared,
 703     * zero is returned.
 704     */
 705    int array_size() const
 706    {
 707       return is_array() ? length : -1;
 708    }
 709
 710    /**
 711     * Query whether the array size for all dimensions has been declared.
 712     */
 713    bool is_unsized_array() const
 714    {
 715       return is_array() && length == 0;
 716    }
 717
 718    /**
 719     * Return the number of coordinate components needed for this
 720     * sampler or image type.
 721     *
 722     * This is based purely on the sampler's dimensionality.  For example, this
 723     * returns 1 for sampler1D, and 3 for sampler2DArray.
 724     *
 725     * Note that this is often different than actual coordinate type used in
 726     * a texturing built-in function, since those pack additional values (such
 727     * as the shadow comparitor or projector) into the coordinate type.
 728     */
 729    int coordinate_components() const;
 730
 731    /**
 732     * Compare a record type against another record type.
 733     *
 734     * This is useful for matching record types declared across shader stages.
 735     */
 736    bool record_compare(const glsl_type *b) const;
 737
 738 private:
 739
 740    static mtx_t mutex;
 741
 742    /**
 743     * ralloc context for all glsl_type allocations
 744     *
 745     * Set on the first call to \c glsl_type::new.
 746     */
 747    static void *mem_ctx;
 748
 749    void init_ralloc_type_ctx(void);
 750
 751    /** Constructor for vector and matrix types */
 752    glsl_type(GLenum gl_type,
 753              glsl_base_type base_type, unsigned vector_elements,
 754              unsigned matrix_columns, const char *name);
 755
 756    /** Constructor for sampler or image types */
 757    glsl_type(GLenum gl_type, glsl_base_type base_type,
 758              enum glsl_sampler_dim dim, bool shadow, bool array,
 759              unsigned type, const char *name);
 760
 761    /** Constructor for record types */
 762    glsl_type(const glsl_struct_field *fields, unsigned num_fields,
 763              const char *name);
 764
 765    /** Constructor for interface types */
 766    glsl_type(const glsl_struct_field *fields, unsigned num_fields,
 767              enum glsl_interface_packing packing, const char *name);
 768
 769    /** Constructor for interface types */
 770    glsl_type(const glsl_type *return_type,
 771              const glsl_function_param *params, unsigned num_params);
 772
 773    /** Constructor for array types */
 774    glsl_type(const glsl_type *array, unsigned length);
 775
 776    /** Constructor for subroutine types */
 777    glsl_type(const char *name);
 778
 779    /** Hash table containing the known array types. */
 780    static struct hash_table *array_types;
 781
 782    /** Hash table containing the known record types. */
 783    static struct hash_table *record_types;
 784
 785    /** Hash table containing the known interface types. */
 786    static struct hash_table *interface_types;
 787
 788    /** Hash table containing the known subroutine types. */
 789    static struct hash_table *subroutine_types;
 790
 791    /** Hash table containing the known function types. */
 792    static struct hash_table *function_types;
 793
 794    static bool record_key_compare(const void *a, const void *b);
 795    static unsigned record_key_hash(const void *key);
 796
 797    /**
 798     * \name Built-in type flyweights
 799     */
 800    /*@{*/
 801 #undef  DECL_TYPE
 802 #define DECL_TYPE(NAME, ...) static const glsl_type _##NAME##_type;
 803 #undef  STRUCT_TYPE
 804 #define STRUCT_TYPE(NAME)        static const glsl_type _struct_##NAME##_type;
 805 #include "compiler/builtin_type_macros.h"
 806    /*@}*/
 807
 808    /**
 809     * \name Friend functions.
 810     *
 811     * These functions are friends because they must have C linkage and the
 812     * need to call various private methods or access various private static
 813     * data.
 814     */
 815    /*@{*/
 816    friend void _mesa_glsl_initialize_types(struct _mesa_glsl_parse_state *);
 817    friend void _mesa_glsl_release_types(void);
 818    /*@}*/
 819 };
 820
 821 struct glsl_struct_field {
 822    const struct glsl_type *type;
 823    const char *name;
 824
 825    /**
 826     * For interface blocks, gl_varying_slot corresponding to the input/output
 827     * if this is a built-in input/output (i.e. a member of the built-in
 828     * gl_PerVertex interface block); -1 otherwise.
 829     *
 830     * Ignored for structs.
 831     */
 832    int location;
 833
 834    /**
 835     * For interface blocks, the interpolation mode (as in
 836     * ir_variable::interpolation).  0 otherwise.
 837     */
 838    unsigned interpolation:2;
 839
 840    /**
 841     * For interface blocks, 1 if this variable uses centroid interpolation (as
 842     * in ir_variable::centroid).  0 otherwise.
 843     */
 844    unsigned centroid:1;
 845
 846    /**
 847     * For interface blocks, 1 if this variable uses sample interpolation (as
 848     * in ir_variable::sample). 0 otherwise.
 849     */
 850    unsigned sample:1;
 851
 852    /**
 853     * Layout of the matrix.  Uses glsl_matrix_layout values.
 854     */
 855    unsigned matrix_layout:2;
 856
 857    /**
 858     * For interface blocks, 1 if this variable is a per-patch input or output
 859     * (as in ir_variable::patch). 0 otherwise.
 860     */
 861    unsigned patch:1;
 862
 863    /**
 864     * Precision qualifier
 865     */
 866    unsigned precision:2;
 867
 868    /**
 869     * Image qualifiers, applicable to buffer variables defined in shader
 870     * storage buffer objects (SSBOs)
 871     */
 872    unsigned image_read_only:1;
 873    unsigned image_write_only:1;
 874    unsigned image_coherent:1;
 875    unsigned image_volatile:1;
 876    unsigned image_restrict:1;
 877
 878    glsl_struct_field(const struct glsl_type *_type, const char *_name)
 879       : type(_type), name(_name), location(-1), interpolation(0), centroid(0),
 880         sample(0), matrix_layout(GLSL_MATRIX_LAYOUT_INHERITED), patch(0),
 881         precision(GLSL_PRECISION_NONE), image_read_only(0), image_write_only(0),
 882         image_coherent(0), image_volatile(0), image_restrict(0)
 883    {
 884       /* empty */
 885    }
 886
 887    glsl_struct_field()
 888    {
 889       /* empty */
 890    }
 891 };
 892
 893 struct glsl_function_param {
 894    const struct glsl_type *type;
 895
 896    bool in;
 897    bool out;
 898 };
 899
 900 static inline unsigned int
 901 glsl_align(unsigned int a, unsigned int align)
 902 {
 903    return (a + align - 1) / align * align;
 904 }
 905
 906 #undef DECL_TYPE
 907 #undef STRUCT_TYPE
 908 #endif /* __cplusplus */
 909
 910 #endif /* GLSL_TYPES_H */