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.
36 struct _mesa_glsl_parse_state
;
37 struct glsl_symbol_table
;
40 _mesa_glsl_initialize_types(struct _mesa_glsl_parse_state
*state
);
43 _mesa_glsl_release_types(void);
50 /* Note: GLSL_TYPE_UINT, GLSL_TYPE_INT, and GLSL_TYPE_FLOAT must be 0, 1,
51 * and 2 so that they will fit in the 2 bits of glsl_type::sampled_type.
60 GLSL_TYPE_ATOMIC_UINT
,
70 static inline bool glsl_base_type_is_64bit(enum glsl_base_type type
)
72 return type
== GLSL_TYPE_DOUBLE
;
75 enum glsl_sampler_dim
{
76 GLSL_SAMPLER_DIM_1D
= 0,
79 GLSL_SAMPLER_DIM_CUBE
,
80 GLSL_SAMPLER_DIM_RECT
,
82 GLSL_SAMPLER_DIM_EXTERNAL
,
86 enum glsl_interface_packing
{
87 GLSL_INTERFACE_PACKING_STD140
,
88 GLSL_INTERFACE_PACKING_SHARED
,
89 GLSL_INTERFACE_PACKING_PACKED
,
90 GLSL_INTERFACE_PACKING_STD430
93 enum glsl_matrix_layout
{
95 * The layout of the matrix is inherited from the object containing the
96 * matrix (the top level structure or the uniform block).
98 GLSL_MATRIX_LAYOUT_INHERITED
,
101 * Explicit column-major layout
103 * If a uniform block doesn't have an explicit layout set, it will default
106 GLSL_MATRIX_LAYOUT_COLUMN_MAJOR
,
111 GLSL_MATRIX_LAYOUT_ROW_MAJOR
115 GLSL_PRECISION_NONE
= 0,
117 GLSL_PRECISION_MEDIUM
,
123 #include "util/ralloc.h"
124 #include "main/mtypes.h" /* for gl_texture_index, C++'s enum rules are broken */
128 glsl_base_type base_type
;
130 unsigned sampler_dimensionality
:3; /**< \see glsl_sampler_dim */
131 unsigned sampler_shadow
:1;
132 unsigned sampler_array
:1;
133 unsigned sampled_type
:2; /**< Type of data returned using this
134 * sampler or image. Only \c
135 * GLSL_TYPE_FLOAT, \c GLSL_TYPE_INT,
136 * and \c GLSL_TYPE_UINT are valid.
138 unsigned interface_packing
:2;
140 /* Callers of this ralloc-based new need not call delete. It's
141 * easier to just ralloc_free 'mem_ctx' (or any of its ancestors). */
142 static void* operator new(size_t size
)
144 mtx_lock(&glsl_type::mutex
);
146 /* mem_ctx should have been created by the static members */
147 assert(glsl_type::mem_ctx
!= NULL
);
151 type
= ralloc_size(glsl_type::mem_ctx
, size
);
152 assert(type
!= NULL
);
154 mtx_unlock(&glsl_type::mutex
);
159 /* If the user *does* call delete, that's OK, we will just
160 * ralloc_free in that case. */
161 static void operator delete(void *type
)
163 mtx_lock(&glsl_type::mutex
);
165 mtx_unlock(&glsl_type::mutex
);
169 * \name Vector and matrix element counts
171 * For scalars, each of these values will be 1. For non-numeric types
175 uint8_t vector_elements
; /**< 1, 2, 3, or 4 vector elements. */
176 uint8_t matrix_columns
; /**< 1, 2, 3, or 4 matrix columns. */
180 * For \c GLSL_TYPE_ARRAY, this is the length of the array. For
181 * \c GLSL_TYPE_STRUCT or \c GLSL_TYPE_INTERFACE, it is the number of
182 * elements in the structure and the number of values pointed to by
183 * \c fields.structure (below).
188 * Name of the data type
190 * Will never be \c NULL.
195 * Subtype of composite data types.
198 const struct glsl_type
*array
; /**< Type of array elements. */
199 struct glsl_function_param
*parameters
; /**< Parameters to function. */
200 struct glsl_struct_field
*structure
; /**< List of struct fields. */
204 * \name Pointers to various public type singletons
208 #define DECL_TYPE(NAME, ...) \
209 static const glsl_type *const NAME##_type;
211 #define STRUCT_TYPE(NAME) \
212 static const glsl_type *const struct_##NAME##_type;
213 #include "compiler/builtin_type_macros.h"
217 * Convenience accessors for vector types (shorter than get_instance()).
220 static const glsl_type
*vec(unsigned components
);
221 static const glsl_type
*dvec(unsigned components
);
222 static const glsl_type
*ivec(unsigned components
);
223 static const glsl_type
*uvec(unsigned components
);
224 static const glsl_type
*bvec(unsigned components
);
228 * For numeric and boolean derived types returns the basic scalar type
230 * If the type is a numeric or boolean scalar, vector, or matrix type,
231 * this function gets the scalar type of the individual components. For
232 * all other types, including arrays of numeric or boolean types, the
233 * error type is returned.
235 const glsl_type
*get_base_type() const;
238 * Get the basic scalar type which this type aggregates.
240 * If the type is a numeric or boolean scalar, vector, or matrix, or an
241 * array of any of those, this function gets the scalar type of the
242 * individual components. For structs and arrays of structs, this function
243 * returns the struct type. For samplers and arrays of samplers, this
244 * function returns the sampler type.
246 const glsl_type
*get_scalar_type() const;
249 * Get the instance of a built-in scalar, vector, or matrix type
251 static const glsl_type
*get_instance(unsigned base_type
, unsigned rows
,
255 * Get the instance of a sampler type
257 static const glsl_type
*get_sampler_instance(enum glsl_sampler_dim dim
,
260 glsl_base_type type
);
262 static const glsl_type
*get_image_instance(enum glsl_sampler_dim dim
,
263 bool array
, glsl_base_type type
);
266 * Get the instance of an array type
268 static const glsl_type
*get_array_instance(const glsl_type
*base
,
272 * Get the instance of a record type
274 static const glsl_type
*get_record_instance(const glsl_struct_field
*fields
,
279 * Get the instance of an interface block type
281 static const glsl_type
*get_interface_instance(const glsl_struct_field
*fields
,
283 enum glsl_interface_packing packing
,
284 const char *block_name
);
287 * Get the instance of an subroutine type
289 static const glsl_type
*get_subroutine_instance(const char *subroutine_name
);
292 * Get the instance of a function type
294 static const glsl_type
*get_function_instance(const struct glsl_type
*return_type
,
295 const glsl_function_param
*parameters
,
296 unsigned num_params
);
299 * Get the type resulting from a multiplication of \p type_a * \p type_b
301 static const glsl_type
*get_mul_type(const glsl_type
*type_a
,
302 const glsl_type
*type_b
);
305 * Query the total number of scalars that make up a scalar, vector or matrix
307 unsigned components() const
309 return vector_elements
* matrix_columns
;
313 * Calculate the number of components slots required to hold this type
315 * This is used to determine how many uniform or varying locations a type
318 unsigned component_slots() const;
321 * Calculate offset between the base location of the struct in
322 * uniform storage and a struct member.
323 * For the initial call, length is the index of the member to find the
326 unsigned record_location_offset(unsigned length
) const;
329 * Calculate the number of unique values from glGetUniformLocation for the
330 * elements of the type.
332 * This is used to allocate slots in the UniformRemapTable, the amount of
333 * locations may not match with actual used storage space by the driver.
335 unsigned uniform_locations() const;
338 * Used to count the number of varyings contained in the type ignoring
339 * innermost array elements.
341 unsigned varying_count() const;
344 * Calculate the number of attribute slots required to hold this type
346 * This implements the language rules of GLSL 1.50 for counting the number
347 * of slots used by a vertex attribute. It also determines the number of
348 * varying slots the type will use up in the absence of varying packing
349 * (and thus, it can be used to measure the number of varying slots used by
350 * the varyings that are generated by lower_packed_varyings).
352 * For vertex shader attributes - doubles only take one slot.
353 * For inter-shader varyings - dvec3/dvec4 take two slots.
355 unsigned count_attribute_slots(bool is_vertex_input
) const;
358 * Alignment in bytes of the start of this type in a std140 uniform
361 unsigned std140_base_alignment(bool row_major
) const;
363 /** Size in bytes of this type in a std140 uniform block.
365 * Note that this is not GL_UNIFORM_SIZE (which is the number of
366 * elements in the array)
368 unsigned std140_size(bool row_major
) const;
371 * Alignment in bytes of the start of this type in a std430 shader
374 unsigned std430_base_alignment(bool row_major
) const;
377 * Calculate array stride in bytes of this type in a std430 shader storage
380 unsigned std430_array_stride(bool row_major
) const;
383 * Size in bytes of this type in a std430 shader storage block.
385 * Note that this is not GL_BUFFER_SIZE
387 unsigned std430_size(bool row_major
) const;
390 * \brief Can this type be implicitly converted to another?
392 * \return True if the types are identical or if this type can be converted
393 * to \c desired according to Section 4.1.10 of the GLSL spec.
396 * From page 25 (31 of the pdf) of the GLSL 1.50 spec, Section 4.1.10
397 * Implicit Conversions:
399 * In some situations, an expression and its type will be implicitly
400 * converted to a different type. The following table shows all allowed
401 * implicit conversions:
403 * Type of expression | Can be implicitly converted to
404 * --------------------------------------------------
417 * There are no implicit array or structure conversions. For example,
418 * an array of int cannot be implicitly converted to an array of float.
419 * There are no implicit conversions between signed and unsigned
423 bool can_implicitly_convert_to(const glsl_type
*desired
,
424 _mesa_glsl_parse_state
*state
) const;
427 * Query whether or not a type is a scalar (non-vector and non-matrix).
429 bool is_scalar() const
431 return (vector_elements
== 1)
432 && (base_type
>= GLSL_TYPE_UINT
)
433 && (base_type
<= GLSL_TYPE_BOOL
);
437 * Query whether or not a type is a vector
439 bool is_vector() const
441 return (vector_elements
> 1)
442 && (matrix_columns
== 1)
443 && (base_type
>= GLSL_TYPE_UINT
)
444 && (base_type
<= GLSL_TYPE_BOOL
);
448 * Query whether or not a type is a matrix
450 bool is_matrix() const
452 /* GLSL only has float matrices. */
453 return (matrix_columns
> 1) && (base_type
== GLSL_TYPE_FLOAT
|| base_type
== GLSL_TYPE_DOUBLE
);
457 * Query whether or not a type is a non-array numeric type
459 bool is_numeric() const
461 return (base_type
>= GLSL_TYPE_UINT
) && (base_type
<= GLSL_TYPE_DOUBLE
);
465 * Query whether or not a type is an integral type
467 bool is_integer() const
469 return (base_type
== GLSL_TYPE_UINT
) || (base_type
== GLSL_TYPE_INT
);
473 * Query whether or not type is an integral type, or for struct and array
474 * types, contains an integral type.
476 bool contains_integer() const;
479 * Query whether or not type is a double type, or for struct and array
480 * types, contains a double type.
482 bool contains_double() const;
485 * Query whether or not a type is a float type
487 bool is_float() const
489 return base_type
== GLSL_TYPE_FLOAT
;
493 * Query whether or not a type is a double type
495 bool is_double() const
497 return base_type
== GLSL_TYPE_DOUBLE
;
501 * Query whether a 64-bit type takes two slots.
503 bool is_dual_slot() const
505 return is_64bit() && vector_elements
> 2;
509 * Query whether or not a type is 64-bit
511 bool is_64bit() const
513 return glsl_base_type_is_64bit(base_type
);
517 * Query whether or not a type is a non-array boolean type
519 bool is_boolean() const
521 return base_type
== GLSL_TYPE_BOOL
;
525 * Query whether or not a type is a sampler
527 bool is_sampler() const
529 return base_type
== GLSL_TYPE_SAMPLER
;
533 * Query whether or not type is a sampler, or for struct and array
534 * types, contains a sampler.
536 bool contains_sampler() const;
539 * Get the Mesa texture target index for a sampler type.
541 gl_texture_index
sampler_index() const;
544 * Query whether or not type is an image, or for struct and array
545 * types, contains an image.
547 bool contains_image() const;
550 * Query whether or not a type is an image
552 bool is_image() const
554 return base_type
== GLSL_TYPE_IMAGE
;
558 * Query whether or not a type is an array
560 bool is_array() const
562 return base_type
== GLSL_TYPE_ARRAY
;
565 bool is_array_of_arrays() const
567 return is_array() && fields
.array
->is_array();
571 * Query whether or not a type is a record
573 bool is_record() const
575 return base_type
== GLSL_TYPE_STRUCT
;
579 * Query whether or not a type is an interface
581 bool is_interface() const
583 return base_type
== GLSL_TYPE_INTERFACE
;
587 * Query whether or not a type is the void type singleton.
591 return base_type
== GLSL_TYPE_VOID
;
595 * Query whether or not a type is the error type singleton.
597 bool is_error() const
599 return base_type
== GLSL_TYPE_ERROR
;
603 * Query if a type is unnamed/anonymous (named by the parser)
606 bool is_subroutine() const
608 return base_type
== GLSL_TYPE_SUBROUTINE
;
610 bool contains_subroutine() const;
612 bool is_anonymous() const
614 return !strncmp(name
, "#anon", 5);
618 * Get the type stripped of any arrays
621 * Pointer to the type of elements of the first non-array type for array
622 * types, or pointer to itself for non-array types.
624 const glsl_type
*without_array() const
626 const glsl_type
*t
= this;
628 while (t
->is_array())
635 * Return the total number of elements in an array including the elements
636 * in arrays of arrays.
638 unsigned arrays_of_arrays_size() const
643 unsigned size
= length
;
644 const glsl_type
*base_type
= fields
.array
;
646 while (base_type
->is_array()) {
647 size
= size
* base_type
->length
;
648 base_type
= base_type
->fields
.array
;
654 * Return the amount of atomic counter storage required for a type.
656 unsigned atomic_size() const
658 if (base_type
== GLSL_TYPE_ATOMIC_UINT
)
659 return ATOMIC_COUNTER_SIZE
;
661 return length
* fields
.array
->atomic_size();
667 * Return whether a type contains any atomic counters.
669 bool contains_atomic() const
671 return atomic_size() > 0;
675 * Return whether a type contains any opaque types.
677 bool contains_opaque() const;
680 * Query the full type of a matrix row
683 * If the type is not a matrix, \c glsl_type::error_type is returned.
684 * Otherwise a type matching the rows of the matrix is returned.
686 const glsl_type
*row_type() const
689 ? get_instance(base_type
, matrix_columns
, 1)
694 * Query the full type of a matrix column
697 * If the type is not a matrix, \c glsl_type::error_type is returned.
698 * Otherwise a type matching the columns of the matrix is returned.
700 const glsl_type
*column_type() const
703 ? get_instance(base_type
, vector_elements
, 1)
708 * Get the type of a structure field
711 * Pointer to the type of the named field. If the type is not a structure
712 * or the named field does not exist, \c glsl_type::error_type is returned.
714 const glsl_type
*field_type(const char *name
) const;
717 * Get the location of a field within a record type
719 int field_index(const char *name
) const;
722 * Query the number of elements in an array type
725 * The number of elements in the array for array types or -1 for non-array
726 * types. If the number of elements in the array has not yet been declared,
729 int array_size() const
731 return is_array() ? length
: -1;
735 * Query whether the array size for all dimensions has been declared.
737 bool is_unsized_array() const
739 return is_array() && length
== 0;
743 * Return the number of coordinate components needed for this
744 * sampler or image type.
746 * This is based purely on the sampler's dimensionality. For example, this
747 * returns 1 for sampler1D, and 3 for sampler2DArray.
749 * Note that this is often different than actual coordinate type used in
750 * a texturing built-in function, since those pack additional values (such
751 * as the shadow comparitor or projector) into the coordinate type.
753 int coordinate_components() const;
756 * Compare a record type against another record type.
758 * This is useful for matching record types declared across shader stages.
759 * The option to not match locations is to deal with places where the
760 * same struct is defined in a block which has a location set on it.
762 bool record_compare(const glsl_type
*b
, bool match_locations
= true) const;
765 * Get the type interface packing.
767 enum glsl_interface_packing
get_interface_packing() const
769 return (enum glsl_interface_packing
)interface_packing
;
777 * ralloc context for all glsl_type allocations
779 * Set on the first call to \c glsl_type::new.
781 static void *mem_ctx
;
783 void init_ralloc_type_ctx(void);
785 /** Constructor for vector and matrix types */
786 glsl_type(GLenum gl_type
,
787 glsl_base_type base_type
, unsigned vector_elements
,
788 unsigned matrix_columns
, const char *name
);
790 /** Constructor for sampler or image types */
791 glsl_type(GLenum gl_type
, glsl_base_type base_type
,
792 enum glsl_sampler_dim dim
, bool shadow
, bool array
,
793 unsigned type
, const char *name
);
795 /** Constructor for record types */
796 glsl_type(const glsl_struct_field
*fields
, unsigned num_fields
,
799 /** Constructor for interface types */
800 glsl_type(const glsl_struct_field
*fields
, unsigned num_fields
,
801 enum glsl_interface_packing packing
, const char *name
);
803 /** Constructor for interface types */
804 glsl_type(const glsl_type
*return_type
,
805 const glsl_function_param
*params
, unsigned num_params
);
807 /** Constructor for array types */
808 glsl_type(const glsl_type
*array
, unsigned length
);
810 /** Constructor for subroutine types */
811 glsl_type(const char *name
);
813 /** Hash table containing the known array types. */
814 static struct hash_table
*array_types
;
816 /** Hash table containing the known record types. */
817 static struct hash_table
*record_types
;
819 /** Hash table containing the known interface types. */
820 static struct hash_table
*interface_types
;
822 /** Hash table containing the known subroutine types. */
823 static struct hash_table
*subroutine_types
;
825 /** Hash table containing the known function types. */
826 static struct hash_table
*function_types
;
828 static bool record_key_compare(const void *a
, const void *b
);
829 static unsigned record_key_hash(const void *key
);
832 * \name Built-in type flyweights
836 #define DECL_TYPE(NAME, ...) static const glsl_type _##NAME##_type;
838 #define STRUCT_TYPE(NAME) static const glsl_type _struct_##NAME##_type;
839 #include "compiler/builtin_type_macros.h"
843 * \name Friend functions.
845 * These functions are friends because they must have C linkage and the
846 * need to call various private methods or access various private static
850 friend void _mesa_glsl_initialize_types(struct _mesa_glsl_parse_state
*);
851 friend void _mesa_glsl_release_types(void);
857 #endif /* __cplusplus */
859 struct glsl_struct_field
{
860 const struct glsl_type
*type
;
864 * For interface blocks, gl_varying_slot corresponding to the input/output
865 * if this is a built-in input/output (i.e. a member of the built-in
866 * gl_PerVertex interface block); -1 otherwise.
868 * Ignored for structs.
873 * For interface blocks, members may have an explicit byte offset
874 * specified; -1 otherwise. Also used for xfb_offset layout qualifier.
876 * Unless used for xfb_offset this field is ignored for structs.
881 * For interface blocks, members may define a transform feedback buffer;
887 * For interface blocks, members may define a transform feedback stride;
893 * For interface blocks, the interpolation mode (as in
894 * ir_variable::interpolation). 0 otherwise.
896 unsigned interpolation
:2;
899 * For interface blocks, 1 if this variable uses centroid interpolation (as
900 * in ir_variable::centroid). 0 otherwise.
905 * For interface blocks, 1 if this variable uses sample interpolation (as
906 * in ir_variable::sample). 0 otherwise.
911 * Layout of the matrix. Uses glsl_matrix_layout values.
913 unsigned matrix_layout
:2;
916 * For interface blocks, 1 if this variable is a per-patch input or output
917 * (as in ir_variable::patch). 0 otherwise.
922 * Precision qualifier
924 unsigned precision
:2;
927 * Image qualifiers, applicable to buffer variables defined in shader
928 * storage buffer objects (SSBOs)
930 unsigned image_read_only
:1;
931 unsigned image_write_only
:1;
932 unsigned image_coherent
:1;
933 unsigned image_volatile
:1;
934 unsigned image_restrict
:1;
937 * Any of the xfb_* qualifiers trigger the shader to be in transform
938 * feedback mode so we need to keep track of whether the buffer was
939 * explicitly set or if its just been assigned the default global value.
941 unsigned explicit_xfb_buffer
:1;
943 unsigned implicit_sized_array
:1;
945 glsl_struct_field(const struct glsl_type
*_type
, const char *_name
)
946 : type(_type
), name(_name
), location(-1), interpolation(0), centroid(0),
947 sample(0), matrix_layout(GLSL_MATRIX_LAYOUT_INHERITED
), patch(0),
948 precision(GLSL_PRECISION_NONE
), image_read_only(0), image_write_only(0),
949 image_coherent(0), image_volatile(0), image_restrict(0)
961 struct glsl_function_param
{
962 const struct glsl_type
*type
;
968 static inline unsigned int
969 glsl_align(unsigned int a
, unsigned int align
)
971 return (a
+ align
- 1) / align
* align
;
974 #endif /* GLSL_TYPES_H */