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);
254 static const glsl_type *get_image_instance(enum glsl_sampler_dim dim,
255 bool array, glsl_base_type type);
258 * Get the instance of an array type
260 static const glsl_type *get_array_instance(const glsl_type *base,
264 * Get the instance of a record type
266 static const glsl_type *get_record_instance(const glsl_struct_field *fields,
271 * Get the instance of an interface block type
273 static const glsl_type *get_interface_instance(const glsl_struct_field *fields,
275 enum glsl_interface_packing packing,
276 const char *block_name);
279 * Get the instance of an subroutine type
281 static const glsl_type *get_subroutine_instance(const char *subroutine_name);
284 * Get the instance of a function type
286 static const glsl_type *get_function_instance(const struct glsl_type *return_type,
287 const glsl_function_param *parameters,
288 unsigned num_params);
291 * Get the type resulting from a multiplication of \p type_a * \p type_b
293 static const glsl_type *get_mul_type(const glsl_type *type_a,
294 const glsl_type *type_b);
297 * Query the total number of scalars that make up a scalar, vector or matrix
299 unsigned components() const
301 return vector_elements * matrix_columns;
305 * Calculate the number of components slots required to hold this type
307 * This is used to determine how many uniform or varying locations a type
310 unsigned component_slots() const;
313 * Calculate offset between the base location of the struct in
314 * uniform storage and a struct member.
315 * For the initial call, length is the index of the member to find the
318 unsigned record_location_offset(unsigned length) const;
321 * Calculate the number of unique values from glGetUniformLocation for the
322 * elements of the type.
324 * This is used to allocate slots in the UniformRemapTable, the amount of
325 * locations may not match with actual used storage space by the driver.
327 unsigned uniform_locations() const;
330 * Used to count the number of varyings contained in the type ignoring
331 * innermost array elements.
333 unsigned varying_count() const;
336 * Calculate the number of attribute slots required to hold this type
338 * This implements the language rules of GLSL 1.50 for counting the number
339 * of slots used by a vertex attribute. It also determines the number of
340 * varying slots the type will use up in the absence of varying packing
341 * (and thus, it can be used to measure the number of varying slots used by
342 * the varyings that are generated by lower_packed_varyings).
344 * For vertex shader attributes - doubles only take one slot.
345 * For inter-shader varyings - dvec3/dvec4 take two slots.
347 unsigned count_attribute_slots(bool is_vertex_input) const;
350 * Alignment in bytes of the start of this type in a std140 uniform
353 unsigned std140_base_alignment(bool row_major) const;
355 /** Size in bytes of this type in a std140 uniform block.
357 * Note that this is not GL_UNIFORM_SIZE (which is the number of
358 * elements in the array)
360 unsigned std140_size(bool row_major) const;
363 * Alignment in bytes of the start of this type in a std430 shader
366 unsigned std430_base_alignment(bool row_major) const;
369 * Calculate array stride in bytes of this type in a std430 shader storage
372 unsigned std430_array_stride(bool row_major) const;
375 * Size in bytes of this type in a std430 shader storage block.
377 * Note that this is not GL_BUFFER_SIZE
379 unsigned std430_size(bool row_major) const;
382 * \brief Can this type be implicitly converted to another?
384 * \return True if the types are identical or if this type can be converted
385 * to \c desired according to Section 4.1.10 of the GLSL spec.
388 * From page 25 (31 of the pdf) of the GLSL 1.50 spec, Section 4.1.10
389 * Implicit Conversions:
391 * In some situations, an expression and its type will be implicitly
392 * converted to a different type. The following table shows all allowed
393 * implicit conversions:
395 * Type of expression | Can be implicitly converted to
396 * --------------------------------------------------
409 * There are no implicit array or structure conversions. For example,
410 * an array of int cannot be implicitly converted to an array of float.
411 * There are no implicit conversions between signed and unsigned
415 bool can_implicitly_convert_to(const glsl_type *desired,
416 _mesa_glsl_parse_state *state) const;
419 * Query whether or not a type is a scalar (non-vector and non-matrix).
421 bool is_scalar() const
423 return (vector_elements == 1)
424 && (base_type >= GLSL_TYPE_UINT)
425 && (base_type <= GLSL_TYPE_BOOL);
429 * Query whether or not a type is a vector
431 bool is_vector() const
433 return (vector_elements > 1)
434 && (matrix_columns == 1)
435 && (base_type >= GLSL_TYPE_UINT)
436 && (base_type <= GLSL_TYPE_BOOL);
440 * Query whether or not a type is a matrix
442 bool is_matrix() const
444 /* GLSL only has float matrices. */
445 return (matrix_columns > 1) && (base_type == GLSL_TYPE_FLOAT || base_type == GLSL_TYPE_DOUBLE);
449 * Query whether or not a type is a non-array numeric type
451 bool is_numeric() const
453 return (base_type >= GLSL_TYPE_UINT) && (base_type <= GLSL_TYPE_DOUBLE);
457 * Query whether or not a type is an integral type
459 bool is_integer() const
461 return (base_type == GLSL_TYPE_UINT) || (base_type == GLSL_TYPE_INT);
465 * Query whether or not type is an integral type, or for struct and array
466 * types, contains an integral type.
468 bool contains_integer() const;
471 * Query whether or not type is a double type, or for struct and array
472 * types, contains a double type.
474 bool contains_double() const;
477 * Query whether or not a type is a float type
479 bool is_float() const
481 return base_type == GLSL_TYPE_FLOAT;
485 * Query whether or not a type is a double type
487 bool is_double() const
489 return base_type == GLSL_TYPE_DOUBLE;
493 * Query whether a double takes two slots.
495 bool is_dual_slot_double() const
497 return base_type == GLSL_TYPE_DOUBLE && vector_elements > 2;
501 * Query whether or not a type is a non-array boolean type
503 bool is_boolean() const
505 return base_type == GLSL_TYPE_BOOL;
509 * Query whether or not a type is a sampler
511 bool is_sampler() const
513 return base_type == GLSL_TYPE_SAMPLER;
517 * Query whether or not type is a sampler, or for struct and array
518 * types, contains a sampler.
520 bool contains_sampler() const;
523 * Get the Mesa texture target index for a sampler type.
525 gl_texture_index sampler_index() const;
528 * Query whether or not type is an image, or for struct and array
529 * types, contains an image.
531 bool contains_image() const;
534 * Query whether or not a type is an image
536 bool is_image() const
538 return base_type == GLSL_TYPE_IMAGE;
542 * Query whether or not a type is an array
544 bool is_array() const
546 return base_type == GLSL_TYPE_ARRAY;
549 bool is_array_of_arrays() const
551 return is_array() && fields.array->is_array();
555 * Query whether or not a type is a record
557 bool is_record() const
559 return base_type == GLSL_TYPE_STRUCT;
563 * Query whether or not a type is an interface
565 bool is_interface() const
567 return base_type == GLSL_TYPE_INTERFACE;
571 * Query whether or not a type is the void type singleton.
575 return base_type == GLSL_TYPE_VOID;
579 * Query whether or not a type is the error type singleton.
581 bool is_error() const
583 return base_type == GLSL_TYPE_ERROR;
587 * Query if a type is unnamed/anonymous (named by the parser)
590 bool is_subroutine() const
592 return base_type == GLSL_TYPE_SUBROUTINE;
594 bool contains_subroutine() const;
596 bool is_anonymous() const
598 return !strncmp(name, "#anon", 5);
602 * Get the type stripped of any arrays
605 * Pointer to the type of elements of the first non-array type for array
606 * types, or pointer to itself for non-array types.
608 const glsl_type *without_array() const
610 const glsl_type *t = this;
612 while (t->is_array())
619 * Return the total number of elements in an array including the elements
620 * in arrays of arrays.
622 unsigned arrays_of_arrays_size() const
627 unsigned size = length;
628 const glsl_type *base_type = fields.array;
630 while (base_type->is_array()) {
631 size = size * base_type->length;
632 base_type = base_type->fields.array;
638 * Return the amount of atomic counter storage required for a type.
640 unsigned atomic_size() const
642 if (base_type == GLSL_TYPE_ATOMIC_UINT)
643 return ATOMIC_COUNTER_SIZE;
645 return length * fields.array->atomic_size();
651 * Return whether a type contains any atomic counters.
653 bool contains_atomic() const
655 return atomic_size() > 0;
659 * Return whether a type contains any opaque types.
661 bool contains_opaque() const;
664 * Query the full type of a matrix row
667 * If the type is not a matrix, \c glsl_type::error_type is returned.
668 * Otherwise a type matching the rows of the matrix is returned.
670 const glsl_type *row_type() const
673 ? get_instance(base_type, matrix_columns, 1)
678 * Query the full type of a matrix column
681 * If the type is not a matrix, \c glsl_type::error_type is returned.
682 * Otherwise a type matching the columns of the matrix is returned.
684 const glsl_type *column_type() const
687 ? get_instance(base_type, vector_elements, 1)
692 * Get the type of a structure field
695 * Pointer to the type of the named field. If the type is not a structure
696 * or the named field does not exist, \c glsl_type::error_type is returned.
698 const glsl_type *field_type(const char *name) const;
701 * Get the location of a field within a record type
703 int field_index(const char *name) const;
706 * Query the number of elements in an array type
709 * The number of elements in the array for array types or -1 for non-array
710 * types. If the number of elements in the array has not yet been declared,
713 int array_size() const
715 return is_array() ? length : -1;
719 * Query whether the array size for all dimensions has been declared.
721 bool is_unsized_array() const
723 return is_array() && length == 0;
727 * Return the number of coordinate components needed for this
728 * sampler or image type.
730 * This is based purely on the sampler's dimensionality. For example, this
731 * returns 1 for sampler1D, and 3 for sampler2DArray.
733 * Note that this is often different than actual coordinate type used in
734 * a texturing built-in function, since those pack additional values (such
735 * as the shadow comparitor or projector) into the coordinate type.
737 int coordinate_components() const;
740 * Compare a record type against another record type.
742 * This is useful for matching record types declared across shader stages.
743 * The option to not match locations is to deal with places where the
744 * same struct is defined in a block which has a location set on it.
746 bool record_compare(const glsl_type *b, bool match_locations = true) const;
753 * ralloc context for all glsl_type allocations
755 * Set on the first call to \c glsl_type::new.
757 static void *mem_ctx;
759 void init_ralloc_type_ctx(void);
761 /** Constructor for vector and matrix types */
762 glsl_type(GLenum gl_type,
763 glsl_base_type base_type, unsigned vector_elements,
764 unsigned matrix_columns, const char *name);
766 /** Constructor for sampler or image types */
767 glsl_type(GLenum gl_type, glsl_base_type base_type,
768 enum glsl_sampler_dim dim, bool shadow, bool array,
769 unsigned type, const char *name);
771 /** Constructor for record types */
772 glsl_type(const glsl_struct_field *fields, unsigned num_fields,
775 /** Constructor for interface types */
776 glsl_type(const glsl_struct_field *fields, unsigned num_fields,
777 enum glsl_interface_packing packing, const char *name);
779 /** Constructor for interface types */
780 glsl_type(const glsl_type *return_type,
781 const glsl_function_param *params, unsigned num_params);
783 /** Constructor for array types */
784 glsl_type(const glsl_type *array, unsigned length);
786 /** Constructor for subroutine types */
787 glsl_type(const char *name);
789 /** Hash table containing the known array types. */
790 static struct hash_table *array_types;
792 /** Hash table containing the known record types. */
793 static struct hash_table *record_types;
795 /** Hash table containing the known interface types. */
796 static struct hash_table *interface_types;
798 /** Hash table containing the known subroutine types. */
799 static struct hash_table *subroutine_types;
801 /** Hash table containing the known function types. */
802 static struct hash_table *function_types;
804 static bool record_key_compare(const void *a, const void *b);
805 static unsigned record_key_hash(const void *key);
808 * \name Built-in type flyweights
812 #define DECL_TYPE(NAME, ...) static const glsl_type _##NAME##_type;
814 #define STRUCT_TYPE(NAME) static const glsl_type _struct_##NAME##_type;
815 #include "compiler/builtin_type_macros.h"
819 * \name Friend functions.
821 * These functions are friends because they must have C linkage and the
822 * need to call various private methods or access various private static
826 friend void _mesa_glsl_initialize_types(struct _mesa_glsl_parse_state *);
827 friend void _mesa_glsl_release_types(void);
833 #endif /* __cplusplus */
835 struct glsl_struct_field {
836 const struct glsl_type *type;
840 * For interface blocks, gl_varying_slot corresponding to the input/output
841 * if this is a built-in input/output (i.e. a member of the built-in
842 * gl_PerVertex interface block); -1 otherwise.
844 * Ignored for structs.
849 * For interface blocks, members may have an explicit byte offset
850 * specified; -1 otherwise. Also used for xfb_offset layout qualifier.
852 * Unless used for xfb_offset this field is ignored for structs.
857 * For interface blocks, members may define a transform feedback buffer;
863 * For interface blocks, members may define a transform feedback stride;
869 * For interface blocks, the interpolation mode (as in
870 * ir_variable::interpolation). 0 otherwise.
872 unsigned interpolation:2;
875 * For interface blocks, 1 if this variable uses centroid interpolation (as
876 * in ir_variable::centroid). 0 otherwise.
881 * For interface blocks, 1 if this variable uses sample interpolation (as
882 * in ir_variable::sample). 0 otherwise.
887 * Layout of the matrix. Uses glsl_matrix_layout values.
889 unsigned matrix_layout:2;
892 * For interface blocks, 1 if this variable is a per-patch input or output
893 * (as in ir_variable::patch). 0 otherwise.
898 * Precision qualifier
900 unsigned precision:2;
903 * Image qualifiers, applicable to buffer variables defined in shader
904 * storage buffer objects (SSBOs)
906 unsigned image_read_only:1;
907 unsigned image_write_only:1;
908 unsigned image_coherent:1;
909 unsigned image_volatile:1;
910 unsigned image_restrict:1;
913 * Any of the xfb_* qualifiers trigger the shader to be in transform
914 * feedback mode so we need to keep track of whether the buffer was
915 * explicitly set or if its just been assigned the default global value.
917 unsigned explicit_xfb_buffer:1;
919 unsigned implicit_sized_array:1;
921 glsl_struct_field(const struct glsl_type *_type, const char *_name)
922 : type(_type), name(_name), location(-1), interpolation(0), centroid(0),
923 sample(0), matrix_layout(GLSL_MATRIX_LAYOUT_INHERITED), patch(0),
924 precision(GLSL_PRECISION_NONE), image_read_only(0), image_write_only(0),
925 image_coherent(0), image_volatile(0), image_restrict(0)
937 struct glsl_function_param {
938 const struct glsl_type *type;
944 static inline unsigned int
945 glsl_align(unsigned int a, unsigned int align)
947 return (a + align - 1) / align * align;
950 #endif /* GLSL_TYPES_H */