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.
31 #include "shader_enums.h"
32 #include "c11/threads.h"
33 #include "util/blob.h"
34 #include "util/macros.h"
37 #include "main/config.h"
46 struct _mesa_glsl_parse_state
;
47 struct glsl_symbol_table
;
50 glsl_type_singleton_init_or_ref();
53 glsl_type_singleton_decref();
56 _mesa_glsl_initialize_types(struct _mesa_glsl_parse_state
*state
);
58 void encode_type_to_blob(struct blob
*blob
, const struct glsl_type
*type
);
60 const struct glsl_type
*decode_type_from_blob(struct blob_reader
*blob
);
66 typedef void (*glsl_type_size_align_func
)(const struct glsl_type
*type
,
67 unsigned *size
, unsigned *align
);
70 /* Note: GLSL_TYPE_UINT, GLSL_TYPE_INT, and GLSL_TYPE_FLOAT must be 0, 1,
71 * and 2 so that they will fit in the 2 bits of glsl_type::sampled_type.
87 GLSL_TYPE_ATOMIC_UINT
,
97 /* Return the bit size of a type. Note that this differs from
98 * glsl_get_bit_size in that it returns 32 bits for bools, whereas at
99 * the NIR level we would want to return 1 bit for bools.
101 static unsigned glsl_base_type_bit_size(enum glsl_base_type type
)
107 case GLSL_TYPE_FLOAT
: /* TODO handle mediump */
108 case GLSL_TYPE_SUBROUTINE
:
111 case GLSL_TYPE_FLOAT16
:
112 case GLSL_TYPE_UINT16
:
113 case GLSL_TYPE_INT16
:
116 case GLSL_TYPE_UINT8
:
120 case GLSL_TYPE_DOUBLE
:
121 case GLSL_TYPE_INT64
:
122 case GLSL_TYPE_UINT64
:
123 case GLSL_TYPE_IMAGE
:
124 case GLSL_TYPE_SAMPLER
:
128 /* For GLSL_TYPE_STRUCT etc, it should be ok to return 0. This usually
129 * happens when calling this method through is_64bit and is_16bit
138 static inline bool glsl_base_type_is_16bit(enum glsl_base_type type
)
140 return glsl_base_type_bit_size(type
) == 16;
143 static inline bool glsl_base_type_is_64bit(enum glsl_base_type type
)
145 return glsl_base_type_bit_size(type
) == 64;
148 static inline bool glsl_base_type_is_integer(enum glsl_base_type type
)
150 return type
== GLSL_TYPE_UINT8
||
151 type
== GLSL_TYPE_INT8
||
152 type
== GLSL_TYPE_UINT16
||
153 type
== GLSL_TYPE_INT16
||
154 type
== GLSL_TYPE_UINT
||
155 type
== GLSL_TYPE_INT
||
156 type
== GLSL_TYPE_UINT64
||
157 type
== GLSL_TYPE_INT64
||
158 type
== GLSL_TYPE_BOOL
||
159 type
== GLSL_TYPE_SAMPLER
||
160 type
== GLSL_TYPE_IMAGE
;
163 static inline unsigned int
164 glsl_base_type_get_bit_size(const enum glsl_base_type base_type
)
172 case GLSL_TYPE_FLOAT
: /* TODO handle mediump */
173 case GLSL_TYPE_SUBROUTINE
:
176 case GLSL_TYPE_FLOAT16
:
177 case GLSL_TYPE_UINT16
:
178 case GLSL_TYPE_INT16
:
181 case GLSL_TYPE_UINT8
:
185 case GLSL_TYPE_DOUBLE
:
186 case GLSL_TYPE_INT64
:
187 case GLSL_TYPE_UINT64
:
188 case GLSL_TYPE_IMAGE
:
189 case GLSL_TYPE_SAMPLER
:
193 unreachable("unknown base type");
199 static inline enum glsl_base_type
200 glsl_unsigned_base_type_of(enum glsl_base_type type
)
204 return GLSL_TYPE_UINT
;
206 return GLSL_TYPE_UINT8
;
207 case GLSL_TYPE_INT16
:
208 return GLSL_TYPE_UINT16
;
209 case GLSL_TYPE_INT64
:
210 return GLSL_TYPE_UINT64
;
212 assert(type
== GLSL_TYPE_UINT
||
213 type
== GLSL_TYPE_UINT8
||
214 type
== GLSL_TYPE_UINT16
||
215 type
== GLSL_TYPE_UINT64
);
220 enum glsl_sampler_dim
{
221 GLSL_SAMPLER_DIM_1D
= 0,
224 GLSL_SAMPLER_DIM_CUBE
,
225 GLSL_SAMPLER_DIM_RECT
,
226 GLSL_SAMPLER_DIM_BUF
,
227 GLSL_SAMPLER_DIM_EXTERNAL
,
229 GLSL_SAMPLER_DIM_SUBPASS
, /* for vulkan input attachments */
230 GLSL_SAMPLER_DIM_SUBPASS_MS
, /* for multisampled vulkan input attachments */
233 enum glsl_matrix_layout
{
235 * The layout of the matrix is inherited from the object containing the
236 * matrix (the top level structure or the uniform block).
238 GLSL_MATRIX_LAYOUT_INHERITED
,
241 * Explicit column-major layout
243 * If a uniform block doesn't have an explicit layout set, it will default
246 GLSL_MATRIX_LAYOUT_COLUMN_MAJOR
,
251 GLSL_MATRIX_LAYOUT_ROW_MAJOR
255 GLSL_PRECISION_NONE
= 0,
257 GLSL_PRECISION_MEDIUM
,
263 #include "util/ralloc.h"
264 #include "main/menums.h" /* for gl_texture_index, C++'s enum rules are broken */
268 glsl_base_type base_type
:8;
270 glsl_base_type sampled_type
:8; /**< Type of data returned using this
271 * sampler or image. Only \c
272 * GLSL_TYPE_FLOAT, \c GLSL_TYPE_INT,
273 * and \c GLSL_TYPE_UINT are valid.
276 unsigned sampler_dimensionality
:4; /**< \see glsl_sampler_dim */
277 unsigned sampler_shadow
:1;
278 unsigned sampler_array
:1;
279 unsigned interface_packing
:2;
280 unsigned interface_row_major
:1;
283 * For \c GLSL_TYPE_STRUCT this specifies if the struct is packed or not.
285 * Only used for Compute kernels
290 glsl_type() : mem_ctx(NULL
)
292 // Dummy constructor, just for the sake of ASSERT_BITFIELD_SIZE.
297 * \name Vector and matrix element counts
299 * For scalars, each of these values will be 1. For non-numeric types
303 uint8_t vector_elements
; /**< 1, 2, 3, or 4 vector elements. */
304 uint8_t matrix_columns
; /**< 1, 2, 3, or 4 matrix columns. */
308 * For \c GLSL_TYPE_ARRAY, this is the length of the array. For
309 * \c GLSL_TYPE_STRUCT or \c GLSL_TYPE_INTERFACE, it is the number of
310 * elements in the structure and the number of values pointed to by
311 * \c fields.structure (below).
316 * Name of the data type
318 * Will never be \c NULL.
323 * Explicit array, matrix, or vector stride. This is used to communicate
324 * explicit array layouts from SPIR-V. Should be 0 if the type has no
327 unsigned explicit_stride
;
330 * Subtype of composite data types.
333 const struct glsl_type
*array
; /**< Type of array elements. */
334 struct glsl_function_param
*parameters
; /**< Parameters to function. */
335 struct glsl_struct_field
*structure
; /**< List of struct fields. */
339 * \name Pointers to various public type singletons
343 #define DECL_TYPE(NAME, ...) \
344 static const glsl_type *const NAME##_type;
346 #define STRUCT_TYPE(NAME) \
347 static const glsl_type *const struct_##NAME##_type;
348 #include "compiler/builtin_type_macros.h"
352 * Convenience accessors for vector types (shorter than get_instance()).
355 static const glsl_type
*vec(unsigned components
, const glsl_type
*const ts
[]);
356 static const glsl_type
*vec(unsigned components
);
357 static const glsl_type
*f16vec(unsigned components
);
358 static const glsl_type
*dvec(unsigned components
);
359 static const glsl_type
*ivec(unsigned components
);
360 static const glsl_type
*uvec(unsigned components
);
361 static const glsl_type
*bvec(unsigned components
);
362 static const glsl_type
*i64vec(unsigned components
);
363 static const glsl_type
*u64vec(unsigned components
);
364 static const glsl_type
*i16vec(unsigned components
);
365 static const glsl_type
*u16vec(unsigned components
);
366 static const glsl_type
*i8vec(unsigned components
);
367 static const glsl_type
*u8vec(unsigned components
);
371 * For numeric and boolean derived types returns the basic scalar type
373 * If the type is a numeric or boolean scalar, vector, or matrix type,
374 * this function gets the scalar type of the individual components. For
375 * all other types, including arrays of numeric or boolean types, the
376 * error type is returned.
378 const glsl_type
*get_base_type() const;
381 * Get the basic scalar type which this type aggregates.
383 * If the type is a numeric or boolean scalar, vector, or matrix, or an
384 * array of any of those, this function gets the scalar type of the
385 * individual components. For structs and arrays of structs, this function
386 * returns the struct type. For samplers and arrays of samplers, this
387 * function returns the sampler type.
389 const glsl_type
*get_scalar_type() const;
392 * Gets the "bare" type without any decorations or layout information.
394 const glsl_type
*get_bare_type() const;
397 * Get the instance of a built-in scalar, vector, or matrix type
399 static const glsl_type
*get_instance(unsigned base_type
, unsigned rows
,
401 unsigned explicit_stride
= 0,
402 bool row_major
= false);
405 * Get the instance of a sampler type
407 static const glsl_type
*get_sampler_instance(enum glsl_sampler_dim dim
,
410 glsl_base_type type
);
412 static const glsl_type
*get_image_instance(enum glsl_sampler_dim dim
,
413 bool array
, glsl_base_type type
);
416 * Get the instance of an array type
418 static const glsl_type
*get_array_instance(const glsl_type
*base
,
420 unsigned explicit_stride
= 0);
423 * Get the instance of a record type
425 static const glsl_type
*get_struct_instance(const glsl_struct_field
*fields
,
428 bool packed
= false);
431 * Get the instance of an interface block type
433 static const glsl_type
*get_interface_instance(const glsl_struct_field
*fields
,
435 enum glsl_interface_packing packing
,
437 const char *block_name
);
440 * Get the instance of an subroutine type
442 static const glsl_type
*get_subroutine_instance(const char *subroutine_name
);
445 * Get the instance of a function type
447 static const glsl_type
*get_function_instance(const struct glsl_type
*return_type
,
448 const glsl_function_param
*parameters
,
449 unsigned num_params
);
452 * Get the type resulting from a multiplication of \p type_a * \p type_b
454 static const glsl_type
*get_mul_type(const glsl_type
*type_a
,
455 const glsl_type
*type_b
);
458 * Query the total number of scalars that make up a scalar, vector or matrix
460 unsigned components() const
462 return vector_elements
* matrix_columns
;
466 * Calculate the number of components slots required to hold this type
468 * This is used to determine how many uniform or varying locations a type
471 unsigned component_slots() const;
474 * Calculate offset between the base location of the struct in
475 * uniform storage and a struct member.
476 * For the initial call, length is the index of the member to find the
479 unsigned struct_location_offset(unsigned length
) const;
482 * Calculate the number of unique values from glGetUniformLocation for the
483 * elements of the type.
485 * This is used to allocate slots in the UniformRemapTable, the amount of
486 * locations may not match with actual used storage space by the driver.
488 unsigned uniform_locations() const;
491 * Used to count the number of varyings contained in the type ignoring
492 * innermost array elements.
494 unsigned varying_count() const;
497 * Calculate the number of vec4 slots required to hold this type.
499 * This is the underlying recursive type_size function for
500 * count_attribute_slots() (vertex inputs and varyings) but also for
501 * gallium's !PIPE_CAP_PACKED_UNIFORMS case.
503 unsigned count_vec4_slots(bool is_gl_vertex_input
, bool bindless
) const;
506 * Calculate the number of vec4 slots required to hold this type.
508 * This is the underlying recursive type_size function for
509 * gallium's PIPE_CAP_PACKED_UNIFORMS case.
511 unsigned count_dword_slots(bool bindless
) const;
514 * Calculate the number of attribute slots required to hold this type
516 * This implements the language rules of GLSL 1.50 for counting the number
517 * of slots used by a vertex attribute. It also determines the number of
518 * varying slots the type will use up in the absence of varying packing
519 * (and thus, it can be used to measure the number of varying slots used by
520 * the varyings that are generated by lower_packed_varyings).
522 * For vertex shader attributes - doubles only take one slot.
523 * For inter-shader varyings - dvec3/dvec4 take two slots.
525 * Vulkan doesn’t make this distinction so the argument should always be
528 unsigned count_attribute_slots(bool is_gl_vertex_input
) const {
529 return count_vec4_slots(is_gl_vertex_input
, true);
533 * Alignment in bytes of the start of this type in a std140 uniform
536 unsigned std140_base_alignment(bool row_major
) const;
538 /** Size in bytes of this type in a std140 uniform block.
540 * Note that this is not GL_UNIFORM_SIZE (which is the number of
541 * elements in the array)
543 unsigned std140_size(bool row_major
) const;
546 * Gets an explicitly laid out type with the std140 layout.
548 const glsl_type
*get_explicit_std140_type(bool row_major
) const;
551 * Alignment in bytes of the start of this type in a std430 shader
554 unsigned std430_base_alignment(bool row_major
) const;
557 * Calculate array stride in bytes of this type in a std430 shader storage
560 unsigned std430_array_stride(bool row_major
) const;
563 * Size in bytes of this type in a std430 shader storage block.
565 * Note that this is not GL_BUFFER_SIZE
567 unsigned std430_size(bool row_major
) const;
570 * Gets an explicitly laid out type with the std430 layout.
572 const glsl_type
*get_explicit_std430_type(bool row_major
) const;
575 * Gets an explicitly laid out interface type.
577 const glsl_type
*get_explicit_interface_type(bool supports_std430
) const;
579 /** Returns an explicitly laid out type given a type and size/align func
581 * The size/align func is only called for scalar and vector types and the
582 * returned type is otherwise laid out in the natural way as follows:
584 * - Arrays and matrices have a stride of ALIGN(elem_size, elem_align).
586 * - Structure types have their elements in-order and as tightly packed as
587 * possible following the alignment required by the size/align func.
589 * - All composite types (structures, matrices, and arrays) have an
590 * alignment equal to the highest alighment of any member of the composite.
592 * The types returned by this function are likely not suitable for most UBO
593 * or SSBO layout because they do not add the extra array and substructure
594 * alignment that is required by std140 and std430.
596 const glsl_type
*get_explicit_type_for_size_align(glsl_type_size_align_func type_info
,
597 unsigned *size
, unsigned *align
) const;
600 * Alignment in bytes of the start of this type in OpenCL memory.
602 unsigned cl_alignment() const;
605 * Size in bytes of this type in OpenCL memory
607 unsigned cl_size() const;
610 * Size in bytes of this type based on its explicit data.
612 * When using SPIR-V shaders (ARB_gl_spirv), memory layouts are expressed
613 * through explicit offset, stride and matrix layout, so the size
614 * can/should be computed used those values.
616 * Note that the value returned by this method is only correct if such
617 * values are set, so only with SPIR-V shaders. Should not be used with
620 unsigned explicit_size(bool align_to_stride
=false) const;
623 * \brief Can this type be implicitly converted to another?
625 * \return True if the types are identical or if this type can be converted
626 * to \c desired according to Section 4.1.10 of the GLSL spec.
629 * From page 25 (31 of the pdf) of the GLSL 1.50 spec, Section 4.1.10
630 * Implicit Conversions:
632 * In some situations, an expression and its type will be implicitly
633 * converted to a different type. The following table shows all allowed
634 * implicit conversions:
636 * Type of expression | Can be implicitly converted to
637 * --------------------------------------------------
650 * There are no implicit array or structure conversions. For example,
651 * an array of int cannot be implicitly converted to an array of float.
652 * There are no implicit conversions between signed and unsigned
656 bool can_implicitly_convert_to(const glsl_type
*desired
,
657 _mesa_glsl_parse_state
*state
) const;
660 * Query whether or not a type is a scalar (non-vector and non-matrix).
662 bool is_scalar() const
664 return (vector_elements
== 1)
665 && (base_type
>= GLSL_TYPE_UINT
)
666 && (base_type
<= GLSL_TYPE_IMAGE
);
670 * Query whether or not a type is a vector
672 bool is_vector() const
674 return (vector_elements
> 1)
675 && (matrix_columns
== 1)
676 && (base_type
>= GLSL_TYPE_UINT
)
677 && (base_type
<= GLSL_TYPE_BOOL
);
681 * Query whether or not a type is a matrix
683 bool is_matrix() const
685 /* GLSL only has float matrices. */
686 return (matrix_columns
> 1) && (base_type
== GLSL_TYPE_FLOAT
||
687 base_type
== GLSL_TYPE_DOUBLE
||
688 base_type
== GLSL_TYPE_FLOAT16
);
692 * Query whether or not a type is a non-array numeric type
694 bool is_numeric() const
696 return (base_type
>= GLSL_TYPE_UINT
) && (base_type
<= GLSL_TYPE_INT64
);
700 * Query whether or not a type is an integer.
702 bool is_integer() const
704 return glsl_base_type_is_integer(base_type
);
708 * Query whether or not a type is an 32-bit integer.
710 bool is_integer_32() const
712 return (base_type
== GLSL_TYPE_UINT
) || (base_type
== GLSL_TYPE_INT
);
716 * Query whether or not a type is a 64-bit integer.
718 bool is_integer_64() const
720 return base_type
== GLSL_TYPE_UINT64
|| base_type
== GLSL_TYPE_INT64
;
724 * Query whether or not a type is a 32-bit or 64-bit integer
726 bool is_integer_32_64() const
728 return is_integer_32() || is_integer_64();
732 * Query whether or not type is an integral type, or for struct and array
733 * types, contains an integral type.
735 bool contains_integer() const;
738 * Query whether or not type is a double type, or for struct, interface and
739 * array types, contains a double type.
741 bool contains_double() const;
744 * Query whether or not type is a 64-bit type, or for struct, interface and
745 * array types, contains a double type.
747 bool contains_64bit() const;
750 * Query whether or not a type is a float type
752 bool is_float() const
754 return base_type
== GLSL_TYPE_FLOAT
;
758 * Query whether or not a type is a double type
760 bool is_double() const
762 return base_type
== GLSL_TYPE_DOUBLE
;
766 * Query whether a 64-bit type takes two slots.
768 bool is_dual_slot() const
770 return is_64bit() && vector_elements
> 2;
774 * Query whether or not a type is 64-bit
776 bool is_64bit() const
778 return glsl_base_type_is_64bit(base_type
);
782 * Query whether or not a type is 16-bit
784 bool is_16bit() const
786 return glsl_base_type_is_16bit(base_type
);
790 * Query whether or not a type is 32-bit
792 bool is_32bit() const
794 return base_type
== GLSL_TYPE_UINT
||
795 base_type
== GLSL_TYPE_INT
||
796 base_type
== GLSL_TYPE_FLOAT
;
800 * Query whether or not a type is a non-array boolean type
802 bool is_boolean() const
804 return base_type
== GLSL_TYPE_BOOL
;
808 * Query whether or not a type is a sampler
810 bool is_sampler() const
812 return base_type
== GLSL_TYPE_SAMPLER
;
816 * Query whether or not type is a sampler, or for struct, interface and
817 * array types, contains a sampler.
819 bool contains_sampler() const;
822 * Query whether or not type is an array or for struct, interface and
823 * array types, contains an array.
825 bool contains_array() const;
828 * Get the Mesa texture target index for a sampler type.
830 gl_texture_index
sampler_index() const;
833 * Query whether or not type is an image, or for struct, interface and
834 * array types, contains an image.
836 bool contains_image() const;
839 * Query whether or not a type is an image
841 bool is_image() const
843 return base_type
== GLSL_TYPE_IMAGE
;
847 * Query whether or not a type is an array
849 bool is_array() const
851 return base_type
== GLSL_TYPE_ARRAY
;
854 bool is_array_of_arrays() const
856 return is_array() && fields
.array
->is_array();
860 * Query whether or not a type is a record
862 bool is_struct() const
864 return base_type
== GLSL_TYPE_STRUCT
;
868 * Query whether or not a type is an interface
870 bool is_interface() const
872 return base_type
== GLSL_TYPE_INTERFACE
;
876 * Query whether or not a type is the void type singleton.
880 return base_type
== GLSL_TYPE_VOID
;
884 * Query whether or not a type is the error type singleton.
886 bool is_error() const
888 return base_type
== GLSL_TYPE_ERROR
;
892 * Query if a type is unnamed/anonymous (named by the parser)
895 bool is_subroutine() const
897 return base_type
== GLSL_TYPE_SUBROUTINE
;
899 bool contains_subroutine() const;
901 bool is_anonymous() const
903 return !strncmp(name
, "#anon", 5);
907 * Get the type stripped of any arrays
910 * Pointer to the type of elements of the first non-array type for array
911 * types, or pointer to itself for non-array types.
913 const glsl_type
*without_array() const
915 const glsl_type
*t
= this;
917 while (t
->is_array())
924 * Return the total number of elements in an array including the elements
925 * in arrays of arrays.
927 unsigned arrays_of_arrays_size() const
932 unsigned size
= length
;
933 const glsl_type
*base_type
= fields
.array
;
935 while (base_type
->is_array()) {
936 size
= size
* base_type
->length
;
937 base_type
= base_type
->fields
.array
;
943 * Return bit size for this type.
945 unsigned bit_size() const
947 return glsl_base_type_bit_size(this->base_type
);
952 * Query whether or not a type is an atomic_uint.
954 bool is_atomic_uint() const
956 return base_type
== GLSL_TYPE_ATOMIC_UINT
;
960 * Return the amount of atomic counter storage required for a type.
962 unsigned atomic_size() const
964 if (is_atomic_uint())
965 return ATOMIC_COUNTER_SIZE
;
967 return length
* fields
.array
->atomic_size();
973 * Return whether a type contains any atomic counters.
975 bool contains_atomic() const
977 return atomic_size() > 0;
981 * Return whether a type contains any opaque types.
983 bool contains_opaque() const;
986 * Query the full type of a matrix row
989 * If the type is not a matrix, \c glsl_type::error_type is returned.
990 * Otherwise a type matching the rows of the matrix is returned.
992 const glsl_type
*row_type() const
997 if (explicit_stride
&& !interface_row_major
)
998 return get_instance(base_type
, matrix_columns
, 1, explicit_stride
);
1000 return get_instance(base_type
, matrix_columns
, 1);
1004 * Query the full type of a matrix column
1007 * If the type is not a matrix, \c glsl_type::error_type is returned.
1008 * Otherwise a type matching the columns of the matrix is returned.
1010 const glsl_type
*column_type() const
1015 if (explicit_stride
&& interface_row_major
)
1016 return get_instance(base_type
, vector_elements
, 1, explicit_stride
);
1018 return get_instance(base_type
, vector_elements
, 1);
1022 * Get the type of a structure field
1025 * Pointer to the type of the named field. If the type is not a structure
1026 * or the named field does not exist, \c glsl_type::error_type is returned.
1028 const glsl_type
*field_type(const char *name
) const;
1031 * Get the location of a field within a record type
1033 int field_index(const char *name
) const;
1036 * Query the number of elements in an array type
1039 * The number of elements in the array for array types or -1 for non-array
1040 * types. If the number of elements in the array has not yet been declared,
1043 int array_size() const
1045 return is_array() ? length
: -1;
1049 * Query whether the array size for all dimensions has been declared.
1051 bool is_unsized_array() const
1053 return is_array() && length
== 0;
1057 * Return the number of coordinate components needed for this
1058 * sampler or image type.
1060 * This is based purely on the sampler's dimensionality. For example, this
1061 * returns 1 for sampler1D, and 3 for sampler2DArray.
1063 * Note that this is often different than actual coordinate type used in
1064 * a texturing built-in function, since those pack additional values (such
1065 * as the shadow comparator or projector) into the coordinate type.
1067 int coordinate_components() const;
1070 * Compares whether this type matches another type without taking into
1071 * account the precision in structures.
1073 * This is applied recursively so that structures containing structure
1074 * members can also ignore the precision.
1076 bool compare_no_precision(const glsl_type
*b
) const;
1079 * Compare a record type against another record type.
1081 * This is useful for matching record types declared on the same shader
1082 * stage as well as across different shader stages.
1083 * The option to not match name is needed for matching record types
1084 * declared across different shader stages.
1085 * The option to not match locations is to deal with places where the
1086 * same struct is defined in a block which has a location set on it.
1088 bool record_compare(const glsl_type
*b
, bool match_name
,
1089 bool match_locations
= true,
1090 bool match_precision
= true) const;
1093 * Get the type interface packing.
1095 enum glsl_interface_packing
get_interface_packing() const
1097 return (enum glsl_interface_packing
)interface_packing
;
1101 * Get the type interface packing used internally. For shared and packing
1102 * layouts this is implementation defined.
1104 enum glsl_interface_packing
get_internal_ifc_packing(bool std430_supported
) const
1106 enum glsl_interface_packing packing
= this->get_interface_packing();
1107 if (packing
== GLSL_INTERFACE_PACKING_STD140
||
1108 (!std430_supported
&&
1109 (packing
== GLSL_INTERFACE_PACKING_SHARED
||
1110 packing
== GLSL_INTERFACE_PACKING_PACKED
))) {
1111 return GLSL_INTERFACE_PACKING_STD140
;
1113 assert(packing
== GLSL_INTERFACE_PACKING_STD430
||
1114 (std430_supported
&&
1115 (packing
== GLSL_INTERFACE_PACKING_SHARED
||
1116 packing
== GLSL_INTERFACE_PACKING_PACKED
)));
1117 return GLSL_INTERFACE_PACKING_STD430
;
1122 * Check if the type interface is row major
1124 bool get_interface_row_major() const
1126 return (bool) interface_row_major
;
1133 static mtx_t hash_mutex
;
1136 * ralloc context for the type itself.
1140 /** Constructor for vector and matrix types */
1141 glsl_type(GLenum gl_type
,
1142 glsl_base_type base_type
, unsigned vector_elements
,
1143 unsigned matrix_columns
, const char *name
,
1144 unsigned explicit_stride
= 0, bool row_major
= false);
1146 /** Constructor for sampler or image types */
1147 glsl_type(GLenum gl_type
, glsl_base_type base_type
,
1148 enum glsl_sampler_dim dim
, bool shadow
, bool array
,
1149 glsl_base_type type
, const char *name
);
1151 /** Constructor for record types */
1152 glsl_type(const glsl_struct_field
*fields
, unsigned num_fields
,
1153 const char *name
, bool packed
= false);
1155 /** Constructor for interface types */
1156 glsl_type(const glsl_struct_field
*fields
, unsigned num_fields
,
1157 enum glsl_interface_packing packing
,
1158 bool row_major
, const char *name
);
1160 /** Constructor for interface types */
1161 glsl_type(const glsl_type
*return_type
,
1162 const glsl_function_param
*params
, unsigned num_params
);
1164 /** Constructors for array types */
1165 glsl_type(const glsl_type
*array
, unsigned length
, unsigned explicit_stride
);
1167 /** Constructor for subroutine types */
1168 glsl_type(const char *name
);
1170 /** Hash table containing the known explicit matrix and vector types. */
1171 static struct hash_table
*explicit_matrix_types
;
1173 /** Hash table containing the known array types. */
1174 static struct hash_table
*array_types
;
1176 /** Hash table containing the known struct types. */
1177 static struct hash_table
*struct_types
;
1179 /** Hash table containing the known interface types. */
1180 static struct hash_table
*interface_types
;
1182 /** Hash table containing the known subroutine types. */
1183 static struct hash_table
*subroutine_types
;
1185 /** Hash table containing the known function types. */
1186 static struct hash_table
*function_types
;
1188 static bool record_key_compare(const void *a
, const void *b
);
1189 static unsigned record_key_hash(const void *key
);
1192 * \name Built-in type flyweights
1196 #define DECL_TYPE(NAME, ...) static const glsl_type _##NAME##_type;
1198 #define STRUCT_TYPE(NAME) static const glsl_type _struct_##NAME##_type;
1199 #include "compiler/builtin_type_macros.h"
1203 * \name Friend functions.
1205 * These functions are friends because they must have C linkage and the
1206 * need to call various private methods or access various private static
1210 friend void glsl_type_singleton_init_or_ref(void);
1211 friend void glsl_type_singleton_decref(void);
1212 friend void _mesa_glsl_initialize_types(struct _mesa_glsl_parse_state
*);
1218 #endif /* __cplusplus */
1220 struct glsl_struct_field
{
1221 const struct glsl_type
*type
;
1225 * For interface blocks, gl_varying_slot corresponding to the input/output
1226 * if this is a built-in input/output (i.e. a member of the built-in
1227 * gl_PerVertex interface block); -1 otherwise.
1229 * Ignored for structs.
1234 * For interface blocks, members may have an explicit byte offset
1235 * specified; -1 otherwise. Also used for xfb_offset layout qualifier.
1237 * Unless used for xfb_offset this field is ignored for structs.
1242 * For interface blocks, members may define a transform feedback buffer;
1248 * For interface blocks, members may define a transform feedback stride;
1254 * For interface blocks, the interpolation mode (as in
1255 * ir_variable::interpolation). 0 otherwise.
1257 unsigned interpolation
:3;
1260 * For interface blocks, 1 if this variable uses centroid interpolation (as
1261 * in ir_variable::centroid). 0 otherwise.
1263 unsigned centroid
:1;
1266 * For interface blocks, 1 if this variable uses sample interpolation (as
1267 * in ir_variable::sample). 0 otherwise.
1272 * Layout of the matrix. Uses glsl_matrix_layout values.
1274 unsigned matrix_layout
:2;
1277 * For interface blocks, 1 if this variable is a per-patch input or output
1278 * (as in ir_variable::patch). 0 otherwise.
1283 * Precision qualifier
1285 unsigned precision
:2;
1288 * Memory qualifiers, applicable to buffer variables defined in shader
1289 * storage buffer objects (SSBOs)
1291 unsigned memory_read_only
:1;
1292 unsigned memory_write_only
:1;
1293 unsigned memory_coherent
:1;
1294 unsigned memory_volatile
:1;
1295 unsigned memory_restrict
:1;
1298 * Layout format, applicable to image variables only.
1300 unsigned image_format
:16;
1303 * Any of the xfb_* qualifiers trigger the shader to be in transform
1304 * feedback mode so we need to keep track of whether the buffer was
1305 * explicitly set or if its just been assigned the default global value.
1307 unsigned explicit_xfb_buffer
:1;
1309 unsigned implicit_sized_array
:1;
1311 #define DEFAULT_CONSTRUCTORS(_type, _precision, _name) \
1312 type(_type), name(_name), location(-1), offset(-1), xfb_buffer(0), \
1313 xfb_stride(0), interpolation(0), centroid(0), \
1314 sample(0), matrix_layout(GLSL_MATRIX_LAYOUT_INHERITED), patch(0), \
1315 precision(_precision), memory_read_only(0), \
1316 memory_write_only(0), memory_coherent(0), memory_volatile(0), \
1317 memory_restrict(0), image_format(0), explicit_xfb_buffer(0), \
1318 implicit_sized_array(0)
1320 glsl_struct_field(const struct glsl_type
*_type
,
1323 : DEFAULT_CONSTRUCTORS(_type
, _precision
, _name
)
1328 glsl_struct_field(const struct glsl_type
*_type
, const char *_name
)
1329 : DEFAULT_CONSTRUCTORS(_type
, GLSL_PRECISION_NONE
, _name
)
1335 : DEFAULT_CONSTRUCTORS(NULL
, GLSL_PRECISION_NONE
, NULL
)
1339 #undef DEFAULT_CONSTRUCTORS
1343 struct glsl_function_param
{
1344 const struct glsl_type
*type
;
1350 static inline unsigned int
1351 glsl_align(unsigned int a
, unsigned int align
)
1353 return (a
+ align
- 1) / align
* align
;
1356 #endif /* GLSL_TYPES_H */