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
||
76 type
== GLSL_TYPE_IMAGE
||
77 type
== GLSL_TYPE_SAMPLER
;
80 enum glsl_sampler_dim
{
81 GLSL_SAMPLER_DIM_1D
= 0,
84 GLSL_SAMPLER_DIM_CUBE
,
85 GLSL_SAMPLER_DIM_RECT
,
87 GLSL_SAMPLER_DIM_EXTERNAL
,
89 GLSL_SAMPLER_DIM_SUBPASS
, /* for vulkan input attachments */
90 GLSL_SAMPLER_DIM_SUBPASS_MS
, /* for multisampled vulkan input attachments */
93 enum glsl_interface_packing
{
94 GLSL_INTERFACE_PACKING_STD140
,
95 GLSL_INTERFACE_PACKING_SHARED
,
96 GLSL_INTERFACE_PACKING_PACKED
,
97 GLSL_INTERFACE_PACKING_STD430
100 enum glsl_matrix_layout
{
102 * The layout of the matrix is inherited from the object containing the
103 * matrix (the top level structure or the uniform block).
105 GLSL_MATRIX_LAYOUT_INHERITED
,
108 * Explicit column-major layout
110 * If a uniform block doesn't have an explicit layout set, it will default
113 GLSL_MATRIX_LAYOUT_COLUMN_MAJOR
,
118 GLSL_MATRIX_LAYOUT_ROW_MAJOR
122 GLSL_PRECISION_NONE
= 0,
124 GLSL_PRECISION_MEDIUM
,
130 #include "util/ralloc.h"
131 #include "main/mtypes.h" /* for gl_texture_index, C++'s enum rules are broken */
135 glsl_base_type base_type
;
137 unsigned sampler_dimensionality
:4; /**< \see glsl_sampler_dim */
138 unsigned sampler_shadow
:1;
139 unsigned sampler_array
:1;
140 unsigned sampled_type
:2; /**< Type of data returned using this
141 * sampler or image. Only \c
142 * GLSL_TYPE_FLOAT, \c GLSL_TYPE_INT,
143 * and \c GLSL_TYPE_UINT are valid.
145 unsigned interface_packing
:2;
146 unsigned interface_row_major
:1;
148 /* Callers of this ralloc-based new need not call delete. It's
149 * easier to just ralloc_free 'mem_ctx' (or any of its ancestors). */
150 static void* operator new(size_t size
)
152 mtx_lock(&glsl_type::mem_mutex
);
154 /* mem_ctx should have been created by the static members */
155 assert(glsl_type::mem_ctx
!= NULL
);
159 type
= ralloc_size(glsl_type::mem_ctx
, size
);
160 assert(type
!= NULL
);
162 mtx_unlock(&glsl_type::mem_mutex
);
167 /* If the user *does* call delete, that's OK, we will just
168 * ralloc_free in that case. */
169 static void operator delete(void *type
)
171 mtx_lock(&glsl_type::mem_mutex
);
173 mtx_unlock(&glsl_type::mem_mutex
);
177 * \name Vector and matrix element counts
179 * For scalars, each of these values will be 1. For non-numeric types
183 uint8_t vector_elements
; /**< 1, 2, 3, or 4 vector elements. */
184 uint8_t matrix_columns
; /**< 1, 2, 3, or 4 matrix columns. */
188 * For \c GLSL_TYPE_ARRAY, this is the length of the array. For
189 * \c GLSL_TYPE_STRUCT or \c GLSL_TYPE_INTERFACE, it is the number of
190 * elements in the structure and the number of values pointed to by
191 * \c fields.structure (below).
196 * Name of the data type
198 * Will never be \c NULL.
203 * Subtype of composite data types.
206 const struct glsl_type
*array
; /**< Type of array elements. */
207 struct glsl_function_param
*parameters
; /**< Parameters to function. */
208 struct glsl_struct_field
*structure
; /**< List of struct fields. */
212 * \name Pointers to various public type singletons
216 #define DECL_TYPE(NAME, ...) \
217 static const glsl_type *const NAME##_type;
219 #define STRUCT_TYPE(NAME) \
220 static const glsl_type *const struct_##NAME##_type;
221 #include "compiler/builtin_type_macros.h"
225 * Convenience accessors for vector types (shorter than get_instance()).
228 static const glsl_type
*vec(unsigned components
);
229 static const glsl_type
*dvec(unsigned components
);
230 static const glsl_type
*ivec(unsigned components
);
231 static const glsl_type
*uvec(unsigned components
);
232 static const glsl_type
*bvec(unsigned components
);
233 static const glsl_type
*i64vec(unsigned components
);
234 static const glsl_type
*u64vec(unsigned components
);
238 * For numeric and boolean derived types returns the basic scalar type
240 * If the type is a numeric or boolean scalar, vector, or matrix type,
241 * this function gets the scalar type of the individual components. For
242 * all other types, including arrays of numeric or boolean types, the
243 * error type is returned.
245 const glsl_type
*get_base_type() const;
248 * Get the basic scalar type which this type aggregates.
250 * If the type is a numeric or boolean scalar, vector, or matrix, or an
251 * array of any of those, this function gets the scalar type of the
252 * individual components. For structs and arrays of structs, this function
253 * returns the struct type. For samplers and arrays of samplers, this
254 * function returns the sampler type.
256 const glsl_type
*get_scalar_type() const;
259 * Get the instance of a built-in scalar, vector, or matrix type
261 static const glsl_type
*get_instance(unsigned base_type
, unsigned rows
,
265 * Get the instance of a sampler type
267 static const glsl_type
*get_sampler_instance(enum glsl_sampler_dim dim
,
270 glsl_base_type type
);
272 static const glsl_type
*get_image_instance(enum glsl_sampler_dim dim
,
273 bool array
, glsl_base_type type
);
276 * Get the instance of an array type
278 static const glsl_type
*get_array_instance(const glsl_type
*base
,
282 * Get the instance of a record type
284 static const glsl_type
*get_record_instance(const glsl_struct_field
*fields
,
289 * Get the instance of an interface block type
291 static const glsl_type
*get_interface_instance(const glsl_struct_field
*fields
,
293 enum glsl_interface_packing packing
,
295 const char *block_name
);
298 * Get the instance of an subroutine type
300 static const glsl_type
*get_subroutine_instance(const char *subroutine_name
);
303 * Get the instance of a function type
305 static const glsl_type
*get_function_instance(const struct glsl_type
*return_type
,
306 const glsl_function_param
*parameters
,
307 unsigned num_params
);
310 * Get the type resulting from a multiplication of \p type_a * \p type_b
312 static const glsl_type
*get_mul_type(const glsl_type
*type_a
,
313 const glsl_type
*type_b
);
316 * Query the total number of scalars that make up a scalar, vector or matrix
318 unsigned components() const
320 return vector_elements
* matrix_columns
;
324 * Calculate the number of components slots required to hold this type
326 * This is used to determine how many uniform or varying locations a type
329 unsigned component_slots() const;
332 * Calculate offset between the base location of the struct in
333 * uniform storage and a struct member.
334 * For the initial call, length is the index of the member to find the
337 unsigned record_location_offset(unsigned length
) const;
340 * Calculate the number of unique values from glGetUniformLocation for the
341 * elements of the type.
343 * This is used to allocate slots in the UniformRemapTable, the amount of
344 * locations may not match with actual used storage space by the driver.
346 unsigned uniform_locations() const;
349 * Used to count the number of varyings contained in the type ignoring
350 * innermost array elements.
352 unsigned varying_count() const;
355 * Calculate the number of attribute slots required to hold this type
357 * This implements the language rules of GLSL 1.50 for counting the number
358 * of slots used by a vertex attribute. It also determines the number of
359 * varying slots the type will use up in the absence of varying packing
360 * (and thus, it can be used to measure the number of varying slots used by
361 * the varyings that are generated by lower_packed_varyings).
363 * For vertex shader attributes - doubles only take one slot.
364 * For inter-shader varyings - dvec3/dvec4 take two slots.
366 unsigned count_attribute_slots(bool is_vertex_input
) const;
369 * Alignment in bytes of the start of this type in a std140 uniform
372 unsigned std140_base_alignment(bool row_major
) const;
374 /** Size in bytes of this type in a std140 uniform block.
376 * Note that this is not GL_UNIFORM_SIZE (which is the number of
377 * elements in the array)
379 unsigned std140_size(bool row_major
) const;
382 * Alignment in bytes of the start of this type in a std430 shader
385 unsigned std430_base_alignment(bool row_major
) const;
388 * Calculate array stride in bytes of this type in a std430 shader storage
391 unsigned std430_array_stride(bool row_major
) const;
394 * Size in bytes of this type in a std430 shader storage block.
396 * Note that this is not GL_BUFFER_SIZE
398 unsigned std430_size(bool row_major
) const;
401 * \brief Can this type be implicitly converted to another?
403 * \return True if the types are identical or if this type can be converted
404 * to \c desired according to Section 4.1.10 of the GLSL spec.
407 * From page 25 (31 of the pdf) of the GLSL 1.50 spec, Section 4.1.10
408 * Implicit Conversions:
410 * In some situations, an expression and its type will be implicitly
411 * converted to a different type. The following table shows all allowed
412 * implicit conversions:
414 * Type of expression | Can be implicitly converted to
415 * --------------------------------------------------
428 * There are no implicit array or structure conversions. For example,
429 * an array of int cannot be implicitly converted to an array of float.
430 * There are no implicit conversions between signed and unsigned
434 bool can_implicitly_convert_to(const glsl_type
*desired
,
435 _mesa_glsl_parse_state
*state
) const;
438 * Query whether or not a type is a scalar (non-vector and non-matrix).
440 bool is_scalar() const
442 return (vector_elements
== 1)
443 && (base_type
>= GLSL_TYPE_UINT
)
444 && (base_type
<= GLSL_TYPE_IMAGE
);
448 * Query whether or not a type is a vector
450 bool is_vector() const
452 return (vector_elements
> 1)
453 && (matrix_columns
== 1)
454 && (base_type
>= GLSL_TYPE_UINT
)
455 && (base_type
<= GLSL_TYPE_BOOL
);
459 * Query whether or not a type is a matrix
461 bool is_matrix() const
463 /* GLSL only has float matrices. */
464 return (matrix_columns
> 1) && (base_type
== GLSL_TYPE_FLOAT
|| base_type
== GLSL_TYPE_DOUBLE
);
468 * Query whether or not a type is a non-array numeric type
470 bool is_numeric() const
472 return (base_type
>= GLSL_TYPE_UINT
) && (base_type
<= GLSL_TYPE_INT64
);
476 * Query whether or not a type is an integral type
478 bool is_integer() const
480 return (base_type
== GLSL_TYPE_UINT
) || (base_type
== GLSL_TYPE_INT
);
484 * Query whether or not a type is a 64-bit integer.
486 bool is_integer_64() const
488 return base_type
== GLSL_TYPE_UINT64
|| base_type
== GLSL_TYPE_INT64
;
492 * Query whether or not a type is a 32-bit or 64-bit integer
494 bool is_integer_32_64() const
496 return is_integer() || is_integer_64();
500 * Query whether or not type is an integral type, or for struct and array
501 * types, contains an integral type.
503 bool contains_integer() const;
506 * Query whether or not type is a double type, or for struct, interface and
507 * array types, contains a double type.
509 bool contains_double() const;
512 * Query whether or not a type is a float type
514 bool is_float() const
516 return base_type
== GLSL_TYPE_FLOAT
;
520 * Query whether or not a type is a double type
522 bool is_double() const
524 return base_type
== GLSL_TYPE_DOUBLE
;
528 * Query whether a 64-bit type takes two slots.
530 bool is_dual_slot() const
532 return is_64bit() && vector_elements
> 2;
536 * Query whether or not a type is 64-bit
538 bool is_64bit() const
540 return glsl_base_type_is_64bit(base_type
);
544 * Query whether or not a type is a non-array boolean type
546 bool is_boolean() const
548 return base_type
== GLSL_TYPE_BOOL
;
552 * Query whether or not a type is a sampler
554 bool is_sampler() const
556 return base_type
== GLSL_TYPE_SAMPLER
;
560 * Query whether or not type is a sampler, or for struct, interface and
561 * array types, contains a sampler.
563 bool contains_sampler() const;
566 * Query whether or not type is an array or for struct, interface and
567 * array types, contains an array.
569 bool contains_array() const;
572 * Get the Mesa texture target index for a sampler type.
574 gl_texture_index
sampler_index() const;
577 * Query whether or not type is an image, or for struct, interface and
578 * array types, contains an image.
580 bool contains_image() const;
583 * Query whether or not a type is an image
585 bool is_image() const
587 return base_type
== GLSL_TYPE_IMAGE
;
591 * Query whether or not a type is an array
593 bool is_array() const
595 return base_type
== GLSL_TYPE_ARRAY
;
598 bool is_array_of_arrays() const
600 return is_array() && fields
.array
->is_array();
604 * Query whether or not a type is a record
606 bool is_record() const
608 return base_type
== GLSL_TYPE_STRUCT
;
612 * Query whether or not a type is an interface
614 bool is_interface() const
616 return base_type
== GLSL_TYPE_INTERFACE
;
620 * Query whether or not a type is the void type singleton.
624 return base_type
== GLSL_TYPE_VOID
;
628 * Query whether or not a type is the error type singleton.
630 bool is_error() const
632 return base_type
== GLSL_TYPE_ERROR
;
636 * Query if a type is unnamed/anonymous (named by the parser)
639 bool is_subroutine() const
641 return base_type
== GLSL_TYPE_SUBROUTINE
;
643 bool contains_subroutine() const;
645 bool is_anonymous() const
647 return !strncmp(name
, "#anon", 5);
651 * Get the type stripped of any arrays
654 * Pointer to the type of elements of the first non-array type for array
655 * types, or pointer to itself for non-array types.
657 const glsl_type
*without_array() const
659 const glsl_type
*t
= this;
661 while (t
->is_array())
668 * Return the total number of elements in an array including the elements
669 * in arrays of arrays.
671 unsigned arrays_of_arrays_size() const
676 unsigned size
= length
;
677 const glsl_type
*base_type
= fields
.array
;
679 while (base_type
->is_array()) {
680 size
= size
* base_type
->length
;
681 base_type
= base_type
->fields
.array
;
687 * Query whether or not a type is an atomic_uint.
689 bool is_atomic_uint() const
691 return base_type
== GLSL_TYPE_ATOMIC_UINT
;
695 * Return the amount of atomic counter storage required for a type.
697 unsigned atomic_size() const
699 if (is_atomic_uint())
700 return ATOMIC_COUNTER_SIZE
;
702 return length
* fields
.array
->atomic_size();
708 * Return whether a type contains any atomic counters.
710 bool contains_atomic() const
712 return atomic_size() > 0;
716 * Return whether a type contains any opaque types.
718 bool contains_opaque() const;
721 * Query the full type of a matrix row
724 * If the type is not a matrix, \c glsl_type::error_type is returned.
725 * Otherwise a type matching the rows of the matrix is returned.
727 const glsl_type
*row_type() const
730 ? get_instance(base_type
, matrix_columns
, 1)
735 * Query the full type of a matrix column
738 * If the type is not a matrix, \c glsl_type::error_type is returned.
739 * Otherwise a type matching the columns of the matrix is returned.
741 const glsl_type
*column_type() const
744 ? get_instance(base_type
, vector_elements
, 1)
749 * Get the type of a structure field
752 * Pointer to the type of the named field. If the type is not a structure
753 * or the named field does not exist, \c glsl_type::error_type is returned.
755 const glsl_type
*field_type(const char *name
) const;
758 * Get the location of a field within a record type
760 int field_index(const char *name
) const;
763 * Query the number of elements in an array type
766 * The number of elements in the array for array types or -1 for non-array
767 * types. If the number of elements in the array has not yet been declared,
770 int array_size() const
772 return is_array() ? length
: -1;
776 * Query whether the array size for all dimensions has been declared.
778 bool is_unsized_array() const
780 return is_array() && length
== 0;
784 * Return the number of coordinate components needed for this
785 * sampler or image type.
787 * This is based purely on the sampler's dimensionality. For example, this
788 * returns 1 for sampler1D, and 3 for sampler2DArray.
790 * Note that this is often different than actual coordinate type used in
791 * a texturing built-in function, since those pack additional values (such
792 * as the shadow comparator or projector) into the coordinate type.
794 int coordinate_components() const;
797 * Compare a record type against another record type.
799 * This is useful for matching record types declared across shader stages.
800 * The option to not match locations is to deal with places where the
801 * same struct is defined in a block which has a location set on it.
803 bool record_compare(const glsl_type
*b
, bool match_locations
= true) const;
806 * Get the type interface packing.
808 enum glsl_interface_packing
get_interface_packing() const
810 return (enum glsl_interface_packing
)interface_packing
;
814 * Check if the type interface is row major
816 bool get_interface_row_major() const
818 return (bool) interface_row_major
;
823 static mtx_t mem_mutex
;
824 static mtx_t hash_mutex
;
827 * ralloc context for all glsl_type allocations
829 * Set on the first call to \c glsl_type::new.
831 static void *mem_ctx
;
833 void init_ralloc_type_ctx(void);
835 /** Constructor for vector and matrix types */
836 glsl_type(GLenum gl_type
,
837 glsl_base_type base_type
, unsigned vector_elements
,
838 unsigned matrix_columns
, const char *name
);
840 /** Constructor for sampler or image types */
841 glsl_type(GLenum gl_type
, glsl_base_type base_type
,
842 enum glsl_sampler_dim dim
, bool shadow
, bool array
,
843 unsigned type
, const char *name
);
845 /** Constructor for record types */
846 glsl_type(const glsl_struct_field
*fields
, unsigned num_fields
,
849 /** Constructor for interface types */
850 glsl_type(const glsl_struct_field
*fields
, unsigned num_fields
,
851 enum glsl_interface_packing packing
,
852 bool row_major
, const char *name
);
854 /** Constructor for interface types */
855 glsl_type(const glsl_type
*return_type
,
856 const glsl_function_param
*params
, unsigned num_params
);
858 /** Constructor for array types */
859 glsl_type(const glsl_type
*array
, unsigned length
);
861 /** Constructor for subroutine types */
862 glsl_type(const char *name
);
864 /** Hash table containing the known array types. */
865 static struct hash_table
*array_types
;
867 /** Hash table containing the known record types. */
868 static struct hash_table
*record_types
;
870 /** Hash table containing the known interface types. */
871 static struct hash_table
*interface_types
;
873 /** Hash table containing the known subroutine types. */
874 static struct hash_table
*subroutine_types
;
876 /** Hash table containing the known function types. */
877 static struct hash_table
*function_types
;
879 static bool record_key_compare(const void *a
, const void *b
);
880 static unsigned record_key_hash(const void *key
);
883 * \name Built-in type flyweights
887 #define DECL_TYPE(NAME, ...) static const glsl_type _##NAME##_type;
889 #define STRUCT_TYPE(NAME) static const glsl_type _struct_##NAME##_type;
890 #include "compiler/builtin_type_macros.h"
894 * \name Friend functions.
896 * These functions are friends because they must have C linkage and the
897 * need to call various private methods or access various private static
901 friend void _mesa_glsl_initialize_types(struct _mesa_glsl_parse_state
*);
902 friend void _mesa_glsl_release_types(void);
908 #endif /* __cplusplus */
910 struct glsl_struct_field
{
911 const struct glsl_type
*type
;
915 * For interface blocks, gl_varying_slot corresponding to the input/output
916 * if this is a built-in input/output (i.e. a member of the built-in
917 * gl_PerVertex interface block); -1 otherwise.
919 * Ignored for structs.
924 * For interface blocks, members may have an explicit byte offset
925 * specified; -1 otherwise. Also used for xfb_offset layout qualifier.
927 * Unless used for xfb_offset this field is ignored for structs.
932 * For interface blocks, members may define a transform feedback buffer;
938 * For interface blocks, members may define a transform feedback stride;
944 * For interface blocks, the interpolation mode (as in
945 * ir_variable::interpolation). 0 otherwise.
947 unsigned interpolation
:2;
950 * For interface blocks, 1 if this variable uses centroid interpolation (as
951 * in ir_variable::centroid). 0 otherwise.
956 * For interface blocks, 1 if this variable uses sample interpolation (as
957 * in ir_variable::sample). 0 otherwise.
962 * Layout of the matrix. Uses glsl_matrix_layout values.
964 unsigned matrix_layout
:2;
967 * For interface blocks, 1 if this variable is a per-patch input or output
968 * (as in ir_variable::patch). 0 otherwise.
973 * Precision qualifier
975 unsigned precision
:2;
978 * Memory qualifiers, applicable to buffer variables defined in shader
979 * storage buffer objects (SSBOs)
981 unsigned memory_read_only
:1;
982 unsigned memory_write_only
:1;
983 unsigned memory_coherent
:1;
984 unsigned memory_volatile
:1;
985 unsigned memory_restrict
:1;
988 * Layout format, applicable to image variables only.
990 unsigned image_format
:16;
993 * Any of the xfb_* qualifiers trigger the shader to be in transform
994 * feedback mode so we need to keep track of whether the buffer was
995 * explicitly set or if its just been assigned the default global value.
997 unsigned explicit_xfb_buffer
:1;
999 unsigned implicit_sized_array
:1;
1001 glsl_struct_field(const struct glsl_type
*_type
, const char *_name
)
1002 : type(_type
), name(_name
), location(-1), offset(0), xfb_buffer(0),
1003 xfb_stride(0), interpolation(0), centroid(0),
1004 sample(0), matrix_layout(GLSL_MATRIX_LAYOUT_INHERITED
), patch(0),
1005 precision(GLSL_PRECISION_NONE
), memory_read_only(0),
1006 memory_write_only(0), memory_coherent(0), memory_volatile(0),
1007 memory_restrict(0), image_format(0), explicit_xfb_buffer(0),
1008 implicit_sized_array(0)
1020 struct glsl_function_param
{
1021 const struct glsl_type
*type
;
1027 static inline unsigned int
1028 glsl_align(unsigned int a
, unsigned int align
)
1030 return (a
+ align
- 1) / align
* align
;
1033 #endif /* GLSL_TYPES_H */