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);
57 GLSL_TYPE_ATOMIC_UINT
,
67 enum glsl_sampler_dim
{
68 GLSL_SAMPLER_DIM_1D
= 0,
71 GLSL_SAMPLER_DIM_CUBE
,
72 GLSL_SAMPLER_DIM_RECT
,
74 GLSL_SAMPLER_DIM_EXTERNAL
,
78 enum glsl_interface_packing
{
79 GLSL_INTERFACE_PACKING_STD140
,
80 GLSL_INTERFACE_PACKING_SHARED
,
81 GLSL_INTERFACE_PACKING_PACKED
,
82 GLSL_INTERFACE_PACKING_STD430
85 enum glsl_matrix_layout
{
87 * The layout of the matrix is inherited from the object containing the
88 * matrix (the top level structure or the uniform block).
90 GLSL_MATRIX_LAYOUT_INHERITED
,
93 * Explicit column-major layout
95 * If a uniform block doesn't have an explicit layout set, it will default
98 GLSL_MATRIX_LAYOUT_COLUMN_MAJOR
,
103 GLSL_MATRIX_LAYOUT_ROW_MAJOR
107 GLSL_PRECISION_NONE
= 0,
109 GLSL_PRECISION_MEDIUM
,
115 #include "util/ralloc.h"
116 #include "main/mtypes.h" /* for gl_texture_index, C++'s enum rules are broken */
120 glsl_base_type base_type
;
122 unsigned sampler_dimensionality
:3; /**< \see glsl_sampler_dim */
123 unsigned sampler_shadow
:1;
124 unsigned sampler_array
:1;
125 unsigned sampled_type
:2; /**< Type of data returned using this
126 * sampler or image. Only \c
127 * GLSL_TYPE_FLOAT, \c GLSL_TYPE_INT,
128 * and \c GLSL_TYPE_UINT are valid.
130 unsigned interface_packing
:2;
132 /* Callers of this ralloc-based new need not call delete. It's
133 * easier to just ralloc_free 'mem_ctx' (or any of its ancestors). */
134 static void* operator new(size_t size
)
136 mtx_lock(&glsl_type::mutex
);
138 /* mem_ctx should have been created by the static members */
139 assert(glsl_type::mem_ctx
!= NULL
);
143 type
= ralloc_size(glsl_type::mem_ctx
, size
);
144 assert(type
!= NULL
);
146 mtx_unlock(&glsl_type::mutex
);
151 /* If the user *does* call delete, that's OK, we will just
152 * ralloc_free in that case. */
153 static void operator delete(void *type
)
155 mtx_lock(&glsl_type::mutex
);
157 mtx_unlock(&glsl_type::mutex
);
161 * \name Vector and matrix element counts
163 * For scalars, each of these values will be 1. For non-numeric types
167 uint8_t vector_elements
; /**< 1, 2, 3, or 4 vector elements. */
168 uint8_t matrix_columns
; /**< 1, 2, 3, or 4 matrix columns. */
172 * For \c GLSL_TYPE_ARRAY, this is the length of the array. For
173 * \c GLSL_TYPE_STRUCT or \c GLSL_TYPE_INTERFACE, it is the number of
174 * elements in the structure and the number of values pointed to by
175 * \c fields.structure (below).
180 * Name of the data type
182 * Will never be \c NULL.
187 * Subtype of composite data types.
190 const struct glsl_type
*array
; /**< Type of array elements. */
191 struct glsl_function_param
*parameters
; /**< Parameters to function. */
192 struct glsl_struct_field
*structure
; /**< List of struct fields. */
196 * \name Pointers to various public type singletons
200 #define DECL_TYPE(NAME, ...) \
201 static const glsl_type *const NAME##_type;
203 #define STRUCT_TYPE(NAME) \
204 static const glsl_type *const struct_##NAME##_type;
205 #include "compiler/builtin_type_macros.h"
209 * Convenience accessors for vector types (shorter than get_instance()).
212 static const glsl_type
*vec(unsigned components
);
213 static const glsl_type
*dvec(unsigned components
);
214 static const glsl_type
*ivec(unsigned components
);
215 static const glsl_type
*uvec(unsigned components
);
216 static const glsl_type
*bvec(unsigned components
);
220 * For numeric and boolean derived types returns the basic scalar type
222 * If the type is a numeric or boolean scalar, vector, or matrix type,
223 * this function gets the scalar type of the individual components. For
224 * all other types, including arrays of numeric or boolean types, the
225 * error type is returned.
227 const glsl_type
*get_base_type() const;
230 * Get the basic scalar type which this type aggregates.
232 * If the type is a numeric or boolean scalar, vector, or matrix, or an
233 * array of any of those, this function gets the scalar type of the
234 * individual components. For structs and arrays of structs, this function
235 * returns the struct type. For samplers and arrays of samplers, this
236 * function returns the sampler type.
238 const glsl_type
*get_scalar_type() const;
241 * Get the instance of a built-in scalar, vector, or matrix type
243 static const glsl_type
*get_instance(unsigned base_type
, unsigned rows
,
247 * Get the instance of a sampler type
249 static const glsl_type
*get_sampler_instance(enum glsl_sampler_dim dim
,
252 glsl_base_type type
);
256 * Get the instance of an array type
258 static const glsl_type
*get_array_instance(const glsl_type
*base
,
262 * Get the instance of a record type
264 static const glsl_type
*get_record_instance(const glsl_struct_field
*fields
,
269 * Get the instance of an interface block type
271 static const glsl_type
*get_interface_instance(const glsl_struct_field
*fields
,
273 enum glsl_interface_packing packing
,
274 const char *block_name
);
277 * Get the instance of an subroutine type
279 static const glsl_type
*get_subroutine_instance(const char *subroutine_name
);
282 * Get the instance of a function type
284 static const glsl_type
*get_function_instance(const struct glsl_type
*return_type
,
285 const glsl_function_param
*parameters
,
286 unsigned num_params
);
289 * Get the type resulting from a multiplication of \p type_a * \p type_b
291 static const glsl_type
*get_mul_type(const glsl_type
*type_a
,
292 const glsl_type
*type_b
);
295 * Query the total number of scalars that make up a scalar, vector or matrix
297 unsigned components() const
299 return vector_elements
* matrix_columns
;
303 * Calculate the number of components slots required to hold this type
305 * This is used to determine how many uniform or varying locations a type
308 unsigned component_slots() const;
311 * Calculate offset between the base location of the struct in
312 * uniform storage and a struct member.
313 * For the initial call, length is the index of the member to find the
316 unsigned record_location_offset(unsigned length
) const;
319 * Calculate the number of unique values from glGetUniformLocation for the
320 * elements of the type.
322 * This is used to allocate slots in the UniformRemapTable, the amount of
323 * locations may not match with actual used storage space by the driver.
325 unsigned uniform_locations() const;
328 * Calculate the number of attribute slots required to hold this type
330 * This implements the language rules of GLSL 1.50 for counting the number
331 * of slots used by a vertex attribute. It also determines the number of
332 * varying slots the type will use up in the absence of varying packing
333 * (and thus, it can be used to measure the number of varying slots used by
334 * the varyings that are generated by lower_packed_varyings).
336 * For vertex shader attributes - doubles only take one slot.
337 * For inter-shader varyings - dvec3/dvec4 take two slots.
339 unsigned count_attribute_slots(bool vertex_input_slots
) const;
342 * Alignment in bytes of the start of this type in a std140 uniform
345 unsigned std140_base_alignment(bool row_major
) const;
347 /** Size in bytes of this type in a std140 uniform block.
349 * Note that this is not GL_UNIFORM_SIZE (which is the number of
350 * elements in the array)
352 unsigned std140_size(bool row_major
) const;
355 * Alignment in bytes of the start of this type in a std430 shader
358 unsigned std430_base_alignment(bool row_major
) const;
361 * Calculate array stride in bytes of this type in a std430 shader storage
364 unsigned std430_array_stride(bool row_major
) const;
367 * Size in bytes of this type in a std430 shader storage block.
369 * Note that this is not GL_BUFFER_SIZE
371 unsigned std430_size(bool row_major
) const;
374 * \brief Can this type be implicitly converted to another?
376 * \return True if the types are identical or if this type can be converted
377 * to \c desired according to Section 4.1.10 of the GLSL spec.
380 * From page 25 (31 of the pdf) of the GLSL 1.50 spec, Section 4.1.10
381 * Implicit Conversions:
383 * In some situations, an expression and its type will be implicitly
384 * converted to a different type. The following table shows all allowed
385 * implicit conversions:
387 * Type of expression | Can be implicitly converted to
388 * --------------------------------------------------
401 * There are no implicit array or structure conversions. For example,
402 * an array of int cannot be implicitly converted to an array of float.
403 * There are no implicit conversions between signed and unsigned
407 bool can_implicitly_convert_to(const glsl_type
*desired
,
408 _mesa_glsl_parse_state
*state
) const;
411 * Query whether or not a type is a scalar (non-vector and non-matrix).
413 bool is_scalar() const
415 return (vector_elements
== 1)
416 && (base_type
>= GLSL_TYPE_UINT
)
417 && (base_type
<= GLSL_TYPE_BOOL
);
421 * Query whether or not a type is a vector
423 bool is_vector() const
425 return (vector_elements
> 1)
426 && (matrix_columns
== 1)
427 && (base_type
>= GLSL_TYPE_UINT
)
428 && (base_type
<= GLSL_TYPE_BOOL
);
432 * Query whether or not a type is a matrix
434 bool is_matrix() const
436 /* GLSL only has float matrices. */
437 return (matrix_columns
> 1) && (base_type
== GLSL_TYPE_FLOAT
|| base_type
== GLSL_TYPE_DOUBLE
);
441 * Query whether or not a type is a non-array numeric type
443 bool is_numeric() const
445 return (base_type
>= GLSL_TYPE_UINT
) && (base_type
<= GLSL_TYPE_DOUBLE
);
449 * Query whether or not a type is an integral type
451 bool is_integer() const
453 return (base_type
== GLSL_TYPE_UINT
) || (base_type
== GLSL_TYPE_INT
);
457 * Query whether or not type is an integral type, or for struct and array
458 * types, contains an integral type.
460 bool contains_integer() const;
463 * Query whether or not type is a double type, or for struct and array
464 * types, contains a double type.
466 bool contains_double() const;
469 * Query whether or not a type is a float type
471 bool is_float() const
473 return base_type
== GLSL_TYPE_FLOAT
;
477 * Query whether or not a type is a double type
479 bool is_double() const
481 return base_type
== GLSL_TYPE_DOUBLE
;
485 * Query whether a double takes two slots.
487 bool is_dual_slot_double() const
489 return base_type
== GLSL_TYPE_DOUBLE
&& vector_elements
> 2;
493 * Query whether or not a type is a non-array boolean type
495 bool is_boolean() const
497 return base_type
== GLSL_TYPE_BOOL
;
501 * Query whether or not a type is a sampler
503 bool is_sampler() const
505 return base_type
== GLSL_TYPE_SAMPLER
;
509 * Query whether or not type is a sampler, or for struct and array
510 * types, contains a sampler.
512 bool contains_sampler() const;
515 * Get the Mesa texture target index for a sampler type.
517 gl_texture_index
sampler_index() const;
520 * Query whether or not type is an image, or for struct and array
521 * types, contains an image.
523 bool contains_image() const;
526 * Query whether or not a type is an image
528 bool is_image() const
530 return base_type
== GLSL_TYPE_IMAGE
;
534 * Query whether or not a type is an array
536 bool is_array() const
538 return base_type
== GLSL_TYPE_ARRAY
;
541 bool is_array_of_arrays() const
543 return is_array() && fields
.array
->is_array();
547 * Query whether or not a type is a record
549 bool is_record() const
551 return base_type
== GLSL_TYPE_STRUCT
;
555 * Query whether or not a type is an interface
557 bool is_interface() const
559 return base_type
== GLSL_TYPE_INTERFACE
;
563 * Query whether or not a type is the void type singleton.
567 return base_type
== GLSL_TYPE_VOID
;
571 * Query whether or not a type is the error type singleton.
573 bool is_error() const
575 return base_type
== GLSL_TYPE_ERROR
;
579 * Query if a type is unnamed/anonymous (named by the parser)
582 bool is_subroutine() const
584 return base_type
== GLSL_TYPE_SUBROUTINE
;
586 bool contains_subroutine() const;
588 bool is_anonymous() const
590 return !strncmp(name
, "#anon", 5);
594 * Get the type stripped of any arrays
597 * Pointer to the type of elements of the first non-array type for array
598 * types, or pointer to itself for non-array types.
600 const glsl_type
*without_array() const
602 const glsl_type
*t
= this;
604 while (t
->is_array())
611 * Return the total number of elements in an array including the elements
612 * in arrays of arrays.
614 unsigned arrays_of_arrays_size() const
619 unsigned size
= length
;
620 const glsl_type
*base_type
= fields
.array
;
622 while (base_type
->is_array()) {
623 size
= size
* base_type
->length
;
624 base_type
= base_type
->fields
.array
;
630 * Return the amount of atomic counter storage required for a type.
632 unsigned atomic_size() const
634 if (base_type
== GLSL_TYPE_ATOMIC_UINT
)
635 return ATOMIC_COUNTER_SIZE
;
637 return length
* fields
.array
->atomic_size();
643 * Return whether a type contains any atomic counters.
645 bool contains_atomic() const
647 return atomic_size() > 0;
651 * Return whether a type contains any opaque types.
653 bool contains_opaque() const;
656 * Query the full type of a matrix row
659 * If the type is not a matrix, \c glsl_type::error_type is returned.
660 * Otherwise a type matching the rows of the matrix is returned.
662 const glsl_type
*row_type() const
665 ? get_instance(base_type
, matrix_columns
, 1)
670 * Query the full type of a matrix column
673 * If the type is not a matrix, \c glsl_type::error_type is returned.
674 * Otherwise a type matching the columns of the matrix is returned.
676 const glsl_type
*column_type() const
679 ? get_instance(base_type
, vector_elements
, 1)
684 * Get the type of a structure field
687 * Pointer to the type of the named field. If the type is not a structure
688 * or the named field does not exist, \c glsl_type::error_type is returned.
690 const glsl_type
*field_type(const char *name
) const;
693 * Get the location of a field within a record type
695 int field_index(const char *name
) const;
698 * Query the number of elements in an array type
701 * The number of elements in the array for array types or -1 for non-array
702 * types. If the number of elements in the array has not yet been declared,
705 int array_size() const
707 return is_array() ? length
: -1;
711 * Query whether the array size for all dimensions has been declared.
713 bool is_unsized_array() const
715 return is_array() && length
== 0;
719 * Return the number of coordinate components needed for this
720 * sampler or image type.
722 * This is based purely on the sampler's dimensionality. For example, this
723 * returns 1 for sampler1D, and 3 for sampler2DArray.
725 * Note that this is often different than actual coordinate type used in
726 * a texturing built-in function, since those pack additional values (such
727 * as the shadow comparitor or projector) into the coordinate type.
729 int coordinate_components() const;
732 * Compare a record type against another record type.
734 * This is useful for matching record types declared across shader stages.
736 bool record_compare(const glsl_type
*b
) const;
743 * ralloc context for all glsl_type allocations
745 * Set on the first call to \c glsl_type::new.
747 static void *mem_ctx
;
749 void init_ralloc_type_ctx(void);
751 /** Constructor for vector and matrix types */
752 glsl_type(GLenum gl_type
,
753 glsl_base_type base_type
, unsigned vector_elements
,
754 unsigned matrix_columns
, const char *name
);
756 /** Constructor for sampler or image types */
757 glsl_type(GLenum gl_type
, glsl_base_type base_type
,
758 enum glsl_sampler_dim dim
, bool shadow
, bool array
,
759 unsigned type
, const char *name
);
761 /** Constructor for record types */
762 glsl_type(const glsl_struct_field
*fields
, unsigned num_fields
,
765 /** Constructor for interface types */
766 glsl_type(const glsl_struct_field
*fields
, unsigned num_fields
,
767 enum glsl_interface_packing packing
, const char *name
);
769 /** Constructor for interface types */
770 glsl_type(const glsl_type
*return_type
,
771 const glsl_function_param
*params
, unsigned num_params
);
773 /** Constructor for array types */
774 glsl_type(const glsl_type
*array
, unsigned length
);
776 /** Constructor for subroutine types */
777 glsl_type(const char *name
);
779 /** Hash table containing the known array types. */
780 static struct hash_table
*array_types
;
782 /** Hash table containing the known record types. */
783 static struct hash_table
*record_types
;
785 /** Hash table containing the known interface types. */
786 static struct hash_table
*interface_types
;
788 /** Hash table containing the known subroutine types. */
789 static struct hash_table
*subroutine_types
;
791 /** Hash table containing the known function types. */
792 static struct hash_table
*function_types
;
794 static bool record_key_compare(const void *a
, const void *b
);
795 static unsigned record_key_hash(const void *key
);
798 * \name Built-in type flyweights
802 #define DECL_TYPE(NAME, ...) static const glsl_type _##NAME##_type;
804 #define STRUCT_TYPE(NAME) static const glsl_type _struct_##NAME##_type;
805 #include "compiler/builtin_type_macros.h"
809 * \name Friend functions.
811 * These functions are friends because they must have C linkage and the
812 * need to call various private methods or access various private static
816 friend void _mesa_glsl_initialize_types(struct _mesa_glsl_parse_state
*);
817 friend void _mesa_glsl_release_types(void);
821 struct glsl_struct_field
{
822 const struct glsl_type
*type
;
826 * For interface blocks, gl_varying_slot corresponding to the input/output
827 * if this is a built-in input/output (i.e. a member of the built-in
828 * gl_PerVertex interface block); -1 otherwise.
830 * Ignored for structs.
835 * For interface blocks, the interpolation mode (as in
836 * ir_variable::interpolation). 0 otherwise.
838 unsigned interpolation
:2;
841 * For interface blocks, 1 if this variable uses centroid interpolation (as
842 * in ir_variable::centroid). 0 otherwise.
847 * For interface blocks, 1 if this variable uses sample interpolation (as
848 * in ir_variable::sample). 0 otherwise.
853 * Layout of the matrix. Uses glsl_matrix_layout values.
855 unsigned matrix_layout
:2;
858 * For interface blocks, 1 if this variable is a per-patch input or output
859 * (as in ir_variable::patch). 0 otherwise.
864 * Precision qualifier
866 unsigned precision
:2;
869 * Image qualifiers, applicable to buffer variables defined in shader
870 * storage buffer objects (SSBOs)
872 unsigned image_read_only
:1;
873 unsigned image_write_only
:1;
874 unsigned image_coherent
:1;
875 unsigned image_volatile
:1;
876 unsigned image_restrict
:1;
878 glsl_struct_field(const struct glsl_type
*_type
, const char *_name
)
879 : type(_type
), name(_name
), location(-1), interpolation(0), centroid(0),
880 sample(0), matrix_layout(GLSL_MATRIX_LAYOUT_INHERITED
), patch(0),
881 precision(GLSL_PRECISION_NONE
), image_read_only(0), image_write_only(0),
882 image_coherent(0), image_volatile(0), image_restrict(0)
893 struct glsl_function_param
{
894 const struct glsl_type
*type
;
900 static inline unsigned int
901 glsl_align(unsigned int a
, unsigned int align
)
903 return (a
+ align
- 1) / align
* align
;
908 #endif /* __cplusplus */
910 #endif /* GLSL_TYPES_H */