3 * Copyright © 2009 Intel Corporation
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:
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
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.
35 struct _mesa_glsl_parse_state
;
36 struct glsl_symbol_table
;
39 _mesa_glsl_initialize_types(struct _mesa_glsl_parse_state
*state
);
42 _mesa_glsl_release_types(void);
49 /* Note: GLSL_TYPE_UINT, GLSL_TYPE_INT, and GLSL_TYPE_FLOAT must be 0, 1,
50 * and 2 so that they will fit in the 2 bits of glsl_type::sampled_type.
61 GLSL_TYPE_ATOMIC_UINT
,
71 static inline bool glsl_base_type_is_64bit(enum glsl_base_type type
)
73 return type
== GLSL_TYPE_DOUBLE
||
74 type
== GLSL_TYPE_UINT64
||
75 type
== GLSL_TYPE_INT64
;
78 enum glsl_sampler_dim
{
79 GLSL_SAMPLER_DIM_1D
= 0,
82 GLSL_SAMPLER_DIM_CUBE
,
83 GLSL_SAMPLER_DIM_RECT
,
85 GLSL_SAMPLER_DIM_EXTERNAL
,
87 GLSL_SAMPLER_DIM_SUBPASS
, /* for vulkan input attachments */
88 GLSL_SAMPLER_DIM_SUBPASS_MS
, /* for multisampled vulkan input attachments */
91 enum glsl_interface_packing
{
92 GLSL_INTERFACE_PACKING_STD140
,
93 GLSL_INTERFACE_PACKING_SHARED
,
94 GLSL_INTERFACE_PACKING_PACKED
,
95 GLSL_INTERFACE_PACKING_STD430
98 enum glsl_matrix_layout
{
100 * The layout of the matrix is inherited from the object containing the
101 * matrix (the top level structure or the uniform block).
103 GLSL_MATRIX_LAYOUT_INHERITED
,
106 * Explicit column-major layout
108 * If a uniform block doesn't have an explicit layout set, it will default
111 GLSL_MATRIX_LAYOUT_COLUMN_MAJOR
,
116 GLSL_MATRIX_LAYOUT_ROW_MAJOR
120 GLSL_PRECISION_NONE
= 0,
122 GLSL_PRECISION_MEDIUM
,
128 #include "util/ralloc.h"
129 #include "main/mtypes.h" /* for gl_texture_index, C++'s enum rules are broken */
133 glsl_base_type base_type
;
135 unsigned sampler_dimensionality
:4; /**< \see glsl_sampler_dim */
136 unsigned sampler_shadow
:1;
137 unsigned sampler_array
:1;
138 unsigned sampled_type
:2; /**< Type of data returned using this
139 * sampler or image. Only \c
140 * GLSL_TYPE_FLOAT, \c GLSL_TYPE_INT,
141 * and \c GLSL_TYPE_UINT are valid.
143 unsigned interface_packing
:2;
144 unsigned interface_row_major
:1;
146 /* Callers of this ralloc-based new need not call delete. It's
147 * easier to just ralloc_free 'mem_ctx' (or any of its ancestors). */
148 static void* operator new(size_t size
)
150 mtx_lock(&glsl_type::mutex
);
152 /* mem_ctx should have been created by the static members */
153 assert(glsl_type::mem_ctx
!= NULL
);
157 type
= ralloc_size(glsl_type::mem_ctx
, size
);
158 assert(type
!= NULL
);
160 mtx_unlock(&glsl_type::mutex
);
165 /* If the user *does* call delete, that's OK, we will just
166 * ralloc_free in that case. */
167 static void operator delete(void *type
)
169 mtx_lock(&glsl_type::mutex
);
171 mtx_unlock(&glsl_type::mutex
);
175 * \name Vector and matrix element counts
177 * For scalars, each of these values will be 1. For non-numeric types
181 uint8_t vector_elements
; /**< 1, 2, 3, or 4 vector elements. */
182 uint8_t matrix_columns
; /**< 1, 2, 3, or 4 matrix columns. */
186 * For \c GLSL_TYPE_ARRAY, this is the length of the array. For
187 * \c GLSL_TYPE_STRUCT or \c GLSL_TYPE_INTERFACE, it is the number of
188 * elements in the structure and the number of values pointed to by
189 * \c fields.structure (below).
194 * Name of the data type
196 * Will never be \c NULL.
201 * Subtype of composite data types.
204 const struct glsl_type
*array
; /**< Type of array elements. */
205 struct glsl_function_param
*parameters
; /**< Parameters to function. */
206 struct glsl_struct_field
*structure
; /**< List of struct fields. */
210 * \name Pointers to various public type singletons
214 #define DECL_TYPE(NAME, ...) \
215 static const glsl_type *const NAME##_type;
217 #define STRUCT_TYPE(NAME) \
218 static const glsl_type *const struct_##NAME##_type;
219 #include "compiler/builtin_type_macros.h"
223 * Convenience accessors for vector types (shorter than get_instance()).
226 static const glsl_type
*vec(unsigned components
);
227 static const glsl_type
*dvec(unsigned components
);
228 static const glsl_type
*ivec(unsigned components
);
229 static const glsl_type
*uvec(unsigned components
);
230 static const glsl_type
*bvec(unsigned components
);
231 static const glsl_type
*i64vec(unsigned components
);
232 static const glsl_type
*u64vec(unsigned components
);
236 * For numeric and boolean derived types returns the basic scalar type
238 * If the type is a numeric or boolean scalar, vector, or matrix type,
239 * this function gets the scalar type of the individual components. For
240 * all other types, including arrays of numeric or boolean types, the
241 * error type is returned.
243 const glsl_type
*get_base_type() const;
246 * Get the basic scalar type which this type aggregates.
248 * If the type is a numeric or boolean scalar, vector, or matrix, or an
249 * array of any of those, this function gets the scalar type of the
250 * individual components. For structs and arrays of structs, this function
251 * returns the struct type. For samplers and arrays of samplers, this
252 * function returns the sampler type.
254 const glsl_type
*get_scalar_type() const;
257 * Get the instance of a built-in scalar, vector, or matrix type
259 static const glsl_type
*get_instance(unsigned base_type
, unsigned rows
,
263 * Get the instance of a sampler type
265 static const glsl_type
*get_sampler_instance(enum glsl_sampler_dim dim
,
268 glsl_base_type type
);
270 static const glsl_type
*get_image_instance(enum glsl_sampler_dim dim
,
271 bool array
, glsl_base_type type
);
274 * Get the instance of an array type
276 static const glsl_type
*get_array_instance(const glsl_type
*base
,
280 * Get the instance of a record type
282 static const glsl_type
*get_record_instance(const glsl_struct_field
*fields
,
287 * Get the instance of an interface block type
289 static const glsl_type
*get_interface_instance(const glsl_struct_field
*fields
,
291 enum glsl_interface_packing packing
,
293 const char *block_name
);
296 * Get the instance of an subroutine type
298 static const glsl_type
*get_subroutine_instance(const char *subroutine_name
);
301 * Get the instance of a function type
303 static const glsl_type
*get_function_instance(const struct glsl_type
*return_type
,
304 const glsl_function_param
*parameters
,
305 unsigned num_params
);
308 * Get the type resulting from a multiplication of \p type_a * \p type_b
310 static const glsl_type
*get_mul_type(const glsl_type
*type_a
,
311 const glsl_type
*type_b
);
314 * Query the total number of scalars that make up a scalar, vector or matrix
316 unsigned components() const
318 return vector_elements
* matrix_columns
;
322 * Calculate the number of components slots required to hold this type
324 * This is used to determine how many uniform or varying locations a type
327 unsigned component_slots() const;
330 * Calculate offset between the base location of the struct in
331 * uniform storage and a struct member.
332 * For the initial call, length is the index of the member to find the
335 unsigned record_location_offset(unsigned length
) const;
338 * Calculate the number of unique values from glGetUniformLocation for the
339 * elements of the type.
341 * This is used to allocate slots in the UniformRemapTable, the amount of
342 * locations may not match with actual used storage space by the driver.
344 unsigned uniform_locations() const;
347 * Used to count the number of varyings contained in the type ignoring
348 * innermost array elements.
350 unsigned varying_count() const;
353 * Calculate the number of attribute slots required to hold this type
355 * This implements the language rules of GLSL 1.50 for counting the number
356 * of slots used by a vertex attribute. It also determines the number of
357 * varying slots the type will use up in the absence of varying packing
358 * (and thus, it can be used to measure the number of varying slots used by
359 * the varyings that are generated by lower_packed_varyings).
361 * For vertex shader attributes - doubles only take one slot.
362 * For inter-shader varyings - dvec3/dvec4 take two slots.
364 unsigned count_attribute_slots(bool is_vertex_input
) const;
367 * Alignment in bytes of the start of this type in a std140 uniform
370 unsigned std140_base_alignment(bool row_major
) const;
372 /** Size in bytes of this type in a std140 uniform block.
374 * Note that this is not GL_UNIFORM_SIZE (which is the number of
375 * elements in the array)
377 unsigned std140_size(bool row_major
) const;
380 * Alignment in bytes of the start of this type in a std430 shader
383 unsigned std430_base_alignment(bool row_major
) const;
386 * Calculate array stride in bytes of this type in a std430 shader storage
389 unsigned std430_array_stride(bool row_major
) const;
392 * Size in bytes of this type in a std430 shader storage block.
394 * Note that this is not GL_BUFFER_SIZE
396 unsigned std430_size(bool row_major
) const;
399 * \brief Can this type be implicitly converted to another?
401 * \return True if the types are identical or if this type can be converted
402 * to \c desired according to Section 4.1.10 of the GLSL spec.
405 * From page 25 (31 of the pdf) of the GLSL 1.50 spec, Section 4.1.10
406 * Implicit Conversions:
408 * In some situations, an expression and its type will be implicitly
409 * converted to a different type. The following table shows all allowed
410 * implicit conversions:
412 * Type of expression | Can be implicitly converted to
413 * --------------------------------------------------
426 * There are no implicit array or structure conversions. For example,
427 * an array of int cannot be implicitly converted to an array of float.
428 * There are no implicit conversions between signed and unsigned
432 bool can_implicitly_convert_to(const glsl_type
*desired
,
433 _mesa_glsl_parse_state
*state
) const;
436 * Query whether or not a type is a scalar (non-vector and non-matrix).
438 bool is_scalar() const
440 return (vector_elements
== 1)
441 && (base_type
>= GLSL_TYPE_UINT
)
442 && (base_type
<= GLSL_TYPE_BOOL
);
446 * Query whether or not a type is a vector
448 bool is_vector() const
450 return (vector_elements
> 1)
451 && (matrix_columns
== 1)
452 && (base_type
>= GLSL_TYPE_UINT
)
453 && (base_type
<= GLSL_TYPE_BOOL
);
457 * Query whether or not a type is a matrix
459 bool is_matrix() const
461 /* GLSL only has float matrices. */
462 return (matrix_columns
> 1) && (base_type
== GLSL_TYPE_FLOAT
|| base_type
== GLSL_TYPE_DOUBLE
);
466 * Query whether or not a type is a non-array numeric type
468 bool is_numeric() const
470 return (base_type
>= GLSL_TYPE_UINT
) && (base_type
<= GLSL_TYPE_INT64
);
474 * Query whether or not a type is an integral type
476 bool is_integer() const
478 return (base_type
== GLSL_TYPE_UINT
) || (base_type
== GLSL_TYPE_INT
);
482 * Query whether or not a type is a 32-bit or 64-bit integer
484 bool is_integer_32_64() const
486 return (base_type
== GLSL_TYPE_UINT
) || (base_type
== GLSL_TYPE_INT
) ||
487 (base_type
== GLSL_TYPE_UINT64
) || (base_type
== GLSL_TYPE_INT64
);
491 * Query whether or not type is an integral type, or for struct and array
492 * types, contains an integral type.
494 bool contains_integer() const;
497 * Query whether or not type is a double type, or for struct, interface and
498 * array types, contains a double type.
500 bool contains_double() const;
503 * Query whether or not a type is a float type
505 bool is_float() const
507 return base_type
== GLSL_TYPE_FLOAT
;
511 * Query whether or not a type is a double type
513 bool is_double() const
515 return base_type
== GLSL_TYPE_DOUBLE
;
519 * Query whether a 64-bit type takes two slots.
521 bool is_dual_slot() const
523 return is_64bit() && vector_elements
> 2;
527 * Query whether or not a type is 64-bit
529 bool is_64bit() const
531 return glsl_base_type_is_64bit(base_type
);
535 * Query whether or not a type is a non-array boolean type
537 bool is_boolean() const
539 return base_type
== GLSL_TYPE_BOOL
;
543 * Query whether or not a type is a sampler
545 bool is_sampler() const
547 return base_type
== GLSL_TYPE_SAMPLER
;
551 * Query whether or not type is a sampler, or for struct, interface and
552 * array types, contains a sampler.
554 bool contains_sampler() const;
557 * Get the Mesa texture target index for a sampler type.
559 gl_texture_index
sampler_index() const;
562 * Query whether or not type is an image, or for struct, interface and
563 * array types, contains an image.
565 bool contains_image() const;
568 * Query whether or not a type is an image
570 bool is_image() const
572 return base_type
== GLSL_TYPE_IMAGE
;
576 * Query whether or not a type is an array
578 bool is_array() const
580 return base_type
== GLSL_TYPE_ARRAY
;
583 bool is_array_of_arrays() const
585 return is_array() && fields
.array
->is_array();
589 * Query whether or not a type is a record
591 bool is_record() const
593 return base_type
== GLSL_TYPE_STRUCT
;
597 * Query whether or not a type is an interface
599 bool is_interface() const
601 return base_type
== GLSL_TYPE_INTERFACE
;
605 * Query whether or not a type is the void type singleton.
609 return base_type
== GLSL_TYPE_VOID
;
613 * Query whether or not a type is the error type singleton.
615 bool is_error() const
617 return base_type
== GLSL_TYPE_ERROR
;
621 * Query if a type is unnamed/anonymous (named by the parser)
624 bool is_subroutine() const
626 return base_type
== GLSL_TYPE_SUBROUTINE
;
628 bool contains_subroutine() const;
630 bool is_anonymous() const
632 return !strncmp(name
, "#anon", 5);
636 * Get the type stripped of any arrays
639 * Pointer to the type of elements of the first non-array type for array
640 * types, or pointer to itself for non-array types.
642 const glsl_type
*without_array() const
644 const glsl_type
*t
= this;
646 while (t
->is_array())
653 * Return the total number of elements in an array including the elements
654 * in arrays of arrays.
656 unsigned arrays_of_arrays_size() const
661 unsigned size
= length
;
662 const glsl_type
*base_type
= fields
.array
;
664 while (base_type
->is_array()) {
665 size
= size
* base_type
->length
;
666 base_type
= base_type
->fields
.array
;
672 * Return the amount of atomic counter storage required for a type.
674 unsigned atomic_size() const
676 if (base_type
== GLSL_TYPE_ATOMIC_UINT
)
677 return ATOMIC_COUNTER_SIZE
;
679 return length
* fields
.array
->atomic_size();
685 * Return whether a type contains any atomic counters.
687 bool contains_atomic() const
689 return atomic_size() > 0;
693 * Return whether a type contains any opaque types.
695 bool contains_opaque() const;
698 * Query the full type of a matrix row
701 * If the type is not a matrix, \c glsl_type::error_type is returned.
702 * Otherwise a type matching the rows of the matrix is returned.
704 const glsl_type
*row_type() const
707 ? get_instance(base_type
, matrix_columns
, 1)
712 * Query the full type of a matrix column
715 * If the type is not a matrix, \c glsl_type::error_type is returned.
716 * Otherwise a type matching the columns of the matrix is returned.
718 const glsl_type
*column_type() const
721 ? get_instance(base_type
, vector_elements
, 1)
726 * Get the type of a structure field
729 * Pointer to the type of the named field. If the type is not a structure
730 * or the named field does not exist, \c glsl_type::error_type is returned.
732 const glsl_type
*field_type(const char *name
) const;
735 * Get the location of a field within a record type
737 int field_index(const char *name
) const;
740 * Query the number of elements in an array type
743 * The number of elements in the array for array types or -1 for non-array
744 * types. If the number of elements in the array has not yet been declared,
747 int array_size() const
749 return is_array() ? length
: -1;
753 * Query whether the array size for all dimensions has been declared.
755 bool is_unsized_array() const
757 return is_array() && length
== 0;
761 * Return the number of coordinate components needed for this
762 * sampler or image type.
764 * This is based purely on the sampler's dimensionality. For example, this
765 * returns 1 for sampler1D, and 3 for sampler2DArray.
767 * Note that this is often different than actual coordinate type used in
768 * a texturing built-in function, since those pack additional values (such
769 * as the shadow comparator or projector) into the coordinate type.
771 int coordinate_components() const;
774 * Compare a record type against another record type.
776 * This is useful for matching record types declared across shader stages.
777 * The option to not match locations is to deal with places where the
778 * same struct is defined in a block which has a location set on it.
780 bool record_compare(const glsl_type
*b
, bool match_locations
= true) const;
783 * Get the type interface packing.
785 enum glsl_interface_packing
get_interface_packing() const
787 return (enum glsl_interface_packing
)interface_packing
;
791 * Check if the type interface is row major
793 bool get_interface_row_major() const
795 return (bool) interface_row_major
;
803 * ralloc context for all glsl_type allocations
805 * Set on the first call to \c glsl_type::new.
807 static void *mem_ctx
;
809 void init_ralloc_type_ctx(void);
811 /** Constructor for vector and matrix types */
812 glsl_type(GLenum gl_type
,
813 glsl_base_type base_type
, unsigned vector_elements
,
814 unsigned matrix_columns
, const char *name
);
816 /** Constructor for sampler or image types */
817 glsl_type(GLenum gl_type
, glsl_base_type base_type
,
818 enum glsl_sampler_dim dim
, bool shadow
, bool array
,
819 unsigned type
, const char *name
);
821 /** Constructor for record types */
822 glsl_type(const glsl_struct_field
*fields
, unsigned num_fields
,
825 /** Constructor for interface types */
826 glsl_type(const glsl_struct_field
*fields
, unsigned num_fields
,
827 enum glsl_interface_packing packing
,
828 bool row_major
, const char *name
);
830 /** Constructor for interface types */
831 glsl_type(const glsl_type
*return_type
,
832 const glsl_function_param
*params
, unsigned num_params
);
834 /** Constructor for array types */
835 glsl_type(const glsl_type
*array
, unsigned length
);
837 /** Constructor for subroutine types */
838 glsl_type(const char *name
);
840 /** Hash table containing the known array types. */
841 static struct hash_table
*array_types
;
843 /** Hash table containing the known record types. */
844 static struct hash_table
*record_types
;
846 /** Hash table containing the known interface types. */
847 static struct hash_table
*interface_types
;
849 /** Hash table containing the known subroutine types. */
850 static struct hash_table
*subroutine_types
;
852 /** Hash table containing the known function types. */
853 static struct hash_table
*function_types
;
855 static bool record_key_compare(const void *a
, const void *b
);
856 static unsigned record_key_hash(const void *key
);
859 * \name Built-in type flyweights
863 #define DECL_TYPE(NAME, ...) static const glsl_type _##NAME##_type;
865 #define STRUCT_TYPE(NAME) static const glsl_type _struct_##NAME##_type;
866 #include "compiler/builtin_type_macros.h"
870 * \name Friend functions.
872 * These functions are friends because they must have C linkage and the
873 * need to call various private methods or access various private static
877 friend void _mesa_glsl_initialize_types(struct _mesa_glsl_parse_state
*);
878 friend void _mesa_glsl_release_types(void);
884 #endif /* __cplusplus */
886 struct glsl_struct_field
{
887 const struct glsl_type
*type
;
891 * For interface blocks, gl_varying_slot corresponding to the input/output
892 * if this is a built-in input/output (i.e. a member of the built-in
893 * gl_PerVertex interface block); -1 otherwise.
895 * Ignored for structs.
900 * For interface blocks, members may have an explicit byte offset
901 * specified; -1 otherwise. Also used for xfb_offset layout qualifier.
903 * Unless used for xfb_offset this field is ignored for structs.
908 * For interface blocks, members may define a transform feedback buffer;
914 * For interface blocks, members may define a transform feedback stride;
920 * For interface blocks, the interpolation mode (as in
921 * ir_variable::interpolation). 0 otherwise.
923 unsigned interpolation
:2;
926 * For interface blocks, 1 if this variable uses centroid interpolation (as
927 * in ir_variable::centroid). 0 otherwise.
932 * For interface blocks, 1 if this variable uses sample interpolation (as
933 * in ir_variable::sample). 0 otherwise.
938 * Layout of the matrix. Uses glsl_matrix_layout values.
940 unsigned matrix_layout
:2;
943 * For interface blocks, 1 if this variable is a per-patch input or output
944 * (as in ir_variable::patch). 0 otherwise.
949 * Precision qualifier
951 unsigned precision
:2;
954 * Image qualifiers, applicable to buffer variables defined in shader
955 * storage buffer objects (SSBOs)
957 unsigned image_read_only
:1;
958 unsigned image_write_only
:1;
959 unsigned image_coherent
:1;
960 unsigned image_volatile
:1;
961 unsigned image_restrict
:1;
964 * Any of the xfb_* qualifiers trigger the shader to be in transform
965 * feedback mode so we need to keep track of whether the buffer was
966 * explicitly set or if its just been assigned the default global value.
968 unsigned explicit_xfb_buffer
:1;
970 unsigned implicit_sized_array
:1;
972 glsl_struct_field(const struct glsl_type
*_type
, const char *_name
)
973 : type(_type
), name(_name
), location(-1), offset(0), xfb_buffer(0),
974 xfb_stride(0), interpolation(0), centroid(0),
975 sample(0), matrix_layout(GLSL_MATRIX_LAYOUT_INHERITED
), patch(0),
976 precision(GLSL_PRECISION_NONE
), image_read_only(0), image_write_only(0),
977 image_coherent(0), image_volatile(0), image_restrict(0),
978 explicit_xfb_buffer(0), implicit_sized_array(0)
990 struct glsl_function_param
{
991 const struct glsl_type
*type
;
997 static inline unsigned int
998 glsl_align(unsigned int a
, unsigned int align
)
1000 return (a
+ align
- 1) / align
* align
;
1003 #endif /* GLSL_TYPES_H */