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/format/u_format.h"
35 #include "util/macros.h"
38 #include "main/config.h"
47 struct _mesa_glsl_parse_state
;
48 struct glsl_symbol_table
;
51 glsl_type_singleton_init_or_ref();
54 glsl_type_singleton_decref();
57 _mesa_glsl_initialize_types(struct _mesa_glsl_parse_state
*state
);
59 void encode_type_to_blob(struct blob
*blob
, const struct glsl_type
*type
);
61 const struct glsl_type
*decode_type_from_blob(struct blob_reader
*blob
);
63 typedef void (*glsl_type_size_align_func
)(const struct glsl_type
*type
,
64 unsigned *size
, unsigned *align
);
67 /* Note: GLSL_TYPE_UINT, GLSL_TYPE_INT, and GLSL_TYPE_FLOAT must be 0, 1,
68 * and 2 so that they will fit in the 2 bits of glsl_type::sampled_type.
84 GLSL_TYPE_ATOMIC_UINT
,
94 /* Return the bit size of a type. Note that this differs from
95 * glsl_get_bit_size in that it returns 32 bits for bools, whereas at
96 * the NIR level we would want to return 1 bit for bools.
98 static unsigned glsl_base_type_bit_size(enum glsl_base_type type
)
104 case GLSL_TYPE_FLOAT
: /* TODO handle mediump */
105 case GLSL_TYPE_SUBROUTINE
:
108 case GLSL_TYPE_FLOAT16
:
109 case GLSL_TYPE_UINT16
:
110 case GLSL_TYPE_INT16
:
113 case GLSL_TYPE_UINT8
:
117 case GLSL_TYPE_DOUBLE
:
118 case GLSL_TYPE_INT64
:
119 case GLSL_TYPE_UINT64
:
120 case GLSL_TYPE_IMAGE
:
121 case GLSL_TYPE_SAMPLER
:
125 /* For GLSL_TYPE_STRUCT etc, it should be ok to return 0. This usually
126 * happens when calling this method through is_64bit and is_16bit
135 static inline bool glsl_base_type_is_16bit(enum glsl_base_type type
)
137 return glsl_base_type_bit_size(type
) == 16;
140 static inline bool glsl_base_type_is_64bit(enum glsl_base_type type
)
142 return glsl_base_type_bit_size(type
) == 64;
145 static inline bool glsl_base_type_is_integer(enum glsl_base_type type
)
147 return type
== GLSL_TYPE_UINT8
||
148 type
== GLSL_TYPE_INT8
||
149 type
== GLSL_TYPE_UINT16
||
150 type
== GLSL_TYPE_INT16
||
151 type
== GLSL_TYPE_UINT
||
152 type
== GLSL_TYPE_INT
||
153 type
== GLSL_TYPE_UINT64
||
154 type
== GLSL_TYPE_INT64
||
155 type
== GLSL_TYPE_BOOL
||
156 type
== GLSL_TYPE_SAMPLER
||
157 type
== GLSL_TYPE_IMAGE
;
160 static inline unsigned int
161 glsl_base_type_get_bit_size(const enum glsl_base_type base_type
)
169 case GLSL_TYPE_FLOAT
: /* TODO handle mediump */
170 case GLSL_TYPE_SUBROUTINE
:
173 case GLSL_TYPE_FLOAT16
:
174 case GLSL_TYPE_UINT16
:
175 case GLSL_TYPE_INT16
:
178 case GLSL_TYPE_UINT8
:
182 case GLSL_TYPE_DOUBLE
:
183 case GLSL_TYPE_INT64
:
184 case GLSL_TYPE_UINT64
:
185 case GLSL_TYPE_IMAGE
:
186 case GLSL_TYPE_SAMPLER
:
190 unreachable("unknown base type");
196 static inline enum glsl_base_type
197 glsl_unsigned_base_type_of(enum glsl_base_type type
)
201 return GLSL_TYPE_UINT
;
203 return GLSL_TYPE_UINT8
;
204 case GLSL_TYPE_INT16
:
205 return GLSL_TYPE_UINT16
;
206 case GLSL_TYPE_INT64
:
207 return GLSL_TYPE_UINT64
;
209 assert(type
== GLSL_TYPE_UINT
||
210 type
== GLSL_TYPE_UINT8
||
211 type
== GLSL_TYPE_UINT16
||
212 type
== GLSL_TYPE_UINT64
);
217 enum glsl_sampler_dim
{
218 GLSL_SAMPLER_DIM_1D
= 0,
221 GLSL_SAMPLER_DIM_CUBE
,
222 GLSL_SAMPLER_DIM_RECT
,
223 GLSL_SAMPLER_DIM_BUF
,
224 GLSL_SAMPLER_DIM_EXTERNAL
,
226 GLSL_SAMPLER_DIM_SUBPASS
, /* for vulkan input attachments */
227 GLSL_SAMPLER_DIM_SUBPASS_MS
, /* for multisampled vulkan input attachments */
231 glsl_get_sampler_dim_coordinate_components(enum glsl_sampler_dim dim
);
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
,
265 #include "util/ralloc.h"
266 #include "main/menums.h" /* for gl_texture_index, C++'s enum rules are broken */
270 glsl_base_type base_type
:8;
272 glsl_base_type sampled_type
:8; /**< Type of data returned using this
273 * sampler or image. Only \c
274 * GLSL_TYPE_FLOAT, \c GLSL_TYPE_INT,
275 * and \c GLSL_TYPE_UINT are valid.
278 unsigned sampler_dimensionality
:4; /**< \see glsl_sampler_dim */
279 unsigned sampler_shadow
:1;
280 unsigned sampler_array
:1;
281 unsigned interface_packing
:2;
282 unsigned interface_row_major
:1;
285 * For \c GLSL_TYPE_STRUCT this specifies if the struct is packed or not.
287 * Only used for Compute kernels
292 glsl_type() : mem_ctx(NULL
)
294 // Dummy constructor, just for the sake of ASSERT_BITFIELD_SIZE.
299 * \name Vector and matrix element counts
301 * For scalars, each of these values will be 1. For non-numeric types
305 uint8_t vector_elements
; /**< 1, 2, 3, or 4 vector elements. */
306 uint8_t matrix_columns
; /**< 1, 2, 3, or 4 matrix columns. */
310 * For \c GLSL_TYPE_ARRAY, this is the length of the array. For
311 * \c GLSL_TYPE_STRUCT or \c GLSL_TYPE_INTERFACE, it is the number of
312 * elements in the structure and the number of values pointed to by
313 * \c fields.structure (below).
318 * Name of the data type
320 * Will never be \c NULL.
325 * Explicit array, matrix, or vector stride. This is used to communicate
326 * explicit array layouts from SPIR-V. Should be 0 if the type has no
329 unsigned explicit_stride
;
332 * Subtype of composite data types.
335 const struct glsl_type
*array
; /**< Type of array elements. */
336 struct glsl_function_param
*parameters
; /**< Parameters to function. */
337 struct glsl_struct_field
*structure
; /**< List of struct fields. */
341 * \name Pointers to various public type singletons
345 #define DECL_TYPE(NAME, ...) \
346 static const glsl_type *const NAME##_type;
348 #define STRUCT_TYPE(NAME) \
349 static const glsl_type *const struct_##NAME##_type;
350 #include "compiler/builtin_type_macros.h"
354 * Convenience accessors for vector types (shorter than get_instance()).
357 static const glsl_type
*vec(unsigned components
, const glsl_type
*const ts
[]);
358 static const glsl_type
*vec(unsigned components
);
359 static const glsl_type
*f16vec(unsigned components
);
360 static const glsl_type
*dvec(unsigned components
);
361 static const glsl_type
*ivec(unsigned components
);
362 static const glsl_type
*uvec(unsigned components
);
363 static const glsl_type
*bvec(unsigned components
);
364 static const glsl_type
*i64vec(unsigned components
);
365 static const glsl_type
*u64vec(unsigned components
);
366 static const glsl_type
*i16vec(unsigned components
);
367 static const glsl_type
*u16vec(unsigned components
);
368 static const glsl_type
*i8vec(unsigned components
);
369 static const glsl_type
*u8vec(unsigned components
);
373 * For numeric and boolean derived types returns the basic scalar type
375 * If the type is a numeric or boolean scalar, vector, or matrix type,
376 * this function gets the scalar type of the individual components. For
377 * all other types, including arrays of numeric or boolean types, the
378 * error type is returned.
380 const glsl_type
*get_base_type() const;
383 * Get the basic scalar type which this type aggregates.
385 * If the type is a numeric or boolean scalar, vector, or matrix, or an
386 * array of any of those, this function gets the scalar type of the
387 * individual components. For structs and arrays of structs, this function
388 * returns the struct type. For samplers and arrays of samplers, this
389 * function returns the sampler type.
391 const glsl_type
*get_scalar_type() const;
394 * Gets the "bare" type without any decorations or layout information.
396 const glsl_type
*get_bare_type() const;
399 * Gets the float16 version of this type.
401 const glsl_type
*get_float16_type() const;
404 * Gets the int16 version of this type.
406 const glsl_type
*get_int16_type() const;
409 * Gets the uint16 version of this type.
411 const glsl_type
*get_uint16_type() const;
414 * Get the instance of a built-in scalar, vector, or matrix type
416 static const glsl_type
*get_instance(unsigned base_type
, unsigned rows
,
418 unsigned explicit_stride
= 0,
419 bool row_major
= false);
422 * Get the instance of a sampler type
424 static const glsl_type
*get_sampler_instance(enum glsl_sampler_dim dim
,
427 glsl_base_type type
);
429 static const glsl_type
*get_image_instance(enum glsl_sampler_dim dim
,
430 bool array
, glsl_base_type type
);
433 * Get the instance of an array type
435 static const glsl_type
*get_array_instance(const glsl_type
*base
,
437 unsigned explicit_stride
= 0);
440 * Get the instance of a record type
442 static const glsl_type
*get_struct_instance(const glsl_struct_field
*fields
,
445 bool packed
= false);
448 * Get the instance of an interface block type
450 static const glsl_type
*get_interface_instance(const glsl_struct_field
*fields
,
452 enum glsl_interface_packing packing
,
454 const char *block_name
);
457 * Get the instance of an subroutine type
459 static const glsl_type
*get_subroutine_instance(const char *subroutine_name
);
462 * Get the instance of a function type
464 static const glsl_type
*get_function_instance(const struct glsl_type
*return_type
,
465 const glsl_function_param
*parameters
,
466 unsigned num_params
);
469 * Get the type resulting from a multiplication of \p type_a * \p type_b
471 static const glsl_type
*get_mul_type(const glsl_type
*type_a
,
472 const glsl_type
*type_b
);
475 * Query the total number of scalars that make up a scalar, vector or matrix
477 unsigned components() const
479 return vector_elements
* matrix_columns
;
483 * Calculate the number of components slots required to hold this type
485 * This is used to determine how many uniform or varying locations a type
488 unsigned component_slots() const;
491 * Calculate offset between the base location of the struct in
492 * uniform storage and a struct member.
493 * For the initial call, length is the index of the member to find the
496 unsigned struct_location_offset(unsigned length
) const;
499 * Calculate the number of unique values from glGetUniformLocation for the
500 * elements of the type.
502 * This is used to allocate slots in the UniformRemapTable, the amount of
503 * locations may not match with actual used storage space by the driver.
505 unsigned uniform_locations() const;
508 * Used to count the number of varyings contained in the type ignoring
509 * innermost array elements.
511 unsigned varying_count() const;
514 * Calculate the number of vec4 slots required to hold this type.
516 * This is the underlying recursive type_size function for
517 * count_attribute_slots() (vertex inputs and varyings) but also for
518 * gallium's !PIPE_CAP_PACKED_UNIFORMS case.
520 unsigned count_vec4_slots(bool is_gl_vertex_input
, bool bindless
) const;
523 * Calculate the number of vec4 slots required to hold this type.
525 * This is the underlying recursive type_size function for
526 * gallium's PIPE_CAP_PACKED_UNIFORMS case.
528 unsigned count_dword_slots(bool bindless
) const;
531 * Calculate the number of attribute slots required to hold this type
533 * This implements the language rules of GLSL 1.50 for counting the number
534 * of slots used by a vertex attribute. It also determines the number of
535 * varying slots the type will use up in the absence of varying packing
536 * (and thus, it can be used to measure the number of varying slots used by
537 * the varyings that are generated by lower_packed_varyings).
539 * For vertex shader attributes - doubles only take one slot.
540 * For inter-shader varyings - dvec3/dvec4 take two slots.
542 * Vulkan doesn’t make this distinction so the argument should always be
545 unsigned count_attribute_slots(bool is_gl_vertex_input
) const {
546 return count_vec4_slots(is_gl_vertex_input
, true);
550 * Alignment in bytes of the start of this type in a std140 uniform
553 unsigned std140_base_alignment(bool row_major
) const;
555 /** Size in bytes of this type in a std140 uniform block.
557 * Note that this is not GL_UNIFORM_SIZE (which is the number of
558 * elements in the array)
560 unsigned std140_size(bool row_major
) const;
563 * Gets an explicitly laid out type with the std140 layout.
565 const glsl_type
*get_explicit_std140_type(bool row_major
) const;
568 * Alignment in bytes of the start of this type in a std430 shader
571 unsigned std430_base_alignment(bool row_major
) const;
574 * Calculate array stride in bytes of this type in a std430 shader storage
577 unsigned std430_array_stride(bool row_major
) const;
580 * Size in bytes of this type in a std430 shader storage block.
582 * Note that this is not GL_BUFFER_SIZE
584 unsigned std430_size(bool row_major
) const;
587 * Gets an explicitly laid out type with the std430 layout.
589 const glsl_type
*get_explicit_std430_type(bool row_major
) const;
592 * Gets an explicitly laid out interface type.
594 const glsl_type
*get_explicit_interface_type(bool supports_std430
) const;
596 /** Returns an explicitly laid out type given a type and size/align func
598 * The size/align func is only called for scalar and vector types and the
599 * returned type is otherwise laid out in the natural way as follows:
601 * - Arrays and matrices have a stride of ALIGN(elem_size, elem_align).
603 * - Structure types have their elements in-order and as tightly packed as
604 * possible following the alignment required by the size/align func.
606 * - All composite types (structures, matrices, and arrays) have an
607 * alignment equal to the highest alighment of any member of the composite.
609 * The types returned by this function are likely not suitable for most UBO
610 * or SSBO layout because they do not add the extra array and substructure
611 * alignment that is required by std140 and std430.
613 const glsl_type
*get_explicit_type_for_size_align(glsl_type_size_align_func type_info
,
614 unsigned *size
, unsigned *align
) const;
617 * Alignment in bytes of the start of this type in OpenCL memory.
619 unsigned cl_alignment() const;
622 * Size in bytes of this type in OpenCL memory
624 unsigned cl_size() const;
627 * Size in bytes of this type based on its explicit data.
629 * When using SPIR-V shaders (ARB_gl_spirv), memory layouts are expressed
630 * through explicit offset, stride and matrix layout, so the size
631 * can/should be computed used those values.
633 * Note that the value returned by this method is only correct if such
634 * values are set, so only with SPIR-V shaders. Should not be used with
637 unsigned explicit_size(bool align_to_stride
=false) const;
640 * \brief Can this type be implicitly converted to another?
642 * \return True if the types are identical or if this type can be converted
643 * to \c desired according to Section 4.1.10 of the GLSL spec.
646 * From page 25 (31 of the pdf) of the GLSL 1.50 spec, Section 4.1.10
647 * Implicit Conversions:
649 * In some situations, an expression and its type will be implicitly
650 * converted to a different type. The following table shows all allowed
651 * implicit conversions:
653 * Type of expression | Can be implicitly converted to
654 * --------------------------------------------------
667 * There are no implicit array or structure conversions. For example,
668 * an array of int cannot be implicitly converted to an array of float.
669 * There are no implicit conversions between signed and unsigned
673 bool can_implicitly_convert_to(const glsl_type
*desired
,
674 _mesa_glsl_parse_state
*state
) const;
677 * Query whether or not a type is a scalar (non-vector and non-matrix).
679 bool is_scalar() const
681 return (vector_elements
== 1)
682 && (base_type
>= GLSL_TYPE_UINT
)
683 && (base_type
<= GLSL_TYPE_IMAGE
);
687 * Query whether or not a type is a vector
689 bool is_vector() const
691 return (vector_elements
> 1)
692 && (matrix_columns
== 1)
693 && (base_type
>= GLSL_TYPE_UINT
)
694 && (base_type
<= GLSL_TYPE_BOOL
);
698 * Query whether or not a type is a matrix
700 bool is_matrix() const
702 /* GLSL only has float matrices. */
703 return (matrix_columns
> 1) && (base_type
== GLSL_TYPE_FLOAT
||
704 base_type
== GLSL_TYPE_DOUBLE
||
705 base_type
== GLSL_TYPE_FLOAT16
);
709 * Query whether or not a type is a non-array numeric type
711 bool is_numeric() const
713 return (base_type
>= GLSL_TYPE_UINT
) && (base_type
<= GLSL_TYPE_INT64
);
717 * Query whether or not a type is an integer.
719 bool is_integer() const
721 return glsl_base_type_is_integer(base_type
);
725 * Query whether or not a type is an 32-bit integer.
727 bool is_integer_32() const
729 return (base_type
== GLSL_TYPE_UINT
) || (base_type
== GLSL_TYPE_INT
);
733 * Query whether or not a type is a 64-bit integer.
735 bool is_integer_64() const
737 return base_type
== GLSL_TYPE_UINT64
|| base_type
== GLSL_TYPE_INT64
;
741 * Query whether or not a type is a 32-bit or 64-bit integer
743 bool is_integer_32_64() const
745 return is_integer_32() || is_integer_64();
749 * Query whether or not type is an integral type, or for struct and array
750 * types, contains an integral type.
752 bool contains_integer() const;
755 * Query whether or not type is a double type, or for struct, interface and
756 * array types, contains a double type.
758 bool contains_double() const;
761 * Query whether or not type is a 64-bit type, or for struct, interface and
762 * array types, contains a double type.
764 bool contains_64bit() const;
767 * Query whether or not a type is a float type
769 bool is_float() const
771 return base_type
== GLSL_TYPE_FLOAT
;
775 * Query whether or not a type is a half-float or float type
777 bool is_float_16_32() const
779 return base_type
== GLSL_TYPE_FLOAT16
|| is_float();
783 * Query whether or not a type is a half-float, float or double
785 bool is_float_16_32_64() const
787 return base_type
== GLSL_TYPE_FLOAT16
|| is_float() || is_double();
791 * Query whether or not a type is a double type
793 bool is_double() const
795 return base_type
== GLSL_TYPE_DOUBLE
;
799 * Query whether a 64-bit type takes two slots.
801 bool is_dual_slot() const
803 return is_64bit() && vector_elements
> 2;
807 * Query whether or not a type is 64-bit
809 bool is_64bit() const
811 return glsl_base_type_is_64bit(base_type
);
815 * Query whether or not a type is 16-bit
817 bool is_16bit() const
819 return glsl_base_type_is_16bit(base_type
);
823 * Query whether or not a type is 32-bit
825 bool is_32bit() const
827 return base_type
== GLSL_TYPE_UINT
||
828 base_type
== GLSL_TYPE_INT
||
829 base_type
== GLSL_TYPE_FLOAT
;
833 * Query whether or not a type is a non-array boolean type
835 bool is_boolean() const
837 return base_type
== GLSL_TYPE_BOOL
;
841 * Query whether or not a type is a sampler
843 bool is_sampler() const
845 return base_type
== GLSL_TYPE_SAMPLER
;
849 * Query whether or not type is a sampler, or for struct, interface and
850 * array types, contains a sampler.
852 bool contains_sampler() const;
855 * Query whether or not type is an array or for struct, interface and
856 * array types, contains an array.
858 bool contains_array() const;
861 * Get the Mesa texture target index for a sampler type.
863 gl_texture_index
sampler_index() const;
866 * Query whether or not type is an image, or for struct, interface and
867 * array types, contains an image.
869 bool contains_image() const;
872 * Query whether or not a type is an image
874 bool is_image() const
876 return base_type
== GLSL_TYPE_IMAGE
;
880 * Query whether or not a type is an array
882 bool is_array() const
884 return base_type
== GLSL_TYPE_ARRAY
;
887 bool is_array_of_arrays() const
889 return is_array() && fields
.array
->is_array();
893 * Query whether or not a type is a record
895 bool is_struct() const
897 return base_type
== GLSL_TYPE_STRUCT
;
901 * Query whether or not a type is an interface
903 bool is_interface() const
905 return base_type
== GLSL_TYPE_INTERFACE
;
909 * Query whether or not a type is the void type singleton.
913 return base_type
== GLSL_TYPE_VOID
;
917 * Query whether or not a type is the error type singleton.
919 bool is_error() const
921 return base_type
== GLSL_TYPE_ERROR
;
925 * Query if a type is unnamed/anonymous (named by the parser)
928 bool is_subroutine() const
930 return base_type
== GLSL_TYPE_SUBROUTINE
;
932 bool contains_subroutine() const;
934 bool is_anonymous() const
936 return !strncmp(name
, "#anon", 5);
940 * Get the type stripped of any arrays
943 * Pointer to the type of elements of the first non-array type for array
944 * types, or pointer to itself for non-array types.
946 const glsl_type
*without_array() const
948 const glsl_type
*t
= this;
950 while (t
->is_array())
957 * Return the total number of elements in an array including the elements
958 * in arrays of arrays.
960 unsigned arrays_of_arrays_size() const
965 unsigned size
= length
;
966 const glsl_type
*base_type
= fields
.array
;
968 while (base_type
->is_array()) {
969 size
= size
* base_type
->length
;
970 base_type
= base_type
->fields
.array
;
976 * Return bit size for this type.
978 unsigned bit_size() const
980 return glsl_base_type_bit_size(this->base_type
);
985 * Query whether or not a type is an atomic_uint.
987 bool is_atomic_uint() const
989 return base_type
== GLSL_TYPE_ATOMIC_UINT
;
993 * Return the amount of atomic counter storage required for a type.
995 unsigned atomic_size() const
997 if (is_atomic_uint())
998 return ATOMIC_COUNTER_SIZE
;
1000 return length
* fields
.array
->atomic_size();
1006 * Return whether a type contains any atomic counters.
1008 bool contains_atomic() const
1010 return atomic_size() > 0;
1014 * Return whether a type contains any opaque types.
1016 bool contains_opaque() const;
1019 * Query the full type of a matrix row
1022 * If the type is not a matrix, \c glsl_type::error_type is returned.
1023 * Otherwise a type matching the rows of the matrix is returned.
1025 const glsl_type
*row_type() const
1030 if (explicit_stride
&& !interface_row_major
)
1031 return get_instance(base_type
, matrix_columns
, 1, explicit_stride
);
1033 return get_instance(base_type
, matrix_columns
, 1);
1037 * Query the full type of a matrix column
1040 * If the type is not a matrix, \c glsl_type::error_type is returned.
1041 * Otherwise a type matching the columns of the matrix is returned.
1043 const glsl_type
*column_type() const
1048 if (explicit_stride
&& interface_row_major
)
1049 return get_instance(base_type
, vector_elements
, 1, explicit_stride
);
1051 return get_instance(base_type
, vector_elements
, 1);
1055 * Get the type of a structure field
1058 * Pointer to the type of the named field. If the type is not a structure
1059 * or the named field does not exist, \c glsl_type::error_type is returned.
1061 const glsl_type
*field_type(const char *name
) const;
1064 * Get the location of a field within a record type
1066 int field_index(const char *name
) const;
1069 * Query the number of elements in an array type
1072 * The number of elements in the array for array types or -1 for non-array
1073 * types. If the number of elements in the array has not yet been declared,
1076 int array_size() const
1078 return is_array() ? length
: -1;
1082 * Query whether the array size for all dimensions has been declared.
1084 bool is_unsized_array() const
1086 return is_array() && length
== 0;
1090 * Return the number of coordinate components needed for this
1091 * sampler or image type.
1093 * This is based purely on the sampler's dimensionality. For example, this
1094 * returns 1 for sampler1D, and 3 for sampler2DArray.
1096 * Note that this is often different than actual coordinate type used in
1097 * a texturing built-in function, since those pack additional values (such
1098 * as the shadow comparator or projector) into the coordinate type.
1100 int coordinate_components() const;
1103 * Compares whether this type matches another type without taking into
1104 * account the precision in structures.
1106 * This is applied recursively so that structures containing structure
1107 * members can also ignore the precision.
1109 bool compare_no_precision(const glsl_type
*b
) const;
1112 * Compare a record type against another record type.
1114 * This is useful for matching record types declared on the same shader
1115 * stage as well as across different shader stages.
1116 * The option to not match name is needed for matching record types
1117 * declared across different shader stages.
1118 * The option to not match locations is to deal with places where the
1119 * same struct is defined in a block which has a location set on it.
1121 bool record_compare(const glsl_type
*b
, bool match_name
,
1122 bool match_locations
= true,
1123 bool match_precision
= true) const;
1126 * Get the type interface packing.
1128 enum glsl_interface_packing
get_interface_packing() const
1130 return (enum glsl_interface_packing
)interface_packing
;
1134 * Get the type interface packing used internally. For shared and packing
1135 * layouts this is implementation defined.
1137 enum glsl_interface_packing
get_internal_ifc_packing(bool std430_supported
) const
1139 enum glsl_interface_packing packing
= this->get_interface_packing();
1140 if (packing
== GLSL_INTERFACE_PACKING_STD140
||
1141 (!std430_supported
&&
1142 (packing
== GLSL_INTERFACE_PACKING_SHARED
||
1143 packing
== GLSL_INTERFACE_PACKING_PACKED
))) {
1144 return GLSL_INTERFACE_PACKING_STD140
;
1146 assert(packing
== GLSL_INTERFACE_PACKING_STD430
||
1147 (std430_supported
&&
1148 (packing
== GLSL_INTERFACE_PACKING_SHARED
||
1149 packing
== GLSL_INTERFACE_PACKING_PACKED
)));
1150 return GLSL_INTERFACE_PACKING_STD430
;
1155 * Check if the type interface is row major
1157 bool get_interface_row_major() const
1159 return (bool) interface_row_major
;
1166 static mtx_t hash_mutex
;
1169 * ralloc context for the type itself.
1173 /** Constructor for vector and matrix types */
1174 glsl_type(GLenum gl_type
,
1175 glsl_base_type base_type
, unsigned vector_elements
,
1176 unsigned matrix_columns
, const char *name
,
1177 unsigned explicit_stride
= 0, bool row_major
= false);
1179 /** Constructor for sampler or image types */
1180 glsl_type(GLenum gl_type
, glsl_base_type base_type
,
1181 enum glsl_sampler_dim dim
, bool shadow
, bool array
,
1182 glsl_base_type type
, const char *name
);
1184 /** Constructor for record types */
1185 glsl_type(const glsl_struct_field
*fields
, unsigned num_fields
,
1186 const char *name
, bool packed
= false);
1188 /** Constructor for interface types */
1189 glsl_type(const glsl_struct_field
*fields
, unsigned num_fields
,
1190 enum glsl_interface_packing packing
,
1191 bool row_major
, const char *name
);
1193 /** Constructor for interface types */
1194 glsl_type(const glsl_type
*return_type
,
1195 const glsl_function_param
*params
, unsigned num_params
);
1197 /** Constructors for array types */
1198 glsl_type(const glsl_type
*array
, unsigned length
, unsigned explicit_stride
);
1200 /** Constructor for subroutine types */
1201 glsl_type(const char *name
);
1203 /** Hash table containing the known explicit matrix and vector types. */
1204 static struct hash_table
*explicit_matrix_types
;
1206 /** Hash table containing the known array types. */
1207 static struct hash_table
*array_types
;
1209 /** Hash table containing the known struct types. */
1210 static struct hash_table
*struct_types
;
1212 /** Hash table containing the known interface types. */
1213 static struct hash_table
*interface_types
;
1215 /** Hash table containing the known subroutine types. */
1216 static struct hash_table
*subroutine_types
;
1218 /** Hash table containing the known function types. */
1219 static struct hash_table
*function_types
;
1221 static bool record_key_compare(const void *a
, const void *b
);
1222 static unsigned record_key_hash(const void *key
);
1225 * \name Built-in type flyweights
1229 #define DECL_TYPE(NAME, ...) static const glsl_type _##NAME##_type;
1231 #define STRUCT_TYPE(NAME) static const glsl_type _struct_##NAME##_type;
1232 #include "compiler/builtin_type_macros.h"
1236 * \name Friend functions.
1238 * These functions are friends because they must have C linkage and the
1239 * need to call various private methods or access various private static
1243 friend void glsl_type_singleton_init_or_ref(void);
1244 friend void glsl_type_singleton_decref(void);
1245 friend void _mesa_glsl_initialize_types(struct _mesa_glsl_parse_state
*);
1251 #endif /* __cplusplus */
1253 struct glsl_struct_field
{
1254 const struct glsl_type
*type
;
1258 * For interface blocks, gl_varying_slot corresponding to the input/output
1259 * if this is a built-in input/output (i.e. a member of the built-in
1260 * gl_PerVertex interface block); -1 otherwise.
1262 * Ignored for structs.
1267 * For interface blocks, members may have an explicit byte offset
1268 * specified; -1 otherwise. Also used for xfb_offset layout qualifier.
1270 * Unless used for xfb_offset this field is ignored for structs.
1275 * For interface blocks, members may define a transform feedback buffer;
1281 * For interface blocks, members may define a transform feedback stride;
1286 * Layout format, applicable to image variables only.
1288 enum pipe_format image_format
;
1293 * For interface blocks, the interpolation mode (as in
1294 * ir_variable::interpolation). 0 otherwise.
1296 unsigned interpolation
:3;
1299 * For interface blocks, 1 if this variable uses centroid interpolation (as
1300 * in ir_variable::centroid). 0 otherwise.
1302 unsigned centroid
:1;
1305 * For interface blocks, 1 if this variable uses sample interpolation (as
1306 * in ir_variable::sample). 0 otherwise.
1311 * Layout of the matrix. Uses glsl_matrix_layout values.
1313 unsigned matrix_layout
:2;
1316 * For interface blocks, 1 if this variable is a per-patch input or output
1317 * (as in ir_variable::patch). 0 otherwise.
1322 * Precision qualifier
1324 unsigned precision
:2;
1327 * Memory qualifiers, applicable to buffer variables defined in shader
1328 * storage buffer objects (SSBOs)
1330 unsigned memory_read_only
:1;
1331 unsigned memory_write_only
:1;
1332 unsigned memory_coherent
:1;
1333 unsigned memory_volatile
:1;
1334 unsigned memory_restrict
:1;
1337 * Any of the xfb_* qualifiers trigger the shader to be in transform
1338 * feedback mode so we need to keep track of whether the buffer was
1339 * explicitly set or if its just been assigned the default global value.
1341 unsigned explicit_xfb_buffer
:1;
1343 unsigned implicit_sized_array
:1;
1348 #define DEFAULT_CONSTRUCTORS(_type, _name) \
1349 type(_type), name(_name), location(-1), offset(-1), xfb_buffer(0), \
1350 xfb_stride(0), image_format(PIPE_FORMAT_NONE), flags(0) \
1352 glsl_struct_field(const struct glsl_type *_type,
1355 : DEFAULT_CONSTRUCTORS(_type
, _name
)
1357 matrix_layout
= GLSL_MATRIX_LAYOUT_INHERITED
;
1358 precision
= _precision
;
1361 glsl_struct_field(const struct glsl_type
*_type
, const char *_name
)
1362 : DEFAULT_CONSTRUCTORS(_type
, _name
)
1364 matrix_layout
= GLSL_MATRIX_LAYOUT_INHERITED
;
1365 precision
= GLSL_PRECISION_NONE
;
1369 : DEFAULT_CONSTRUCTORS(NULL
, NULL
)
1371 matrix_layout
= GLSL_MATRIX_LAYOUT_INHERITED
;
1372 precision
= GLSL_PRECISION_NONE
;
1374 #undef DEFAULT_CONSTRUCTORS
1378 struct glsl_function_param
{
1379 const struct glsl_type
*type
;
1385 static inline unsigned int
1386 glsl_align(unsigned int a
, unsigned int align
)
1388 return (a
+ align
- 1) / align
* align
;
1391 #endif /* GLSL_TYPES_H */