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 #ifndef GLSL_TYPES_H
  26 #define GLSL_TYPES_H
  27
  28 #include <string.h>
  29 #include <assert.h>
  30
  31 #include "shader_enums.h"
  32 #include "blob.h"
  33 #include "c11/threads.h"
  34 #include "util/macros.h"
  35
  36 #ifdef __cplusplus
  37 #include "main/config.h"
  38 #endif
  39
  40 struct glsl_type;
  41
  42 #ifdef __cplusplus
  43 extern "C" {
  44 #endif
  45
  46 struct _mesa_glsl_parse_state;
  47 struct glsl_symbol_table;
  48
  49 extern void
  50 glsl_type_singleton_init_or_ref();
  51
  52 extern void
  53 glsl_type_singleton_decref();
  54
  55 extern void
  56 _mesa_glsl_initialize_types(struct _mesa_glsl_parse_state *state);
  57
  58 void encode_type_to_blob(struct blob *blob, const struct glsl_type *type);
  59
  60 const struct glsl_type *decode_type_from_blob(struct blob_reader *blob);
  61
  62 #ifdef __cplusplus
  63 }
  64 #endif
  65
  66 enum glsl_base_type {
  67    /* Note: GLSL_TYPE_UINT, GLSL_TYPE_INT, and GLSL_TYPE_FLOAT must be 0, 1,
  68     * and 2 so that they will fit in the 2 bits of glsl_type::sampled_type.
  69     */
  70    GLSL_TYPE_UINT = 0,
  71    GLSL_TYPE_INT,
  72    GLSL_TYPE_FLOAT,
  73    GLSL_TYPE_FLOAT16,
  74    GLSL_TYPE_DOUBLE,
  75    GLSL_TYPE_UINT8,
  76    GLSL_TYPE_INT8,
  77    GLSL_TYPE_UINT16,
  78    GLSL_TYPE_INT16,
  79    GLSL_TYPE_UINT64,
  80    GLSL_TYPE_INT64,
  81    GLSL_TYPE_BOOL,
  82    GLSL_TYPE_SAMPLER,
  83    GLSL_TYPE_IMAGE,
  84    GLSL_TYPE_ATOMIC_UINT,
  85    GLSL_TYPE_STRUCT,
  86    GLSL_TYPE_INTERFACE,
  87    GLSL_TYPE_ARRAY,
  88    GLSL_TYPE_VOID,
  89    GLSL_TYPE_SUBROUTINE,
  90    GLSL_TYPE_FUNCTION,
  91    GLSL_TYPE_ERROR
  92 };
  93
  94 static inline bool glsl_base_type_is_16bit(enum glsl_base_type type)
  95 {
  96    return type == GLSL_TYPE_FLOAT16 ||
  97           type == GLSL_TYPE_UINT16 ||
  98           type == GLSL_TYPE_INT16;
  99 }
 100
 101 static inline bool glsl_base_type_is_64bit(enum glsl_base_type type)
 102 {
 103    return type == GLSL_TYPE_DOUBLE ||
 104           type == GLSL_TYPE_UINT64 ||
 105           type == GLSL_TYPE_INT64  ||
 106           type == GLSL_TYPE_IMAGE  ||
 107           type == GLSL_TYPE_SAMPLER;
 108 }
 109
 110 static inline bool glsl_base_type_is_integer(enum glsl_base_type type)
 111 {
 112    return type == GLSL_TYPE_UINT8 ||
 113           type == GLSL_TYPE_INT8 ||
 114           type == GLSL_TYPE_UINT16 ||
 115           type == GLSL_TYPE_INT16 ||
 116           type == GLSL_TYPE_UINT ||
 117           type == GLSL_TYPE_INT ||
 118           type == GLSL_TYPE_UINT64 ||
 119           type == GLSL_TYPE_INT64 ||
 120           type == GLSL_TYPE_BOOL ||
 121           type == GLSL_TYPE_SAMPLER ||
 122           type == GLSL_TYPE_IMAGE;
 123 }
 124
 125 static inline unsigned int
 126 glsl_base_type_get_bit_size(const enum glsl_base_type base_type)
 127 {
 128    switch (base_type) {
 129    case GLSL_TYPE_BOOL:
 130       return 1;
 131
 132    case GLSL_TYPE_INT:
 133    case GLSL_TYPE_UINT:
 134    case GLSL_TYPE_FLOAT: /* TODO handle mediump */
 135    case GLSL_TYPE_SUBROUTINE:
 136       return 32;
 137
 138    case GLSL_TYPE_FLOAT16:
 139    case GLSL_TYPE_UINT16:
 140    case GLSL_TYPE_INT16:
 141       return 16;
 142
 143    case GLSL_TYPE_UINT8:
 144    case GLSL_TYPE_INT8:
 145       return 8;
 146
 147    case GLSL_TYPE_DOUBLE:
 148    case GLSL_TYPE_INT64:
 149    case GLSL_TYPE_UINT64:
 150    case GLSL_TYPE_IMAGE:
 151    case GLSL_TYPE_SAMPLER:
 152       return 64;
 153
 154    default:
 155       unreachable("unknown base type");
 156    }
 157
 158    return 0;
 159 }
 160
 161 enum glsl_sampler_dim {
 162    GLSL_SAMPLER_DIM_1D = 0,
 163    GLSL_SAMPLER_DIM_2D,
 164    GLSL_SAMPLER_DIM_3D,
 165    GLSL_SAMPLER_DIM_CUBE,
 166    GLSL_SAMPLER_DIM_RECT,
 167    GLSL_SAMPLER_DIM_BUF,
 168    GLSL_SAMPLER_DIM_EXTERNAL,
 169    GLSL_SAMPLER_DIM_MS,
 170    GLSL_SAMPLER_DIM_SUBPASS, /* for vulkan input attachments */
 171    GLSL_SAMPLER_DIM_SUBPASS_MS, /* for multisampled vulkan input attachments */
 172 };
 173
 174 enum glsl_matrix_layout {
 175    /**
 176     * The layout of the matrix is inherited from the object containing the
 177     * matrix (the top level structure or the uniform block).
 178     */
 179    GLSL_MATRIX_LAYOUT_INHERITED,
 180
 181    /**
 182     * Explicit column-major layout
 183     *
 184     * If a uniform block doesn't have an explicit layout set, it will default
 185     * to this layout.
 186     */
 187    GLSL_MATRIX_LAYOUT_COLUMN_MAJOR,
 188
 189    /**
 190     * Row-major layout
 191     */
 192    GLSL_MATRIX_LAYOUT_ROW_MAJOR
 193 };
 194
 195 enum {
 196    GLSL_PRECISION_NONE = 0,
 197    GLSL_PRECISION_HIGH,
 198    GLSL_PRECISION_MEDIUM,
 199    GLSL_PRECISION_LOW
 200 };
 201
 202 #ifdef __cplusplus
 203 #include "GL/gl.h"
 204 #include "util/ralloc.h"
 205 #include "main/menums.h" /* for gl_texture_index, C++'s enum rules are broken */
 206
 207 struct glsl_type {
 208    GLenum gl_type;
 209    glsl_base_type base_type:8;
 210
 211    glsl_base_type sampled_type:8; /**< Type of data returned using this
 212                                    * sampler or image.  Only \c
 213                                    * GLSL_TYPE_FLOAT, \c GLSL_TYPE_INT,
 214                                    * and \c GLSL_TYPE_UINT are valid.
 215                                    */
 216
 217    unsigned sampler_dimensionality:4; /**< \see glsl_sampler_dim */
 218    unsigned sampler_shadow:1;
 219    unsigned sampler_array:1;
 220    unsigned interface_packing:2;
 221    unsigned interface_row_major:1;
 222
 223    /**
 224     * For \c GLSL_TYPE_STRUCT this specifies if the struct is packed or not.
 225     *
 226     * Only used for Compute kernels
 227     */
 228    unsigned packed:1;
 229
 230 private:
 231    glsl_type() : mem_ctx(NULL)
 232    {
 233       // Dummy constructor, just for the sake of ASSERT_BITFIELD_SIZE.
 234    }
 235
 236 public:
 237    /**
 238     * \name Vector and matrix element counts
 239     *
 240     * For scalars, each of these values will be 1.  For non-numeric types
 241     * these will be 0.
 242     */
 243    /*@{*/
 244    uint8_t vector_elements;    /**< 1, 2, 3, or 4 vector elements. */
 245    uint8_t matrix_columns;     /**< 1, 2, 3, or 4 matrix columns. */
 246    /*@}*/
 247
 248    /**
 249     * For \c GLSL_TYPE_ARRAY, this is the length of the array.  For
 250     * \c GLSL_TYPE_STRUCT or \c GLSL_TYPE_INTERFACE, it is the number of
 251     * elements in the structure and the number of values pointed to by
 252     * \c fields.structure (below).
 253     */
 254    unsigned length;
 255
 256    /**
 257     * Name of the data type
 258     *
 259     * Will never be \c NULL.
 260     */
 261    const char *name;
 262
 263    /**
 264     * Explicit array, matrix, or vector stride.  This is used to communicate
 265     * explicit array layouts from SPIR-V.  Should be 0 if the type has no
 266     * explicit stride.
 267     */
 268    unsigned explicit_stride;
 269
 270    /**
 271     * Subtype of composite data types.
 272     */
 273    union {
 274       const struct glsl_type *array;            /**< Type of array elements. */
 275       struct glsl_function_param *parameters;   /**< Parameters to function. */
 276       struct glsl_struct_field *structure;      /**< List of struct fields. */
 277    } fields;
 278
 279    /**
 280     * \name Pointers to various public type singletons
 281     */
 282    /*@{*/
 283 #undef  DECL_TYPE
 284 #define DECL_TYPE(NAME, ...) \
 285    static const glsl_type *const NAME##_type;
 286 #undef  STRUCT_TYPE
 287 #define STRUCT_TYPE(NAME) \
 288    static const glsl_type *const struct_##NAME##_type;
 289 #include "compiler/builtin_type_macros.h"
 290    /*@}*/
 291
 292    /**
 293     * Convenience accessors for vector types (shorter than get_instance()).
 294     * @{
 295     */
 296    static const glsl_type *vec(unsigned components, const glsl_type *const ts[]);
 297    static const glsl_type *vec(unsigned components);
 298    static const glsl_type *f16vec(unsigned components);
 299    static const glsl_type *dvec(unsigned components);
 300    static const glsl_type *ivec(unsigned components);
 301    static const glsl_type *uvec(unsigned components);
 302    static const glsl_type *bvec(unsigned components);
 303    static const glsl_type *i64vec(unsigned components);
 304    static const glsl_type *u64vec(unsigned components);
 305    static const glsl_type *i16vec(unsigned components);
 306    static const glsl_type *u16vec(unsigned components);
 307    static const glsl_type *i8vec(unsigned components);
 308    static const glsl_type *u8vec(unsigned components);
 309    /**@}*/
 310
 311    /**
 312     * For numeric and boolean derived types returns the basic scalar type
 313     *
 314     * If the type is a numeric or boolean scalar, vector, or matrix type,
 315     * this function gets the scalar type of the individual components.  For
 316     * all other types, including arrays of numeric or boolean types, the
 317     * error type is returned.
 318     */
 319    const glsl_type *get_base_type() const;
 320
 321    /**
 322     * Get the basic scalar type which this type aggregates.
 323     *
 324     * If the type is a numeric or boolean scalar, vector, or matrix, or an
 325     * array of any of those, this function gets the scalar type of the
 326     * individual components.  For structs and arrays of structs, this function
 327     * returns the struct type.  For samplers and arrays of samplers, this
 328     * function returns the sampler type.
 329     */
 330    const glsl_type *get_scalar_type() const;
 331
 332    /**
 333     * Gets the "bare" type without any decorations or layout information.
 334     */
 335    const glsl_type *get_bare_type() const;
 336
 337    /**
 338     * Get the instance of a built-in scalar, vector, or matrix type
 339     */
 340    static const glsl_type *get_instance(unsigned base_type, unsigned rows,
 341                                         unsigned columns,
 342                                         unsigned explicit_stride = 0,
 343                                         bool row_major = false);
 344
 345    /**
 346     * Get the instance of a sampler type
 347     */
 348    static const glsl_type *get_sampler_instance(enum glsl_sampler_dim dim,
 349                                                 bool shadow,
 350                                                 bool array,
 351                                                 glsl_base_type type);
 352
 353    static const glsl_type *get_image_instance(enum glsl_sampler_dim dim,
 354                                               bool array, glsl_base_type type);
 355
 356    /**
 357     * Get the instance of an array type
 358     */
 359    static const glsl_type *get_array_instance(const glsl_type *base,
 360                                               unsigned elements,
 361                                               unsigned explicit_stride = 0);
 362
 363    /**
 364     * Get the instance of a record type
 365     */
 366    static const glsl_type *get_struct_instance(const glsl_struct_field *fields,
 367                                                unsigned num_fields,
 368                                                const char *name,
 369                                                bool packed = false);
 370
 371    /**
 372     * Get the instance of an interface block type
 373     */
 374    static const glsl_type *get_interface_instance(const glsl_struct_field *fields,
 375                                                   unsigned num_fields,
 376                                                   enum glsl_interface_packing packing,
 377                                                   bool row_major,
 378                                                   const char *block_name);
 379
 380    /**
 381     * Get the instance of an subroutine type
 382     */
 383    static const glsl_type *get_subroutine_instance(const char *subroutine_name);
 384
 385    /**
 386     * Get the instance of a function type
 387     */
 388    static const glsl_type *get_function_instance(const struct glsl_type *return_type,
 389                                                  const glsl_function_param *parameters,
 390                                                  unsigned num_params);
 391
 392    /**
 393     * Get the type resulting from a multiplication of \p type_a * \p type_b
 394     */
 395    static const glsl_type *get_mul_type(const glsl_type *type_a,
 396                                         const glsl_type *type_b);
 397
 398    /**
 399     * Query the total number of scalars that make up a scalar, vector or matrix
 400     */
 401    unsigned components() const
 402    {
 403       return vector_elements * matrix_columns;
 404    }
 405
 406    /**
 407     * Calculate the number of components slots required to hold this type
 408     *
 409     * This is used to determine how many uniform or varying locations a type
 410     * might occupy.
 411     */
 412    unsigned component_slots() const;
 413
 414    /**
 415     * Calculate offset between the base location of the struct in
 416     * uniform storage and a struct member.
 417     * For the initial call, length is the index of the member to find the
 418     * offset for.
 419     */
 420    unsigned struct_location_offset(unsigned length) const;
 421
 422    /**
 423     * Calculate the number of unique values from glGetUniformLocation for the
 424     * elements of the type.
 425     *
 426     * This is used to allocate slots in the UniformRemapTable, the amount of
 427     * locations may not match with actual used storage space by the driver.
 428     */
 429    unsigned uniform_locations() const;
 430
 431    /**
 432     * Used to count the number of varyings contained in the type ignoring
 433     * innermost array elements.
 434     */
 435    unsigned varying_count() const;
 436
 437    /**
 438     * Calculate the number of attribute slots required to hold this type
 439     *
 440     * This implements the language rules of GLSL 1.50 for counting the number
 441     * of slots used by a vertex attribute.  It also determines the number of
 442     * varying slots the type will use up in the absence of varying packing
 443     * (and thus, it can be used to measure the number of varying slots used by
 444     * the varyings that are generated by lower_packed_varyings).
 445     *
 446     * For vertex shader attributes - doubles only take one slot.
 447     * For inter-shader varyings - dvec3/dvec4 take two slots.
 448     *
 449     * Vulkan doesn’t make this distinction so the argument should always be
 450     * false.
 451     */
 452    unsigned count_attribute_slots(bool is_gl_vertex_input) const;
 453
 454    /**
 455     * Alignment in bytes of the start of this type in a std140 uniform
 456     * block.
 457     */
 458    unsigned std140_base_alignment(bool row_major) const;
 459
 460    /** Size in bytes of this type in a std140 uniform block.
 461     *
 462     * Note that this is not GL_UNIFORM_SIZE (which is the number of
 463     * elements in the array)
 464     */
 465    unsigned std140_size(bool row_major) const;
 466
 467    /**
 468     * Gets an explicitly laid out type with the std140 layout.
 469     */
 470    const glsl_type *get_explicit_std140_type(bool row_major) const;
 471
 472    /**
 473     * Alignment in bytes of the start of this type in a std430 shader
 474     * storage block.
 475     */
 476    unsigned std430_base_alignment(bool row_major) const;
 477
 478    /**
 479     * Calculate array stride in bytes of this type in a std430 shader storage
 480     * block.
 481     */
 482    unsigned std430_array_stride(bool row_major) const;
 483
 484    /**
 485     * Size in bytes of this type in a std430 shader storage block.
 486     *
 487     * Note that this is not GL_BUFFER_SIZE
 488     */
 489    unsigned std430_size(bool row_major) const;
 490
 491    /**
 492     * Gets an explicitly laid out type with the std430 layout.
 493     */
 494    const glsl_type *get_explicit_std430_type(bool row_major) const;
 495
 496    /**
 497     * Gets an explicitly laid out interface type.
 498     */
 499    const glsl_type *get_explicit_interface_type(bool supports_std430) const;
 500
 501    /**
 502     * Alignment in bytes of the start of this type in OpenCL memory.
 503     */
 504    unsigned cl_alignment() const;
 505
 506    /**
 507     * Size in bytes of this type in OpenCL memory
 508     */
 509    unsigned cl_size() const;
 510
 511    /**
 512     * \brief Can this type be implicitly converted to another?
 513     *
 514     * \return True if the types are identical or if this type can be converted
 515     *         to \c desired according to Section 4.1.10 of the GLSL spec.
 516     *
 517     * \verbatim
 518     * From page 25 (31 of the pdf) of the GLSL 1.50 spec, Section 4.1.10
 519     * Implicit Conversions:
 520     *
 521     *     In some situations, an expression and its type will be implicitly
 522     *     converted to a different type. The following table shows all allowed
 523     *     implicit conversions:
 524     *
 525     *     Type of expression | Can be implicitly converted to
 526     *     --------------------------------------------------
 527     *     int                  float
 528     *     uint
 529     *
 530     *     ivec2                vec2
 531     *     uvec2
 532     *
 533     *     ivec3                vec3
 534     *     uvec3
 535     *
 536     *     ivec4                vec4
 537     *     uvec4
 538     *
 539     *     There are no implicit array or structure conversions. For example,
 540     *     an array of int cannot be implicitly converted to an array of float.
 541     *     There are no implicit conversions between signed and unsigned
 542     *     integers.
 543     * \endverbatim
 544     */
 545    bool can_implicitly_convert_to(const glsl_type *desired,
 546                                   _mesa_glsl_parse_state *state) const;
 547
 548    /**
 549     * Query whether or not a type is a scalar (non-vector and non-matrix).
 550     */
 551    bool is_scalar() const
 552    {
 553       return (vector_elements == 1)
 554          && (base_type >= GLSL_TYPE_UINT)
 555          && (base_type <= GLSL_TYPE_IMAGE);
 556    }
 557
 558    /**
 559     * Query whether or not a type is a vector
 560     */
 561    bool is_vector() const
 562    {
 563       return (vector_elements > 1)
 564          && (matrix_columns == 1)
 565          && (base_type >= GLSL_TYPE_UINT)
 566          && (base_type <= GLSL_TYPE_BOOL);
 567    }
 568
 569    /**
 570     * Query whether or not a type is a matrix
 571     */
 572    bool is_matrix() const
 573    {
 574       /* GLSL only has float matrices. */
 575       return (matrix_columns > 1) && (base_type == GLSL_TYPE_FLOAT ||
 576                                       base_type == GLSL_TYPE_DOUBLE ||
 577                                       base_type == GLSL_TYPE_FLOAT16);
 578    }
 579
 580    /**
 581     * Query whether or not a type is a non-array numeric type
 582     */
 583    bool is_numeric() const
 584    {
 585       return (base_type >= GLSL_TYPE_UINT) && (base_type <= GLSL_TYPE_INT64);
 586    }
 587
 588    /**
 589     * Query whether or not a type is an integral type
 590     */
 591    bool is_integer() const
 592    {
 593       return (base_type == GLSL_TYPE_UINT) || (base_type == GLSL_TYPE_INT);
 594    }
 595
 596    /**
 597     * Query whether or not a type is a 64-bit integer.
 598     */
 599    bool is_integer_64() const
 600    {
 601       return base_type == GLSL_TYPE_UINT64 || base_type == GLSL_TYPE_INT64;
 602    }
 603
 604    /**
 605     * Query whether or not a type is a 32-bit or 64-bit integer
 606     */
 607    bool is_integer_32_64() const
 608    {
 609       return is_integer() || is_integer_64();
 610    }
 611
 612    /**
 613     * Query whether or not type is an integral type, or for struct and array
 614     * types, contains an integral type.
 615     */
 616    bool contains_integer() const;
 617
 618    /**
 619     * Query whether or not type is a double type, or for struct, interface and
 620     * array types, contains a double type.
 621     */
 622    bool contains_double() const;
 623
 624    /**
 625     * Query whether or not type is a 64-bit type, or for struct, interface and
 626     * array types, contains a double type.
 627     */
 628    bool contains_64bit() const;
 629
 630    /**
 631     * Query whether or not a type is a float type
 632     */
 633    bool is_float() const
 634    {
 635       return base_type == GLSL_TYPE_FLOAT;
 636    }
 637
 638    /**
 639     * Query whether or not a type is a double type
 640     */
 641    bool is_double() const
 642    {
 643       return base_type == GLSL_TYPE_DOUBLE;
 644    }
 645
 646    /**
 647     * Query whether a 64-bit type takes two slots.
 648     */
 649    bool is_dual_slot() const
 650    {
 651       return is_64bit() && vector_elements > 2;
 652    }
 653
 654    /**
 655     * Query whether or not a type is 64-bit
 656     */
 657    bool is_64bit() const
 658    {
 659       return glsl_base_type_is_64bit(base_type);
 660    }
 661
 662    /**
 663     * Query whether or not a type is 16-bit
 664     */
 665    bool is_16bit() const
 666    {
 667       return glsl_base_type_is_16bit(base_type);
 668    }
 669
 670    /**
 671     * Query whether or not a type is 32-bit
 672     */
 673    bool is_32bit() const
 674    {
 675       return base_type == GLSL_TYPE_UINT ||
 676              base_type == GLSL_TYPE_INT ||
 677              base_type == GLSL_TYPE_FLOAT;
 678    }
 679
 680    /**
 681     * Query whether or not a type is a non-array boolean type
 682     */
 683    bool is_boolean() const
 684    {
 685       return base_type == GLSL_TYPE_BOOL;
 686    }
 687
 688    /**
 689     * Query whether or not a type is a sampler
 690     */
 691    bool is_sampler() const
 692    {
 693       return base_type == GLSL_TYPE_SAMPLER;
 694    }
 695
 696    /**
 697     * Query whether or not type is a sampler, or for struct, interface and
 698     * array types, contains a sampler.
 699     */
 700    bool contains_sampler() const;
 701
 702    /**
 703     * Query whether or not type is an array or for struct, interface and
 704     * array types, contains an array.
 705     */
 706    bool contains_array() const;
 707
 708    /**
 709     * Get the Mesa texture target index for a sampler type.
 710     */
 711    gl_texture_index sampler_index() const;
 712
 713    /**
 714     * Query whether or not type is an image, or for struct, interface and
 715     * array types, contains an image.
 716     */
 717    bool contains_image() const;
 718
 719    /**
 720     * Query whether or not a type is an image
 721     */
 722    bool is_image() const
 723    {
 724       return base_type == GLSL_TYPE_IMAGE;
 725    }
 726
 727    /**
 728     * Query whether or not a type is an array
 729     */
 730    bool is_array() const
 731    {
 732       return base_type == GLSL_TYPE_ARRAY;
 733    }
 734
 735    bool is_array_of_arrays() const
 736    {
 737       return is_array() && fields.array->is_array();
 738    }
 739
 740    /**
 741     * Query whether or not a type is a record
 742     */
 743    bool is_struct() const
 744    {
 745       return base_type == GLSL_TYPE_STRUCT;
 746    }
 747
 748    /**
 749     * Query whether or not a type is an interface
 750     */
 751    bool is_interface() const
 752    {
 753       return base_type == GLSL_TYPE_INTERFACE;
 754    }
 755
 756    /**
 757     * Query whether or not a type is the void type singleton.
 758     */
 759    bool is_void() const
 760    {
 761       return base_type == GLSL_TYPE_VOID;
 762    }
 763
 764    /**
 765     * Query whether or not a type is the error type singleton.
 766     */
 767    bool is_error() const
 768    {
 769       return base_type == GLSL_TYPE_ERROR;
 770    }
 771
 772    /**
 773     * Query if a type is unnamed/anonymous (named by the parser)
 774     */
 775
 776    bool is_subroutine() const
 777    {
 778       return base_type == GLSL_TYPE_SUBROUTINE;
 779    }
 780    bool contains_subroutine() const;
 781
 782    bool is_anonymous() const
 783    {
 784       return !strncmp(name, "#anon", 5);
 785    }
 786
 787    /**
 788     * Get the type stripped of any arrays
 789     *
 790     * \return
 791     * Pointer to the type of elements of the first non-array type for array
 792     * types, or pointer to itself for non-array types.
 793     */
 794    const glsl_type *without_array() const
 795    {
 796       const glsl_type *t = this;
 797
 798       while (t->is_array())
 799          t = t->fields.array;
 800
 801       return t;
 802    }
 803
 804    /**
 805     * Return the total number of elements in an array including the elements
 806     * in arrays of arrays.
 807     */
 808    unsigned arrays_of_arrays_size() const
 809    {
 810       if (!is_array())
 811          return 0;
 812
 813       unsigned size = length;
 814       const glsl_type *base_type = fields.array;
 815
 816       while (base_type->is_array()) {
 817          size = size * base_type->length;
 818          base_type = base_type->fields.array;
 819       }
 820       return size;
 821    }
 822
 823    /**
 824     * Query whether or not a type is an atomic_uint.
 825     */
 826    bool is_atomic_uint() const
 827    {
 828       return base_type == GLSL_TYPE_ATOMIC_UINT;
 829    }
 830
 831    /**
 832     * Return the amount of atomic counter storage required for a type.
 833     */
 834    unsigned atomic_size() const
 835    {
 836       if (is_atomic_uint())
 837          return ATOMIC_COUNTER_SIZE;
 838       else if (is_array())
 839          return length * fields.array->atomic_size();
 840       else
 841          return 0;
 842    }
 843
 844    /**
 845     * Return whether a type contains any atomic counters.
 846     */
 847    bool contains_atomic() const
 848    {
 849       return atomic_size() > 0;
 850    }
 851
 852    /**
 853     * Return whether a type contains any opaque types.
 854     */
 855    bool contains_opaque() const;
 856
 857    /**
 858     * Query the full type of a matrix row
 859     *
 860     * \return
 861     * If the type is not a matrix, \c glsl_type::error_type is returned.
 862     * Otherwise a type matching the rows of the matrix is returned.
 863     */
 864    const glsl_type *row_type() const
 865    {
 866       if (!is_matrix())
 867          return error_type;
 868
 869       if (explicit_stride && !interface_row_major)
 870          return get_instance(base_type, matrix_columns, 1, explicit_stride);
 871       else
 872          return get_instance(base_type, matrix_columns, 1);
 873    }
 874
 875    /**
 876     * Query the full type of a matrix column
 877     *
 878     * \return
 879     * If the type is not a matrix, \c glsl_type::error_type is returned.
 880     * Otherwise a type matching the columns of the matrix is returned.
 881     */
 882    const glsl_type *column_type() const
 883    {
 884       if (!is_matrix())
 885          return error_type;
 886
 887       if (explicit_stride && interface_row_major)
 888          return get_instance(base_type, vector_elements, 1, explicit_stride);
 889       else
 890          return get_instance(base_type, vector_elements, 1);
 891    }
 892
 893    /**
 894     * Get the type of a structure field
 895     *
 896     * \return
 897     * Pointer to the type of the named field.  If the type is not a structure
 898     * or the named field does not exist, \c glsl_type::error_type is returned.
 899     */
 900    const glsl_type *field_type(const char *name) const;
 901
 902    /**
 903     * Get the location of a field within a record type
 904     */
 905    int field_index(const char *name) const;
 906
 907    /**
 908     * Query the number of elements in an array type
 909     *
 910     * \return
 911     * The number of elements in the array for array types or -1 for non-array
 912     * types.  If the number of elements in the array has not yet been declared,
 913     * zero is returned.
 914     */
 915    int array_size() const
 916    {
 917       return is_array() ? length : -1;
 918    }
 919
 920    /**
 921     * Query whether the array size for all dimensions has been declared.
 922     */
 923    bool is_unsized_array() const
 924    {
 925       return is_array() && length == 0;
 926    }
 927
 928    /**
 929     * Return the number of coordinate components needed for this
 930     * sampler or image type.
 931     *
 932     * This is based purely on the sampler's dimensionality.  For example, this
 933     * returns 1 for sampler1D, and 3 for sampler2DArray.
 934     *
 935     * Note that this is often different than actual coordinate type used in
 936     * a texturing built-in function, since those pack additional values (such
 937     * as the shadow comparator or projector) into the coordinate type.
 938     */
 939    int coordinate_components() const;
 940
 941    /**
 942     * Compare a record type against another record type.
 943     *
 944     * This is useful for matching record types declared on the same shader
 945     * stage as well as across different shader stages.
 946     * The option to not match name is needed for matching record types
 947     * declared across different shader stages.
 948     * The option to not match locations is to deal with places where the
 949     * same struct is defined in a block which has a location set on it.
 950     */
 951    bool record_compare(const glsl_type *b, bool match_name,
 952                        bool match_locations = true) const;
 953
 954    /**
 955     * Get the type interface packing.
 956     */
 957    enum glsl_interface_packing get_interface_packing() const
 958    {
 959       return (enum glsl_interface_packing)interface_packing;
 960    }
 961
 962    /**
 963     * Get the type interface packing used internally. For shared and packing
 964     * layouts this is implementation defined.
 965     */
 966    enum glsl_interface_packing get_internal_ifc_packing(bool std430_supported) const
 967    {
 968       enum glsl_interface_packing packing = this->get_interface_packing();
 969       if (packing == GLSL_INTERFACE_PACKING_STD140 ||
 970           (!std430_supported &&
 971            (packing == GLSL_INTERFACE_PACKING_SHARED ||
 972             packing == GLSL_INTERFACE_PACKING_PACKED))) {
 973          return GLSL_INTERFACE_PACKING_STD140;
 974       } else {
 975          assert(packing == GLSL_INTERFACE_PACKING_STD430 ||
 976                 (std430_supported &&
 977                  (packing == GLSL_INTERFACE_PACKING_SHARED ||
 978                   packing == GLSL_INTERFACE_PACKING_PACKED)));
 979          return GLSL_INTERFACE_PACKING_STD430;
 980       }
 981    }
 982
 983    /**
 984     * Check if the type interface is row major
 985     */
 986    bool get_interface_row_major() const
 987    {
 988       return (bool) interface_row_major;
 989    }
 990
 991    ~glsl_type();
 992
 993 private:
 994
 995    static mtx_t hash_mutex;
 996
 997    /**
 998     * ralloc context for the type itself.
 999     */
1000    void *mem_ctx;
1001
1002    /** Constructor for vector and matrix types */
1003    glsl_type(GLenum gl_type,
1004              glsl_base_type base_type, unsigned vector_elements,
1005              unsigned matrix_columns, const char *name,
1006              unsigned explicit_stride = 0, bool row_major = false);
1007
1008    /** Constructor for sampler or image types */
1009    glsl_type(GLenum gl_type, glsl_base_type base_type,
1010              enum glsl_sampler_dim dim, bool shadow, bool array,
1011              glsl_base_type type, const char *name);
1012
1013    /** Constructor for record types */
1014    glsl_type(const glsl_struct_field *fields, unsigned num_fields,
1015              const char *name, bool packed = false);
1016
1017    /** Constructor for interface types */
1018    glsl_type(const glsl_struct_field *fields, unsigned num_fields,
1019              enum glsl_interface_packing packing,
1020              bool row_major, const char *name);
1021
1022    /** Constructor for interface types */
1023    glsl_type(const glsl_type *return_type,
1024              const glsl_function_param *params, unsigned num_params);
1025
1026    /** Constructors for array types */
1027    glsl_type(const glsl_type *array, unsigned length, unsigned explicit_stride);
1028
1029    /** Constructor for subroutine types */
1030    glsl_type(const char *name);
1031
1032    /** Hash table containing the known explicit matrix and vector types. */
1033    static struct hash_table *explicit_matrix_types;
1034
1035    /** Hash table containing the known array types. */
1036    static struct hash_table *array_types;
1037
1038    /** Hash table containing the known struct types. */
1039    static struct hash_table *struct_types;
1040
1041    /** Hash table containing the known interface types. */
1042    static struct hash_table *interface_types;
1043
1044    /** Hash table containing the known subroutine types. */
1045    static struct hash_table *subroutine_types;
1046
1047    /** Hash table containing the known function types. */
1048    static struct hash_table *function_types;
1049
1050    static bool record_key_compare(const void *a, const void *b);
1051    static unsigned record_key_hash(const void *key);
1052
1053    /**
1054     * \name Built-in type flyweights
1055     */
1056    /*@{*/
1057 #undef  DECL_TYPE
1058 #define DECL_TYPE(NAME, ...) static const glsl_type _##NAME##_type;
1059 #undef  STRUCT_TYPE
1060 #define STRUCT_TYPE(NAME)        static const glsl_type _struct_##NAME##_type;
1061 #include "compiler/builtin_type_macros.h"
1062    /*@}*/
1063
1064    /**
1065     * \name Friend functions.
1066     *
1067     * These functions are friends because they must have C linkage and the
1068     * need to call various private methods or access various private static
1069     * data.
1070     */
1071    /*@{*/
1072    friend void glsl_type_singleton_init_or_ref(void);
1073    friend void glsl_type_singleton_decref(void);
1074    friend void _mesa_glsl_initialize_types(struct _mesa_glsl_parse_state *);
1075    /*@}*/
1076 };
1077
1078 #undef DECL_TYPE
1079 #undef STRUCT_TYPE
1080 #endif /* __cplusplus */
1081
1082 struct glsl_struct_field {
1083    const struct glsl_type *type;
1084    const char *name;
1085
1086    /**
1087     * For interface blocks, gl_varying_slot corresponding to the input/output
1088     * if this is a built-in input/output (i.e. a member of the built-in
1089     * gl_PerVertex interface block); -1 otherwise.
1090     *
1091     * Ignored for structs.
1092     */
1093    int location;
1094
1095    /**
1096     * For interface blocks, members may have an explicit byte offset
1097     * specified; -1 otherwise. Also used for xfb_offset layout qualifier.
1098     *
1099     * Unless used for xfb_offset this field is ignored for structs.
1100     */
1101    int offset;
1102
1103    /**
1104     * For interface blocks, members may define a transform feedback buffer;
1105     * -1 otherwise.
1106     */
1107    int xfb_buffer;
1108
1109    /**
1110     * For interface blocks, members may define a transform feedback stride;
1111     * -1 otherwise.
1112     */
1113    int xfb_stride;
1114
1115    /**
1116     * For interface blocks, the interpolation mode (as in
1117     * ir_variable::interpolation).  0 otherwise.
1118     */
1119    unsigned interpolation:2;
1120
1121    /**
1122     * For interface blocks, 1 if this variable uses centroid interpolation (as
1123     * in ir_variable::centroid).  0 otherwise.
1124     */
1125    unsigned centroid:1;
1126
1127    /**
1128     * For interface blocks, 1 if this variable uses sample interpolation (as
1129     * in ir_variable::sample). 0 otherwise.
1130     */
1131    unsigned sample:1;
1132
1133    /**
1134     * Layout of the matrix.  Uses glsl_matrix_layout values.
1135     */
1136    unsigned matrix_layout:2;
1137
1138    /**
1139     * For interface blocks, 1 if this variable is a per-patch input or output
1140     * (as in ir_variable::patch). 0 otherwise.
1141     */
1142    unsigned patch:1;
1143
1144    /**
1145     * Precision qualifier
1146     */
1147    unsigned precision:2;
1148
1149    /**
1150     * Memory qualifiers, applicable to buffer variables defined in shader
1151     * storage buffer objects (SSBOs)
1152     */
1153    unsigned memory_read_only:1;
1154    unsigned memory_write_only:1;
1155    unsigned memory_coherent:1;
1156    unsigned memory_volatile:1;
1157    unsigned memory_restrict:1;
1158
1159    /**
1160     * Layout format, applicable to image variables only.
1161     */
1162    unsigned image_format:16;
1163
1164    /**
1165     * Any of the xfb_* qualifiers trigger the shader to be in transform
1166     * feedback mode so we need to keep track of whether the buffer was
1167     * explicitly set or if its just been assigned the default global value.
1168     */
1169    unsigned explicit_xfb_buffer:1;
1170
1171    unsigned implicit_sized_array:1;
1172 #ifdef __cplusplus
1173    glsl_struct_field(const struct glsl_type *_type, const char *_name)
1174       : type(_type), name(_name), location(-1), offset(-1), xfb_buffer(0),
1175         xfb_stride(0), interpolation(0), centroid(0),
1176         sample(0), matrix_layout(GLSL_MATRIX_LAYOUT_INHERITED), patch(0),
1177         precision(GLSL_PRECISION_NONE), memory_read_only(0),
1178         memory_write_only(0), memory_coherent(0), memory_volatile(0),
1179         memory_restrict(0), image_format(0), explicit_xfb_buffer(0),
1180         implicit_sized_array(0)
1181    {
1182       /* empty */
1183    }
1184
1185    glsl_struct_field()
1186       : type(NULL), name(NULL), location(-1), offset(-1), xfb_buffer(0),
1187         xfb_stride(0), interpolation(0), centroid(0),
1188         sample(0), matrix_layout(0), patch(0),
1189         precision(0), memory_read_only(0),
1190         memory_write_only(0), memory_coherent(0), memory_volatile(0),
1191         memory_restrict(0), image_format(0), explicit_xfb_buffer(0),
1192         implicit_sized_array(0)
1193    {
1194       /* empty */
1195    }
1196 #endif
1197 };
1198
1199 struct glsl_function_param {
1200    const struct glsl_type *type;
1201
1202    bool in;
1203    bool out;
1204 };
1205
1206 static inline unsigned int
1207 glsl_align(unsigned int a, unsigned int align)
1208 {
1209    return (a + align - 1) / align * align;
1210 }
1211
1212 #endif /* GLSL_TYPES_H */